google-dfp-api 0.2.3 → 0.2.4

data/ChangeLog

@@ -1,3 +1,9 @@
+0.2.4:
+  - Support for proxies.
+  - Require google-ads-common 0.5.1 or later from now on.
+  - Support for v201108.
+  - v201101 is now deprecated.
+
 0.2.3:
   - Support for v201107.
 

data/README

@@ -106,7 +106,7 @@ Once the library object is created you can request services with a 'service'
 method:
   user_service = dfp.service(:UserService, <API_VERSION>)
 
-where <API_VERSION> is required version of DFP API as symbol, e.g. :v201104.
+where <API_VERSION> is required version of DFP API as symbol, e.g. :v201108.
 
 Then you should be able to execute service methods:
 
@@ -139,7 +139,7 @@ Examples can be run by executing by running:
 
 from the "examples/<version>/<service_name>" directory i.e.
 
-  $ cd examples/v201104/user_service
+  $ cd examples/v201108/user_service
   $ ruby get_all_users.rb
 
 Some examples require modification to be functional, like create_order example
@@ -174,8 +174,14 @@ to the Ruby Logger documentation.
 
 == What if I am behind an HTTP Proxy server?
 
-The Ruby Client Libraries does not support proxy servers in this version but it
-is planned for next releases.
+You can specify a proxy server to be used for all requests as part of
+configuration hash:
+
+   config[:connection] = {
+     :proxy => 'http://user:password@proxy_hostname:8080'
+   }
+
+or via configuration file (see example).
 
 
 = External dependencies:
@@ -183,7 +189,7 @@ is planned for next releases.
 External dependencies should be pulled automatically on gem install. Here is the
 list though:
 
-  - Google Ads Common library (google-ads-common-0.5.0);
+  - Google Ads Common library (google-ads-common-0.5.1);
   - Savon 'the heavy metal Ruby SOAP client' (savon-0.9.6).
 
 

data/Rakefile

@@ -47,7 +47,7 @@ spec = Gem::Specification.new do |s|
   s.test_files = tests
   s.has_rdoc = true
   s.extra_rdoc_files = docs
-  s.add_dependency('google-ads-common', '~> 0.5.0')
+  s.add_dependency('google-ads-common', '~> 0.5.1')
   s.add_dependency('savon', '= 0.9.6')
 end
 

data/examples/{v201101 → v201108}/common/error_handling.rb

@@ -24,7 +24,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def produce_api_error()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/common/oauth_handling.rb

@@ -25,7 +25,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 PAGE_SIZE = 500
 MAX_RETRIES = 3
 

data/examples/{v201101 → v201108}/company_service/create_companies.rb

@@ -25,7 +25,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 # Number of companies to create.
 ITEM_COUNT = 5
 

data/examples/{v201101 → v201108}/company_service/get_all_companies.rb

@@ -24,7 +24,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 PAGE_SIZE = 500
 
 def get_all_companies()

data/examples/{v201101 → v201108}/company_service/get_companies_by_statement.rb

@@ -26,7 +26,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def get_companies_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/company_service/get_company.rb

@@ -25,7 +25,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def get_company()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/company_service/update_companies.rb

@@ -26,7 +26,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def update_companies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/creative_service/copy_image_creatives.rb

@@ -28,7 +28,7 @@ require 'dfp_api'
 
 require 'base64'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def copy_image_creatives()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/creative_service/create_creatives.rb

@@ -27,7 +27,7 @@ require 'rubygems'
 require 'base64'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 # Number of creatives to create.
 ITEM_COUNT = 5
 

data/examples/{v201101 → v201108}/creative_service/get_all_creatives.rb

@@ -24,7 +24,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 PAGE_SIZE = 500
 
 def get_all_creatives()

data/examples/{v201101 → v201108}/creative_service/get_creative.rb

@@ -25,7 +25,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def get_creative()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/creative_service/get_creatives_by_statement.rb

@@ -26,7 +26,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def get_creatives_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/creative_service/update_creatives.rb

@@ -25,7 +25,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def update_creatives()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/custom_targeting_service/create_custom_targeting_keys_and_values.rb

@@ -28,7 +28,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def create_custom_targeting_keys_and_values()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/custom_targeting_service/delete_custom_targeting_keys.rb

@@ -26,7 +26,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 PAGE_SIZE = 500
 
 def delete_custom_targeting_keys()

data/examples/{v201101 → v201108}/custom_targeting_service/delete_custom_targeting_values.rb

@@ -27,7 +27,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 PAGE_SIZE = 500
 
 def delete_custom_targeting_values()

data/examples/{v201101 → v201108}/custom_targeting_service/get_all_custom_targeting_keys_and_values.rb

@@ -26,7 +26,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 PAGE_SIZE = 500
 
 def get_all_custom_targeting_keys_and_values()

data/examples/{v201101 → v201108}/custom_targeting_service/get_custom_targeting_keys_by_statement.rb

@@ -26,7 +26,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def get_custom_targeting_keys_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/custom_targeting_service/get_custom_targeting_values_by_statement.rb

@@ -28,7 +28,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def get_custom_targeting_values_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/custom_targeting_service/update_custom_targeting_keys.rb

@@ -27,7 +27,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def update_custom_targeting_keys()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/custom_targeting_service/update_custom_targeting_values.rb

@@ -27,7 +27,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def update_custom_targeting_values()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/forecast_service/get_forecast.rb

@@ -25,7 +25,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def get_forecast()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -39,7 +39,7 @@ def get_forecast()
   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]
+  targeted_placement_ids = ['INSERT_PLACEMENT_ID_HERE'.to_i]
 
   # Create targeting.
   targeting = {
@@ -47,13 +47,17 @@ def get_forecast()
           {: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_sizes =>
-        {:width => 300, :height => 250, :is_aspect_ratio => false},
+    :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(2012, 01, 01),

data/examples/{v201101 → v201108}/forecast_service/get_forecast_by_id.rb

@@ -25,7 +25,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def get_forecast_by_id()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201101 → v201108}/inventory_service/create_ad_units.rb

@@ -26,7 +26,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 # Number of ad units to create.
 ITEM_COUNT = 5
 
@@ -50,6 +50,12 @@ def create_ad_units()
 
   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,
@@ -57,7 +63,7 @@ def create_ad_units()
      :description => 'Ad unit description.',
      :target_window => 'BLANK',
      # Set the size of possible creatives that can match this ad unit.
-     :sizes => [{:width => 300, :height => 250, :is_aspect_ratio => false}]}
+     :ad_unit_sizes => [creative_placeholder]}
   end
 
   # Create the ad units on the server.

data/examples/{v201101 → v201108}/inventory_service/deactivate_ad_units.rb

@@ -26,7 +26,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 PAGE_SIZE = 500
 
 def deactivate_ad_units()

data/examples/{v201101 → v201108}/inventory_service/get_ad_unit.rb

@@ -25,7 +25,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def get_ad_unit()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/v201108/inventory_service/get_ad_unit_sizes.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/ruby
+#
+# 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 all ad unit sizes in the network.
+#
+# Tags: InventoryService.getAdUnitSizes
+
+require 'rubygems'
+require 'dfp_api'
+
+API_VERSION = :v201108
+
+def get_all_ad_unit_sizes()
+  # 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 all ad unit sizes.
+  ad_unit_sizes = inventory_service.get_ad_unit_sizes()
+
+  if ad_unit_sizes
+    # Print details about each ad unit in results.
+    ad_unit_sizes.each_with_index do |ad_unit_size, index|
+      puts "%d) Ad unit size %dx%d was found." % [index,
+          ad_unit_size[:size][:width], ad_unit_size[:size][:height]]
+    end
+  else
+    puts 'No ad unit sizes found.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_all_ad_unit_sizes()
+
+  # 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/{v201101 → v201108}/inventory_service/get_ad_units_by_statement.rb

@@ -25,7 +25,7 @@
 require 'rubygems'
 require 'dfp_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201108
 
 def get_ad_units_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.