google-dfp-api 0.10.0 → 0.10.1

data/examples/{v201408 → v201508}/custom_targeting_service/get_custom_targeting_values_by_statement.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");
@@ -23,12 +21,11 @@
 # 500. To create custom targeting values, run
 # create_custom_targeting_keys_and_values.rb. To determine which custom
 # targeting keys exist, run get_all_custom_targeting_keys_and_values.rb.
-#
-# Tags: CustomTargetingService.getCustomTargetingValuesByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def get_custom_targeting_values_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -45,31 +42,33 @@ def get_custom_targeting_values_by_statement()
   custom_targeting_key_id = 'INSERT_CUSTOM_TARGETING_KEY_ID_HERE'.to_i
 
   # Create a statement to only select custom targeting values for a given key.
-  statement = {
-      :query => 'WHERE customTargetingKeyId = :key_id ORDER BY id ' +
-          'ASC LIMIT 500',
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE customTargetingKeyId = :key_id ORDER BY id',
+      [
           {:key => 'key_id',
            :value => {:value => custom_targeting_key_id,
                       :xsi_type => 'NumberValue'}
           }
       ]
-  }
+  )
 
   # Get custom targeting values by statement.
   page = custom_targeting_service.get_custom_targeting_values_by_statement(
-      statement)
+      statement.toStatement())
 
-  if page[:results]
-    # Print details about each value in results.
-    page[:results].each_with_index do |custom_targeting_value, index|
-      puts ("%d) Custom targeting value with ID [%d], name: %s," +
-          " displayName: %s") % [index,
-                                 custom_targeting_value[:id],
-                                 custom_targeting_value[:name],
-                                 custom_targeting_value[:display_name]]
+  begin
+    if page[:results]
+      # Print details about each value in results.
+      page[:results].each_with_index do |custom_targeting_value, index|
+        puts ("%d) Custom targeting value with ID [%d], name: %s," +
+            " displayName: %s") % [index + statement.offset,
+                                   custom_targeting_value[:id],
+                                   custom_targeting_value[:name],
+                                   custom_targeting_value[:display_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/{v201408 → v201508}/custom_targeting_service/update_custom_targeting_keys.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 example updates the display name of each custom targeting key up to the
 # first 500. To determine which custom targeting keys exist, run
 # get_all_custom_targeting_keys_and_values.rb.
-#
-# Tags: CustomTargetingService.getCustomTargetingKeysByStatement
-# Tags: CustomTargetingService.updateCustomTargetingKeys
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def update_custom_targeting_keys()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -40,8 +36,8 @@ def update_custom_targeting_keys()
   # Get the CustomTargetingService.
   custom_targeting_service = dfp.service(:CustomTargetingService, API_VERSION)
 
-  # Create a statement to get first 500 custom targeting keys.
-  statement = {:query => "LIMIT 500"}
+  # Create a statement to get all custom targeting keys.
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
   # Get custom targeting keys by statement.
   page = custom_targeting_service.get_custom_targeting_keys_by_statement(

data/examples/{v201408 → v201508}/custom_targeting_service/update_custom_targeting_values.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");
@@ -18,16 +16,14 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example updates the display name of each custom targeting value up to
-# the first 500. To determine which custom targeting keys exist, run
+# This example updates the display name of each custom targeting value belonging
+# to a single key. To determine which custom targeting keys exist, run
 # get_all_custom_targeting_keys_and_values.rb.
-#
-# Tags: CustomTargetingService.getCustomTargetingValuesByStatement
-# Tags: CustomTargetingService.updateCustomTargetingValues
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
 def update_custom_targeting_values()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -44,44 +40,47 @@ def update_custom_targeting_values()
   custom_targeting_key_id = 'INSERT_CUSTOM_TARGETING_KEY_ID_HERE'.to_i
 
   # Create a statement to get first 500 custom targeting keys.
-  statement = {
-      :query => 'WHERE customTargetingKeyId = :key_id LIMIT 500',
+  statement = DfpApiStatement::FilterStatement.new(
+      :query => 'WHERE customTargetingKeyId = :key_id',
       :values => [
           {:key => 'key_id',
            :value => {:value => custom_targeting_key_id,
                       :xsi_type => 'NumberValue'}
           }
       ]
-  }
+  )
 
-  # Get custom targeting keys by statement.
-  page = custom_targeting_service.get_custom_targeting_values_by_statement(
-      statement)
-  values = page[:results]
-
-  raise 'No targeting values found to update' if !values || values.empty?
+  begin
+    # Get custom targeting keys by statement.
+    page = custom_targeting_service.get_custom_targeting_values_by_statement(
+        statement.toStatement())
 
-  # Update each local custom targeting values object by changing its display
-  # name.
-  values.each do |value|
-    display_name = (value[:display_name].nil?) ?
-        value[:name] : value[:display_name]
-    value[:display_name] = display_name + ' (Deprecated)'
-  end
+    if page[:results]
+      # Update each local custom targeting values object by changing its display
+      # name.
+      page[:results].each do |value|
+        display_name = (value[:display_name].nil?) ?
+            value[:name] : value[:display_name]
+        value[:display_name] = display_name + ' (Deprecated)'
+      end
 
-  # Update the custom targeting keys on the server.
-  result_values = custom_targeting_service.update_custom_targeting_values(values)
+      # Update the custom targeting keys on the server.
+      result_values = custom_targeting_service.update_custom_targeting_values(
+          values)
 
-  if result_values
-    # Print details about each value in results.
-    result_values.each_with_index do |custom_targeting_value, index|
-      puts ("%d) Custom targeting key with ID [%d], name: %s," +
-          " displayName: %s was updated") % [index, custom_targeting_value[:id],
-          custom_targeting_value[:name], custom_targeting_value[:display_name]]
+      if result_values
+      # Print details about each value in results.
+        result_values.each_with_index do |custom_targeting_value, index|
+          puts ("%d) Custom targeting key with ID [%d], name: %s," +
+                " displayName: %s was updated") % [
+                    index + statement.offset, custom_targeting_value[:id],
+                    custom_targeting_value[:name],
+                    custom_targeting_value[:display_name]]
+        end
+      end
     end
-  else
-    puts 'No targeting keys values updated'
-  end
+    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+  end while statement.offset < page[:total_result_set_size]
 end
 
 if __FILE__ == $0

data/examples/{v201408/forecast_service/get_forecast.rb → v201508/forecast_service/get_availability_forecast.rb}

@@ -1,9 +1,7 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2015, 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.
@@ -20,14 +18,12 @@
 #
 # This example gets a forecast for a prospective line item. To determine which
 # placements exist, run get_all_placements.rb.
-#
-# Tags: ForecastService.getForecast
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
-def get_forecast()
+def get_availability_forecast()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -35,21 +31,36 @@ def get_forecast()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the CreativeService.
+  # Get the ForecastService.
   forecast_service = dfp.service(:ForecastService, API_VERSION)
 
-  # Set the placement that the prospective line item will target.
-  targeted_placement_ids = ['INSERT_PLACEMENT_ID_HERE'.to_i]
+  # Get the NetworkService.
+  network_service = dfp.service(:NetworkService, API_VERSION)
+
+  # Set the advertiser to assign the prospective line item to.
+  # This allows for forecasting while taking into account
+  # same advertiser exclusion.
+  advertiser_id = 'INSERT_ADVERTISER_ID_HERE'.to_i
+
+  # Set the root ad unit to target the entire network.
+  root_ad_unit_id = (
+      network_service.get_current_network()[:effective_root_ad_unit_id].to_i)
 
   # Create targeting.
   targeting = {
-      :inventory_targeting =>
-          {:targeted_placement_ids => targeted_placement_ids}
+    :inventory_targeting => {
+      :targeted_ad_units => [
+        {
+          :include_descendants => True,
+          :ad_unit_id => root_ad_unit_id
+        }
+      ]
+    }
   }
 
   # Create the creative placeholder.
   creative_placeholder = {
-      :size => {:width => 300, :height => 250, :is_aspect_ratio => false}
+    :size => {:width => 300, :height => 250, :is_aspect_ratio => false}
   }
 
   # Create prospective line item.
@@ -63,16 +74,28 @@ def get_forecast()
     :end_date_time => Time.utc(2014, 01, 01),
     # Set the line item to use 50% of the impressions.
     :primary_goal => {:goal => {
-        :units => '50',
-        :unit_type => 'IMPRESSIONS',
-        :goal_type => 'DAILY'}
-    }
+      :units => '50',
+      :unit_type => 'IMPRESSIONS',
+      :goal_type => 'DAILY'}
+    },
     # Set the cost type to match the unit type.
     :cost_type => 'CPM'
   }
 
+  prospective_line_item = {
+    :advertiser_id => advertiser_id,
+    :line_item => line_item
+  }
+
+  # Set forecasting options.
+  forecast_options = {
+    :include_contending_line_items => True,
+    :include_targeting_criteria_breakdown => True,
+  }
+
   # Get forecast for the line item.
-  forecast = forecast_service.get_forecast(line_item)
+  forecast = forecast_service.get_availability_forecast(
+      prospective_line_item, forecast_options)
 
   if forecast
     # Display results.
@@ -81,17 +104,17 @@ def get_forecast()
     unit_type = forecast[:unit_type].to_s.downcase
     puts "%.2f %s matched." % [matched, unit_type]
     puts "%.2f%% %s available." % [available_percent, unit_type]
+    puts "%d contending line items." % forecast[:contending_line_items].size
     if forecast[:possible_units]
       possible_percent = forecast[:possible_units] * 100.0 / matched
       puts "%.2f%% %s possible." % [possible_percent, unit_type]
     end
-    puts "%d contending line items." % forecast[:contending_line_items].size
   end
 end
 
 if __FILE__ == $0
   begin
-    get_forecast()
+    get_availability_forecast()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201408/forecast_service/get_forecast_by_id.rb → v201508/forecast_service/get_availability_forecast_for_line_item.rb}

@@ -1,9 +1,7 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2015, 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,16 +16,14 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets a forecast for an existing line item. To determine which
-# line items exist, run get_all_line_items.rb.
-#
-# Tags: ForecastService.getForecastById
+# This example gets a forecast for a prospective line item. To determine which
+# placements exist, run get_all_placements.rb.
 
 require 'dfp_api'
 
-API_VERSION = :v201408
+API_VERSION = :v201508
 
-def get_forecast_by_id()
+def get_availability_forecast_for_line_item()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -35,14 +31,21 @@ def get_forecast_by_id()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the CreativeService.
+  # Get the ForecastService.
   forecast_service = dfp.service(:ForecastService, API_VERSION)
 
   # Set the line item to get a forecast for.
   line_item_id = 'INSERT_LINE_ITEM_ID_HERE'.to_i
 
-  # Get forecast for line item.
-  forecast = forecast_service.get_forecast_by_id(line_item_id)
+  # Set forecasting options.
+  forecast_options = {
+    :include_contending_line_items => True,
+    :include_targeting_criteria_breakdown => True,
+  }
+
+  # Get forecast for the line item.
+  forecast = forecast_service.get_availability_forecast_by_id(
+      line_item_id, forecast_options)
 
   if forecast
     # Display results.
@@ -51,17 +54,17 @@ def get_forecast_by_id()
     unit_type = forecast[:unit_type].to_s.downcase
     puts "%.2f %s matched." % [matched, unit_type]
     puts "%.2f%% %s available." % [available_percent, unit_type]
+    puts "%d contending line items." % forecast[:contending_line_items].size
     if forecast[:possible_units]
       possible_percent = forecast[:possible_units] * 100.0 / matched
       puts "%.2f%% %s possible." % [possible_percent, unit_type]
     end
-    puts "%d contending line items." % forecast[:contending_line_items].size
   end
 end
 
 if __FILE__ == $0
   begin
-    get_forecast_by_id()
+    get_availability_forecast_for_line_item()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201508/forecast_service/get_delivery_forecast_for_line_items.rb

@@ -0,0 +1,77 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Copyright:: Copyright 2015, 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 gets a delivery forecast for multiple line items. To determine
+# which placements exist, run get_all_placements.rb.
+
+require 'dfp_api'
+
+API_VERSION = :v201508
+
+def get_delivery_forecast_for_line_items()
+  # 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 ForecastService.
+  forecast_service = dfp.service(:ForecastService, API_VERSION)
+
+  # Set the line items to get a forecast for.
+  line_item_id1 = 'INSERT_LINE_ITEM_ID_1_HERE'.to_i
+  line_item_id2 = 'INSERT_LINE_ITEM_ID_2_HERE'.to_i
+
+  # Get forecast for the line item.
+  forecast = forecast_service.get_delivery_forecast_by_ids(
+      [line_item_id1, line_item_id2], nil)
+
+  if forecast
+    forecast[:line_item_delivery_forecasts].each do |single_forecast|
+      # Display results.
+      unit_type = single_forecast[:unit_type]
+      puts ('Forecast for line item %d:\n\t%d %s matched\n\t%d %s ' +
+            'delivered\n\t%d %s predicted\n') % [
+                single_forecast[:line_item_id], single_forecast[:matched_units],
+                unit_type, single_forecast[:delivered_units], unit_type,
+                single_forecast[:predicted_delivery_units], unit_type]
+    end
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_delivery_forecast_for_line_items()
+
+  # 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