google-adwords-api 0.9.2 → 0.9.3

data/ChangeLog

@@ -1,3 +1,8 @@
+0.9.3:
+  - Updated examples to use OAuth2 by default.
+  - Require google-ads-common 0.9.3 or later from now on.
+  - Support and examples for v201306.
+
 0.9.2:
   - AdWords for Video API v201302 support and examples (beta feature).
 

data/README

@@ -3,8 +3,8 @@
 Welcome to the next generation Google-developed Ruby client library for the
 AdWords and DoubleClick Ad Exchange Buyer API!
 
-It contains full support for v201209 and v201302, with full stubs, and a
-simplified programming interface that lets you handle everything in native
+It contains full support for v201209, v201302 and v201306, with full stubs, and
+a simplified programming interface that lets you handle everything in native
 Ruby collections.
 
 
@@ -63,7 +63,7 @@ To obtain OAuth2 client credentials, follow instructions on the wiki:
 
 Once the library instance is create, specify which service you're looking to
 use, and which version:
-   campaign_srv = adwords.service(:CampaignService, :v201302)
+   campaign_srv = adwords.service(:CampaignService, :v201306)
 
 and you should now be able to just use the API methods in the object you were
 returned:

data/examples/v201302/account_management/create_account.rb

@@ -69,6 +69,14 @@ if __FILE__ == $0
   begin
     create_account()
 
+  # 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/v201302/account_management/get_account_alerts.rb

@@ -96,6 +96,14 @@ if __FILE__ == $0
   begin
     get_account_alerts()
 
+  # 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/v201302/account_management/get_account_changes.rb

@@ -119,6 +119,14 @@ if __FILE__ == $0
   begin
     get_account_changes()
 
+  # 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/v201302/account_management/get_account_hierarchy.rb

@@ -77,6 +77,14 @@ if __FILE__ == $0
   begin
     get_account_hierarchy()
 
+  # 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/v201302/advanced_operations/add_ad_group_bid_modifier.rb

@@ -79,6 +79,14 @@ if __FILE__ == $0
 
     add_ad_group_bid_modifier(ad_group_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/v201302/advanced_operations/add_click_to_download_ad.rb

@@ -111,6 +111,14 @@ if __FILE__ == $0
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
     add_click_to_download_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/v201302/advanced_operations/add_site_links.rb

@@ -195,6 +195,14 @@ if __FILE__ == $0
     campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
     add_site_links(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/v201302/advanced_operations/create_and_attach_shared_keyword_set.rb

@@ -121,6 +121,14 @@ if __FILE__ == $0
 
     create_and_attach_shared_keyword_set(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/v201302/advanced_operations/find_and_remove_criteria_from_shared_set.rb

@@ -155,6 +155,14 @@ if __FILE__ == $0
 
     find_and_remove_criteria_from_shared_set(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/v201302/advanced_operations/get_ad_group_bid_modifiers.rb

@@ -80,6 +80,14 @@ if __FILE__ == $0
 
     get_ad_group_bid_modifiers(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/v201302/basic_operations/add_ad_groups.rb

@@ -117,6 +117,14 @@ if __FILE__ == $0
     campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
     add_ad_groups(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/v201302/basic_operations/add_campaigns.rb

@@ -136,6 +136,14 @@ if __FILE__ == $0
   begin
     add_campaigns()
 
+  # 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/v201302/basic_operations/add_keywords.rb

@@ -90,6 +90,14 @@ if __FILE__ == $0
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
     add_keywords(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/v201302/basic_operations/add_text_ads.rb

@@ -87,6 +87,14 @@ if __FILE__ == $0
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
     add_text_ads(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/v201302/basic_operations/delete_ad.rb

@@ -67,6 +67,14 @@ if __FILE__ == $0
     ad_id = 'INSERT_AD_ID_HERE'.to_i
     delete_ad(ad_group_id, ad_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/v201302/basic_operations/delete_ad_group.rb

@@ -84,6 +84,14 @@ if __FILE__ == $0
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
     delete_ad_group(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/v201302/basic_operations/delete_campaign.rb

@@ -85,6 +85,14 @@ if __FILE__ == $0
     campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
     delete_campaign(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/v201302/basic_operations/delete_keyword.rb

@@ -72,6 +72,14 @@ if __FILE__ == $0
     criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
     delete_keyword(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/v201302/basic_operations/get_ad_groups.rb

@@ -80,6 +80,14 @@ if __FILE__ == $0
     campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
     get_ad_groups(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/v201302/basic_operations/get_campaigns.rb

@@ -75,6 +75,14 @@ if __FILE__ == $0
   begin
     get_campaigns()
 
+  # 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/v201302/basic_operations/get_campaigns_with_awql.rb

@@ -67,6 +67,14 @@ if __FILE__ == $0
   begin
     get_campaigns_with_awql()
 
+  # 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/v201302/basic_operations/get_keywords.rb

@@ -86,6 +86,14 @@ if __FILE__ == $0
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
     get_keywords(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/v201302/basic_operations/get_text_ads.rb

@@ -88,6 +88,14 @@ if __FILE__ == $0
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
     get_text_ads(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/v201302/basic_operations/pause_ad.rb

@@ -66,6 +66,14 @@ if __FILE__ == $0
     ad_id = 'INSERT_AD_ID_HERE'.to_i
     pause_ad(ad_group_id, ad_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/v201302/basic_operations/update_ad_group.rb

@@ -63,6 +63,14 @@ if __FILE__ == $0
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
     update_ad_group(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/v201302/basic_operations/update_campaign.rb

@@ -64,6 +64,14 @@ if __FILE__ == $0
     campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
     update_campaign(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/v201302/basic_operations/update_keyword.rb

@@ -84,6 +84,14 @@ if __FILE__ == $0
     criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
     update_keyword(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