google-adx-buyer-api 0.4.6 → 0.4.7

data/examples/{v201206/misc/use_oauth.rb → v201306/misc/use_oauth2_jwt.rb}

@@ -3,7 +3,7 @@
 #
 # 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.
@@ -18,13 +18,14 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example illustrates how to use OAuth authentication method.
+# This example illustrates how to use OAuth2.0 authentication method with
+# Service Account (JWT).
 #
 # Tags: CampaignService.get
 
 require 'adwords_api'
 
-def use_oauth()
+def use_oauth2_jwt()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -33,6 +34,19 @@ def use_oauth()
   # the configuration file or provide your own logger:
   # adwords.logger = Logger.new('adwords_xml.log')
 
+  # Option 1: provide key filename as authentication -> oauth2_keyfile in the
+  #           configuration file. No additional code is necessary.
+  # To provide a file name at runtime, use authorize:
+  # adwords.authorize({:oauth2_keyfile => key_filename})
+
+  # Option 2: retrieve key manually and create OpenSSL::PKCS12 object.
+  # key_filename = 'INSERT_FILENAME_HERE'
+  # key_secret = 'INSERT_SECRET_HERE'
+  # key_file_data = File.read(key_filename)
+  # key = OpenSSL::PKCS12.new(key_file_data, key_secret).key
+  # adwords.authorize({:oauth2_key => key})
+
+  # Now you can make API calls.
   campaign_srv = adwords.service(:CampaignService, API_VERSION)
 
   # Get all the campaigns for this account; empty selector.
@@ -43,24 +57,7 @@ def use_oauth()
     ]
   }
 
-  retry_count = 0
-
-  begin
-    response = campaign_srv.get(selector)
-  rescue AdsCommon::Errors::OAuthVerificationRequired => e
-    if retry_count < MAX_RETRIES
-      puts "Hit Auth error, please navigate to URL:\n\t%s" % e.oauth_url
-      print 'log in and type the verification code: '
-      verification_code = gets.chomp
-      adwords.credential_handler.set_credential(
-          :oauth_verification_code, verification_code)
-      retry_count += 1
-      retry
-    else
-      raise AdsCommon::Errors::AuthError, 'Failed to authenticate.'
-    end
-  end
-
+  response = campaign_srv.get(selector)
   if response and response[:entries]
     campaigns = response[:entries]
     campaigns.each do |campaign|
@@ -73,11 +70,10 @@ def use_oauth()
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
-  MAX_RETRIES = 3
+  API_VERSION = :v201306
 
   begin
-    use_oauth()
+    use_oauth2_jwt()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201206 → v201306}/optimization/get_placement_ideas.rb

@@ -24,7 +24,6 @@
 # Tags: TargetingIdeaService.get
 
 require 'adwords_api'
-require 'adwords_api/utils'
 
 def get_placement_ideas(url)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
@@ -72,8 +71,7 @@ def get_placement_ideas(url)
 
   # Display results.
   results.each do |result|
-    data = AdwordsApi::Utils.map(result[:data])
-    placement = data['CRITERION'][:value]
+    placement = result[:data]['CRITERION'][:value]
     puts "Related placement found at URL [%s]" % placement[:url]
   end
   puts "Total URLs found with keywords related to keywords at [%s]: %d." %
@@ -81,13 +79,21 @@ def get_placement_ideas(url)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
   PAGE_SIZE = 100
 
   begin
     url = 'INSERT_PLACEMENT_URL_HERE'
     get_placement_ideas(url)
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201206 → v201306}/remarketing/add_audience.rb

@@ -34,7 +34,7 @@ def add_audience()
   # the configuration file or provide your own logger:
   # adwords.logger = Logger.new('adwords_xml.log')
 
-  user_list_srv = adwords.service(:UserListService, API_VERSION)
+  user_list_srv = adwords.service(:AdwordsUserListService, API_VERSION)
   conv_tracker_srv = adwords.service(:ConversionTrackerService, API_VERSION)
 
   # Prepare for adding remarketing user list.
@@ -45,7 +45,7 @@ def add_audience()
       # The 'xsi_type' field allows you to specify the xsi:type of the object
       # being created. It's only necessary when you must provide an explicit
       # type that the client library can't infer.
-      :xsi_type => 'RemarketingUserList',
+      :xsi_type => 'BasicUserList',
       :name => name,
       :description => 'A list of mars cruise customers in the last year',
       :status => 'OPEN',
@@ -58,41 +58,53 @@ def add_audience()
 
   # Add user list.
   response = user_list_srv.mutate([operation])
-  user_list = response[:value].first
+  if response and response[:value]
+    user_list = response[:value].first
 
-  # Get conversion snippets.
-  if user_list and user_list[:conversion_types]
-    conversion_ids = user_list[:conversion_types].map {|type| type[:id]}
-    selector = {
-      # We're actually interested in the 'Snippet' field, which is returned
-      # automatically.
-      :fields => ['Id'],
-      :predicates => [
-        {:field => 'Id', :operator => 'IN', :values => conversion_ids}
-      ]
-    }
-    conv_tracker_response = conv_tracker_srv.get(selector)
-    if conv_tracker_response and conv_tracker_response[:entries]
-      conversions = conv_tracker_response[:entries]
+    # Get conversion snippets.
+    if user_list and user_list[:conversion_types]
+      conversion_ids = user_list[:conversion_types].map {|type| type[:id]}
+      selector = {
+        # We're actually interested in the 'Snippet' field, which is returned
+        # automatically.
+        :fields => ['Id'],
+        :predicates => [
+          {:field => 'Id', :operator => 'IN', :values => conversion_ids}
+        ]
+      }
+      conv_tracker_response = conv_tracker_srv.get(selector)
+      if conv_tracker_response and conv_tracker_response[:entries]
+        conversions = conv_tracker_response[:entries]
+      end
     end
-  end
-  puts "User list with name '%s' and ID %d was added." %
-      [user_list[:name], user_list[:id]]
-  # Display user list associated conversion code snippets.
-  if conversions
-    conversions.each do |conversion|
-      puts "Conversion type code snipped associated to the list:\n\t\t%s\n" %
-        conversion[:snippet]
+    puts "User list with name '%s' and ID %d was added." %
+        [user_list[:name], user_list[:id]]
+    # Display user list associated conversion code snippets.
+    if conversions
+      conversions.each do |conversion|
+        puts "Conversion type code snipped associated to the list:\n\t\t%s\n" %
+          conversion[:snippet]
+      end
     end
+  else
+    puts 'No user lists were added.'
   end
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
 
   begin
     add_audience()
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201206 → v201306}/remarketing/add_conversion_tracker.rb

@@ -47,7 +47,6 @@ def add_conversion_tracker()
           (Time.new.to_f * 1000).to_i,
       :category => 'DEFAULT',
       :markup_language => 'HTML',
-      :http_protocol => 'HTTP',
       :text_format => 'HIDDEN',
       # Optional fields:
       :status => 'ENABLED',
@@ -63,18 +62,30 @@ def add_conversion_tracker()
 
   # Add conversion.
   response = conv_tracker_srv.mutate([operation])
-  conversion = response[:value].first
-  puts ("Conversion with ID %d, name '%s', status '%s' and category '%s'" +
-      " was added.") % [conversion[:id], conversion[:name],
-                        conversion[:status], conversion[:category]]
+  if response and response[:value]
+    conversion = response[:value].first
+    puts ("Conversion with ID %d, name '%s', status '%s' and category '%s'" +
+        " was added.") % [conversion[:id], conversion[:name],
+        conversion[:status], conversion[:category]]
+  else
+    puts 'No conversions were added.'
+  end
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
 
   begin
     add_conversion_tracker()
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201206 → v201306}/reporting/download_criteria_report.rb

@@ -61,13 +61,21 @@ def download_criteria_report(file_name)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
 
   begin
     # File name to write report to.
     file_name = 'INSERT_OUTPUT_FILE_NAME_HERE'
     download_criteria_report(file_name)
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201206 → v201306}/reporting/get_campaign_stats.rb

@@ -81,12 +81,20 @@ def get_campaign_stats()
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
   PAGE_SIZE = 500
 
   begin
     get_campaign_stats()
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201206 → v201306}/reporting/get_report_fields.rb

@@ -47,12 +47,20 @@ def get_report_fields(report_type)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
 
   begin
     report_type = 'INSERT_REPORT_TYPE_HERE'
     get_report_fields(report_type)
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201206 → v201306}/targeting/add_campaign_targeting_criteria.rb

@@ -46,10 +46,7 @@ def add_campaign_targeting_criteria(campaign_id)
     # Language criteria. The IDs can be found in the documentation or retrieved
     # with the ConstantDataService.
     {:xsi_type => 'Language', :id => 1000},  # English
-    {:xsi_type => 'Language', :id => 1003},  # Spanish
-    # Platform criteria. The IDs can be found in the documentation.
-    {:xsi_type => 'Platform', :id => 30001}, # Mobile
-    {:xsi_type => 'Platform', :id => 30002}  # Tablets
+    {:xsi_type => 'Language', :id => 1003}   # Spanish
   ]
 
   # Create operations.
@@ -86,12 +83,20 @@ def add_campaign_targeting_criteria(campaign_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
 
   begin
     campaign_id = 'INSERT_CAMPAIGN_ID_HERE'
     add_campaign_targeting_criteria(campaign_id)
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201206 → v201306}/targeting/get_campaign_targeting_criteria.rb

@@ -78,7 +78,7 @@ def get_campaign_targeting_criteria(campaign_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
   PAGE_SIZE = 500
 
   begin
@@ -86,6 +86,14 @@ if __FILE__ == $0
     campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
     get_campaign_targeting_criteria(campaign_id)
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201206 → v201306}/targeting/get_targetable_languages_and_carriers.rb

@@ -52,18 +52,30 @@ def get_targetable_languages_and_carriers()
   # Get all carriers from ConstantDataService.
   carriers = constant_data_srv.get_carrier_criterion()
 
-  carriers.each do |carrier|
-    puts "Carrier name is '%s', ID is %d and country code is '%s'." %
-        [carrier[:name], carrier[:id], carrier[:country_code]]
+  if carriers
+    carriers.each do |carrier|
+      puts "Carrier name is '%s', ID is %d and country code is '%s'." %
+          [carrier[:name], carrier[:id], carrier[:country_code]]
+    end
+  else
+    puts 'No carriers were retrieved.'
   end
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
 
   begin
     get_targetable_languages_and_carriers()
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e

data/examples/{v201206 → v201306}/targeting/lookup_location.rb

@@ -81,11 +81,19 @@ def lookup_location()
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
 
   begin
     lookup_location()
 
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
+
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
     puts "HTTP Error: %s" % e