google-adwords-api 0.13.1 → 0.13.2

data/examples/v201409/campaign_management/set_criterion_bid_modifier.rb

@@ -0,0 +1,108 @@
+#!/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 sets a bid modifier for the mobile platform on given campaign.
+# To get campaigns, run get_campaigns.rb.
+#
+# Tags: CampaignCriterionService.mutate
+
+require 'adwords_api'
+
+def set_criterion_bid_modifier(campaign_id, bid_modifier)
+  # 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')
+
+  campaign_criterion_srv =
+      adwords.service(:CampaignCriterionService, API_VERSION)
+
+  # Create campaign criterion with modified bid.
+  campaign_criterion = {
+    :campaign_id => campaign_id,
+    # Mobile platform. The ID can be found in the documentation.
+    # https://developers.google.com/adwords/api/docs/appendix/platforms
+    :criterion => {
+      :xsi_type => 'Platform',
+      :id => 30001
+    },
+    :bid_modifier => bid_modifier
+  }
+
+  # Create operation.
+  operation = {
+    :operator => 'SET',
+    :operand => campaign_criterion
+  }
+
+  response = campaign_criterion_srv.mutate([operation])
+
+  if response and response[:value]
+    criteria = response[:value]
+    criteria.each do |campaign_criterion|
+      criterion = campaign_criterion[:criterion]
+      puts ("Campaign criterion with campaign ID %d, criterion ID %d was " +
+          "updated with bid modifier %f.") % [campaign_criterion[:campaign_id],
+          criterion[:id], campaign_criterion[:bid_modifier]]
+    end
+  else
+    puts 'No criteria were returned.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201409
+
+  begin
+    # ID of a campaign to use mobile bid modifier for.
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+
+    # Bid modifier to set.
+    bid_modifier = 1.5
+
+    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
+
+  # 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/v201409/campaign_management/validate_text_ad.rb

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2011, 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 shows how to use the 'validate only' header. No objects will be
+# created, but exceptions will still be thrown.
+#
+# Tags: CampaignService.mutate
+
+require 'adwords_api'
+
+def validate_text_ad(ad_group_id)
+  # 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')
+
+  ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
+
+  # Enable 'validate only' option.
+  adwords.validate_only = true
+
+  # Prepare for adding text ad.
+  operation = {
+    :operator => 'ADD',
+    :operand => {
+      :ad_group_id => ad_group_id,
+      :ad => {
+        :xsi_type => 'TextAd',
+        :headline => 'Luxury Cruise to Mars',
+        :description1 => 'Visit the Red Planet in style.',
+        :description2 => 'Low-gravity fun for everyone!',
+        :url => 'http://www.example.com',
+        :display_url => 'www.example.com'
+      }
+    }
+  }
+
+  # Validate text ad add operation.
+  response = ad_group_ad_srv.mutate([operation])
+  if response and response[:value]
+    ad = response[:value].first
+    puts "Unexpected ad creation! Name '%s', ID %d and status '%s'." %
+        [campaign[:name], campaign[:id], campaign[:status]]
+  else
+    puts 'Text ad validated, no error thrown and no ad created.'
+  end
+
+  # Now let's check an invalid ad using extra punctuation to trigger an error.
+  operation[:operand][:ad][:headline] = 'Luxury Cruise to Mars!!!!!'
+
+  # Validate text ad add operation.
+  begin
+    response = ad_group_ad_srv.mutate([operation])
+    if response and response[:value]
+      ad = response[:value].first
+      raise StandardError, ("Unexpected ad creation! Name '%s', ID %d and " +
+          "status '%s'.") % [campaign[:name], campaign[:id], campaign[:status]]
+    end
+  rescue AdwordsApi::Errors::ApiException => e
+    puts "Validation correctly failed with an exception: %s" % e.class
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201409
+
+  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
+
+  # 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/v201409/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 = :v201409
+  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

data/examples/v201409/error_handling/handle_partial_failures.rb

@@ -0,0 +1,134 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# Copyright:: Copyright 2011, 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 demonstrates how to handle partial failures.
+#
+# Tags: AdGroupCriterionService.mutate
+
+require 'adwords_api'
+require 'adwords_api/utils'
+
+def handle_partial_failures(ad_group_id)
+  # 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')
+
+  ad_group_criterion_srv =
+      adwords.service(:AdGroupCriterionService, API_VERSION)
+
+  # Set partial failures flag.
+  adwords.partial_failure = true
+
+  # Create keywords.
+  keyword_text = ['mars cruise', 'inv@lid cruise', 'venus cruise',
+                  'b(a)d keyword cruise']
+  keywords = []
+  keyword_text.each do |text|
+    keyword = {
+      # 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 => 'Keyword',
+      :match_type => 'BROAD',
+      :text => text
+    }
+    keywords << keyword
+  end
+
+  # Create biddable ad group criteria and operations.
+  operations = []
+  keywords.each do |kwd|
+    operation = {
+      :operator => 'ADD',
+      :operand => {
+        :xsi_type => 'BiddableAdGroupCriterion',
+        :ad_group_id => ad_group_id,
+        :criterion => kwd
+      }
+    }
+    operations << operation
+  end
+
+  # Add criteria.
+  response = ad_group_criterion_srv.mutate(operations)
+  if response and response[:value]
+    ad_group_criteria = response[:value]
+    ad_group_criteria.each do |ad_group_criterion|
+      if ad_group_criterion[:criterion]
+        puts "Ad group criterion with ad group id " +
+           "#{ad_group_criterion[:ad_group_id]}, criterion id "+
+           "#{ad_group_criterion[:criterion][:id]} and keyword \"" +
+           "#{ad_group_criterion[:criterion][:text]}\" was added."
+      end
+    end
+  else
+    puts "No criteria were added."
+  end
+
+  # Check partial failures.
+  if response and response[:partial_failure_errors]
+    response[:partial_failure_errors].each do |error|
+      operation_index = AdwordsApi::Utils.operation_index_for_error(error)
+      if operation_index
+        ad_group_criterion = operations[operation_index][:operand]
+        puts "Ad group criterion with ad group id " +
+            "#{ad_group_criterion[:ad_group_id]} and keyword \"" +
+            "#{ad_group_criterion[:criterion][:text]}\" triggered an error " +
+            "for the following reason: \"#{error[:error_string]}\"."
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201409
+
+  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
+
+  # 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