google-adwords-api 0.9.2 → 0.9.3

data/examples/v201306/error_handling/handle_policy_violation_error.rb

@@ -0,0 +1,145 @@
+#!/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 policy violation errors. To create
+# an ad group, run add_ad_group.rb.
+#
+# Tags: AdGroupAdService.mutate
+
+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!',
+        :url => '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 = :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
+
+  # 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/v201306/error_handling/handle_two_factor_authorization_error.rb

@@ -0,0 +1,88 @@
+#!/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 illustrates how to handle 'two factor' authorization error.
+
+require 'adwords_api'
+
+def handle_two_factor_authorization_error()
+  # Set up credentials with an account that has 2Factor enabled.
+  config = {
+      :authentication => {
+          :method => 'ClientLogin',
+          :email => '2steptester@gmail.com',
+          :password => 'testaccount',
+          :user_agent => 'Ruby 2 Factor Sample',
+          :developer_token => 'qwerty'
+      },
+      :service => {
+          :environment => 'PRODUCTION'
+      }
+  }
+  adwords = AdwordsApi::Api.new(config)
+
+  # 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')
+
+  begin
+    # Forcing library to request authorization token.
+    auth_token = adwords.authorize()
+    puts 'Successfully retrieved the token.'
+
+  # Second factor error is one of AuthErrors.
+  rescue AdsCommon::Errors::AuthError => e
+    puts "Authorization failed with message:"
+    puts "\t%s" % e.message
+    # Checking 'Info' field for particular auth error type.
+    if e.info and e.info.casecmp('InvalidSecondFactor') == 0
+      puts "The user has enabled two factor authentication in this account." +
+      " Please use OAuth authentication method or have the user generate an" +
+      " application-specific password to make calls against the AdWords" +
+      " API. See \n" +
+      "    http://adwordsapi.blogspot.com/2011/02/authentication-changes-with" +
+      "-2-step.html\n" +
+      "for more details."
+    end
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201306
+
+  begin
+    handle_two_factor_authorization_error()
+
+  # 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/v201306/migration/upgrade_legacy_sitelinks.rb

@@ -0,0 +1,313 @@
+#!/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 migrates legacy sitelinks to upgraded sitelinks for a given list
+# of campaigns. The campaigns must be upgraded to enhanced campaigns before you
+# can run this example. To upgrade a campaign to enhanced, run
+# set_campaign_enhanced.rb. To get all campaigns, run get_campaigns.rb.
+#
+# Tags: CampaignAdExtensionService.get, CampaignAdExtensionService.mutate
+# Tags: FeedService.mutate, FeedItemService.mutate, FeedMappingService.mutate
+# Tags: CampaignFeedService.mutate
+
+require 'adwords_api'
+
+def upgrade_legacy_sitelinks(campaign_ids)
+  # 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')
+
+  # Obtain the required services.
+  campaign_ad_extension_srv =
+      adwords.service(:CampaignAdExtensionService, API_VERSION)
+  feed_mapping_srv = adwords.service(:FeedMappingService, API_VERSION)
+  feed_srv = adwords.service(:FeedService, API_VERSION)
+  feed_item_srv = adwords.service(:FeedItemService, API_VERSION)
+  campaign_feed_srv = adwords.service(:CampaignFeedService, API_VERSION)
+
+  # Try to retrieve an existing feed that has been mapped for use with
+  # sitelinks. If multiple such feeds exist, the first matching feed is
+  # retrieved. You could modify this code example to retrieve all the feeds
+  # and pick the appropriate feed based on user input.
+  site_links_feed = get_existing_feed(feed_mapping_srv)
+  if site_links_feed.nil?
+    # Create a feed for storing sitelinks.
+    site_links_feed = create_site_links_feed(feed_srv)
+    # Map the feed for using with sitelinks.
+    create_site_links_feed_mapping(feed_mapping_srv, site_links_feed)
+  end
+
+  campaign_ids.each do |campaign_id|
+    # Get legacy extensions for the campaign.
+    legacy_extensions = get_legacy_extensions_for_campaign(
+        campaign_ad_extension_srv, campaign_id)
+    legacy_extensions.each do |extension|
+      # Get the sitelinks.
+      legacy_site_links = extension[:ad_extension][:sitelinks]
+
+      # Add the sitelinks to the feed.
+      site_link_feed_item_ids = create_site_link_feed_items(feed_item_srv,
+                                                            site_links_feed,
+                                                            legacy_site_links)
+
+      # Associate feeditems to the campaign.
+      associate_sitelink_feed_items_with_campaign(campaign_feed_srv,
+                                                  site_links_feed,
+                                                  site_link_feed_item_ids,
+                                                  campaign_id)
+
+      # Once the upgraded sitelinks are added to a campaign, the legacy
+      # sitelinks will stop serving. You can delete the legacy sitelinks
+      # once you have verified that the migration went fine. In case the
+      # migration didn't succeed, you can roll back the migration by deleting
+      # the campaign feed you created in the previous step.
+      campaign_ad_extension_srv.mutate([
+          {:operator => 'REMOVE', :operand => extension}
+      ])
+    end
+  end
+end
+
+# Create a feed for holding upgraded sitelinks.
+def create_site_links_feed(feed_srv)
+  # Create the feed.
+  site_links_feed = {
+    :name => 'Feed For Sitelinks',
+    :attributes => [
+      {:type => 'STRING', :name => 'Link Text'},
+      {:type => 'URL', :name => 'Link URL'}
+    ],
+    :origin => 'USER'
+  }
+
+  # Add the feed.
+  response = feed_srv.mutate([
+      {:operator => 'ADD', :operand => site_links_feed}
+  ])
+
+  saved_feed = response[:value].first
+  return {
+    :site_links_feed_id => saved_feed[:id],
+    :saved_attributes => saved_feed[:attributes],
+    :link_text_feed_attribute_id => saved_feed[:attributes][0][:id],
+    :link_url_feed_attribute_id => saved_feed[:attributes][1][:id]
+  }
+end
+
+# Map the feed for use with Sitelinks.
+def create_site_links_feed_mapping(feed_mapping_srv, site_links_feed)
+  # Map the feedAttributeIds to the fieldId constants.
+  link_text_field_mapping = {
+    :feed_attribute_id => site_links_feed[:link_text_feed_attribute_id],
+    :field_id => PLACEHOLDER_FIELD_SITELINK_TEXT
+  }
+  link_url_field_mapping = {
+    :feed_attribute_id => site_links_feed[:link_url_feed_attribute_id],
+    :field_id => PLACEHOLDER_FIELD_SITELINK_URL
+  }
+
+  # Create the field mapping.
+  feed_mapping = {
+    :placeholder_type => PLACEHOLDER_SITELINKS,
+    :feed_id => site_links_feed[:site_links_feed_id],
+    :attribute_field_mappings =>
+        [link_text_field_mapping, link_url_field_mapping]
+  }
+
+  # Save the field mapping.
+  feed_mapping_srv.mutate([{:operator => 'ADD', :operand => feed_mapping}])
+end
+
+# Retrieves an existing feed that is mapped to hold sitelinks. The first active
+# sitelinks feed is retrieved by this method.
+def get_existing_feed(feed_mapping_srv)
+  selector = {
+    :fields => ['FeedId', 'FeedMappingId', 'PlaceholderType', 'Status',
+        'AttributeFieldMappings'],
+    :predicates => [
+      {
+        :field => 'PlaceholderType',
+        :operator => 'EQUALS',
+        :values => [PLACEHOLDER_SITELINKS]
+      },
+      {:field => 'Status', :operator => 'EQUALS', :values => ['ACTIVE']}
+    ]
+  }
+
+  response = feed_mapping_srv.get(selector)
+  if response and response[:entries]
+    response[:entries].each do |feed_mapping|
+      feed_id = feed_mapping[:feed_id]
+      text_attribute_id = nil
+      url_attribute_id = nil
+      feed_mapping[:attribute_field_mappings].each do |attribute_mapping|
+        case attribute_mapping[:field_id].to_i
+          when PLACEHOLDER_FIELD_SITELINK_TEXT
+            text_attribute_id = attribute_mapping[:feed_attribute_id]
+          when PLACEHOLDER_FIELD_SITELINK_URL
+            url_attribute_id = attribute_mapping[:feed_attribute_id]
+        end
+      end
+      unless feed_id.nil? or text_attribute_id.nil? or url_attribute_id.nil?
+        return {
+          :site_links_feed_id => feed_id,
+          :link_text_feed_attribute_id => text_attribute_id,
+          :link_url_feed_attribute_id => url_attribute_id
+        }
+      end
+    end
+  end
+  return nil
+end
+
+# Gets legacy sitelink extensions for a campaign.
+def get_legacy_extensions_for_campaign(campaign_ad_extension_srv, campaign_id)
+  # Create the selector.
+  selector = {
+    :fields => ['CampaignId', 'AdExtensionId',
+                'Status', 'DisplayText', 'DestinationUrl'],
+    :predicates => [
+      # Filter the results for specified campaign id.
+      {:field => 'CampaignId', :operator => 'EQUALS', :values => [campaign_id]},
+      # Filter the results for active campaign ad extensions. You may add
+      # additional filtering conditions here as required.
+      {:field => 'Status', :operator => 'EQUALS', :values => ['ACTIVE']},
+      {
+        :field => 'AdExtensionType',
+        :operator => 'EQUALS',
+        :values => ['SITELINKS_EXTENSION']
+      }
+    ]
+  }
+  response = campaign_ad_extension_srv.get(selector)
+  return (response and response[:entries]) ? response[:entries] : []
+end
+
+# Adds legacy sitelinks to the sitelinks feed.
+def create_site_link_feed_items(feed_item_srv, site_links_feed, site_links)
+  # Create operation for adding each legacy sitelink to the sitelinks feed.
+  feed_item_operations = site_links.map do |site_link|
+    {
+      :operator => 'ADD',
+      :operand => {
+        :feed_id => site_links_feed[:site_links_feed_id],
+        :attribute_values => [
+          {
+            :feed_attribute_id => site_links_feed[:link_text_feed_attribute_id],
+            :string_value => site_link[:display_text]
+          },
+          {
+            :feed_attribute_id => site_links_feed[:link_url_feed_attribute_id],
+            :string_value => site_link[:destination_url]
+          }
+        ]
+      }
+    }
+  end
+
+  response = feed_item_srv.mutate(feed_item_operations);
+  # Retrieve the feed item ids.
+  site_link_feed_item_ids = response[:value].map {|item| item[:feed_item_id]}
+  return site_link_feed_item_ids
+end
+
+# Associates sitelink feed items with a campaign.
+def associate_sitelink_feed_items_with_campaign(campaign_feed_srv,
+    site_links_feed, site_link_feed_item_ids, campaign_id)
+  # Create a custom matching function that matches the given feed items to the
+  # campaign.
+  request_context_operand = {
+    :xsi_type => 'RequestContextOperand',
+    :context_type => 'FEED_ITEM_ID'
+  }
+
+  operands = site_link_feed_item_ids.map do |feed_item_id|
+    {
+      :xsi_type => 'ConstantOperand',
+      :long_value => feed_item_id,
+      :type => 'LONG'
+    }
+  end
+
+  function = {
+    :operator => 'IN',
+    :lhs_operand => [request_context_operand],
+    :rhs_operand => operands
+  }
+
+  # Create upgraded sitelinks for the campaign. Use the sitelinks feed we
+  # created, and restrict feed items by matching function.
+  campaign_feed = {
+    :feed_id => site_links_feed[:site_links_feed_id],
+    :campaign_id => campaign_id,
+    :matching_function => function,
+    :placeholder_types => [PLACEHOLDER_SITELINKS]
+  }
+
+  campaign_feed_srv.mutate([{:operator => 'ADD', :operand => campaign_feed}])
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201306
+
+  # See the Placeholder reference page for a list of all the placeholder types
+  # and fields, see:
+  #     https://developers.google.com/adwords/api/docs/appendix/placeholders
+  PLACEHOLDER_SITELINKS = 1
+  PLACEHOLDER_FIELD_SITELINK_TEXT = 1
+  PLACEHOLDER_FIELD_SITELINK_URL = 2
+
+  begin
+    # IDs of campaigns to add upgrade legacy sitelinks for.
+    campaign_ids = [
+      'INSERT_CAMPAIGN_ID_HERE'.to_i,
+      'INSERT_CAMPAIGN_ID_HERE'.to_i
+    ]
+
+    upgrade_legacy_sitelinks(campaign_ids)
+
+  # 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