google-dfp-api 0.9.3 → 0.9.4

data/examples/{v201403/forecast_service/get_forecast_by_id.rb → v201502/forecast_service/get_availability_forecast_for_line_item.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.
@@ -18,16 +18,16 @@
 #           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.
 #
-# Tags: ForecastService.getForecastById
+# Tags: ForecastService.getAvailabilityForecastById
 
 require 'dfp_api'
 
-API_VERSION = :v201403
+API_VERSION = :v201502
 
-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 +35,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 +58,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/v201502/forecast_service/get_delivery_forecast_for_line_items.rb

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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.
+#
+# Tags: ForecastService.getDeliveryForecastByIds
+
+require 'dfp_api'
+
+API_VERSION = :v201502
+
+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

data/examples/{v201403 → v201502}/inventory_service/create_ad_units.rb

@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201403
+API_VERSION = :v201502
 # Number of ad units to create.
 ITEM_COUNT = 5
 

data/examples/{v201403 → v201502}/inventory_service/create_mobile_ad_unit.rb

@@ -28,7 +28,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201403
+API_VERSION = :v201502
 
 def create_mobile_ad_unit()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201403 → v201502}/inventory_service/create_video_ad_unit.rb

@@ -28,7 +28,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201403
+API_VERSION = :v201502
 
 def create_video_ad_unit()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201403 → v201502}/inventory_service/deactivate_ad_units.rb

@@ -25,9 +25,9 @@
 # Tags: InventoryService.performAdUnitAction
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201403
-PAGE_SIZE = 500
+API_VERSION = :v201502
 
 def deactivate_ad_units()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -41,50 +41,46 @@ def deactivate_ad_units()
   inventory_service = dfp.service(:InventoryService, API_VERSION)
 
   # Create statement text to select active ad units.
-  statement_text = 'WHERE status = :status'
-  statement = {
-      :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE status = :status',
+      [
           {:key => 'status',
            :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
       ]
-  }
+  )
 
-  # Define initial values.
-  offset = 0
-  page = {}
   ad_unit_ids = []
 
   begin
-    # Create a statement to get one page with the current offset.
-    statement[:query] = statement_text +
-        " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
-
     # Get ad units by statement.
-    page = inventory_service.get_ad_units_by_statement(statement)
+    page = inventory_service.get_ad_units_by_statement(statement.toStatement())
 
     if page[:results]
-      # Increase query offset by page size.
-      offset += PAGE_SIZE
-
-      page[:results].each do |ad_unit|
+      page[:results].each_with_index do |ad_unit, index|
         puts ("%d) Ad unit with ID: %d, status: %s and name: %s will be " +
-              "deactivated.") % [ad_unit_ids.size, ad_unit[:id],
+              "deactivated.") % [index + statement.offset, ad_unit[:id],
               ad_unit[:status], ad_unit[:name]]
         ad_unit_ids << ad_unit[:id]
       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]
 
   puts "Number of ad units to be deactivated: %d" % ad_unit_ids.size
 
   if !ad_unit_ids.empty?
     # Modify statement for action. Note, the values are still present.
-    statement[:query] = statement_text + " AND id IN (%s)" %
-        ad_unit_ids.join(', ')
+    statement = DfpApiStatement::FilterStatement.new(
+        "WHERE status = :status AND id in (%s)" % ad_unit_ids.join(', '),
+        [
+            {:key => 'status',
+             :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
+        ]
+    )
 
     # Perform action.
     result = inventory_service.perform_ad_unit_action(
-        {:xsi_type => 'DeactivateAdUnits'}, statement)
+        {:xsi_type => 'DeactivateAdUnits'}, statement.toStatement())
 
     # Display results.
     if result and result[:num_changes] > 0

data/examples/{v201403 → v201502}/inventory_service/get_ad_unit_sizes.rb

@@ -18,13 +18,14 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This code example gets all web target platform ad unit sizes.
+# This code example gets all ad unit sizes.
 #
 # Tags: InventoryService.getAdUnitSizesByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201403
+API_VERSION = :v201502
 
 def get_all_ad_unit_sizes()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -37,20 +38,12 @@ def get_all_ad_unit_sizes()
   # Get the InventoryService.
   inventory_service = dfp.service(:InventoryService, API_VERSION)
 
-  target_platform = 'WEB'
-
-  # Create statement object to only select web ad unit sizes.
-  statement = {
-     :query => 'WHERE targetPlatform = :target_platform',
-     :values => [
-         {:key => 'target_platform',
-          :value => {:value => target_platform,
-                     :xsi_type => 'TextValue'}}
-     ]
-  }
+  # Create statement select all ad unit sizes.
+  statement = DfpApiStatement::FilterStatement.new('ORDER BY id ASC')
 
   # Get ad unit sizes by statement.
-  ad_unit_sizes = inventory_service.get_ad_unit_sizes_by_statement(statement)
+  ad_unit_sizes = inventory_service.get_ad_unit_sizes_by_statement(
+      statement.toStatement())
 
   if ad_unit_sizes
     # Print details about each ad unit in results.

data/examples/{v201403 → v201502}/inventory_service/get_ad_units_by_statement.rb

@@ -24,8 +24,9 @@
 # Tags: InventoryService.getAdUnitsByStatement, NetworkService.getCurrentNetwork
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201403
+API_VERSION = :v201502
 
 def get_ad_units_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -48,25 +49,29 @@ def get_ad_units_by_statement()
   puts "Using effective root ad unit: %d" % effective_root_ad_unit_id
 
   # Create a statement to select the children of the effective root ad unit.
-  statement = {
-     :query => 'WHERE parentId = :id LIMIT 500',
-     :values => [
+  statement = DfpApiStatement::FilterStatement.new(
+     'WHERE parentId = :id ORDER BY id',
+     [
          {:key => 'id',
           :value => {:value => effective_root_ad_unit_id,
                      :xsi_type => 'NumberValue'}}
      ]
-  }
+  )
 
-  # Get ad units by statement.
-  page = inventory_service.get_ad_units_by_statement(statement)
+  begin
+    # Get ad units by statement.
+    page = inventory_service.get_ad_units_by_statement(statement.toStatement())
 
-  if page[:results]
-    # Print details about each 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]]
+    if page[:results]
+      # Print details about each ad unit in results.
+      page[:results].each_with_index do |ad_unit, index|
+        puts "%d) Ad unit ID: %d, name: %s, status: %s." %
+            [index + statement.offset, ad_unit[:id],
+             ad_unit[:name], ad_unit[:status]]
+      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}/inventory_service/get_all_ad_units.rb

@@ -23,9 +23,9 @@
 # Tags: InventoryService.getAdUnitsByStatement
 
 require 'dfp_api'
+require 'dfp_api_statement'
 
-API_VERSION = :v201403
-PAGE_SIZE = 500
+API_VERSION = :v201502
 
 def get_all_ad_units()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -38,32 +38,23 @@ def get_all_ad_units()
   # Get the InventoryService.
   inventory_service = dfp.service(:InventoryService, API_VERSION)
 
-  # Define initial values.
-  offset = 0
-  page = {}
+  # Create a statement to get all 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 ad units by statement.
-    page = inventory_service.get_ad_units_by_statement(statement)
+    page = inventory_service.get_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 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],
+            [index + statement.offset, ad_unit[:id],
              ad_unit[:name], ad_unit[:status]]
       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}/inventory_service/update_ad_units.rb

@@ -18,7 +18,7 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example updates an ad unit by enabling AdSense to the first 500. To
+# This example adds a new 1x1 creative placeholder for a specific ad unit. To
 # determine which ad units exist, run get_all_ad_units.rb or
 # get_inventory_tree.rb.
 #
@@ -26,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201403
+API_VERSION = :v201502
 
 def update_ad_units()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,19 +39,33 @@ def update_ad_units()
   # Get the InventoryService.
   inventory_service = dfp.service(:InventoryService, API_VERSION)
 
+  # Specify which ad unit to update.
+  ad_unit_id = 'INSERT_AD_UNIT_ID_HERE'.to_i
+
   # Create a statement to get first 500 ad units.
-  statement = {:query => "LIMIT 500"}
+  statement = DfpApiStatement::FilterStatement.new(
+      'WHERE id = :id',
+      [
+          {:key => 'id',
+           :value => {:value => ad_unit_id, :xsi_type => 'NumberValue'}}
+      ],
+      1
+  }
 
   # Get ad units by statement.
-  page = inventory_service.get_ad_units_by_statement(statement)
+  page = inventory_service.get_ad_units_by_statement(statement.toStatement())
 
   if page[:results]
     ad_units = page[:results]
 
-    # Update each local ad unit object by enabling AdSense.
+    new_ad_unit_size = {
+        :size => {:width => 1, :height => 1, :is_aspect_ration => false},
+        :environment_type => 'BROWSER'
+    }
+
+    # Update local ad unit by adding a new size of 1x1.
     ad_units.each do |ad_unit|
-      ad_unit[:inherited_ad_sense_settings] =
-          {:value => {:ad_sense_enabled => true}}
+      ad_unit[:ad_unit_sizes] = ad_unit[:ad_unit_sizes] << new_ad_unit_size
       # Workaround for issue #94.
       ad_unit[:description] = "" if ad_unit[:description].nil?
     end
@@ -61,10 +75,8 @@ def update_ad_units()
 
     if return_ad_units
       return_ad_units.each do |ad_unit|
-        puts ("Ad unit with ID: %d, name: %s and status: %s was updated " +
-            "with AdSense enabled: %s") %
-            [ad_unit[:id], ad_unit[:name], ad_unit[:status],
-             ad_unit[:inherited_ad_sense_settings][:value][:ad_sense_enabled]]
+        puts ("Ad unit with ID: %d, name: %s and status: %s was updated") %
+            [ad_unit[:id], ad_unit[:name], ad_unit[:status]]
       end
     else
       raise 'No ad units were updated.'