google-adwords-api 0.12.1 → 0.13.0

data/examples/v201309/advanced_operations/add_ad_group_bid_modifier.rb

@@ -1,105 +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 add an ad group level mobile bid modifier
-# override for a campaign.
-#
-# Tags: AdGroupBidModifierService.mutate
-
-require 'adwords_api'
-
-def add_ad_group_bid_modifier(ad_group_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')
-
-  bid_modifier_srv = adwords.service(:AdGroupBidModifierService, API_VERSION)
-
-  # Mobile criterion ID.
-  criterion_id = 30001
-
-  # Prepare to add an ad group level override.
-  operation = {
-    # Use 'ADD' to add a new modifier and 'SET' to update an existing one. A
-    # modifier can be removed with the 'REMOVE' operator.
-    :operator => 'ADD',
-    :operand => {
-      :ad_group_id => ad_group_id,
-      :criterion => {
-        :xsi_type => 'Platform',
-        :id => criterion_id
-      },
-      :bid_modifier => bid_modifier
-    }
-  }
-
-  # Add ad group level mobile bid modifier.
-  response = bid_modifier_srv.mutate([operation])
-  if response and response[:value]
-    modifier = response[:value].first
-    value = modifier[:bid_modifier] || 'unset'
-    puts ('Campaign ID %d, AdGroup ID %d, Criterion ID %d was updated with ' +
-        'ad group level modifier: %s') %
-           [modifier[:campaign_id], modifier[:ad_group_id],
-            modifier[:criterion][:id], value]
-  else
-    puts 'No modifiers were added.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201309
-
-  begin
-    # ID of an ad group to add an override for.
-    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-    # Bid modifier to override with.
-    bid_modifier = 1.5
-
-    add_ad_group_bid_modifier(ad_group_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/v201309/advanced_operations/add_click_to_download_ad.rb

@@ -1,137 +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 creates a click-to-download ad, also known as an app
-# promotion ad to a given ad group. To list ad groups, run get_ad_groups.rb.
-#
-# Tags: AdGroupAdService.mutate
-
-require 'adwords_api'
-
-def add_click_to_download_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)
-
-  # Create the template elements for the ad. You can refer to
-  #     https://developers.google.com/adwords/api/docs/appendix/templateads
-  # for the list of available template fields.
-  ad_data = {
-    :unique_name => 'adData',
-    :fields => [
-      {
-        :name => 'headline',
-        :field_text => 'Enjoy your drive in Mars',
-        :type => 'TEXT'
-      },
-      {
-        :name => 'description1',
-        :field_text => 'Realistic physics simulation',
-        :type => 'TEXT'
-      },
-      {
-        :name => 'description2',
-        :field_text => 'Race against players online',
-        :type => 'TEXT'
-      },
-      {
-        :name => 'appId',
-        :field_text => 'com.example.demogame',
-        :type => 'TEXT'
-      },
-      {
-        :name => 'appStore',
-        :field_text => '2',
-        :type => 'ENUM'
-      }
-    ]
-  }
-
-  # Create click to download ad.
-  click_to_download_app_ad = {
-    :xsi_type => 'TemplateAd',
-    :name => 'Ad for demo game',
-    :template_id => 353,
-    :url =>
-        'http://play.google.com/store/apps/details?id=com.example.demogame',
-    :display_url => 'play.google.com',
-    :template_elements => [ad_data]
-  }
-
-  # Create ad group ad.
-  ad_group_ad = {
-    :ad_group_id => ad_group_id,
-    :ad => click_to_download_app_ad,
-    # Optional.
-    :status => 'PAUSED'
-  }
-
-  # Add ad.
-  response = ad_group_ad_srv.mutate([
-      {:operator => 'ADD', :operand => ad_group_ad}
-  ])
-  if response and response[:value]
-    response[:value].each do |ad|
-      puts "Added new click-to-download ad to ad group ID %d with url '%s'." %
-          [ad[:ad][:id], ad[:ad][:url]]
-    end
-  else
-    raise StandardError, 'No ads were added.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201309
-
-  begin
-    # Ad group ID to add text ads to.
-    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-    add_click_to_download_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/v201309/advanced_operations/add_site_links.rb

@@ -1,306 +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 sitelinks feed and associates it with a campaign.
-#
-# Tags: CampaignFeedService.mutate, FeedItemService.mutate
-# Tags: FeedMappingService.mutate, FeedService.mutate
-
-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', :name => 'Link URL'},
-      {: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.
-    link_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 URL attribute ID %d " +
-        "and Line 1 attribute ID %d and Line 2 attribute ID %d." % [
-          link_text_feed_attribute_id,
-          link_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[:link_url_feed_id] = link_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',
-      :url => 'http://www.example.com',
-      :line_1 => 'Home line 1',
-      :line_2 => 'Home line 2'
-    },
-    {
-      :text => 'Stores',
-      :url => 'http://www.example.com/stores',
-      :line_1 => 'Stores line 1',
-      :line_2 => 'Stores line 2'
-     },
-    {
-      :text => 'On Sale',
-      :url => 'http://www.example.com/sale',
-      :line_1 => 'On Sale line 1',
-      :line_2 => 'On Sale line 2'
-    },
-    {
-      :text => 'Support',
-      :url => 'http://www.example.com/support',
-      :line_1 => 'Support line 1',
-      :line_2 => 'Support line 2'
-    },
-    {
-      :text => 'Products',
-      :url => 'http://www.example.com/products',
-      :line_1 => 'Products line 1',
-      :line_2 => 'Products line 2'
-    },
-    {
-      :text => 'About',
-      :url => 'http://www.example.com/about',
-      :line_1 => 'About line 1',
-      :line_2 => 'About line 2'
-    }
-  ]
-
-  feed_items = items_data.map do |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[:link_url_feed_id],
-          :string_value => item[:url]
-        },
-        {
-          :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]
-        }
-      ]
-    }
-  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[:link_url_feed_id],
-        :field_id => PLACEHOLDER_FIELD_SITELINK_LINK_URL
-      },
-      {
-        :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
-
-  # Create site links campaign feed.
-  operands = sitelinks_data[:feed_item_ids].map do |feed_item_id|
-    {
-      :xsi_type => 'ConstantOperand',
-      :type => 'LONG',
-      :long_value => feed_item_id
-    }
-  end
-
-  feed_item_function = {
-    :operator => 'IN',
-    :lhs_operand => [
-      {:xsi_type => 'RequestContextOperand', :context_type => 'FEED_ITEM_ID'}
-    ],
-    :rhs_operand => operands
-  }
-
-  # Optional: to target to a platform, define a function and 'AND' it with the
-  #           feed item ID link:
-  platform_function = {
-    :operator => 'EQUALS',
-    :lhs_operand => [
-      {:xsi_type => 'RequestContextOperand', :context_type => 'DEVICE_PLATFORM'}
-    ],
-    :rhs_operand => [
-      {
-        :xsi_type => 'ConstantOperand',
-        :type => 'STRING',
-        :string_value => 'Mobile'
-      }
-    ]
-  }
-  combined_function = {
-    :operator => 'AND',
-    :lhs_operand => [
-      {:xsi_type => 'FunctionOperand', :value => feed_item_function},
-      {:xsi_type => 'FunctionOperand', :value => platform_function}
-    ]
-  }
-
-  campaign_feed = {
-    :feed_id => sitelinks_data[:feed_id],
-    :campaign_id => campaign_id,
-    :matching_function => combined_function,
-    # 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 = :v201309
-
-  # 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_LINK_URL = 2
-  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  " +
-        '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