google-dfp-api 0.10.1 → 0.12.0

data/examples/{v201411 → v201511}/custom_targeting_service/delete_custom_targeting_values.rb

@@ -21,9 +21,9 @@
 # get_all_custom_targeting_keys_and_values.rb.
 
 require 'dfp_api'
-require 'dfp_api_statement'
 
-API_VERSION = :v201411
+
+API_VERSION = :v201511
 
 def delete_custom_targeting_values()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -44,7 +44,7 @@ def delete_custom_targeting_values()
 
   # Create statement to only select custom values by the given custom targeting
   # key ID.
-  statement = DfpApiStatement::FilterStatement.new(
+  statement = DfpApi::FilterStatement.new(
       'WHERE customTargetingKeyId = :key_id',
       [
           {:key => 'key_id',
@@ -66,7 +66,7 @@ def delete_custom_targeting_values()
         custom_target_value_ids << value[:id]
       end
     end
-    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
   end while statement.offset < page[:total_result_set_size]
 
   # Print a footer.
@@ -75,7 +75,7 @@ def delete_custom_targeting_values()
 
   if !(custom_target_value_ids.empty?)
     # Modify statement for action, note, values are still present.
-    statement = DfpApiStatement::FilterStatement.new(
+    statement = DfpApi::FilterStatement.new(
         "WHERE customTargetingKeyId = :key_id AND id IN (%s)" %
         [custom_target_value_ids.join(', ')],
         [

data/examples/{v201411 → v201511}/custom_targeting_service/get_all_custom_targeting_keys_and_values.rb

@@ -20,9 +20,9 @@
 # targeting keys and values, run create_custom_targeting_keys_and_values.rb.
 
 require 'dfp_api'
-require 'dfp_api_statement'
 
-API_VERSION = :v201411
+
+API_VERSION = :v201511
 
 def get_all_custom_targeting_keys_and_values()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -37,7 +37,7 @@ def get_all_custom_targeting_keys_and_values()
 
   begin
     # Create a statement to get one page with current offset.
-    statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
+    statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
 
     # Get custom targeting keys by statement.
     page = custom_targeting_service.get_custom_targeting_keys_by_statement(
@@ -55,7 +55,7 @@ def get_all_custom_targeting_keys_and_values()
         print_all_values_for_key(custom_targeting_service, custom_targeting_key)
       end
     end
-    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
   end while statement.offset < page[:total_result_set_size]
 
   # Print a footer.
@@ -67,7 +67,7 @@ end
 
 def print_all_values_for_key(custom_targeting_service, custom_targeting_key)
   # Create a statement to get values for given key.
-  statement = DfpApiStatement::FilterStatement.new(
+  statement = DfpApi::FilterStatement.new(
       'WHERE customTargetingKeyId = :key_id',
       [
           {:key => 'key_id',
@@ -91,7 +91,7 @@ def print_all_values_for_key(custom_targeting_service, custom_targeting_key)
              custom_targeting_value[:display_name]]
       end
     end
-    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
   end while statement.offset < page[:total_result_set_size]
 
   # Print a footer.

data/examples/{v201411 → v201511}/custom_targeting_service/get_custom_targeting_keys_by_statement.rb

@@ -21,9 +21,9 @@
 # targeting keys, run create_custom_targeting_keys_and_values.rb.
 
 require 'dfp_api'
-require 'dfp_api_statement'
 
-API_VERSION = :v201411
+
+API_VERSION = :v201511
 
 def get_custom_targeting_keys_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -37,7 +37,7 @@ def get_custom_targeting_keys_by_statement()
   custom_targeting_service = dfp.service(:CustomTargetingService, API_VERSION)
 
   # Create a statement to only select predefined custom targeting keys.
-  statement = DfpApiStatement::FilterStatement.new(
+  statement = DfpApi::FilterStatement.new(
       'WHERE type = :type ORDER BY id ASC',
       [
           {:key => 'type',
@@ -61,7 +61,7 @@ def get_custom_targeting_keys_by_statement()
                                             custom_targeting_key[:type]]
       end
     end
-    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
   end while statement.offset < page[:total_result_set_size]
 
   # Print a footer.

data/examples/{v201411 → v201511}/custom_targeting_service/get_custom_targeting_values_by_statement.rb

@@ -23,9 +23,9 @@
 # targeting keys exist, run get_all_custom_targeting_keys_and_values.rb.
 
 require 'dfp_api'
-require 'dfp_api_statement'
 
-API_VERSION = :v201411
+
+API_VERSION = :v201511
 
 def get_custom_targeting_values_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -42,7 +42,7 @@ 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 = DfpApiStatement::FilterStatement.new(
+  statement = DfpApi::FilterStatement.new(
       'WHERE customTargetingKeyId = :key_id ORDER BY id',
       [
           {:key => 'key_id',
@@ -67,7 +67,7 @@ def get_custom_targeting_values_by_statement()
                                    custom_targeting_value[:display_name]]
       end
     end
-    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
   end while statement.offset < page[:total_result_set_size]
 
   # Print a footer.

data/examples/{v201411 → v201511}/custom_targeting_service/update_custom_targeting_keys.rb

@@ -21,9 +21,9 @@
 # get_all_custom_targeting_keys_and_values.rb.
 
 require 'dfp_api'
-require 'dfp_api_statement'
 
-API_VERSION = :v201411
+
+API_VERSION = :v201511
 
 def update_custom_targeting_keys()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -37,7 +37,7 @@ def update_custom_targeting_keys()
   custom_targeting_service = dfp.service(:CustomTargetingService, API_VERSION)
 
   # Create a statement to get all custom targeting keys.
-  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
+  statement = DfpApi::FilterStatement.new('ORDER BY id ASC')
 
   # Get custom targeting keys by statement.
   page = custom_targeting_service.get_custom_targeting_keys_by_statement(

data/examples/{v201411 → v201511}/custom_targeting_service/update_custom_targeting_values.rb

@@ -21,9 +21,9 @@
 # get_all_custom_targeting_keys_and_values.rb.
 
 require 'dfp_api'
-require 'dfp_api_statement'
 
-API_VERSION = :v201411
+
+API_VERSION = :v201511
 
 def update_custom_targeting_values()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -40,7 +40,7 @@ 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 = DfpApiStatement::FilterStatement.new(
+  statement = DfpApi::FilterStatement.new(
       :query => 'WHERE customTargetingKeyId = :key_id',
       :values => [
           {:key => 'key_id',
@@ -79,7 +79,7 @@ def update_custom_targeting_values()
         end
       end
     end
-    statement.offset += DfpApiStatement::SUGGESTED_PAGE_LIMIT
+    statement.offset += DfpApi::SUGGESTED_PAGE_LIMIT
   end while statement.offset < page[:total_result_set_size]
 end
 

data/examples/{v201411/forecast_service/get_forecast.rb → v201511/forecast_service/get_availability_forecast.rb}

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# 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.
@@ -21,9 +21,9 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201411
+API_VERSION = :v201511
 
-def get_forecast()
+def get_availability_forecast()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -31,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.
@@ -59,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.
@@ -77,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/{v201411/forecast_service/get_forecast_by_id.rb → v201511/forecast_service/get_availability_forecast_for_line_item.rb}

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# 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.
@@ -16,14 +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.
+# 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 = :v201411
+API_VERSION = :v201511
 
-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
 
@@ -31,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.
@@ -47,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/v201511/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 = :v201511
+
+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