google-dfp-api 0.4.0 → 0.5.0

data/ChangeLog

@@ -1,3 +1,7 @@
+0.5.0:
+  - Added support and examples for v201211.
+  - Removed support for deprecated v201108, v201111, v201201.
+
 0.4.0:
   - Added support and examples for v201208.
   - Require google-ads-common 0.8.0 or later from now on.

data/examples/{v201201/third_party_slot_service/get_all_third_party_slots.rb → v201211/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,17 +18,16 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example gets all third party slots. To create third party slots, run
-# create_third_party_slot.rb.
+# This code example gets all audience segments.
 #
-# Tags: ThirdPartySlotService.getThirdPartySlotsByStatement
+# Tags: AudienceSegmentService.getAudienceSegmentsByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
-def get_all_third_party_slots()
+def get_all_audience_segments()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -35,8 +35,8 @@ def get_all_third_party_slots()
   # the configuration file or provide your own logger:
   # dfp.logger = Logger.new('dfp_xml.log')
 
-  # Get the ThirdPartySlotService.
-  third_party_slot_service = dfp.service(:ThirdPartySlotService, API_VERSION)
+  # Get the AudienceSegmentService.
+  audience_segment_service = dfp.service(:AudienceSegmentService, API_VERSION)
 
   # Define initial values.
   offset = 0
@@ -46,8 +46,9 @@ def get_all_third_party_slots()
     # Create statement for one page with current offset.
     statement = {:query => "LIMIT %d OFFSET %d" % [PAGE_SIZE, offset]}
 
-    # Get third party slots by statement.
-    page = third_party_slot_service.get_third_party_slots_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.
@@ -56,23 +57,23 @@ def get_all_third_party_slots()
       # Get the start index for printout.
       start_index = page[:start_index]
 
-      # Print details about each third party slot in results page.
-      page[:results].each_with_index do |slot, index|
-        puts "%d) Third party slot ID: %d, name: '%s'" %
-            [index + start_index, slot[:id], slot[:name]]
+      # 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 third party slots: %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_third_party_slots()
+    get_all_audience_segments()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

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

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -23,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 
 def produce_api_error()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201201/common/oauth_handling.rb → v201211/common/oauth2_handling.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,18 +18,18 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example shows how to use OAuth authorization method. It is designed to be
-# run from console and requires user input.
+# This example shows how to use OAuth2.0 authorization method. It is designed to
+# be run from console and requires user input.
 #
 # Tags: UserService.getUsersByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 PAGE_SIZE = 500
 MAX_RETRIES = 3
 
-def oauth_handling()
+def oauth2_handling()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
   dfp = DfpApi::Api.new
 
@@ -64,11 +65,11 @@ def oauth_handling()
     # The second way to do OAuth authentication is to make a request and catch
     # the OAuthVerificationRequired exception. Add the verification code to the
     # credentials once acquired.
-    rescue AdsCommon::Errors::OAuthVerificationRequired => e
+    rescue AdsCommon::Errors::OAuth2VerificationRequired => e
       if retry_count < MAX_RETRIES
         verification_code = get_verification_code(e.oauth_url)
         dfp.credential_handler.set_credential(
-            :oauth_verification_code, verification_code)
+            :oauth2_verification_code, verification_code)
         retry_count += 1
         retry
       else
@@ -107,7 +108,7 @@ end
 
 if __FILE__ == $0
   begin
-    oauth_handling()
+    oauth2_handling()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201111 → v201211}/common/oauth_handling.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -17,14 +18,17 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example shows how to use OAuth authorization method. It is designed to be
-# run from console and requires user input.
+# This example shows how to use OAuth1.0a authorization method. It is designed
+# to be run from console and requires user input.
+#
+# NOTE: OAuth1.0a authorization method is deprecated, use OAuth2.0 instead.
+#       See oauth2_handling.rb for an example.
 #
 # Tags: UserService.getUsersByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
 PAGE_SIZE = 500
 MAX_RETRIES = 3
 

data/examples/{v201111 → v201211}/company_service/create_companies.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -19,12 +20,12 @@
 #
 # This example creates new companies. To determine which companies exist, run
 # get_all_companies.rb.
-
+#
 # Tags: CompanyService.createCompanies
 
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
 # Number of companies to create.
 ITEM_COUNT = 5
 

data/examples/{v201201 → v201211}/company_service/get_all_companies.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -23,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def get_all_companies()
@@ -57,7 +58,7 @@ def get_all_companies()
 
       # Print details about each company in results.
       page[:results].each_with_index do |company, index|
-        puts "%d) Company ID: %d, name: %s, type: %s" %
+        puts "%d) Company ID: %d, name: '%s', type: '%s'" %
             [index + start_index, company[:id], company[:name], company[:type]]
       end
     end

data/examples/{v201111 → v201211}/company_service/get_companies_by_statement.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -25,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
 
 def get_companies_by_statement()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201111 → v201211}/company_service/get_company.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -24,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
 
 def get_company()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201201 → v201211}/company_service/update_companies.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -25,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
 def update_companies()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201111 → v201211}/content_service/get_all_content.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -25,7 +26,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def get_all_content()

data/examples/{v201111 → v201211}/content_service/get_content_by_category.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -22,13 +23,13 @@
 #
 # This feature is only available to DFP video publishers.
 #
-# Tags: NetworkService.getCurrentNetwork,
-#       ContentService.getContentByStatementAndCustomTargetingValue
-#       CustomTargetingService.getCustomTargetingValuesByStatement
+# Tags: NetworkService.getCurrentNetwork
+# Tags: ContentService.getContentByStatementAndCustomTargetingValue
+# Tags: CustomTargetingService.getCustomTargetingValuesByStatement
 
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def get_content_by_statement()

data/examples/{v201201 → v201211}/creative_service/copy_image_creatives.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -27,7 +28,7 @@ require 'dfp_api'
 
 require 'base64'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
 def copy_image_creatives()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201111 → v201211}/creative_service/create_creative_from_template.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -27,7 +28,7 @@
 require 'base64'
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
 
 def create_creative_from_template()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

data/examples/{v201201 → v201211}/creative_service/create_creatives.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -26,7 +27,7 @@
 require 'base64'
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 # Number of creatives to create.
 ITEM_COUNT = 5
 

data/examples/{v201201 → v201211}/creative_service/create_custom_creative.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -28,7 +29,7 @@
 require 'base64'
 require 'dfp_api'
 
-API_VERSION = :v201201
+API_VERSION = :v201211
 
 def create_custom_creative()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.

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

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -23,7 +24,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201108
+API_VERSION = :v201211
 PAGE_SIZE = 500
 
 def get_all_creatives()
@@ -59,7 +60,7 @@ def get_all_creatives()
       page[:results].each_with_index do |creative, index|
         puts "%d) Creative ID: %d, name: %s, type: %s" %
             [index + start_index, creative[:id],
-             creative[:name], creative[:type]]
+             creative[:name], creative[:creative_type]]
       end
     end
   end while offset < page[:total_result_set_size]

data/examples/{v201111 → v201211}/creative_service/get_creative.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -24,7 +25,7 @@
 
 require 'dfp_api'
 
-API_VERSION = :v201111
+API_VERSION = :v201211
 
 def get_creative()
   # Get DfpApi instance and load configuration from ~/dfp_api.yml.
@@ -45,7 +46,7 @@ def get_creative()
 
   if creative
     puts "Creative with ID: %d, name: %s and type: %s was found." %
-        [creative[:id], creative[:name], creative[:type]]
+        [creative[:id], creative[:name], creative[:creative_type]]
   end
 end