google-dfp-api 0.6.2 → 0.6.3

data/examples/v201306/forecast_service/get_forecast.rb

@@ -0,0 +1,107 @@
+#!/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");
+#           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 forecast for a prospective line item. To determine which
+# placements exist, run get_all_placements.rb.
+#
+# Tags: ForecastService.getForecast
+
+require 'dfp_api'
+
+API_VERSION = :v201306
+
+def get_forecast()
+  # 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 CreativeService.
+  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]
+
+  # Create targeting.
+  targeting = {
+      :inventory_targeting =>
+          {:targeted_placement_ids => targeted_placement_ids}
+  }
+
+  # Create the creative placeholder.
+  creative_placeholder = {
+      :size => {:width => 300, :height => 250, :is_aspect_ratio => false}
+  }
+
+  # Create prospective line item.
+  line_item = {
+    :line_item_type => 'SPONSORSHIP',
+    :targeting => targeting,
+    # Set the size of creatives that can be associated with this line item.
+    :creative_placeholders => [creative_placeholder],
+    # Set the line item's time to be now until the projected end date time.
+    :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,
+    # Set the cost type to match the unit type.
+    :cost_type => 'CPM'
+  }
+
+  # Get forecast for the line item.
+  forecast = forecast_service.get_forecast(line_item)
+
+  if forecast
+    # Display results.
+    matched = forecast[:matched_units]
+    available_percent = forecast[:available_units] * 100.0 / matched
+    unit_type = forecast[:unit_type].to_s.downcase
+    puts "%.2f %s matched." % [matched, unit_type]
+    puts "%.2f%% %s available." % [available_percent, unit_type]
+    if forecast[:possible_units]
+      possible_percent = forecast[:possible_units] * 100.0 / matched
+      puts "%.2f%% %s possible." % [possible_percent, unit_type]
+    end
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_forecast()
+
+  # 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/v201306/forecast_service/get_forecast_by_id.rb

@@ -0,0 +1,80 @@
+#!/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");
+#           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 forecast for an existing line item. To determine which
+# line items exist, run get_all_line_items.rb.
+#
+# Tags: ForecastService.getForecastById
+
+require 'dfp_api'
+
+API_VERSION = :v201306
+
+def get_forecast_by_id()
+  # 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 CreativeService.
+  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)
+
+  if forecast
+    # Display results.
+    matched = forecast[:matched_units]
+    available_percent = forecast[:available_units] * 100.0 / matched
+    unit_type = forecast[:unit_type].to_s.downcase
+    puts "%.2f %s matched." % [matched, unit_type]
+    puts "%.2f%% %s available." % [available_percent, unit_type]
+    if forecast[:possible_units]
+      possible_percent = forecast[:possible_units] * 100.0 / matched
+      puts "%.2f%% %s possible." % [possible_percent, unit_type]
+    end
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_forecast_by_id()
+
+  # 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/v201306/inventory_service/create_ad_units.rb

@@ -0,0 +1,101 @@
+#!/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");
+#           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 creates new ad units under a the effective root ad unit. To
+# determine which ad units exist, run get_inventory_tree.rb or
+# get_all_ad_units.rb.
+#
+# Tags: InventoryService.createAdUnits, NetworkService.getCurrentNetwork
+
+require 'dfp_api'
+
+API_VERSION = :v201306
+# Number of ad units to create.
+ITEM_COUNT = 5
+
+def create_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 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
+
+  # Create the creative placeholder.
+  creative_placeholder = {
+      :size => {:width => 300, :height => 250, :is_aspect_ratio => false},
+      :environment_type => 'BROWSER'
+  }
+
+  # Create an array to store local ad unit objects.
+  ad_units = (1..ITEM_COUNT).map do |index|
+    {:name => "Ad_Unit_%d" % index,
+     :parent_id => effective_root_ad_unit_id,
+     :description => 'Ad unit description.',
+     :target_window => 'BLANK',
+     # Set the size of possible creatives that can match this ad unit.
+     :ad_unit_sizes => [creative_placeholder]}
+  end
+
+  # Create the ad units on the server.
+  return_ad_units = inventory_service.create_ad_units(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 created." %
+          [ad_unit[:id], ad_unit[:name], ad_unit[:status]]
+    end
+  else
+    raise 'No ad units were created.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_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/v201306/inventory_service/create_mobile_ad_unit.rb

@@ -0,0 +1,101 @@
+#!/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");
+#           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 creates a new mobile ad unit under the effective root ad unit.
+# To determine which ad units exist, run get_inventory_tree.rb or
+# get_all_ad_units.rb.
+#
+# Mobile features need to be enabled on your account to use mobile targeting.
+#
+# Tags: InventoryService.createAdUnits, NetworkService.getCurrentNetwork
+
+require 'dfp_api'
+
+API_VERSION = :v201306
+
+def create_mobile_ad_unit()
+  # 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 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: %s" % effective_root_ad_unit_id.to_s
+
+  # Create ad unit size.
+  ad_unit_size = {
+      :size => {:width => 400, :height => 300, :is_aspect_ratio => false},
+      :environment_type => 'BROWSER'
+  }
+
+  # Create local ad unit object.
+  ad_unit = {
+     :name => "Mobile_Ad_Unit_%d" % (Time.new.to_f * 1000).to_i,
+     :parent_id => effective_root_ad_unit_id,
+     :description => 'Mobile Ad unit description',
+     :target_window => 'BLANK',
+     :target_platform => 'MOBILE',
+     :mobile_platform => 'APPLICATION',
+     # Set the size of possible creatives that can match this ad unit.
+     :ad_unit_sizes => [ad_unit_size]
+  }
+
+  # Create the ad unit on the server.
+  return_ad_unit = inventory_service.create_ad_unit(ad_unit)
+
+  if return_ad_unit
+    puts "Ad unit with ID: %d, name: %s and status: %s was created." %
+        [return_ad_unit[:id], return_ad_unit[:name], return_ad_unit[:status]]
+  else
+    raise 'No ad units were created.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_mobile_ad_unit()
+
+  # 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/v201306/inventory_service/create_video_ad_unit.rb

@@ -0,0 +1,108 @@
+#!/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");
+#           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 creates a new video ad unit under a the effective root ad unit.
+# To determine which ad units exist, run get_inventory_tree.rb or
+# get_all_ad_units.rb.
+#
+# This feature is only available to DFP premium solution networks.
+#
+# Tags: InventoryService.createAdUnits, NetworkService.getCurrentNetwork
+
+require 'dfp_api'
+
+API_VERSION = :v201306
+
+def create_video_ad_unit()
+  # 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 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: %s" % effective_root_ad_unit_id.to_s
+
+  # Create master ad unit size.
+  master_ad_unit_size = {
+      :size => {:width => 400, :height => 300, :is_aspect_ratio => false},
+      :environment_type => 'VIDEO_PLAYER',
+      # Add companions to master ad unit size.
+      :companions => [
+          {:size => {:width => 300, :height => 250, :is_aspect_ratio => false},
+           :environment_type => 'BROWSER'},
+          {:size => {:width => 728, :height => 90, :is_aspect_ratio => false},
+           :environment_type => 'BROWSER'}
+      ]
+  }
+
+  # Create local ad unit object.
+  ad_unit = {
+     :name => "Video_Ad_Unit_%d" % (Time.new.to_f * 1000).to_i,
+     :parent_id => effective_root_ad_unit_id,
+     :description => 'Video Ad unit description',
+     :target_window => 'BLANK',
+     :explicitly_targeted => true,
+     :target_platform => 'WEB',
+     # Set the size of possible creatives that can match this ad unit.
+     :ad_unit_sizes => [master_ad_unit_size]
+  }
+
+  # Create the ad unit on the server.
+  return_ad_unit = inventory_service.create_ad_unit(ad_unit)
+
+  if return_ad_unit
+    puts "Ad unit with ID: %d, name: %s and status: %s was created." %
+        [return_ad_unit[:id], return_ad_unit[:name], return_ad_unit[:status]]
+  else
+    raise 'No ad units were created.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_video_ad_unit()
+
+  # 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