google-adx-buyer-api 0.4.6 → 0.4.7

data/examples/{v201206 → v201306}/basic_operations/get_placements.rb

@@ -68,12 +68,20 @@ def get_placements(ad_group_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
 
   begin
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
     get_placements(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/{v201206 → v201306}/basic_operations/get_thirdparty_redirect_ads.rb

@@ -76,12 +76,20 @@ def get_all_ads(ad_group_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
 
   begin
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
     get_all_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/{v201206 → v201306}/basic_operations/pause_ad.rb

@@ -56,13 +56,21 @@ def pause_ad(ad_group_id, ad_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
 
   begin
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
     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/{v201206 → v201306}/basic_operations/update_ad_group.rb

@@ -52,12 +52,20 @@ def update_ad_group(ad_group_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
 
   begin
     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/{v201206 → v201306}/basic_operations/update_campaign.rb

@@ -55,12 +55,20 @@ def update_campaign(campaign_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
 
   begin
     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/{v201206 → v201306}/basic_operations/update_placement.rb

@@ -49,13 +49,13 @@ def update_placement(ad_group_id, placement_id)
       :criterion => {
         :id => placement_id
       },
-      :bids => {
-        :xsi_type => 'ManualCPMAdGroupCriterionBids',
-        :max_cpm => {
-          :amount => {
-            :micro_amount => 1000000
+      :bidding_strategy_configuration => {
+        :bids => [
+          {
+            :xsi_type => 'CpmBid',
+            :bid => {:micro_amount => 1000000}
           }
-        }
+        ]
       }
     }
   }
@@ -69,13 +69,21 @@ def update_placement(ad_group_id, placement_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
 
   begin
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
     placement_id = 'INSERT_PLACEMENT_ID_HERE'.to_i
     update_placement(ad_group_id, placement_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}/campaign_management/add_placements_in_bulk.rb

@@ -64,7 +64,7 @@ def add_placements_in_bulk(ad_group_id)
   job_id = response[:id]
   puts "Job ID %d was successfully created." % job_id
 
-  # Creating selector to retrive hob status and wait for it to complete.
+  # Creating selector to retrive job status and wait for it to complete.
   selector = {
       :xsi_type => 'BulkMutateJobSelector',
       :job_ids => [job_id]
@@ -124,7 +124,7 @@ def add_placements_in_bulk(ad_group_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
   RETRY_INTERVAL = 30
   RETRIES_COUNT = 30
   PLACEMENT_NUMBER = 100
@@ -133,6 +133,14 @@ if __FILE__ == $0
     ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
     add_placements_in_bulk(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/{v201206 → v201306}/campaign_management/get_all_disapproved_ads.rb

@@ -43,7 +43,7 @@ def get_all_disapproved_ads(ad_group_id)
     :predicates => [
       {:field => 'AdGroupId', :operator => 'IN', :values => [ad_group_id]},
       {
-        :field => 'CreativeApprovalStatus',
+        :field => 'AdGroupCreativeApprovalStatus',
         :operator => 'IN',
         :values => ['DISAPPROVED']
       }
@@ -68,12 +68,20 @@ def get_all_disapproved_ads(ad_group_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
 
   begin
     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/{v201206 → v201306}/error_handling/handle_captcha_challenge.rb

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

data/examples/{v201206 → v201306}/error_handling/handle_partial_failures.rb

@@ -93,12 +93,20 @@ def handle_partial_failures(ad_group_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
 
   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/{v201206 → v201306}/error_handling/handle_policy_violation_error.rb

@@ -114,12 +114,20 @@ def handle_policy_violation_error(ad_group_id)
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
 
   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/{v201206 → v201306}/error_handling/handle_two_factor_authorization_error.rb

@@ -29,7 +29,8 @@ def handle_two_factor_authorization_error()
           :method => 'ClientLogin',
           :email => '2steptester@gmail.com',
           :password => 'testaccount',
-          :user_agent => 'Ruby 2 Factor Sample'
+          :user_agent => 'Ruby 2 Factor Sample',
+          :developer_token => 'qwerty'
       },
       :service => {
           :environment => 'PRODUCTION'
@@ -64,7 +65,7 @@ def handle_two_factor_authorization_error()
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
 
   begin
     handle_two_factor_authorization_error()

data/examples/{v201206 → v201306}/misc/get_all_images_and_videos.rb

@@ -25,7 +25,6 @@
 # Tags: MediaService.get
 
 require 'adwords_api'
-require 'adwords_api/utils'
 
 def get_all_images_and_videos()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
@@ -60,10 +59,10 @@ def get_all_images_and_videos()
     page = media_srv.get(selector)
     if page[:entries]
       page[:entries].each do |entry|
-        dimensions = AdwordsApi::Utils.map(entry[:dimensions])
+        full_dimensions = entry[:dimensions]['FULL']
         puts "Entry ID %d with dimensions %dx%d and MIME type is '%s'" %
-            [entry[:media_id], dimensions['FULL'][:height],
-             dimensions['FULL'][:width], entry[:mime_type]]
+            [entry[:media_id], full_dimensions[:height],
+             full_dimensions[:width], entry[:mime_type]]
       end
       # Increment values to request the next page.
       offset += PAGE_SIZE
@@ -77,12 +76,20 @@ def get_all_images_and_videos()
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
   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/v201306/misc/setup_oauth2.rb

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+# This example illustrates how to set up OAuth2.0 authentication credentials.
+#
+# Tags: CampaignService.get
+
+require 'adwords_api'
+
+def setup_oauth2()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+
+  # To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
+  # the configuration file or provide your own logger:
+  # adwords.logger = Logger.new('adwords_xml.log')
+
+  # You can call authorize explicitely to obtain the access token. Otherwise, it
+  # will be invoked automatically on the first API call.
+  # There are two ways to provide verification code, first one is via the block:
+  token = adwords.authorize() do |auth_url|
+    puts "Hit Auth error, please navigate to URL:\n\t%s" % auth_url
+    print 'log in and type the verification code: '
+    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})
+
+  # Note, 'token' is a Hash. Its value is not used in this example. If you need
+  # to be able to access the API in offline mode, with no user present, you
+  # should persist it to be used in subsequent invocations like this:
+  #adwords.authorize({:oauth2_token => token})
+
+  # No exception thrown - we are good to make a request.
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201306
+
+  begin
+    setup_oauth2()
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue AdwordsApi::Errors::ApiException => e
+    puts "Message: %s" % e.message
+    puts 'Errors:'
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
+      end
+    end
+  end
+end

data/examples/{v201206 → v201306}/misc/upload_image.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.
 #
@@ -18,13 +18,11 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example uploads an image. To get images, run
-# get_all_images_and_videos.rb.
+# This example uploads an image. To get images, run get_all_images.rb.
 #
 # Tags: MediaService.upload
 
 require 'adwords_api'
-require 'adwords_api/utils'
 require 'base64'
 
 def upload_image()
@@ -56,19 +54,31 @@ def upload_image()
 
   # Upload image.
   response = media_srv.upload([image])
-  ret_image = response.first
-  dimensions = AdwordsApi::Utils.map(ret_image[:dimensions])
-  puts "Image with id #{ret_image[:media_id]}, dimensions " +
-      "#{dimensions['FULL'][:height]}x#{dimensions['FULL'][:width]} " +
-      "and MIME type \"#{ret_image[:mime_type]}\" uploaded successfully."
+  if response and !response.empty?
+    ret_image = response.first
+    full_dimensions = ret_image[:dimensions]['FULL']
+    puts ("Image with ID %d, dimensions %dx%d and MIME type '%s' uploaded " +
+        "successfully.") % [ret_image[:media_id], full_dimensions[:height],
+         full_dimensions[:width], ret_image[:mime_type]]
+  else
+    puts 'No images uploaded.'
+  end
 end
 
 if __FILE__ == $0
-  API_VERSION = :v201206
+  API_VERSION = :v201306
 
   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