google-adwords-api 0.18.0 → 0.18.1

data/examples/v201601/error_handling/handle_partial_failures.rb

@@ -0,0 +1,130 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# 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.
+
+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 = :v201601
+
+  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  " +
+        'https://github.com/googleads/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/v201601/error_handling/handle_policy_violation_error.rb

@@ -0,0 +1,141 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# 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 policy violation errors. To create
+# an ad group, run add_ad_group.rb.
+
+require 'adwords_api'
+require 'adwords_api/utils'
+
+def handle_policy_violation_error(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)
+
+  # Create text ad.
+  text_ad_operation = {
+    :operator => 'ADD',
+    :operand => {
+      :ad_group_id => ad_group_id,
+      :ad => {
+        # 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 => 'TextAd',
+        :headline => 'Mars Cruise!!!',
+        :description1 => 'Visit the Red Planet in style.',
+        :description2 => 'Low-gravity fun for everyone!',
+        :final_urls => ['http://www.example.com'],
+        :display_url => 'www.example.com',
+      }
+    }
+  }
+
+  operations = [text_ad_operation]
+
+  # Validate ad.
+  begin
+    # Enable "validate only" for the length of this block
+    adwords.validate_only do
+      ad_group_ad_srv.mutate(operations)
+    end
+    puts 'Validation successful, no errors returned.'
+  rescue AdwordsApi::Errors::ApiException => e
+    e.errors.each do |error|
+      if error[:xsi_type] == 'PolicyViolationError'
+        operation_index = AdwordsApi::Utils.operation_index_for_error(error)
+        operation = operations[operation_index]
+        puts "Ad with headline '%s' violated %s policy '%s'." %
+            [operation[:operand][:ad][:headline],
+             error[:is_exemptable] ? 'exemptable' : 'non-exemptable',
+             error[:external_policy_name]]
+        if error[:is_exemptable]
+          # Add exemption request to the operation.
+          puts "Adding exemption request for policy name '%s' on text '%s'." %
+              [error[:key][:policy_name], error[:key][:violating_text]]
+          unless operation[:exemption_requests]
+            operation[:exemption_requests] = []
+          end
+          operation[:exemption_requests] << {
+            :key => error[:key]
+          }
+        else
+          # Remove non-exemptable operation
+          puts "Removing the operation from the request."
+          operations.delete(operation)
+        end
+      else
+        # Non-policy error returned, re-throw exception.
+        raise e
+      end
+    end
+  end
+
+  # Add ads.
+  if operations.size > 0
+    response = ad_group_ad_srv.mutate(operations)
+    if response and response[:value]
+      ads = response[:value]
+      puts "Added #{ads.length} ad(s) to ad group #{ad_group_id}."
+      ads.each do |ad|
+        puts "  Ad id is #{ad[:ad][:id]}, type is #{ad[:ad][:xsi_type]} and " +
+            "status is \"#{ad[:status]}\"."
+      end
+    else
+      puts "No ads were added."
+    end
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201601
+
+  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  " +
+        'https://github.com/googleads/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/v201601/extensions/add_google_my_business_location_extensions.rb

@@ -0,0 +1,193 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Copyright:: Copyright 2014, 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 adds a feed that syncs feed items from a Google My Business (GMB)
+# account and associates the feed with a customer.
+
+require 'adwords_api'
+require 'date'
+
+def add_gmb_location_extensions(gmb_email_address, gmb_access_token,
+                                business_account_identifier)
+  # 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')
+
+  feed_srv = adwords.service(:FeedService, API_VERSION)
+  customer_feed_srv = adwords.service(:CustomerFeedService, API_VERSION)
+
+  if gmb_access_token.nil?
+    gmb_access_token = adwords.get_auth_handler.get_token(
+        adwords.credential_handler.credentials)[:access_token]
+  end
+
+  # Create a feed that will sync to the Google My Business account specified
+  # by gmb_email_address. Do not add FeedAttributes to this object, as AdWords
+  # will add them automatically because this will be a system generated feed.
+  gmb_feed = {
+    :name => "GMB feed #%d" % (Time.new.to_f * 1000).to_i,
+    :system_feed_generation_data => {
+      :xsi_type => 'PlacesLocationFeedData',
+      :o_auth_info => {
+        :http_method => 'GET',
+        :http_request_url => 'https://www.googleapis.com/auth/adwords',
+        :http_authorization_header => "Bearer %s" % gmb_access_token
+      },
+      :email_address => gmb_email_address
+    },
+    # Since this feed's feed items will be managed by AdWords, you must set
+    # its origin to ADWORDS.
+    :origin => 'ADWORDS'
+  }
+
+  # Optional: specify labels to filter Google My Business listings. If
+  # specified, only listings that have any of the labels set are synchronized
+  # into FeedItems.
+  gmb_feed[:system_feed_generation_data][:label_filters] =
+      ['Stores in New York City']
+
+  # Only include the business_account_identifier if it's specified.
+  # A nil value will cause an invalid request.
+  unless business_account_identifier.nil?
+    gmb_feed[:system_feed_generation_data][:business_account_identifier] =
+        business_account_identifier
+  end
+
+  gmb_operation = {
+    :operator => 'ADD',
+    :operand => gmb_feed
+  }
+
+  result = feed_srv.mutate([gmb_operation])
+  added_feed = result[:value].first
+  puts "Added GMB feed with ID %d" % added_feed[:id]
+
+  # Add a CustomerFeed that associates the feed with this customer for the
+  # LOCATION placeholder type.
+  customer_feed = {
+    :feed_id => added_feed[:id],
+    :placeholder_types => [PLACEHOLDER_TYPE_LOCATION],
+    :matching_function => {
+      :operator => 'IDENTITY',
+      :lhs_operand => {
+        :xsi_type => 'ConstantOperand',
+        :type => 'BOOLEAN',
+        :boolean_value => true
+      }
+    }
+  }
+
+  customer_feed_operation = {
+    :xsi_type => 'CustomerFeedOperation',
+    :operator => 'ADD',
+    :operand => customer_feed
+  }
+
+  added_customer_feed = nil
+  number_of_attempts = 0
+  while i < MAX_CUSTOMER_FEED_ADD_ATTEMPTS && !added_customer_feed
+    number_of_attempts += 1
+    begin
+      result = customer_feed_srv.mutate([customer_feed_operation])
+      added_customer_feed = result[:value].first
+      puts "Attempt #%d to add the CustomerFeed was successful" %
+          number_of_attempts
+    rescue
+      sleep_seconds = 5 * (2 ** number_of_attempts)
+      puts ("Attempt #%d to add the CustomerFeed was not succeessful. " +
+          "Waiting %d seconds before trying again.") %
+          [number_of_attempts, sleep_seconds]
+      sleep(sleep_seconds)
+    end
+  end
+
+  unless added_customer_feed
+    raise StandardError, ("Could not create the CustomerFeed after %d " +
+        "attempts. Please retry the CustomerFeed ADD operation later.") %
+        MAX_CUSTOMER_FEED_ADD_ATTEMPTS
+  end
+
+  puts "Added CustomerFeed for feed ID %d and placeholder type %d" %
+      [added_customer_feed[:id], added_customer_feed[:placeholder_types].first]
+
+  # OPTIONAL: Create a CampaignFeed to specify which FeedItems to use at the
+  # Campaign level. This will be similar to the CampaignFeed in the
+  # add_site_links example, except you can filter based on the business name
+  # and category of each FeedItem by using a FeedAttributeOperand in your
+  # matching function.
+
+  # OPTIONAL: Create an AdGroupFeed for even more fine grained control over
+  # which feed items are used at the AdGroup level.
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201601
+  PLACEHOLDER_TYPE_LOCATION = 7
+  MAX_CUSTOMER_FEED_ADD_ATTEMPTS = 10
+
+  begin
+    # The email address of either an owner or a manager of the GMB account.
+    gmb_email_address = 'INSERT_GMB_EMAIL_ADDRESS_HERE'
+
+    # If the gmbEmailAddress above is the same as you used to generate your
+    # AdWords API refresh token, leave the value below as nil.
+    # Otherwise, to obtain an access token for your GMB account, generate a
+    # refresh token as you did for AdWords, but make sure you are logged in as
+    # the same user as gmb_email_address above when you follow the link, then
+    # capture the generated access token
+    gmb_access_token = nil
+
+    # If the gmb_email_address above is for a GMB manager instead of
+    # the GMB account owner, then set business_account_identifier to the
+    # +Page ID of a location for which the manager has access. See the
+    # location extensions guide at
+    # https://developers.google.com/adwords/api/docs/guides/feed-services-locations
+    # for details.
+    business_account_identifier = nil
+
+    add_gmb_location_extensions(gmb_email_address, gmb_access_token,
+                                business_account_identifier)
+
+  # 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  " +
+        'https://github.com/googleads/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