google-adwords-api 0.9.3 → 0.10.0

data/examples/{v201209 → v201309}/campaign_management/promote_experiment.rb

@@ -53,12 +53,20 @@ def promote_experiment(experiment_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     experiment_id = 'INSERT_EXPERIMENT_ID_HERE'.to_i
     promote_experiment(experiment_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/{v201209 → v201309}/campaign_management/set_ad_parameters.rb

@@ -88,7 +88,7 @@ def set_ad_parameters(ad_group_id, criterion_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     # IDs of ad group and criterion to set ad parameter for.
@@ -96,6 +96,14 @@ if __FILE__ == $0
     criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
     set_ad_parameters(ad_group_id, criterion_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/{v201209 → v201309}/campaign_management/set_criterion_bid_modifier.rb

@@ -19,9 +19,7 @@
 #           limitations under the License.
 #
 # This example sets a bid modifier for the mobile platform on given campaign.
-#
-# NOTE: the campaign must be an enhanced type of campaign. To get campaigns, run
-# get_campaigns.rb. To enhance a campaign, run set_campaign_enhanced.rb.
+# To get campaigns, run get_campaigns.rb.
 #
 # Tags: CampaignCriterionService.mutate
 
@@ -73,10 +71,10 @@ def set_criterion_bid_modifier(campaign_id, bid_modifier)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
-    # ID of a campaign to be updated with the enhanced value.
+    # ID of a campaign to use mobile bid modifier for.
     campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
 
     # Bid modifier to set.
@@ -84,6 +82,14 @@ if __FILE__ == $0
 
     set_criterion_bid_modifier(campaign_id, bid_modifier)
 
+  # 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/{v201209 → v201309}/campaign_management/validate_text_ad.rb

@@ -82,12 +82,20 @@ def validate_text_ad(ad_group_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
     validate_text_ad(ad_group_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/{v201209 → v201309}/error_handling/handle_captcha_challenge.rb

@@ -69,7 +69,7 @@ def handle_captcha_challenge()
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
   MAX_RETRIES = 500
 
   begin

data/examples/{v201209 → v201309}/error_handling/handle_partial_failures.rb

@@ -102,12 +102,20 @@ def handle_partial_failures(ad_group_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
     handle_partial_failures(ad_group_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/{v201209 → v201309}/error_handling/handle_policy_violation_error.rb

@@ -113,12 +113,20 @@ def handle_policy_violation_error(ad_group_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
     handle_policy_violation_error(ad_group_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/{v201209 → v201309}/error_handling/handle_two_factor_authorization_error.rb

@@ -65,7 +65,7 @@ def handle_two_factor_authorization_error()
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     handle_two_factor_authorization_error()

data/examples/{v201209 → v201309}/misc/get_all_images_and_videos.rb

@@ -76,12 +76,20 @@ def get_all_images_and_videos()
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
   PAGE_SIZE = 500
 
   begin
     get_all_images_and_videos()
 
+  # 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/{v201209/misc/use_oauth2.rb → v201309/misc/setup_oauth2.rb}

@@ -3,7 +3,7 @@
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
-# Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
+# Copyright:: Copyright 2013, 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,13 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example illustrates how to use OAuth2.0 authentication method.
+# This example illustrates how to set up OAuth2.0 authentication credentials.
 #
 # Tags: CampaignService.get
 
 require 'adwords_api'
 
-def use_oauth2()
+def setup_oauth2()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -42,6 +42,17 @@ def use_oauth2()
     verification_code = gets.chomp
     verification_code
   end
+  if token
+    print "\nWould you like to update your adwords_api.yml to save " +
+        "OAuth2 crdentials? (y/N): "
+    response = gets.chomp
+    if ('y'.casecmp(response) == 0) or ('yes'.casecmp(response) == 0)
+      adwords.save_oauth2_token(token)
+      puts 'OAuth2 token is now saved to ~/adwords_api.yml and will be ' +
+          'automatically used by the library.'
+    end
+  end
+
   # Alternatively, you can provide one within the parameters:
   #token = adwords.authorize({:oauth2_verification_code => verification_code})
 
@@ -50,34 +61,14 @@ def use_oauth2()
   # should persist it to be used in subsequent invocations like this:
   #adwords.authorize({:oauth2_token => token})
 
-  # No exception thrown - we are good to make the request.
-  campaign_srv = adwords.service(:CampaignService, API_VERSION)
-
-  # Get all the campaigns for this account; empty selector.
-  selector = {
-    :fields => ['Id', 'Name', 'Status'],
-    :ordering => [
-      {:field => 'Name', :sort_order => 'ASCENDING'}
-    ]
-  }
-
-  response = campaign_srv.get(selector)
-  if response and response[:entries]
-    campaigns = response[:entries]
-    campaigns.each do |campaign|
-      puts "Campaign ID %d, name '%s' and status '%s'" %
-          [campaign[:id], campaign[:name], campaign[:status]]
-    end
-  else
-    puts 'No campaigns were found.'
-  end
+  # No exception thrown - we are good to make a request.
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
-    use_oauth2()
+    setup_oauth2()
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/{v201209 → v201309}/misc/upload_image.rb

@@ -66,11 +66,19 @@ def upload_image()
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     upload_image()
 
+  # 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/{v201209 → v201309}/misc/use_oauth2_jwt.rb

@@ -70,7 +70,7 @@ def use_oauth2_jwt()
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     use_oauth2_jwt()

data/examples/{v201209 → v201309}/optimization/estimate_keyword_traffic.rb

@@ -106,11 +106,19 @@ def estimate_keyword_traffic()
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     estimate_keyword_traffic()
 
+  # 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/{v201209 → v201309}/optimization/get_keyword_bid_simulations.rb

@@ -67,13 +67,21 @@ def get_criterion_bid_landscapes(ad_group_id, keyword_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     ad_group_id = 'INSERT_ADGROUP_ID_HERE'.to_i
     keyword_id = 'INSERT_KEYWORD_ID_HERE'.to_i
     get_criterion_bid_landscapes(ad_group_id, keyword_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/{v201209 → v201309}/optimization/get_keyword_ideas.rb

@@ -48,6 +48,14 @@ def get_keyword_ideas(keyword_text)
         # type that the client library can't infer.
         :xsi_type => 'RelatedToQuerySearchParameter',
         :queries => [keyword_text]
+      },
+      {
+        # Language setting (optional).
+        # The ID can be found in the documentation:
+        #  https://developers.google.com/adwords/api/docs/appendix/languagecodes
+        # As of v201302 only one LanguageSearchParameter is allowed per request.
+        :xsi_type => 'LanguageSearchParameter',
+        :languages => [{:id => 1000}]
       }
     ],
     :paging => {
@@ -89,13 +97,21 @@ def get_keyword_ideas(keyword_text)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
   PAGE_SIZE = 100
 
   begin
     keyword_text = 'INSERT_KEYWORD_TEXT_HERE'
     get_keyword_ideas(keyword_text)
 
+  # 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/{v201209 → v201309}/optimization/get_placement_ideas.rb

@@ -79,13 +79,21 @@ def get_placement_ideas(url)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
   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/{v201209 → v201309}/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',
@@ -92,11 +92,19 @@ def add_audience()
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   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