google-dfp-api 0.9.3 → 0.9.4

data/examples/{v201403 → v201502}/custom_targeting_service/get_all_custom_targeting_keys_and_values.rb

@@ -25,9 +25,9 @@
 # Tags: CustomTargetingService.getCustomTargetingValuesByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201403
-PAGE_SIZE = 500
+API_VERSION = :v201502
 
 def get_all_custom_targeting_keys_and_values()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -40,29 +40,19 @@ def get_all_custom_targeting_keys_and_values()
   # Get the CustomTargetingService.
   custom_targeting_service = dfp.service(:CustomTargetingService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
-
   begin
     # Create a statement to get one page with current offset.
-    statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
+    statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
     # Get custom targeting keys by statement.
     page = custom_targeting_service.get_custom_targeting_keys_by_statement(
-        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 key in results.
       page[:results].each_with_index do |custom_targeting_key, index|
         puts ("%d) Custom targeting key ID: %d, name: %s,  displayName: %s, " +
-              "type: %s") % [index + start_index,
+              "type: %s") % [index + statement.offset,
                              custom_targeting_key[:id],
                              custom_targeting_key[:name],
                              custom_targeting_key[:display_name],
@@ -70,7 +60,8 @@ def get_all_custom_targeting_keys_and_values()
         print_all_values_for_key(custom_targeting_service, custom_targeting_key)
       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)
@@ -80,45 +71,33 @@ def get_all_custom_targeting_keys_and_values()
 end
 
 def print_all_values_for_key(custom_targeting_service, custom_targeting_key)
-  # Define initial values.
-  offset = 0
-  page = {}
-
   # Create a statement to get values for given key.
-  statement_text = "WHERE customTargetingKeyId = :key_id LIMIT %d" % PAGE_SIZE
-  statement = {
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE customTargetingKeyId = :key_id',
+      [
           {:key => 'key_id',
            :value => {:value => custom_targeting_key[:id],
                       :xsi_type => 'NumberValue'}}
       ]
-  }
+  )
 
   begin
-    # Modify statement to get the next page.
-    statement[:query] = statement_text + " OFFSET %d" % offset
-
     # Get custom targeting values by statement.
     page = custom_targeting_service.get_custom_targeting_values_by_statement(
-        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 value in results.
       page[:results].each_with_index do |custom_targeting_value, index|
         puts ("\t%d) Custom targeting value ID: %d, name: %s, displayName: %s") %
-            [index + start_index,
+            [index + statement.offset,
              custom_targeting_value[:id],
              custom_targeting_value[:name],
              custom_targeting_value[:display_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/{v201403 → v201502}/custom_targeting_service/get_custom_targeting_keys_by_statement.rb

@@ -25,8 +25,9 @@
 # Tags: CustomTargetingService.getCustomTargetingKeysByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201403
+API_VERSION = :v201502
 
 def get_custom_targeting_keys_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -40,29 +41,32 @@ 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 = {
-      :query => 'WHERE type = :type LIMIT 500',
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE type = :type ORDER BY id ASC',
+      [
           {:key => 'type',
            :value => {:value => 'PREDEFINED', :xsi_type => 'TextValue'}}
       ]
-  }
+  )
 
   # Get custom targeting keys by statement.
   page = custom_targeting_service.get_custom_targeting_keys_by_statement(
-      statement)
+      statement.toStatement())
 
-  if page[:results]
-    # Print details about each key in results.
-    page[:results].each_with_index do |custom_targeting_key, index|
-      puts ("%d) Custom targeting key with ID [%d], name: %s," +
-          " displayName: %s type: %s") % [index,
-                                          custom_targeting_key[:id],
-                                          custom_targeting_key[:name],
-                                          custom_targeting_key[:display_name],
-                                          custom_targeting_key[:type]]
+  begin
+    if page[:results]
+      # Print details about each key in results.
+      page[:results].each_with_index do |custom_targeting_key, index|
+        puts ("%d) Custom targeting key with ID [%d], name: %s," +
+            " displayName: %s type: %s") % [index + statement.offset,
+                                            custom_targeting_key[:id],
+                                            custom_targeting_key[:name],
+                                            custom_targeting_key[:display_name],
+                                            custom_targeting_key[:type]]
+      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/{v201403 → v201502}/custom_targeting_service/get_custom_targeting_values_by_statement.rb

@@ -27,8 +27,9 @@
 # Tags: CustomTargetingService.getCustomTargetingValuesByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201403
+API_VERSION = :v201502
 
 def get_custom_targeting_values_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -45,30 +46,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 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/{v201403 → v201502}/custom_targeting_service/update_custom_targeting_keys.rb

@@ -26,8 +26,9 @@
 # Tags: CustomTargetingService.updateCustomTargetingKeys
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201403
+API_VERSION = :v201502
 
 def update_custom_targeting_keys()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -40,8 +41,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/{v201403 → v201502}/custom_targeting_service/update_custom_targeting_values.rb

@@ -18,16 +18,17 @@
 #           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 = :v201403
+API_VERSION = :v201502
 
 def update_custom_targeting_values()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -44,44 +45,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/{v201403/forecast_service/get_forecast.rb → v201502/forecast_service/get_availability_forecast.rb}

@@ -3,7 +3,7 @@
 #
 # 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.
@@ -21,13 +21,13 @@
 # This example gets a forecast for a prospective line item. To determine which
 # placements exist, run get_all_placements.rb.
 #
-# Tags: ForecastService.getForecast
+# Tags: ForecastService.getAvailabilityForecast
 
 require 'dfp_api'
 
-API_VERSION = :v201403
+API_VERSION = :v201502
 
-def get_forecast()
+def get_availability_forecast()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -35,21 +35,31 @@ 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 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.
@@ -62,14 +72,28 @@ def get_forecast()
     :start_date_time_type => 'IMMEDIATELY',
     :end_date_time => Time.utc(2014, 01, 01),
     # Set the line item to use 50% of the impressions.
-    :unit_type => 'IMPRESSIONS',
-    :units_bought => 50,
+    :primary_goal => {:goal => {
+      :units => '50',
+      :unit_type => 'IMPRESSIONS',
+      :goal_type => 'DAILY'}
+    },
     # Set the cost type to match the unit type.
     :cost_type => 'CPM'
   }
 
+  prospective_line_item = {
+    :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.
@@ -78,17 +102,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