google-dfp-api 0.10.0 → 0.10.1

data/examples/{v201408 → v201508}/publisher_query_language_service/get_line_items_named_like.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
 # Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,15 +18,13 @@
 #
 # This example gets all line items which have a name beginning with "line item".
 # This example may take a while to run.
-#
-# Tags: PublisherQueryLanguageService.select
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 # A string to separate columns in output. Use "," to get CSV.
 COLUMN_SEPARATOR = "\t"
-PAGE_SIZE = 500
 
 def get_line_items_named_like()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -44,16 +40,16 @@ def get_line_items_named_like()
   # Create a statement to select all line items matching subtext.
   statement_text =
       "SELECT Id, Name, Status FROM Line_Item WHERE Name LIKE 'line item%%' " +
-      "ORDER BY Id ASC LIMIT %d OFFSET %d"
+      "ORDER BY Id ASC"
+
+  statement = DfpApiStatement::FilterStatement.new(statement_text)
 
   # Set initial values for paging.
-  offset, result_set, all_rows = 0, nil, 0
+  result_set, all_rows = nil, 0
 
-  # Get all cities starting with "Santa".
+  # Get all line items starting with "line item".
   begin
-    # Create statement for a page.
-    statement = {:query => statement_text % [PAGE_SIZE, offset]}
-    result_set = pql_service.select(statement)
+    result_set = pql_service.select(statement.toStatement())
 
     if result_set
       # Print out columns header.
@@ -68,9 +64,9 @@ def get_line_items_named_like()
     end
 
     # Update the counters.
-    offset += PAGE_SIZE
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
     all_rows += result_set[:rows].size
-  end while result_set[:rows].size == PAGE_SIZE
+  end while result_set[:rows].size == DfpApiStatement::SUGGESTED_PAGE_LIMIT
 
   # Print a footer.
   if result_set[:rows]

data/examples/{v201408 → v201508}/report_service/display_report.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.davidtorres@gmail.com (David Torres)
-#
 # Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,14 +19,12 @@
 # This example downloads a completed report and prints out its contents. To
 # download a completed report to a file, run download_report.rb. To run
 # a report, run run_delivery_report.rb.
-#
-# Tags: ReportService.getReportDownloadURL
 
 require 'dfp_api'
 
 require 'open-uri'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def display_report()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201408 → v201508}/report_service/download_report.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,14 +18,12 @@
 #
 # This example downloads a completed report. To run a report, run
 # run_delivery_report.rb, run_sales_report.rb or run_inventory_report.rb.
-#
-# Tags: ReportService.getReportDownloadURL
 
 require 'dfp_api'
 
 require 'open-uri'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def download_report()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201408 → v201508}/report_service/run_delivery_report.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,12 +19,11 @@
 # This example runs a report similar to the "Orders report" on the DFP website
 # with additional attributes and can filter to include just one order.
 # To download the report see download_report.rb.
-#
-# Tags: ReportService.runReportJob, ReportService.getReportJob
 
+require 'date'
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30
 
@@ -44,9 +41,19 @@ def run_delivery_report()
   # Specify the order ID to filter by.
   order_id = 'INSERT_ORDER_ID_HERE'.to_i
 
+  # Specify a report to run for the last 7 days.
+  report_end_date = DateTime.now
+  report_start_date = report_end_date - 7
+
   # Create report query.
   report_query = {
-    :date_range_type => 'LAST_MONTH',
+    :date_range_type => 'CUSTOM_DATE',
+    :start_date => {:year => report_start_date.year,
+                    :month => report_start_date.month,
+                    :day => report_start_date.day},
+    :end_date => {:year => report_end_date.year,
+                  :month => report_end_date.month,
+                  :day => report_end_date.day},
     :dimensions => ['ORDER_ID', 'ORDER_NAME'],
     :dimension_attributes => ['ORDER_TRAFFICKER', 'ORDER_START_DATE_TIME',
         'ORDER_END_DATE_TIME'],
@@ -70,15 +77,16 @@ def run_delivery_report()
 
   MAX_RETRIES.times do |retry_count|
     # Get the report job status.
-    report_job = report_service.get_report_job(report_job[:id])
+    report_job_status = report_service.get_report_job_status(report_job[:id])
 
-    break unless report_job[:report_job_status] == 'IN_PROGRESS'
+    break unless report_job_status == 'IN_PROGRESS'
     puts "Report with ID: %d is still running." % report_job[:id]
     sleep(RETRY_INTERVAL)
   end
 
   puts "Report job with ID: %d finished with status %s." %
-      [report_job[:id], report_job[:report_job_status]]
+      [report_job[:id],
+       report_service.get_report_job_status(report_job[:id])]
 end
 
 if __FILE__ == $0

data/examples/{v201408 → v201508}/report_service/run_inventory_report.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,12 +18,10 @@
 #
 # This example runs a report equal to the "Whole network report" on the DFP
 # website. To download the report see download_report.rb.
-#
-# Tags: ReportService.runReportJob, ReportService.getReportJob
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30
 
@@ -79,15 +75,16 @@ def run_inventory_report()
 
   MAX_RETRIES.times do |retry_count|
     # Get the report job status.
-    report_job = report_service.get_report_job(report_job[:id])
+    report_job_status = report_service.get_report_job_status(report_job[:id])
 
-    break unless report_job[:report_job_status] == 'IN_PROGRESS'
+    break unless report_job_status == 'IN_PROGRESS'
     puts "Report with ID: %d is still running." % report_job[:id]
     sleep(RETRY_INTERVAL)
   end
 
   puts "Report job with ID: %d finished with status %s." %
-      [report_job[:id], report_job[:report_job_status]]
+      [report_job[:id],
+       report_service.get_report_job_status(report_job[:id])]
 end
 
 if __FILE__ == $0

data/examples/{v201408 → v201508}/report_service/run_reach_report.rb

@@ -1,6 +1,5 @@
 #!/usr/bin/env ruby
-#
-# Author:: api.davidtorres@gmail.com (David Torres)
+# Encoding: utf-8
 #
 # Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
 #
@@ -19,12 +18,10 @@
 #
 # This example runs a reach report. To download the report see
 # download_report.rb.
-#
-# Tags: ReportService.runReportJob, ReportService.getReportJob
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30
 
@@ -54,15 +51,16 @@ def run_reach_report()
 
   MAX_RETRIES.times do |retry_count|
     # Get the report job status.
-    report_job = report_service.get_report_job(report_job[:id])
+    report_job_status = report_service.get_report_job_status(report_job[:id])
 
-    break unless report_job[:report_job_status] == 'IN_PROGRESS'
+    break unless report_job_status == 'IN_PROGRESS'
     puts "Report with ID: %d is still running." % report_job[:id]
     sleep(RETRY_INTERVAL)
   end
 
   puts "Report job with ID: %d finished with status %s." %
-      [report_job[:id], report_job[:report_job_status]]
+      [report_job[:id],
+       report_service.get_report_job_status(report_job[:id])]
 end
 
 if __FILE__ == $0

data/examples/v201508/report_service/run_report_with_custom_fields.rb

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
+#
+# License:: Licensed under the Apache License, Version 2.0 (the "License");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+# This example runs a report filtered on a single custom field. To download the
+# report see download_report.rb.
+
+require 'dfp_api'
+
+API_VERSION = :v201508
+MAX_RETRIES = 10
+RETRY_INTERVAL = 30
+
+def run_report_with_custom_fields()
+  # Get DfpApi instance and load configuration from ~/dfp_api.yml.
+  dfp = DfpApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # dfp.logger = Logger.new('dfp_xml.log')
+
+  # Get the ReportService.
+  report_service = dfp.service(:ReportService, API_VERSION)
+
+  # Set the ID of the custom field to filter on.
+  custom_field_id = 'INSERT_CUSTOM_FIELD_ID_HERE'.to_i
+
+  # Create report query.
+  report_query = {
+    :date_range_type => 'LAST_MONTH',
+    :dimensions => ['LINE_ITEM_ID', 'LINE_ITEM_NAME'],
+    :custom_field_ids => [custom_field_id],
+    :columns => ['AD_SERVER_IMPRESSIONS'],
+  }
+
+  # Create report job.
+  report_job = {:report_query => report_query}
+
+  # Run report job.
+  report_job = report_service.run_report_job(report_job);
+
+  MAX_RETRIES.times do |retry_count|
+    # Get the report job status.
+    report_job_status = report_service.get_report_job_status(report_job[:id])
+
+    break unless report_job_status == 'IN_PROGRESS'
+    puts "Report with ID: %d is still running." % report_job[:id]
+    sleep(RETRY_INTERVAL)
+  end
+
+  puts "Report job with ID: %d finished with status %s." %
+      [report_job[:id],
+       report_service.get_report_job_status(report_job[:id])]
+end
+
+if __FILE__ == $0
+  begin
+    run_report_with_custom_fields()
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue DfpApi::Errors::ApiException => e
+    puts "Message: %s" % e.message
+    puts 'Errors:'
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
+      end
+    end
+  end
+end

data/examples/{v201408 → v201508}/report_service/run_sales_report.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,12 +18,10 @@
 #
 # This example runs a report equal to the "Sales by salespersons report" on the
 # DFP website. To download the report see download_report.rb.
-#
-# Tags: ReportService.runReportJob, ReportService.getReportJobStatus
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30
 
@@ -67,7 +63,8 @@ def run_sales_report()
   end
 
   puts "Report job with ID: %d finished with status %s." %
-      [report_job[:id], report_job[:report_job_status]]
+      [report_job[:id],
+       report_service.get_report_job_status(report_job[:id])]
 end
 
 if __FILE__ == $0

data/examples/{v201408 → v201508}/suggested_ad_unit_service/approve_all_suggested_ad_units.rb

@@ -1,8 +1,6 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
 # License:: Licensed under the Apache License, Version 2.0 (the "License");
@@ -21,13 +19,11 @@
 # This code example approves all suggested ad units with 50 or more requests.
 #
 # This feature is only available to DFP premium solution networks.
-#
-# Tags: SuggestedAdUnitService.getSuggestedAdUnitsByStatement
-# Tags: SuggestedAdUnitService.performSuggestedAdUnitAction
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 NUMBER_OF_REQUESTS = 50
 
 def approve_suggested_ad_units()
@@ -42,31 +38,34 @@ def approve_suggested_ad_units()
   suggested_ad_unit_service = dfp.service(:SuggestedAdUnitService, API_VERSION)
 
   # Create a statement to only select suggested ad units with 50 or more
-  # requests (with maximum limit of 500).
-  statement = {
-     :query => 'WHERE numRequests >= :num_requests',
-     :values => [
-         {:key => 'num_requests',
-          :value => {:value => NUMBER_OF_REQUESTS,
-                     :xsi_type => 'NumberValue'}}
-     ]
-  }
+  # requests.
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE numRequests >= :num_requests',
+      [
+          {:key => 'num_requests',
+           :value => {:value => NUMBER_OF_REQUESTS,
+                      :xsi_type => 'NumberValue'}}
+      ]
+  )
 
-  # Get suggested ad units by statement.
-  page =
-      suggested_ad_unit_service.get_suggested_ad_units_by_statement(statement)
+  begin
+    # Get suggested ad units by statement.
+    page = suggested_ad_unit_service.get_suggested_ad_units_by_statement(
+        statement.toStatement())
 
-  unit_count_to_approve = 0
+    unit_count_to_approve = 0
 
-  if page[:results]
-    page[:results].each do |ad_unit|
-      if ad_unit[:num_requests] >= NUMBER_OF_REQUESTS
-        puts(("%d) Suggested ad unit with ID '%s' and %d requests will be " +
-            "approved.") % [suggested_ad_unit_ids.size, ad_unit[:id],
-            ad_unit[:num_requests]])
-        unit_count_to_approve += 1
+    if page[:results]
+      page[:results].each_with_index do |ad_unit, index|
+        if ad_unit[:num_requests] >= NUMBER_OF_REQUESTS
+          puts(("%d) Suggested ad unit with ID '%s' and %d requests will be " +
+              "approved.") % [index + statement.offset, ad_unit[:id],
+              ad_unit[:num_requests]])
+          unit_count_to_approve += 1
+        end
       end
     end
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
   end
 
   puts "Number of suggested ad units to be approved: %d" % unit_count_to_approve