google-adwords-api 0.20.0 → 0.20.1

data/examples/v201607/extensions/add_site_links.rb

@@ -0,0 +1,199 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Copyright:: Copyright 2015, 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 sitelinks feed and associates it with a campaign.
+
+require 'adwords_api'
+require 'date'
+
+def add_site_links(campaign_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')
+
+  customer_srv = adwords.service(:CustomerService, API_VERSION)
+
+  # Find the matching customer and its time zone. The get_customers method will
+  # return a single customer corresponding to the configured client_customer_id.
+  customer = customer_srv.get_customers().first
+  customer_time_zone = customer[:date_time_zone]
+  puts 'Found customer ID %d with time zone "%s"' %
+      [customer[:customer_id], customer_time_zone]
+
+  if customer_time_zone.nil?
+    raise StandardError, 'Customer not found for customer ID: ' + customer_id
+  end
+
+  campaign_extension_setting_srv =
+      adwords.service(:CampaignExtensionSettingService, API_VERSION)
+
+  sitelink_1 = {
+    :xsi_type => "SitelinkFeedItem",
+    :sitelink_text => "Store Hours",
+    :sitelink_final_urls => {
+      :urls => ["http://www.example.com/storehours"]
+    }
+  }
+
+  sitelink_2 = {
+    :xsi_type => "SitelinkFeedItem",
+    :sitelink_text => "Thanksgiving Specials",
+    :sitelink_final_urls => {
+      :urls => ["http://www.example.com/thanksgiving"]
+    },
+    :start_time => DateTime.new(Date.today.year, 11, 20, 0, 0, 0).
+        strftime("%Y%m%d %H%M%S ") + customer_time_zone,
+    :end_time => DateTime.new(Date.today.year, 11, 27, 23, 59, 59).
+        strftime("%Y%m%d %H%M%S ") + customer_time_zone,
+    # Target this sitelink for United States only. See
+    # https://developers.google.com/adwords/api/docs/appendix/geotargeting
+    # for valid geolocation codes.
+    :geo_targeting => {
+      :id => 2840
+    },
+    # Restrict targeting only to people physically within the United States.
+    # Otherwise, this could also show to people interested in the United States
+    # but not physically located there.
+    :geo_targeting_restriction => {
+      :geo_restriction => 'LOCATION_OF_PRESENCE'
+    }
+  }
+
+  sitelink_3 = {
+    :xsi_type => "SitelinkFeedItem",
+    :sitelink_text => "Wifi available",
+    :sitelink_final_urls => {
+      :urls => ["http://www.example.com/mobile/wifi"]
+    },
+    :device_preference => {:device_preference => 30001},
+    # Target this sitelink only when the ad is triggered by the keyword
+    # "free wifi".
+    :keyword_targeting => {
+      :text => "free wifi",
+      :match_type => 'BROAD'
+    }
+  }
+
+  sitelink_4 = {
+    :xsi_type => "SitelinkFeedItem",
+    :sitelink_text => "Happy hours",
+    :sitelink_final_urls => {
+      :urls => ["http://www.example.com/happyhours"]
+    },
+    :scheduling => {
+      :feed_item_schedules => [
+        {
+          :day_of_week => 'MONDAY',
+          :start_hour => 18,
+          :start_minute => 'ZERO',
+          :end_hour => 21,
+          :end_minute => 'ZERO'
+        },
+        {
+          :day_of_week => 'TUESDAY',
+          :start_hour => 18,
+          :start_minute => 'ZERO',
+          :end_hour => 21,
+          :end_minute => 'ZERO'
+        },
+        {
+          :day_of_week => 'WEDNESDAY',
+          :start_hour => 18,
+          :start_minute => 'ZERO',
+          :end_hour => 21,
+          :end_minute => 'ZERO'
+        },
+        {
+          :day_of_week => 'THURSDAY',
+          :start_hour => 18,
+          :start_minute => 'ZERO',
+          :end_hour => 21,
+          :end_minute => 'ZERO'
+        },
+        {
+          :day_of_week => 'FRIDAY',
+          :start_hour => 18,
+          :start_minute => 'ZERO',
+          :end_hour => 21,
+          :end_minute => 'ZERO'
+        }
+      ]
+    }
+  }
+
+  campaign_extension_setting = {
+    :campaign_id => campaign_id,
+    :extension_type => 'SITELINK',
+    :extension_setting => {
+      :extensions => [sitelink_1, sitelink_2, sitelink_3, sitelink_4]
+    }
+  }
+
+  operation = {
+    :operand => campaign_extension_setting,
+    :operator => 'ADD'
+  }
+
+  response = campaign_extension_setting_srv.mutate([operation])
+  if response and response[:value]
+    new_extension_setting = response[:value].first
+    puts "Extension setting with type = %s was added to campaign ID %d" % [
+      new_extension_setting[:extension_type],
+      new_extension_setting[:campaign_id]
+    ]
+  elsif
+    puts "No extension settings were created."
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201607
+
+  begin
+    # Campaign ID to add site link to.
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+    add_site_links(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  " +
+        '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/v201607/extensions/add_site_links_using_feeds.rb

@@ -0,0 +1,286 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# 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 adds a sitelinks feed and associates it with a campaign.
+
+require 'adwords_api'
+
+def add_site_links(campaign_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')
+
+  feed_srv = adwords.service(:FeedService, API_VERSION)
+  feed_item_srv = adwords.service(:FeedItemService, API_VERSION)
+  feed_mapping_srv = adwords.service(:FeedMappingService, API_VERSION)
+  campaign_feed_srv = adwords.service(:CampaignFeedService, API_VERSION)
+
+  sitelinks_data = {}
+
+  # Create site links feed first.
+  site_links_feed = {
+    :name => 'Feed For Site Links',
+    :attributes => [
+      {:type => 'STRING', :name => 'Link Text'},
+      {:type => 'URL_LIST', :name => 'Final URLs'},
+      {:type => 'STRING', :name => 'Line 1 Description'},
+      {:type => 'STRING', :name => 'Line 2 Description'}
+    ]
+  }
+
+  response = feed_srv.mutate([
+      {:operator => 'ADD', :operand => site_links_feed}
+  ])
+  if response and response[:value]
+    feed = response[:value].first
+    # Attribute of type STRING.
+    link_text_feed_attribute_id = feed[:attributes][0][:id]
+    # Attribute of type URL_LIST.
+    final_url_feed_attribute_id = feed[:attributes][1][:id]
+    # Attribute of type STRING.
+    line_1_feed_attribute_id = feed[:attributes][2][:id]
+    #Attribute of type STRING.
+    line_2_feed_attribute_id = feed[:attributes][3][:id]
+    puts "Feed with name '%s' and ID %d was added with" %
+        [feed[:name], feed[:id]]
+    puts "\tText attribute ID %d and Final URLs attribute ID %d " +
+        "and Line 1 attribute ID %d and Line 2 attribute ID %d." % [
+          link_text_feed_attribute_id,
+          final_url_feed_attribute_id,
+          line_1_feed_attribute_id,
+          line_2_feed_attribute_id
+        ]
+
+    sitelinks_data[:feed_id] = feed[:id]
+    sitelinks_data[:link_text_feed_id] = link_text_feed_attribute_id
+    sitelinks_data[:final_url_feed_id] = final_url_feed_attribute_id
+    sitelinks_data[:line_1_feed_id] = line_1_feed_attribute_id
+    sitelinks_data[:line_2_feed_id] = line_2_feed_attribute_id
+  else
+    raise new StandardError, 'No feeds were added.'
+  end
+
+  # Create site links feed items.
+  items_data = [
+    {
+      :text => 'Home',
+      :final_urls => ['http://www.example.com'],
+      :line_1 => 'Home line 1',
+      :line_2 => 'Home line 2'
+    },
+    {
+      :text => 'Stores',
+      :final_urls => ['http://www.example.com/stores'],
+      :line_1 => 'Stores line 1',
+      :line_2 => 'Stores line 2'
+     },
+    {
+      :text => 'On Sale',
+      :final_urls => ['http://www.example.com/sale'],
+      :line_1 => 'On Sale line 1',
+      :line_2 => 'On Sale line 2'
+    },
+    {
+      :text => 'Support',
+      :final_urls => ['http://www.example.com/support'],
+      :line_1 => 'Support line 1',
+      :line_2 => 'Support line 2'
+    },
+    {
+      :text => 'Products',
+      :final_urls => ['http://www.example.com/products'],
+      :line_1 => 'Products line 1',
+      :line_2 => 'Products line 2'
+    },
+    {
+      :text => 'About Us',
+      :final_urls => ['http://www.example.com/about'],
+      :line_1 => 'About line 1',
+      :line_2 => 'About line 2',
+      :location_id => '21137'
+    }
+  ]
+
+  feed_items = items_data.map do |item|
+    feed_item = {
+      :feed_id => sitelinks_data[:feed_id],
+      :attribute_values => [
+        {
+          :feed_attribute_id => sitelinks_data[:link_text_feed_id],
+          :string_value => item[:text]
+        },
+        {
+          :feed_attribute_id => sitelinks_data[:final_url_feed_id],
+          :string_values => item[:final_urls]
+        },
+        {
+          :feed_attribute_id => sitelinks_data[:line_1_feed_id],
+          :string_value => item[:line_1]
+        },
+        {
+          :feed_attribute_id => sitelinks_data[:line_2_feed_id],
+          :string_value => item[:line_2]
+        }
+      ]
+    }
+    # OPTIONAL: Use geographical targeting on a feed.
+    # The IDs can be found in the documentation or retrieved with the
+    # LocationCriterionService.
+    unless item[:location_id].nil?
+      feed_item[:geo_targeting] = {
+        :id => item[:location_id]
+      }
+      # OPTIONAL: Restrict targeting only to people physically within the
+      # location.
+      feed_item[:geo_targeting_restriction] = {
+        :geo_restriction => 'LOCATION_OF_PRESENCE'
+      }
+    end
+    next feed_item
+  end
+
+  feed_items_operations = feed_items.map do |item|
+    {:operator => 'ADD', :operand => item}
+  end
+
+  response = feed_item_srv.mutate(feed_items_operations)
+  if response and response[:value]
+    sitelinks_data[:feed_item_ids] = []
+    response[:value].each do |feed_item|
+      puts 'Feed item with ID %d was added.' % feed_item[:feed_item_id]
+      sitelinks_data[:feed_item_ids] << feed_item[:feed_item_id]
+    end
+  else
+    raise new StandardError, 'No feed items were added.'
+  end
+
+  # Create site links feed mapping.
+  feed_mapping = {
+    :placeholder_type => PLACEHOLDER_SITELINKS,
+    :feed_id => sitelinks_data[:feed_id],
+    :attribute_field_mappings => [
+      {
+        :feed_attribute_id => sitelinks_data[:link_text_feed_id],
+        :field_id => PLACEHOLDER_FIELD_SITELINK_LINK_TEXT
+      },
+      {
+        :feed_attribute_id => sitelinks_data[:final_url_feed_id],
+        :field_id => PLACEHOLDER_FIELD_SITELINK_FINAL_URLS
+      },
+      {
+        :feed_attribute_id => sitelinks_data[:line_1_feed_id],
+        :field_id => PLACEHOLDER_FIELD_SITELINK_LINE_1_TEXT
+      },
+      {
+        :feed_attribute_id => sitelinks_data[:line_2_feed_id],
+        :field_id => PLACEHOLDER_FIELD_SITELINK_LINE_2_TEXT
+      }
+    ]
+  }
+
+  response = feed_mapping_srv.mutate([
+      {:operator => 'ADD', :operand => feed_mapping}
+  ])
+  if response and response[:value]
+    feed_mapping = response[:value].first
+    puts ('Feed mapping with ID %d and placeholder type %d was saved for feed' +
+        ' with ID %d.') % [
+          feed_mapping[:feed_mapping_id],
+          feed_mapping[:placeholder_type],
+          feed_mapping[:feed_id]
+        ]
+  else
+    raise new StandardError, 'No feed mappings were added.'
+  end
+
+  # Construct a matching function that associates the sitelink feeditems to the
+  # campaign, and set the device preference to Mobile. See the matching function
+  # guide at:
+  # https://developers.google.com/adwords/api/docs/guides/feed-matching-functions
+  # for more details.
+  matching_function_string =
+      "AND(IN(FEED_ITEM_ID, {%s}), EQUALS(CONTEXT.DEVICE, 'Mobile'))" %
+      sitelinks_data[:feed_item_ids].join(',')
+
+  # Create site links campaign feed.
+  campaign_feed = {
+    :feed_id => sitelinks_data[:feed_id],
+    :campaign_id => campaign_id,
+    :matching_function => {:function_string => matching_function_string},
+    # Specifying placeholder types on the CampaignFeed allows the same feed
+    # to be used for different placeholders in different Campaigns.
+    :placeholder_types => [PLACEHOLDER_SITELINKS]
+  }
+
+  response = campaign_feed_srv.mutate([
+      {:operator => 'ADD', :operand => campaign_feed}
+  ])
+  if response and response[:value]
+    campaign_feed = response[:value].first
+    puts 'Campaign with ID %d was associated with feed with ID %d.' %
+      [campaign_feed[:campaign_id], campaign_feed[:feed_id]]
+  else
+    raise new StandardError, 'No campaign feeds were added.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201607
+
+  # 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_LINK_TEXT = 1
+  PLACEHOLDER_FIELD_SITELINK_FINAL_URLS = 5
+  PLACEHOLDER_FIELD_SITELINK_LINE_1_TEXT = 3
+  PLACEHOLDER_FIELD_SITELINK_LINE_2_TEXT = 4
+
+  begin
+    # Campaign ID to add site link to.
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+    add_site_links(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  " +
+        '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