google-dfp-api 0.2.8 → 0.3.0

data/examples/{v201107 → v201203}/report_service/download_report.rb

@@ -26,7 +26,7 @@ require 'dfp_api'
 
 require 'open-uri'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 
 def download_report()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201104 → v201203}/report_service/run_delivery_report.rb

@@ -17,14 +17,15 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example runs a report equal to the "Orders report" on the DFP website.
+# 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 'dfp_api'
 
-API_VERSION = :v201104
+API_VERSION = :v201203
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30
 
@@ -39,12 +40,25 @@ def run_delivery_report()
   # Get the ReportService.
   report_service = dfp.service(:ReportService, API_VERSION)
 
+  # Specify the order ID to filter by.
+  order_id = 'INSERT_ORDER_ID_HERE'.to_i
+
   # Create report query.
   report_query = {
     :date_range_type => 'LAST_MONTH',
     :dimensions => ['ORDER'],
+    :dimension_attributes => ['ORDER_TRAFFICKER', 'ORDER_START_DATE_TIME',
+        'ORDER_END_DATE_TIME'],
     :columns => ['AD_SERVER_IMPRESSIONS', 'AD_SERVER_CLICKS', 'AD_SERVER_CTR',
-        'AD_SERVER_REVENUE', 'AD_SERVER_AVERAGE_ECPM']
+        'AD_SERVER_REVENUE', 'AD_SERVER_AVERAGE_ECPM'],
+    # Create statement object to filter for an order.
+    :statement => {
+        :query => 'WHERE orderId = :order_id',
+        :values => [
+            {:key => 'order_id',
+             :value => {:value => order_id, :xsi_type => 'NumberValue'}}
+        ]
+    }
   }
 
   # Create report job.

data/examples/{v201104 → v201203}/report_service/run_inventory_report.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201104
+API_VERSION = :v201203
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30
 
@@ -43,9 +43,11 @@ def run_inventory_report()
   report_query = {
     :date_range_type => 'LAST_WEEK',
     :dimensions => ['DATE'],
+    :ad_unit_view => 'HIERARCHICAL',
     :columns => ['AD_SERVER_IMPRESSIONS', 'AD_SERVER_CLICKS',
         'ADSENSE_IMPRESSIONS', 'ADSENSE_CLICKS', 'TOTAL_IMPRESSIONS',
-        'TOTAL_REVENUE']
+        'TOTAL_REVENUE'],
+    :date_range_type => 'LAST_WEEK'
   }
 
   # Create report job.

data/examples/{v201107/report_service/run_delivery_report.rb → v201203/report_service/run_merged_delivery_report.rb}

@@ -17,18 +17,18 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example runs a report equal to the "Orders report" on the DFP website.
-# To download the report see download_report.rb.
+# 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.
 #
 # Tags: ReportService.runReportJob, ReportService.getReportJob
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30
 
-def run_delivery_report()
+def run_merged_delivery_report()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -43,8 +43,13 @@ def run_delivery_report()
   report_query = {
     :date_range_type => 'LAST_MONTH',
     :dimensions => ['ORDER'],
-    :columns => ['AD_SERVER_IMPRESSIONS', 'AD_SERVER_CLICKS', 'AD_SERVER_CTR',
-        'AD_SERVER_REVENUE', 'AD_SERVER_AVERAGE_ECPM']
+    :columns => [
+        'MERGED_AD_SERVER_IMPRESSIONS',
+        'MERGED_AD_SERVER_CLICKS',
+        'MERGED_AD_SERVER_CTR',
+        'MERGED_AD_SERVER_REVENUE',
+        'MERGED_AD_SERVER_AVERAGE_ECPM'
+    ]
   }
 
   # Create report job.
@@ -68,7 +73,7 @@ end
 
 if __FILE__ == $0
   begin
-    run_delivery_report()
+    run_merged_delivery_report()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201107 → v201203}/report_service/run_sales_report.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 MAX_RETRIES = 10
 RETRY_INTERVAL = 30
 

data/examples/v201203/suggested_ad_unit_service/approve_all_suggested_ad_units.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/ruby
+#
+# 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");
+#           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 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,
+#       SuggestedAdUnitService.performSuggestedAdUnitAction
+
+require 'dfp_api'
+
+API_VERSION = :v201203
+NUMBER_OF_REQUESTS = 50
+
+def approve_suggested_ad_units()
+  # 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 SuggestedAdUnitService.
+  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'}}
+     ]
+  }
+
+  # Get suggested ad units by statement.
+  page =
+      suggested_ad_unit_service.get_suggested_ad_units_by_statement(statement)
+
+  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
+      end
+    end
+  end
+
+  puts "Number of suggested ad units to be approved: %d" % unit_count_to_approve
+
+  if unit_count_to_approve > 0
+    # Perform action with the same statement.
+    result = suggested_ad_unit_service.perform_suggested_ad_unit_action(
+        {:xsi_type => 'ApproveSuggestedAdUnit'}, statement)
+
+    # Display results.
+    if result and result[:num_changes] > 0
+      puts "Number of ad units approved: %d" % result[:num_changes]
+    else
+      puts 'No ad units were approved.'
+    end
+  else
+    puts 'No ad units found to approve.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    approve_suggested_ad_units()
+
+  # 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/{v201107/inventory_service/get_all_ad_units.rb → v201203/suggested_ad_unit_service/get_all_suggested_ad_units.rb}

@@ -17,16 +17,19 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all ad units. To create ad units, run create_ad_units.rb.
+# This example gets all suggested ad units. To approve suggested ad units, run
+# approve_suggested_ad_units.rb.
 #
-# Tags: InventoryService.getAdUnitsByStatement
+# This feature is only available to DFP premium solution networks.
+#
+# Tags: SuggestedAdUnitService.getSuggestedAdUnitsByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 PAGE_SIZE = 500
 
-def get_all_ad_units()
+def get_all_suggested_ad_units()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -34,8 +37,8 @@ def get_all_ad_units()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the InventoryService.
-  inventory_service = dfp.service(:InventoryService, API_VERSION)
+  # Get the SuggestedAdUnitService.
+  suggested_ad_unit_service = dfp.service(:SuggestedAdUnitService, API_VERSION)
 
   # Define initial values.
   offset = 0
@@ -45,8 +48,9 @@ def get_all_ad_units()
     # Create a statement to get one page with current offset.
     statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
 
-    # Get ad units by statement.
-    page = inventory_service.get_ad_units_by_statement(statement)
+    # Get suggested ad units by statement.
+    page =
+        suggested_ad_unit_service.get_suggested_ad_units_by_statement(statement)
 
     if page[:results]
       # Increase query offset by page size.
@@ -55,24 +59,23 @@ def get_all_ad_units()
       # Get the start index for printout.
       start_index = page[:start_index]
 
-      # Print details about each ad unit in results.
+      # Print details about each suggested ad unit in results.
       page[:results].each_with_index do |ad_unit, index|
-        puts "%d) Ad unit ID: %d, name: %s, status: %s." %
-            [index + start_index, ad_unit[:id],
-             ad_unit[:name], ad_unit[:status]]
+        puts "%d) Suggested ad unit ID: '%s' with number of requests: %d" %
+            [index + start_index, ad_unit[:id], ad_unit[:num_requests]]
       end
     end
   end while offset < page[:total_result_set_size]
 
   # Print a footer.
   if page.include?(:total_result_set_size)
-    puts "Total number of ad units: %d" % page[:total_result_set_size]
+    puts "Total number of suggested ad units: %d" % page[:total_result_set_size]
   end
 end
 
 if __FILE__ == $0
   begin
-    get_all_ad_units()
+    get_all_suggested_ad_units()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201104/inventory_service/get_ad_unit.rb → v201203/suggested_ad_unit_service/get_suggested_ad_unit.rb}

@@ -17,16 +17,18 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets an ad unit by its ID. To determine which ad units
-# exist, run get_inventory_tree.rb or get_all_ad_units.rb.
+# This example gets a suggested ad unit by its ID. To determine which suggested
+# ad units exist, run get_all_suggested_ad_units.rb.
 #
-# Tags: InventoryService.getAdUnit
+# This feature is only available to DFP premium solution networks.
+#
+# Tags: SuggestedAdUnitService.getSuggestedAdUnit
 
 require 'dfp_api'
 
-API_VERSION = :v201104
+API_VERSION = :v201203
 
-def get_ad_unit()
+def get_suggested_ad_unit()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -34,24 +36,25 @@ def get_ad_unit()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the InventoryService.
-  inventory_service = dfp.service(:InventoryService, API_VERSION)
+  # Get the SuggestedAdUnitService.
+  suggested_ad_unit_service = dfp.service(:SuggestedAdUnitService, API_VERSION)
 
   # Set the ID of the ad unit to get.
-  ad_unit_id = 'INSERT_AD_UNIT_ID_HERE'.to_i
+  suggested_ad_unit_id = 'INSERT_SUGGESTED_AD_UNIT_ID_HERE'
 
-  # Get the ad unit.
-  ad_unit = inventory_service.get_ad_unit(ad_unit_id)
+  # Get the suggested ad unit.
+  suggested_ad_unit =
+      suggested_ad_unit_service.get_suggested_ad_unit(suggested_ad_unit_id)
 
-  if ad_unit
-    puts "Ad unit with ID: %d, name: %s and status: %s was found." %
-        [ad_unit[:id], ad_unit[:name], ad_unit[:status]]
+  if suggested_ad_unit
+    puts "Suggested ad unit with ID: '%s' and number of requests: %d" %
+        [suggested_ad_unit[:id], suggested_ad_unit[:num_requests]]
   end
 end
 
 if __FILE__ == $0
   begin
-    get_ad_unit()
+    get_suggested_ad_unit()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201107/inventory_service/get_ad_units_by_statement.rb → v201203/suggested_ad_unit_service/get_suggested_ad_units_by_statement.rb}

@@ -17,16 +17,19 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets first 500 children below the effective root ad unit. To
-# create ad units, run create_ad_units.rb.
+# This example gets suggested ad units that have more than 50 requests. The
+# statement retrieves up to the maximum page size limit of 500.
 #
-# Tags: InventoryService.getAdUnitsByStatement, NetworkService.getCurrentNetwork
+# This feature is only available to DFP premium solution networks.
+#
+# Tags: SuggestedAdUnitService.getSuggestedAdUnitsByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
+NUMBER_OF_REQUESTS = 50
 
-def get_ad_units_by_statement()
+def get_suggested_ad_units_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -34,48 +37,41 @@ def get_ad_units_by_statement()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the InventoryService.
-  inventory_service = dfp.service(:InventoryService, API_VERSION)
-
-  # Get the NetworkService.
-  network_service = dfp.service(:NetworkService, API_VERSION)
-
-  # Get the effective root ad unit ID of the network.
-  effective_root_ad_unit_id =
-      network_service.get_current_network[:effective_root_ad_unit_id]
-
-  puts "Using effective root ad unit: %d" % effective_root_ad_unit_id
+  # Get the SuggestedAdUnitService.
+  suggested_ad_unit_service = dfp.service(:SuggestedAdUnitService, API_VERSION)
 
-  # Create a statement to select the children of the effective root ad unit.
+  # Create a statement to only select suggested ad units with more than 50
+  # requests (with maximum limit of 500).
   statement = {
-     :query => 'WHERE parentId = :id LIMIT 500',
+     :query => 'WHERE numRequests > :num_requests LIMIT 500',
      :values => [
-         {:key => 'id',
-          :value => {:value => effective_root_ad_unit_id,
+         {:key => 'num_requests',
+          :value => {:value => NUMBER_OF_REQUESTS,
                      :xsi_type => 'NumberValue'}}
      ]
   }
 
   # Get ad units by statement.
-  page = inventory_service.get_ad_units_by_statement(statement)
+  page =
+      suggested_ad_unit_service.get_suggested_ad_units_by_statement(statement)
 
   if page[:results]
-    # Print details about each ad unit in results.
+    # Print details about each suggested ad unit in results.
     page[:results].each_with_index do |ad_unit, index|
-      puts "%d) Ad unit ID: %d, name: %s, status: %s." %
-          [index, ad_unit[:id], ad_unit[:name], ad_unit[:status]]
+      puts "%d) Suggested ad unit ID: '%s', number of requests: %d" %
+          [index, ad_unit[:id], ad_unit[:num_requests]]
     end
   end
 
   # Print a footer.
   if page.include?(:total_result_set_size)
-    puts "Total number of ad units: %d" % page[:total_result_set_size]
+    puts "Total number of suggested ad units: %d" % page[:total_result_set_size]
   end
 end
 
 if __FILE__ == $0
   begin
-    get_ad_units_by_statement()
+    get_suggested_ad_units_by_statement()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e