google-adwords-api 0.13.2 → 0.14.0

data/examples/v201402/advanced_operations/get_ad_group_bid_modifiers.rb

@@ -1,106 +0,0 @@
-#!/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 illustrates how to retrieve ad group level bid modifiers for a
-# campaign.
-#
-# Tags: AdGroupBidModifierService.get
-
-require 'adwords_api'
-
-def get_ad_group_bid_modifiers(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')
-
-  bid_modifier_srv = adwords.service(:AdGroupBidModifierService, API_VERSION)
-
-  # Get all ad group bid modifiers for the campaign.
-  selector = {
-    :fields => ['CampaignId', 'AdGroupId', 'Id', 'BidModifier'],
-    :predicates => [
-      {:field => 'CampaignId', :operator => 'EQUALS', :values => [campaign_id]}
-    ],
-    :paging => {
-      :start_index => 0,
-      :number_results => PAGE_SIZE
-    }
-  }
-
-  # Set initial values.
-  offset, page = 0, {}
-
-  begin
-    page = bid_modifier_srv.get(selector)
-    if page[:entries]
-      page[:entries].each do |modifier|
-        value = modifier[:bid_modifier] || 'unset'
-        puts ('Campaign ID %d, AdGroup ID %d, Criterion ID %d has ad group ' +
-           'level modifier: %s') %
-           [modifier[:campaign_id], modifier[:ad_group_id],
-            modifier[:criterion][:id], value]
-      end
-      # Increment values to request the next page.
-      offset += PAGE_SIZE
-      selector[:paging][:start_index] = offset
-    else
-      puts 'No ad group level bid overrides returned.'
-    end
-  end while page[:total_num_entries] > offset
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201402
-  PAGE_SIZE = 500
-
-  begin
-    # ID of a campaign to pull overrides for.
-    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
-    get_ad_group_bid_modifiers(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  " +
-        '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/v201402/advanced_operations/update_site_links.rb

@@ -1,194 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.mcloonan@gmail.com (Michael Cloonan)
-#
-# 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 updates an existing sitelinks feed as follows:
-#  * Adds FeedItemAttributes for line 1 and line 2 descriptions to the Feed
-#  * Populates the new FeedItemAttributes on FeedItems in the Feed
-#  * Replaces the Feed's existing FeedMapping with one that contains the new
-#     set of FeedItemAttributes
-#
-# The end result of this is that any campaign or ad group whose CampaignFeed
-# or AdGroupFeed points to the Feed's ID will now serve line 1 and line 2
-# descriptions in its sitelinks.
-#
-# Tags: FeedItemService.mutate
-# Tags: FeedMappingService.mutate, FeedService.mutate
-
-require 'adwords_api'
-
-def update_site_links(feed_id, feed_item_descriptions)
-  # 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)
-
-  feed_selector = {
-    :fields => ['Id', 'Attributes'],
-    :predicates => [
-      {:field => 'Id', :operator => 'EQUALS', :values => [feed_id]}
-    ]
-  }
-
-  feed = feed_srv.get(feed_selector)[:entries][0]
-
-  # Add new line1 and line2 feed attributes.
-  next_attribute_index = feed[:attributes].length()
-
-  feed[:attributes] = [
-    {:type => 'STRING', :name => 'Line 1 Description'},
-    {:type => 'STRING', :name => 'Line 2 Description'}
-  ]
-
-  mutated_feed_result = feed_srv.mutate([
-    {:operator => 'SET', :operand => feed}
-  ])
-
-  mutated_feed = mutated_feed_result[:value][0]
-  line_1_attribute = mutated_feed[:attributes][next_attribute_index]
-  line_2_attribute = mutated_feed[:attributes][next_attribute_index + 1]
-
-  # Update feed items.
-  feed_item_ids = feed_item_descriptions.keys
-  item_selector = {
-    :fields => ['FeedId', 'FeedItemId', 'AttributeValues'],
-    :predicates => [
-      {:field => 'FeedId', :operator => 'EQUALS', :values => [feed_id]},
-      {:field => 'FeedItemId', :operator => 'IN', :values => feed_item_ids}
-    ]
-  }
-
-  feed_items = feed_item_srv.get(item_selector)[:entries]
-
-  item_operations = feed_items.map do |feed_item|
-    feed_item[:attribute_values] = [
-      {
-        :feed_attribute_id => line_1_attribute[:id],
-        :string_value => feed_item_descriptions[feed_item[:feed_item_id]][0]
-      },
-      {
-        :feed_attribute_id => line_2_attribute[:id],
-        :string_value => feed_item_descriptions[feed_item[:feed_item_id]][1]
-      }
-    ]
-
-    {:operator => 'SET', :operand => feed_item}
-  end
-  items_update_result = feed_item_srv.mutate(item_operations)
-  puts 'Updated %d items' % items_update_result[:value].length
-
-  # Update feed mapping.
-  mapping_selector = {
-    :fields => [
-      'FeedId',
-      'FeedMappingId',
-      'PlaceholderType',
-      'AttributeFieldMappings'
-    ],
-    :predicates => [
-      {:field => 'FeedId', :operator => 'EQUALS', :values => [feed_id]}
-    ]
-  }
-  feed_mapping_results = feed_mapping_srv.get(mapping_selector)
-  feed_mapping = feed_mapping_results[:entries][0]
-
-  # Feed mappings are immutable, so we have to delete it and re-add
-  # it with modifications.
-  feed_mapping_srv.mutate([
-    {:operator => 'REMOVE', :operand => feed_mapping}
-  ])[:value][0]
-
-  feed_mapping[:attribute_field_mappings].push(
-    {
-      :feed_attribute_id => line_1_attribute[:id],
-      :field_id => PLACEHOLDER_FIELD_LINE_1_TEXT
-    },
-    {
-      :feed_attribute_id => line_2_attribute[:id],
-      :field_id => PLACEHOLDER_FIELD_LINE_2_TEXT
-    }
-  )
-  mapping_update_result = feed_mapping_srv.mutate([
-    {:operator => 'ADD', :operand => feed_mapping}
-  ])
-
-  mutated_mapping = mapping_update_result[:value][0]
-  puts 'Updated field mappings for feedId %d and feedMappingId %d to:' %
-    [mutated_mapping[:feed_id], mutated_mapping[:feed_mapping_id]]
-  mutated_mapping[:attribute_field_mappings].each do |field_mapping|
-    puts "\tfeedAttributeId %d --> fieldId %d" %
-      [field_mapping[:feed_attribute_id], field_mapping[:field_id]]
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201402
-
-  # See the Placeholder reference page for a list of all the placeholder types
-  # and fields:
-  #     https://developers.google.com/adwords/api/docs/appendix/placeholders
-  PLACEHOLDER_FIELD_LINE_1_TEXT = 3
-  PLACEHOLDER_FIELD_LINE_2_TEXT = 4
-
-  begin
-    feed_id = 'INSERT_FEED_ID_HERE'.to_i
-    feed_item_descriptions = {
-      'INSERT_FEED_ITEM_A_ID_HERE'.to_i => [
-        'INSERT_FEED_ITEM_A_LINE1_DESC_HERE',
-        'INSERT_FEED_ITEM_A_LINE2_DESC_HERE'
-      ],
-      'INSERT_FEED_ITEM_B_ID_HERE'.to_i => [
-        'INSERT_FEED_ITEM_B_LINE1_DESC_HERE',
-        'INSERT_FEED_ITEM_B_LINE2_DESC_HERE'
-      ]
-    }
-
-    update_site_links(feed_id, feed_item_descriptions)
-
-  # 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/v201402/advanced_operations/upload_offline_conversions.rb

@@ -1,117 +0,0 @@
-#!/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 code example imports offline conversion values for specific clicks to
-# your account. To get Google Click ID for a click, run
-# CLICK_PERFORMANCE_REPORT.
-#
-# Tags: ConversionTrackerService.mutate, OfflineConversionFeedService.mutate
-
-require 'adwords_api'
-require 'date'
-
-def upload_offline_conversions(conversion_name, google_click_id,
-                               conversion_time, conversion_value)
-  # 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')
-
-  conversion_tracker_srv =
-      adwords.service(:ConversionTrackerService, API_VERSION)
-  conversion_feed_srv =
-      adwords.service(:OfflineConversionFeedService, API_VERSION)
-
-  # Create an upload conversion. Once created, this entry will be visible under
-  # Tools and Analysis->Conversion and will have Source = Import.
-  upload_conversion = {
-    :xsi_type => 'UploadConversion',
-    :category => 'PAGE_VIEW',
-    :name => conversion_name,
-    :viewthrough_lookback_window => 30,
-    :ctc_lookback_window => 90
-  }
-  return_conversions = conversion_tracker_srv.mutate([
-    {:operator => 'ADD', :operand => upload_conversion}])
-  return_conversions[:value].each do |tracker|
-    puts "Upload conversion tracker with name '%s' and ID %d was created." %
-      [tracker[:name], tracker[:id]]
-  end
-
-  # Associate offline conversions with the upload conversion tracker we created.
-  feed = {
-    :conversion_name => conversion_name,
-    :google_click_id => google_click_id,
-    :conversion_time => conversion_time,
-    :conversion_value => conversion_value
-  }
-  return_feeds = conversion_feed_srv.mutate([
-    {:operator => 'ADD', :operand => feed}])
-  return_feeds[:value].each do |return_feed|
-    puts ("Uploaded offline conversion value %.2f for Google Click ID '%s', " +
-        'to %s') % [return_feed[:conversion_value],
-                    return_feed[:google_click_id],
-                    return_feed[:conversion_name]]
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201402
-
-  begin
-    # Name of the upload conversion to be created.
-    conversion_name = 'INSERT_CONVERSION_NAME_HERE'
-    # Google Click ID of the click for which offline conversions are uploaded.
-    google_click_id = 'INSERT_GOOGLE_CLICK_ID_HERE'
-    # Conversion time in 'yyyymmdd hhmmss' format.
-    conversion_time = Time.new.strftime("%Y%m%d %H%M%S")
-    # Conversion value to be uploaded.
-    conversion_value = 'INSERT_CONVERSION_VALUE_HERE'.to_f
-
-    upload_offline_conversions(conversion_name, google_click_id,
-                               conversion_time, conversion_value)
-
-  # 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/v201402/advanced_operations/use_shared_bidding_strategy.rb

@@ -1,163 +0,0 @@
-#!/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 adds a Shared Bidding Strategy and uses it to construct a
-# campaign.
-#
-# Tags: BiddingStrategyService.mutate, CampaignService.mutate
-# Tags: BudgetService.mutate
-
-require 'adwords_api'
-require 'date'
-
-def use_shared_bidding_strategy()
-  # 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')
-
-  budget_srv = adwords.service(:BudgetService, API_VERSION)
-  bidding_srv = adwords.service(:BiddingStrategyService, API_VERSION)
-  campaign_srv = adwords.service(:CampaignService, API_VERSION)
-
-  # Create a budget, which can be shared by multiple campaigns.
-  budget = {
-    :name => 'Interplanetary budget #%d' % (Time.new.to_f * 1000).to_i,
-    :amount => {:micro_amount => 50000000},
-    :delivery_method => 'STANDARD',
-    :period => 'DAILY',
-    :is_explicitly_shared => true
-  }
-  return_budget = budget_srv.mutate([
-    {:operator => 'ADD', :operand => budget}])
-  budget_id = return_budget[:value].first[:budget_id]
-
-  # Create a shared bidding strategy.
-  shared_bidding_strategy = {
-    :name => 'Maximize Clicks #%d' % (Time.new.to_f * 1000).to_i,
-    :bidding_scheme => {
-      :xsi_type => 'TargetSpendBiddingScheme',
-      # Optionally set additional bidding scheme parameters.
-      :bid_ceiling => {:micro_amount => 20000000},
-      :spend_target => {:micro_amount => 40000000}
-    }
-  }
-  return_strategy = bidding_srv.mutate([
-    {:operator => 'ADD', :operand => shared_bidding_strategy}])
-
-  bidding_strategy = return_strategy[:value].first
-  puts ("Shared bidding strategy with name '%s' and ID %d of type '%s' was " +
-      'created') %
-      [bidding_strategy[:name], bidding_strategy[:id], bidding_strategy[:type]]
-
-  # Create campaigns.
-  campaigns = [
-    {
-      :name => "Interplanetary Cruise #%d" % (Time.new.to_f * 1000).to_i,
-      :status => 'PAUSED',
-      :bidding_strategy_configuration => {
-        :bidding_strategy_id => bidding_strategy[:id]
-      },
-      # Budget (required) - note only the budget ID is required.
-      :budget => {:budget_id => budget_id},
-      # Set the campaign network options to Search, Content and Search Network.
-      :network_setting => {
-        :target_google_search => true,
-        :target_search_network => true,
-        :target_content_network => true
-      },
-      :settings => [
-        {
-          :xsi_type => 'KeywordMatchSetting',
-          :opt_in => true
-        }
-      ]
-    },
-    {
-      :name => "Interplanetary Cruise banner #%d" % (Time.new.to_f * 1000).to_i,
-      :status => 'PAUSED',
-      :bidding_strategy_configuration => {
-        :bidding_strategy_id => bidding_strategy[:id]
-      },
-      :budget => {:budget_id => budget_id},
-      :settings => [
-        {
-          :xsi_type => 'KeywordMatchSetting',
-          :opt_in => true
-        }
-      ],
-      :network_setting => {
-        :target_google_search => false,
-        :target_search_network => false,
-        :target_content_network => true
-      }
-    }
-  ]
-
-  # Prepare for adding campaign.
-  operations = campaigns.map do |campaign|
-    {:operator => 'ADD', :operand => campaign}
-  end
-
-  # Add campaign.
-  response = campaign_srv.mutate(operations)
-  if response and response[:value]
-    response[:value].each do |campaign|
-      puts "Campaign with name '%s' and ID %d was added." %
-          [campaign[:name], campaign[:id]]
-    end
-  else
-    raise new StandardError, 'No campaigns were added.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201402
-
-  begin
-    use_shared_bidding_strategy()
-
-  # 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