google-adwords-api 0.9.3 → 0.10.0

data/examples/{v201209 → v201309}/basic_operations/get_ad_groups.rb

@@ -72,7 +72,7 @@ def get_ad_groups(campaign_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
   PAGE_SIZE = 500
 
   begin
@@ -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/{v201209 → v201309}/basic_operations/get_campaigns.rb

@@ -69,12 +69,20 @@ def get_campaigns()
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
   PAGE_SIZE = 500
 
   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/{v201209 → v201309}/basic_operations/get_campaigns_with_awql.rb

@@ -61,12 +61,20 @@ def get_campaigns_with_awql()
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
   PAGE_SIZE = 500
 
   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/{v201209 → v201309}/basic_operations/get_keywords.rb

@@ -78,7 +78,7 @@ def get_keywords(ad_group_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
   PAGE_SIZE = 500
 
   begin
@@ -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/{v201209 → v201309}/basic_operations/get_text_ads.rb

@@ -80,7 +80,7 @@ def get_text_ads(ad_group_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
   PAGE_SIZE = 500
 
   begin
@@ -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/{v201209 → v201309}/basic_operations/pause_ad.rb

@@ -58,7 +58,7 @@ def pause_ad(ad_group_id, ad_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     # IDs of ad to pause and its ad group.
@@ -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/{v201209 → v201309}/basic_operations/update_ad_group.rb

@@ -56,13 +56,21 @@ def update_ad_group(ad_group_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     # ID of an ad group to update.
     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/{v201209 → v201309}/basic_operations/update_campaign.rb

@@ -57,13 +57,21 @@ def update_campaign(campaign_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     # ID of a campaign to update.
     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/{v201209 → v201309}/basic_operations/update_keyword.rb

@@ -49,13 +49,13 @@ def update_keyword(ad_group_id, criterion_id)
       :criterion => {
         :id => criterion_id
       },
-      :bids => {
-        :xsi_type => 'ManualCPCAdGroupCriterionBids',
-        :max_cpc => {
-          :amount => {
-            :micro_amount => 1000000
+      :bidding_strategy_configuration => {
+        :bids => [
+          {
+            :xsi_type => 'CpcBid',
+            :bid => {:micro_amount => 1000000}
           }
-        }
+        ]
       }
     }
   }
@@ -64,16 +64,19 @@ def update_keyword(ad_group_id, criterion_id)
   response = ad_group_criterion_srv.mutate([operation])
   if response and response[:value]
     ad_group_criterion = response[:value].first
-    puts "Keyword ID %d was successfully updated, bid set to %d." %
-        [ad_group_criterion[:criterion][:id],
-         ad_group_criterion[:bids][:max_cpc][:amount][:micro_amount]]
+    puts "Keyword ID %d was successfully updated, current bids are:" %
+        ad_group_criterion[:criterion][:id]
+    ad_group_criterion[:bidding_strategy_configuration][:bids].each do |bid|
+      puts "\tType: '%s', value: %d" %
+          [bid[:bids_type], bid[:bid][:micro_amount]]
+    end
   else
     puts 'No keywords were updated.'
   end
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     # IDs of a criterion to update and its ad group.
@@ -81,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

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

@@ -131,7 +131,7 @@ def add_experiment(campaign_id, ad_group_id, criterion_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     # IDs of the required objects.
@@ -140,6 +140,14 @@ if __FILE__ == $0
     criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
     add_experiment(campaign_id, 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/add_keywords_in_bulk.rb

@@ -119,12 +119,12 @@ def add_keywords_in_bulk()
       raise StandardError, 'Error retrieving job results; aborting.'
     end
   else
-    puts "Job failed to complete after %d retries." % RETRIES_COUNT
+    puts "Job failed to complete after %d retries." % RETRY_COUNT
   end
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
   RETRY_INTERVAL = 30
   RETRIES_COUNT = 30
   KEYWORD_NUMBER = 100
@@ -132,6 +132,14 @@ if __FILE__ == $0
   begin
     add_keywords_in_bulk()
 
+  # 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/add_location_extension.rb

@@ -92,13 +92,21 @@ def add_location_extension(campaign_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     # ID of campaign to add location extension to.
     campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
     add_location_extension(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/{v201209 → v201309}/campaign_management/add_location_extension_override.rb

@@ -57,7 +57,7 @@ def add_location_extension_override(ad_id, location_extension_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     # IDs of ad and location extension override to add.
@@ -65,6 +65,14 @@ if __FILE__ == $0
     location_extension_id = 'INSERT_LOCATION_EXTENSION_ID_HERE'.to_i
     add_location_extension_override(ad_id, location_extension_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/get_all_disapproved_ads.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
@@ -38,7 +38,7 @@ def get_all_disapproved_ads(ad_group_id)
 
   # Get all the disapproved ads for this campaign.
   selector = {
-    :fields => ['Id', 'DisapprovalReasons'],
+    :fields => ['Id', 'AdGroupAdDisapprovalReasons'],
     :ordering => [{:field => 'Id', :sort_order => 'ASCENDING'}],
     :predicates => [
       {:field => 'AdGroupId', :operator => 'IN', :values => [ad_group_id]},
@@ -51,30 +51,38 @@ def get_all_disapproved_ads(ad_group_id)
   }
   response = ad_group_ad_srv.get(selector)
   if response and response[:entries]
-    ad_group_ads = response[:entries]
-    puts "Ad group ##{ad_group_id} has #{ad_group_ads.length} " +
-        "disapproved ad(s)."
-    ad_group_ads.each do |ad_group_ad|
-      puts "  Ad with id #{ad_group_ad[:ad][:id]} and type " +
-          "#{ad_group_ad[:ad][:xsi_type]} was disapproved for the following " +
-          "reasons:"
-      ad_group_ad[:ad][:disapproval_reasons].each do |reason|
-        puts "    #{reason}"
+    puts 'Ad group %d has %d disapproved ad(s).' %
+        [ad_group_id, response[:total_num_entries]]
+    response[:entries].each do |ad_group_ad|
+      puts ("\tAd with ID %d and type '%s' was disapproved for the following " +
+          'reasons:') % [ad_group_ad[:ad][:id], ad_group_ad[:ad][:xsi_type]]
+      if ad_group_ad.include?(:disapproval_reasons)
+        ad_group_ad[:disapproval_reasons].each {|reason| puts "\t\t%s" % reason}
+      else
+        puts "\t\tReason not provided."
       end
     end
   else
-    puts "No disapproved ads found for ad group ##{ad_group_id}."
+    puts 'No disapproved ads found for ad group %d.' % ad_group_id
   end
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     # ID of an ad group to get disapproved ads for.
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
     get_all_disapproved_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/{v201209 → v201309}/campaign_management/get_all_disapproved_ads_with_awql.rb

@@ -37,20 +37,21 @@ def get_all_disapproved_ads_with_awql(ad_group_id)
   ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
 
   # Get all the disapproved ads for this campaign.
-  query = ('SELECT Id, DisapprovalReasons ' +
+  query = ('SELECT Id, AdGroupAdDisapprovalReasons ' +
       'WHERE AdGroupId = %d AND AdGroupCreativeApprovalStatus = DISAPPROVED ' +
       'ORDER BY Id') % ad_group_id
 
   response = ad_group_ad_srv.query(query)
   if response and response[:entries]
-    ad_group_ads = response[:entries]
     puts 'Ad group ID %d has %d disapproved ad(s).' %
-        [ad_group_id, ad_group_ads.length]
-    ad_group_ads.each do |ad_group_ad|
+        [ad_group_id, response[:total_num_entries]]
+    response[:entries].each do |ad_group_ad|
       puts ("\tAd with ID %d and type '%s' was disapproved for the following " +
-          + 'reasons:') % [ad_group_ad[:ad][:id], ad_group_ad[:ad][:xsi_type]]
-      ad_group_ad[:ad][:disapproval_reasons].each do |reason|
-        puts "\t\t%s" % reason
+          'reasons:') % [ad_group_ad[:ad][:id], ad_group_ad[:ad][:xsi_type]]
+      if ad_group_ad.include?(:disapproval_reasons)
+        ad_group_ad[:disapproval_reasons].each {|reason| puts "\t\t%s" % reason}
+      else
+        puts "\t\tReason not provided."
       end
     end
   else
@@ -59,13 +60,21 @@ def get_all_disapproved_ads_with_awql(ad_group_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201209
+  API_VERSION = :v201309
 
   begin
     # ID of an ad group to get disapproved ads for.
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
     get_all_disapproved_ads_with_awql(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