google-dfp-api 0.9.4 → 0.9.5

data/examples/{v201405/report_service/run_merged_delivery_report.rb → v201505/report_service/run_report_with_custom_fields.rb}

@@ -3,7 +3,7 @@
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# 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.
@@ -18,18 +18,18 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example runs a report that an upgraded publisher would use to include
-# statistics before the upgrade. To download the report see download_report.rb.
+# This example runs a report filtered on a single custom field. To download the
+# report see download_report.rb.
 #
-# Tags: ReportService.runReportJob, ReportService.getReportJob
+# Tags: ReportService.runReportJob, ReportService.getReportJobStatus
 
 require 'dfp_api'
 
-API_VERSION = :v201405
+API_VERSION = :v201505
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30
 
-def run_merged_delivery_report()
+def run_report_with_custom_fields()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -40,17 +40,15 @@ def run_merged_delivery_report()
   # 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 => ['ORDER_ID', 'ORDER_NAME'],
-    :columns => [
-        'MERGED_AD_SERVER_IMPRESSIONS',
-        'MERGED_AD_SERVER_CLICKS',
-        'MERGED_AD_SERVER_CTR',
-        'MERGED_AD_SERVER_CPM_AND_CPC_REVENUE',
-        'MERGED_AD_SERVER_WITHOUT_CPD_AVERAGE_ECPM'
-    ]
+    :dimensions => ['LINE_ITEM_ID', 'LINE_ITEM_NAME'],
+    :custom_field_ids => [custom_field_id],
+    :columns => ['AD_SERVER_IMPRESSIONS'],
   }
 
   # Create report job.
@@ -61,20 +59,21 @@ def run_merged_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
   begin
-    run_merged_delivery_report()
+    run_report_with_custom_fields()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201405 → v201505}/report_service/run_sales_report.rb

@@ -21,11 +21,11 @@
 # 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.getReportJob
+# Tags: ReportService.runReportJob, ReportService.getReportJobStatus
 
 require 'dfp_api'
 
-API_VERSION = :v201405
+API_VERSION = :v201505
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30
 
@@ -59,15 +59,16 @@ def run_sales_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/{v201405 → v201505}/suggested_ad_unit_service/approve_all_suggested_ad_units.rb

@@ -26,8 +26,9 @@
 # Tags: SuggestedAdUnitService.performSuggestedAdUnitAction
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201405
+API_VERSION = :v201505
 NUMBER_OF_REQUESTS = 50
 
 def approve_suggested_ad_units()
@@ -42,31 +43,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

data/examples/{v201405 → v201505}/suggested_ad_unit_service/get_all_suggested_ad_units.rb

@@ -26,9 +26,9 @@
 # Tags: SuggestedAdUnitService.getSuggestedAdUnitsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201405
-PAGE_SIZE = 500
+API_VERSION = :v201505
 
 def get_all_suggested_ad_units()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -41,32 +41,23 @@ def get_all_suggested_ad_units()
   # Get the SuggestedAdUnitService.
   suggested_ad_unit_service = dfp.service(:SuggestedAdUnitService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create a statement to get all suggested ad units.
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
   begin
-    # Create a statement to get one page with current offset.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
-
     # Get suggested ad units by statement.
-    page =
-        suggested_ad_unit_service.get_suggested_ad_units_by_statement(statement)
+    page = suggested_ad_unit_service.get_suggested_ad_units_by_statement(
+        statement.toStatement())
 
     if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      # Get the start index for printout.
-      start_index = page[:start_index]
-
       # Print details about each suggested ad unit in results.
       page[:results].each_with_index do |ad_unit, index|
         puts "%d) Suggested ad unit ID: '%s' with number of requests: %d" %
-            [index + start_index, ad_unit[:id], ad_unit[:num_requests]]
+            [index + statement.offset, ad_unit[:id], ad_unit[:num_requests]]
       end
     end
-  end while offset < page[:total_result_set_size]
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+  end while statement.offset < page[:total_result_set_size]
 
   # Print a footer.
   if page.include?(:total_result_set_size)

data/examples/{v201405 → v201505}/suggested_ad_unit_service/get_suggested_ad_units_by_statement.rb

@@ -18,16 +18,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets suggested ad units that have more than 50 requests. The
-# statement retrieves up to the maximum page size limit of 500.
+# This example gets suggested ad units that have more than 50 requests. 
 #
 # This feature is only available to DFP premium solution networks.
 #
 # Tags: SuggestedAdUnitService.getSuggestedAdUnitsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201405
+API_VERSION = :v201505
 NUMBER_OF_REQUESTS = 50
 
 def get_suggested_ad_units_by_statement()
@@ -42,27 +42,30 @@ def get_suggested_ad_units_by_statement()
   suggested_ad_unit_service = dfp.service(:SuggestedAdUnitService, API_VERSION)
 
   # Create a statement to only select suggested ad units with more than 50
-  # requests (with maximum limit of 500).
-  statement = {
-     :query => 'WHERE numRequests > :num_requests LIMIT 500',
-     :values => [
-         {:key => 'num_requests',
-          :value => {:value => NUMBER_OF_REQUESTS,
-                     :xsi_type => 'NumberValue'}}
-     ]
-  }
+  # requests.
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE numRequests > :num_requests ORDER BY id ASC',
+      [
+          {:key => 'num_requests',
+           :value => {:value => NUMBER_OF_REQUESTS,
+                      :xsi_type => 'NumberValue'}}
+      ]
+  )
 
-  # Get ad units by statement.
-  page =
-      suggested_ad_unit_service.get_suggested_ad_units_by_statement(statement)
+  begin
+    # Get ad units by statement.
+    page = suggested_ad_unit_service.get_suggested_ad_units_by_statement(
+        statement.toStatement())
 
-  if page[:results]
-    # Print details about each suggested ad unit in results.
-    page[:results].each_with_index do |ad_unit, index|
-      puts "%d) Suggested ad unit ID: '%s', number of requests: %d" %
-          [index, ad_unit[:id], ad_unit[:num_requests]]
+    if page[:results]
+      # Print details about each suggested ad unit in results.
+      page[:results].each_with_index do |ad_unit, index|
+        puts "%d) Suggested ad unit ID: '%s', number of requests: %d" %
+            [index + statement.offset, ad_unit[:id], ad_unit[:num_requests]]
+      end
     end
-  end
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+  end statement.offset < page[:total_result_set_size]
 
   # Print a footer.
   if page.include?(:total_result_set_size)

data/examples/{v201405 → v201505}/team_service/create_teams.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201405
+API_VERSION = :v201505
 ITEM_COUNT = 5
 
 def create_teams()

data/examples/{v201405 → v201505}/team_service/get_all_teams.rb

@@ -23,9 +23,9 @@
 # Tags: TeamService.getTeamsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201405
-PAGE_SIZE = 500
+API_VERSION = :v201505
 
 def get_all_teams()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -38,31 +38,22 @@ def get_all_teams()
   # Get the TeamService.
   team_service = dfp.service(:TeamService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create statement for all teams.
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
   begin
-    # Create statement for one page with current offset.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
-
     # Get teams by statement.
-    page = team_service.get_teams_by_statement(statement)
+    page = team_service.get_teams_by_statement(statement.toStatement())
 
     if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      # Get the start index for printout.
-      start_index = page[:start_index]
-
       # Print details about each team in results page.
       page[:results].each_with_index do |team, index|
         puts "%d) Team ID: %d, name: %s" %
-            [index + start_index, team[:id], team[:name]]
+            [index + statement.offset, team[:id], team[:name]]
       end
     end
-  end while offset < page[:total_result_set_size]
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+  end while statement.offset < page[:total_result_set_size]
 
   # Print a footer
   if page.include?(:total_result_set_size)

data/examples/{v201405 → v201505}/team_service/get_teams_by_statement.rb

@@ -18,14 +18,14 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all teams ordered by name. The statement retrieves up to the
-# maximum page size limit of 500. To create teams, run create_teams.rb.
+# This example gets all teams ordered by name.
 #
 # Tags: TeamService.getTeamsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201405
+API_VERSION = :v201505
 
 def get_teams_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -38,17 +38,21 @@ def get_teams_by_statement()
   # Get the TeamService.
   team_service = dfp.service(:TeamService, API_VERSION)
 
-  # Create a statement to order teams by name.
-  statement = {:query => "ORDER BY name LIMIT 500"}
+  # Create a statement to order teams by id.
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY name ASC')
 
-  # Get teams by statement.
-  page = team_service.get_teams_by_statement(statement)
+  begin
+    # Get teams by statement.
+    page = team_service.get_teams_by_statement(statement.toStatement())
 
-  if page and page[:results]
-    page[:results].each_with_index do |team, index|
-      puts "%d) Team ID: %d, name: %s." % [index, team[:id], team[:name]]
+    if page and page[:results]
+      page[:results].each_with_index do |team, index|
+        puts "%d) Team ID: %d, name: %s." % [index + statement.offset,
+                                             team[:id], team[:name]]
+      end
     end
-  end
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+  end while statement.offset < page[:total_result_set_size]
 
   # Print a footer.
   if page.include?(:total_result_set_size)

data/examples/{v201405 → v201505}/team_service/update_teams.rb

@@ -25,8 +25,9 @@
 # Tags: TeamService.getTeamsByStatement, TeamService.updateTeams
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201405
+API_VERSION = :v201505
 
 def update_teams()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -43,10 +44,10 @@ def update_teams()
   team_service = dfp.service(:TeamService, API_VERSION)
 
   # Create a statement to select first 5 teams that aren't built-in.
-  statement = {:query => 'WHERE id > 0 LIMIT 5'}
+  statement = DfpApiStatement::FilterStatement.new('WHERE id > 0', [], 5)
 
   # Get teams by statement.
-  page = team_service.get_teams_by_statement(statement)
+  page = team_service.get_teams_by_statement(statement.toStatement())
 
   if page[:results]
     teams = page[:results]

data/examples/{v201405 → v201505}/user_service/create_users.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201405
+API_VERSION = :v201505
 
 def create_users()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201405 → v201505}/user_service/deactivate_users.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201405
+API_VERSION = :v201505
 
 def deactivate_users()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -43,16 +43,16 @@ def deactivate_users()
   user_id = 'INSERT_USER_ID_HERE'
 
   # Create filter text to select user by id.
-  statement = {
-      :query => 'WHERE id = :user_id',
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :user_id',
+      [
           {:key => 'user_id',
            :value => {:value => user_id, :xsi_type => 'NumberValue'}}
       ]
-  }
+  )
 
   # Get users by statement.
-  page = user_service.get_users_by_statement(statement)
+  page = user_service.get_users_by_statement(statement.toStatement())
 
   if page[:results]
     page[:results].each do |user|
@@ -62,7 +62,7 @@ def deactivate_users()
 
     # Perform action.
     result = user_service.perform_user_action(
-        {:xsi_type => 'DeactivateUsers'}, statement)
+        {:xsi_type => 'DeactivateUsers'}, statement.toStatement())
 
     # Display results.
     if result and result[:num_changes] > 0