google-adx-buyer-api 0.4.0 → 0.4.1

data/examples/{v201003 → v201109/basic_operations}/update_ad_group.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.sgomes@gmail.com (Sérgio Gomes)
 #
@@ -22,13 +23,9 @@
 #
 # Tags: AdGroupService.mutate
 
-require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 
-API_VERSION = :v201003
-
-def update_ad_group()
+def update_ad_group(ad_group_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -39,8 +36,6 @@ def update_ad_group()
 
   ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
 
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-
   # Prepare for updating ad group.
   operation = {
     :operator => 'SET',
@@ -52,38 +47,29 @@ def update_ad_group()
 
   # Update ad group.
   response = ad_group_srv.mutate([operation])
-  if response and response[:value]
-    ad_group = response[:value].first
-    puts 'Ad group id %d was successfully updated.' % ad_group[:id]
-  else
-    puts 'No ad groups were updated.'
-  end
+  ad_group = response[:value].first
+  puts "Ad group ID %d was successfully updated." % ad_group[:id]
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    update_ad_group()
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    update_ad_group(ad_group_id)
 
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
 
-  # API Error.
+  # API errors.
   rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts "Message: %s" % e.message
     puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
+    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

data/examples/{v201101 → v201109/basic_operations}/update_campaign.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.sgomes@gmail.com (Sérgio Gomes)
 #
@@ -22,13 +23,9 @@
 #
 # Tags: CampaignService.mutate
 
-require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 
-API_VERSION = :v201101
-
-def update_campaign()
+def update_campaign(campaign_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -39,8 +36,6 @@ def update_campaign()
 
   campaign_srv = adwords.service(:CampaignService, API_VERSION)
 
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
   # Prepare for updating campaign.
   operation = {
     :operator => 'SET',
@@ -54,39 +49,30 @@ def update_campaign()
 
   # Update campaign.
   response = campaign_srv.mutate([operation])
-  if response and response[:value]
-    campaign = response[:value].first
-    puts 'Campaign id %d successfully updated, delivery method set to %s.' %
-        [campaign[:id], campaign[:budget][:delivery_method]]
-  else
-    puts 'No campaigns were updated.'
-  end
+  campaign = response[:value].first
+  puts "Campaign ID %d successfully updated, delivery method set to '%s'." %
+      [campaign[:id], campaign[:budget][:delivery_method]]
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    update_campaign()
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+    update_campaign(campaign_id)
 
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
 
-  # API Error.
+  # API errors.
   rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts "Message: %s" % e.message
     puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
+    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

data/examples/{v201003/delete_ad_group_criterion.rb → v201109/basic_operations/update_placement.rb}

@@ -1,6 +1,7 @@
-#!/usr/bin/ruby
+#!/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.
 #
@@ -17,18 +18,14 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example deletes an ad group criterion using the 'REMOVE' operator. To
-# get ad group criteria, run get_all_ad_group_criteria.rb.
+# This example illustrates how to update a placement, setting its bid. To create
+# a placement, run add_placements.rb.
 #
 # Tags: AdGroupCriterionService.mutate
 
-require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 
-API_VERSION = :v201003
-
-def delete_ad_group_criterion()
+def update_placement(ad_group_id, placement_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -40,12 +37,9 @@ def delete_ad_group_criterion()
   ad_group_criterion_srv =
       adwords.service(:AdGroupCriterionService, API_VERSION)
 
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-  criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
-
-  # Prepare for deleting ad group criterion.
+  # Prepare for updating a placement.
   operation = {
-    :operator => 'REMOVE',
+    :operator => 'SET',
     :operand => {
       # 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
@@ -53,42 +47,47 @@ def delete_ad_group_criterion()
       :xsi_type => 'BiddableAdGroupCriterion',
       :ad_group_id => ad_group_id,
       :criterion => {
-        :id => criterion_id
+        :id => placement_id
+      },
+      :bids => {
+        :xsi_type => 'ManualCPMAdGroupCriterionBids',
+        :max_cpm => {
+          :amount => {
+            :micro_amount => 1000000
+          }
+        }
       }
     }
   }
 
-  # Delete criterion.
+  # Update the placement.
   response = ad_group_criterion_srv.mutate([operation])
   ad_group_criterion = response[:value].first
-  puts 'Criterion id %d was successfully deleted.' %
-      ad_group_criterion[:criterion][:id]
+  puts "Placement ID %d was successfully updated, bid set to %.2f." %
+      [ad_group_criterion[:criterion][:id],
+       ad_group_criterion[:bids][:max_cpm][:amount][:micro_amount] / 1000000]
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    delete_ad_group_criterion()
+    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)
 
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
 
-  # API Error.
+  # API errors.
   rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts "Message: %s" % e.message
     puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
+    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

data/examples/v201109/{perform_mutate_job.rb → campaign_management/add_placements_in_bulk.rb}

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
@@ -23,15 +24,9 @@
 # Tags: MutateJobService.mutate, MutateJobService.get,
 #       MutateJobService.getResult
 
-require 'rubygems'
 require 'adwords_api'
 
-API_VERSION = :v201109
-RETRY_INTERVAL = 30
-RETRIES_COUNT = 30
-PLACEMENT_NUMBER = 100
-
-def perform_mutate_job()
+def add_placements_in_bulk(ad_group_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -42,10 +37,9 @@ def perform_mutate_job()
 
   mutate_job_srv = adwords.service(:MutateJobService, API_VERSION)
 
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-
   # Create AdGroupCriterionOperations to add placements.
   operations = (1..PLACEMENT_NUMBER).map do |index|
+    # Add small fraction of invalid URLs to demonstrate errors.
     url = (rand(10) == 0) ? 'invalid-url' : 'http://mars.google.com/'
     {:xsi_type => 'AdGroupCriterionOperation',
      :operator => 'ADD',
@@ -130,8 +124,14 @@ def perform_mutate_job()
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+  RETRY_INTERVAL = 30
+  RETRIES_COUNT = 30
+  PLACEMENT_NUMBER = 100
+
   begin
-    perform_mutate_job()
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    add_placements_in_bulk(ad_group_id)
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e

data/examples/v201109/{get_all_disapproved_ads.rb → campaign_management/get_all_disapproved_ads.rb}

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.sgomes@gmail.com (Sérgio Gomes)
 #
@@ -18,17 +19,13 @@
 #           limitations under the License.
 #
 # This example illustrates how to retrieve all the disapproved ads in a given
-# ad group. To add ads, run add_ads.rb.
+# ad group. To add ads, run add_thirdparty_redirect_ad.rb.
 #
 # Tags: AdGroupAdService.get
 
-require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-def get_all_disapproved_ads()
+def get_all_disapproved_ads(ad_group_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -39,8 +36,6 @@ def get_all_disapproved_ads()
 
   ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
 
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-
   # Get all the disapproved ads for this campaign.
   selector = {
     :fields => ['Id', 'DisapprovalReasons'],
@@ -68,34 +63,29 @@ def get_all_disapproved_ads()
       end
     end
   else
-    puts "No disapproved ads found for ad group ##{ad_group_id}."
+    puts "No disapproved ads found for ad group ID %d" % ad_group_id
   end
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    get_all_disapproved_ads()
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    get_all_disapproved_ads(ad_group_id)
 
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
 
-  # API Error.
+  # API errors.
   rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts "Message: %s" % e.message
     puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
+    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

data/examples/v201109/error_handling/handle_captcha_challenge.rb

@@ -0,0 +1,93 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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.
+#           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 handle 'CAPTCHA required' authorization
+# errors. Refer to the best practices guide on how to avoid this error:
+#
+# http://code.google.com/apis/adwords/docs/guides/bestpractices.html#auth_tokens
+
+require 'adwords_api'
+
+def handle_captcha_challenge()
+  # Initialize token variable.
+  logintoken = nil
+
+  # This code will repeatedly request authToken from the server until it gets
+  # a CAPTCHA challenge request. It is here for illustration purposes only
+  # and should never be used in a real application.
+  begin
+    MAX_RETRIES.times do |retry_number|
+      puts "Running request %d of %d..." % [retry_number + 1, MAX_RETRIES]
+      # Forcing library to request a new authorization token.
+      adwords = AdwordsApi::Api.new
+      auth_token = adwords.authorize()
+    end
+    # Still no challenge, make sure ClientLogin authorization is used.
+    raise StandardError, "Failed to get challenge after %d requests." %
+        MAX_RETRIES
+  rescue AdsCommon::Errors::CaptchaRequiredError => e
+    logintoken = e.captcha_token
+  end
+
+  puts "CaptchaRequiredError occurred. To recover download the image and type" +
+      " the CAPTCHA below: %s\n" % e.captcha_url
+  puts 'Enter code or ENTER to retry: '
+  logincaptcha = gets.chomp
+
+  # Initialize variable for extra parameters.
+  credentials = {}
+  if logincaptcha and !logincaptcha.empty?
+    credentials[:logincaptcha] = logincaptcha
+    credentials[:logintoken] = logintoken
+  end
+
+  begin
+    adwords = AdwordsApi::Api.new
+    auth_token = adwords.authorize(credentials)
+    puts "Successfully retrieved authToken: " + auth_token
+  rescue AdsCommon::Errors::CaptchaRequiredError => e
+    puts 'Invalid CAPTCHA text entered.'
+    raise e
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201109
+  MAX_RETRIES = 500
+
+  begin
+    handle_captcha_challenge()
+
+  # 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