google-dfp-api 0.2.8 → 0.3.0

data/ChangeLog

@@ -1,3 +1,7 @@
+0.3.0:
+  - Added support and examples for v201203.
+  - Removed support for deprecated v201103, v201104, v201107.
+
 0.2.8:
   - Added .gemspec and updated packaging process.
   - Removed explicit require for RubyGems, see README.

data/README

@@ -71,10 +71,8 @@ constructor:
          :method => 'ClientLogin',
          :application_name => 'Ruby DFP Sample',
          :email => 'user@domain.com',
-         :password => 'PASSWORD'
-     },
-     :service => {
-       :environment => 'SANDBOX'
+         :password => 'PASSWORD',
+         :network_code => 123456
      }
    })
 
@@ -114,7 +112,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. :v201201.
+where <API_VERSION> is required version of DFP API as symbol, e.g. :v201203.
 
 Then you should be able to execute service methods:
 
@@ -148,7 +146,7 @@ Examples can be run by executing by running:
 
 from the "examples/<version>/<service_name>" directory i.e.
 
-  $ cd examples/v201201/user_service
+  $ cd examples/v201203/user_service
   $ ruby get_all_users.rb
 
 Some examples require modification to be functional, like create_order example

data/dfp_api.yml

@@ -8,7 +8,7 @@
   # Auth parameters for OAuth method.
   # Set the OAuth consumer key and secret. Anonymous values can be used for
   # testing, and real values can be obtained by registering your application:
-  # http://code.google.com/apis/accounts/docs/RegistrationForWebAppsAuto.html
+  # https://developers.google.com/accounts/docs/RegistrationForWebAppsAuto
   #:oauth_consumer_key: anonymous
   #:oauth_consumer_secret: anonymous
   # If you manage or store access token manually, you can specify it here.
@@ -26,6 +26,10 @@
 
   # Other parameters.
   :application_name: dfp_ruby_examples
+
+  # Starting in v201203, network_code is required for all calls other than
+  # GetAllNetworks and MakeTestNetwork. In earlier versions, networkCode is
+  # optional if the user belongs to only one network.
   :network_code: INSERT_NETWORK_CODE_HERE
 :service:
   :environment: SANDBOX

data/examples/{v201104/order_service/get_all_orders.rb → v201203/audience_segment_service/get_all_audience_segments.rb}

@@ -1,8 +1,9 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2012, 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.
@@ -17,16 +18,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all orders. To create orders, run create_orders.rb.
+# This code example gets all audience segments.
 #
-# Tags: OrderService.getOrdersByStatement
+# Tags: AudienceSegmentService.getAudienceSegmentsByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201104
+API_VERSION = :v201203
 PAGE_SIZE = 500
 
-def get_all_orders()
+def get_all_audience_segments()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -34,8 +35,8 @@ def get_all_orders()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the OrderService.
-  order_service = dfp.service(:OrderService, API_VERSION)
+  # Get the AudienceSegmentService.
+  audience_segment_service = dfp.service(:AudienceSegmentService, API_VERSION)
 
   # Define initial values.
   offset = 0
@@ -45,8 +46,9 @@ def get_all_orders()
     # Create statement for one page with current offset.
     statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
 
-    # Get orders by statement.
-    page = order_service.get_orders_by_statement(statement)
+    # Get audience segments by statement.
+    page =
+        audience_segment_service.get_audience_segments_by_statement(statement)
 
     if page[:results]
       # Increase query offset by page size.
@@ -55,24 +57,23 @@ def get_all_orders()
       # Get the start index for printout.
       start_index = page[:start_index]
 
-      # Print details about each order in results page.
-      page[:results].each_with_index do |order, index|
-        puts "%d) Order ID: %d, name: %s, advertiser ID: %d" %
-            [index + start_index, order[:id], order[:name],
-             order[:advertiser_id]]
+      # Print details about each audience segment in results page.
+      page[:results].each_with_index do |segment, index|
+        puts "%d) Audience segment ID: %d, name: %s" %
+            [index + start_index, segment[:id], segment[:name]]
       end
     end
   end while offset < page[:total_result_set_size]
 
   # Print a footer
   if page.include?(:total_result_set_size)
-    puts "Total number of orders: %d" % page[:total_result_set_size]
+    puts "Total number of audience segments: %d" % page[:total_result_set_size]
   end
 end
 
 if __FILE__ == $0
   begin
-    get_all_orders()
+    get_all_audience_segments()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201103 → v201203}/common/error_handling.rb

@@ -23,7 +23,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201103
+API_VERSION = :v201203
 
 def produce_api_error()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201107 → v201203}/common/oauth_handling.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 PAGE_SIZE = 500
 MAX_RETRIES = 3
 

data/examples/{v201107 → v201203}/company_service/create_companies.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 # Number of companies to create.
 ITEM_COUNT = 5
 

data/examples/{v201107 → v201203}/company_service/get_all_companies.rb

@@ -23,7 +23,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 PAGE_SIZE = 500
 
 def get_all_companies()

data/examples/{v201104 → v201203}/company_service/get_companies_by_statement.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201104
+API_VERSION = :v201203
 
 def get_companies_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201104 → v201203}/company_service/get_company.rb

@@ -24,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201104
+API_VERSION = :v201203
 
 def get_company()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201107 → v201203}/company_service/update_companies.rb

@@ -25,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201107
+API_VERSION = :v201203
 
 def update_companies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201103/user_service/get_all_users.rb → v201203/content_service/get_all_content.rb}

@@ -17,17 +17,18 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all users for an account. To create users run
-# create_users.rb.
+# This example gets all content.
 #
-# Tags: UserService.getUsersByStatement
+# This feature is only available to DFP video publishers.
+#
+# Tags: ContentService.getContentByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201103
+API_VERSION = :v201203
 PAGE_SIZE = 500
 
-def get_all_users()
+def get_all_content()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -35,8 +36,8 @@ def get_all_users()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the UserService.
-  user_service = dfp.service(:UserService, API_VERSION)
+  # Get the ContentService.
+  content_service = dfp.service(:ContentService, API_VERSION)
 
   # Define initial values.
   offset = 0
@@ -46,8 +47,8 @@ def get_all_users()
     # Create statement for one page with current offset.
     statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
 
-    # Get users by statement.
-    page = user_service.get_users_by_statement(statement)
+    # Get content by statement.
+    page = content_service.get_content_by_statement(statement)
 
     if page[:results]
       # Increase query offset by page size.
@@ -56,23 +57,23 @@ def get_all_users()
       # Get the start index for printout.
       start_index = page[:start_index]
 
-      # Print details about each user in results page.
-      page[:results].each_with_index do |user, index|
-        puts "%d) User ID: %d, name: %s, email: %s" %
-            [index + start_index, user[:id], user[:name], user[:email]]
+      # Print details about each content object in results page.
+      page[:results].each_with_index do |content, index|
+        puts "%d) Content ID: %d, name: %s, status: %s." % [index + start_index,
+             content[:id], content[:name], content[:status]]
       end
     end
   end while offset < page[:total_result_set_size]
 
   # Print a footer
   if page.include?(:total_result_set_size)
-    puts "Total number of users: %d" % page[:total_result_set_size]
+    puts "Total number of results: %d" % page[:total_result_set_size]
   end
 end
 
 if __FILE__ == $0
   begin
-    get_all_users()
+    get_all_content()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201203/content_service/get_content_by_category.rb

@@ -0,0 +1,135 @@
+#!/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 active content categorized as "comedy" using the
+# network's content browse custom targeting key.
+#
+# This feature is only available to DFP video publishers.
+#
+# Tags: NetworkService.getCurrentNetwork,
+#       ContentService.getContentByStatementAndCustomTargetingValue
+#       CustomTargetingService.getCustomTargetingValuesByStatement
+
+require 'dfp_api'
+
+API_VERSION = :v201203
+PAGE_SIZE = 500
+
+def get_content_by_statement()
+  # 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 NetworkService.
+  network_service = dfp.service(:NetworkService, API_VERSION)
+
+  # Get content browse custom targeting key ID.
+  current_network = network_service.get_current_network
+  content_browse_custom_targeting_key_id =
+      current_network[:content_browse_custom_targeting_key_id]
+
+  # Get the CustomTargetingService.
+  custom_targeting_service = dfp.service(:CustomTargetingService, API_VERSION)
+
+  # Create a statement to select the categories matching the name comedy.
+  statement = {
+      :query => 'WHERE customTargetingKeyId = :targeting_key_id' +
+          ' and name = :category LIMIT 1',
+      :values => [
+          {:key => 'targeting_key_id',
+           :value => {:value => content_browse_custom_targeting_key_id,
+                      :xsi_type => 'NumberValue'}},
+          {:key => 'category',
+           :value => {:value => 'comedy',
+                      :xsi_type => 'TextValue'}},
+      ]
+  }
+
+  # Get categories matching the filter statement.
+  page = custom_targeting_service.get_custom_targeting_values_by_statement(
+      statement)
+
+  # Get the custom targeting value ID for the comedy category.
+  category_custom_targeting_value_id = page[:results].first()[:id]
+
+  # Get the ContentService.
+  content_service = dfp.service(:ContentService, API_VERSION)
+
+  # Define initial values.
+  offset = 0
+  page = {}
+
+  statement_text = 'WHERE status = :status'
+  statement = {
+      :query => statement_text,
+      :values => [
+          {:key => 'status',
+           :value => {:value => 'ACTIVE', :xsi_type => 'TextValue'}}
+      ]
+  }
+
+  begin
+    # Create a statement to get one page with current offset.
+    statement[:query] = statement_text +
+        " LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]
+
+    # Get content by statement.
+    page = content_service.get_content_by_statement_and_custom_targeting_value(
+        statement, category_custom_targeting_value_id)
+
+    if page[:results]
+      # Increase query offset by page size.
+      offset += PAGE_SIZE
+
+      page[:results].each_with_index do |content, index|
+        puts "%d) Content ID: %d, name: %s, status: %s." % [index + start_index,
+             content[:id], content[:name], content[:status]]
+      end
+    end
+  end while offset < page[:total_result_set_size]
+
+  # Print a footer.
+  if page.include?(:total_result_set_size)
+    puts "Number of results found: %d" % page[:total_result_set_size]
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_content_by_statement()
+
+  # 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/{v201107 → v201203}/creative_service/copy_image_creatives.rb

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

data/examples/v201203/creative_service/create_creative_from_template.rb

@@ -0,0 +1,138 @@
+#!/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 creates a new template creative for a given advertiser. To
+# determine which companies are advertisers, run get_companies_by_statement.rb.
+# To determine which creatives already exist, run get_all_creatives.rb. To
+# determine which creative templates run get_all_creative_templates.rb.
+#
+# Tags: CreativeService.createCreative
+
+require 'base64'
+require 'dfp_api'
+
+API_VERSION = :v201203
+
+def create_creative_from_template()
+  # 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.
+  creative_service = dfp.service(:CreativeService, API_VERSION)
+
+  # Set the ID of the advertiser (company) that all creatives will be assigned
+  # to.
+  advertiser_id = 'INSERT_ADVERTISER_COMPANY_ID_HERE'.to_i
+
+  # Use the image banner with optional third party tracking template.
+  creative_template_id = 10000680
+
+  # Create the local custom creative object.
+  creative = {
+      :xsi_type => 'TemplateCreative',
+      :name => 'Template creative',
+      :advertiser_id => advertiser_id,
+      :creative_template_id => creative_template_id,
+      :size => {:width => 300, :height => 250, :is_aspect_ratio => false}
+  }
+
+  # Prepare image data for asset value.
+  image_url =
+      'http://www.google.com/intl/en/adwords/select/images/samples/inline.jpg'
+  image_data = AdsCommon::Http.get(image_url)
+  image_data_base64 = Base64.encode64(image_data)
+
+  # Create the asset variable value.
+  asset_variable_value = {
+      :xsi_type => 'AssetCreativeTemplateVariableValue',
+      :unique_name => 'Imagefile',
+      :asset_byte_array => image_data_base64,
+      # Filenames must be unique.
+      :file_name => "image%d.jpg" % Time.new.to_i
+  }
+
+  # Create the image width variable value.
+  image_width_variable_value = {
+      :xsi_type => 'LongCreativeTemplateVariableValue',
+      :unique_name => 'Imagewidth',
+      :value => 300
+  }
+
+  # Create the image height variable value.
+  image_height_variable_value = {
+      :xsi_type => 'LongCreativeTemplateVariableValue',
+      :unique_name => 'Imageheight',
+      :value => 250
+  }
+
+  # Create the URL variable value.
+  url_variable_value = {
+      :xsi_type => 'UrlCreativeTemplateVariableValue',
+      :unique_name => 'ClickthroughURL',
+      :value => 'www.google.com'
+  }
+
+  # Create the target window variable value.
+  target_window_variable_value = {
+      :xsi_type => 'StringCreativeTemplateVariableValue',
+      :unique_name => 'Targetwindow',
+      :value => '__blank'
+  }
+
+  creative[:creative_template_variable_values] = [asset_variable_value,
+      image_width_variable_value, image_height_variable_value,
+      url_variable_value, target_window_variable_value]
+
+  # Create the creatives on the server.
+  return_creative = creative_service.create_creative(creative)
+
+  if return_creative
+    puts(("Template creative with ID: %d, name: %s and type '%s' was " +
+            "created and can be previewed at: '%s'") %
+            [return_creative[:id], return_creative[:name],
+             return_creative[:creative_type], return_creative[:preview_url]])
+  else
+    raise 'No creatives were created.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    create_creative_from_template()
+
+  # 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