google-adwords-api 0.16.1 → 0.17.0

data/examples/v201509/advanced_operations/add_ad_group_bid_modifier.rb

@@ -0,0 +1,101 @@
+#!/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 illustrates how to add an ad group level mobile bid modifier
+# override for a campaign.
+
+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 = :v201509
+
+  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  " +
+        '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/v201509/advanced_operations/add_click_to_download_ad.rb

@@ -0,0 +1,133 @@
+#!/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 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.
+
+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,
+    :final_urls =>
+        ['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][:final_urls[0]]]
+    end
+  else
+    raise StandardError, 'No ads were added.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201509
+
+  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  " +
+        '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/v201509/advanced_operations/add_html5_ad.rb

@@ -0,0 +1,137 @@
+#!/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 code example adds an HTML5 ad to a given ad group.
+# To get ad groups, run basic_operations/get_ad_groups.rb.
+
+require 'adwords_api'
+require 'base64'
+
+def add_html5_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)
+
+  # The HTML5 zip file contains all the HTML, CSS, and images needed for the
+  # HTML5 ad. For help on creating an HTML5 zip file, check out Google Web
+  # Designer (https://www.google.com/webdesigner).
+  html5_url = 'http://goo.gl/9Y7qI2'
+  html5_data = AdsCommon::Http.get(html5_url, adwords.config)
+  base64_html5_data = Base64.encode64(html5_data)
+
+  # Create a media bundle containing the zip file with all the HTML5
+  # components.
+  media_bundle = {
+    :xsi_type => 'MediaBundle',
+    :data => base64_html5_data,
+    :entry_point => 'carousel/index.html',
+    :type => 'MEDIA_BUNDLE'
+  }
+
+  # 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 => 'Custom_layout',
+        :field_media => media_bundle,
+        :type => 'MEDIA_BUNDLE'
+      },
+      {
+        :name => 'layout',
+        :field_text => 'Custom',
+        :type => 'ENUM'
+      }
+    ]
+  }
+
+  html5_ad = {
+    :xsi_type => 'TemplateAd',
+    :name => 'Ad for HTML5',
+    :template_id => 419,
+    :final_urls => ['http://example.com/html5'],
+    :display_url => 'www.example.com/html5',
+    :dimensions => {
+      :width => 300,
+      :height => 250
+    },
+    :template_elements => [ad_data]
+  }
+
+  ad_group_ad = {
+    :ad_group_id => ad_group_id,
+    :ad => html5_ad,
+    :status => 'PAUSED'
+  }
+
+  operation = {
+    :operator => 'ADD',
+    :operand => ad_group_ad
+  }
+
+  response = ad_group_ad_srv.mutate([operation])
+  if response and !response.empty?
+    response[:value].each do |ad_group_ad|
+      puts "New HTML5 ad with ID %d and display url '%s' was added." %
+          [ad_group_ad[:ad][:id], ad_group_ad[:ad][:display_url]]
+    end
+  else
+    puts "No HTML5 ads were added."
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201509
+
+  begin
+    # Ad group ID to add text ads to.
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    add_html5_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  " +
+        '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/v201509/advanced_operations/add_text_ad_with_upgraded_urls.rb

@@ -0,0 +1,134 @@
+#!/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 code example adds a text ad that uses advanced features of upgraded
+# URLs.
+
+require 'adwords_api'
+
+def add_text_ad_with_upgraded_urls(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)
+
+  # Since your tracking URL will have two custom parameters, provide their
+  # values too. This can be provided at campaign, ad group, ad, criterion, or
+  # feed item levels.
+  season_parameter = {
+    :key => 'season',
+    :value => 'christmas'
+  }
+
+  promo_code_parameter = {
+    :key => 'promocode',
+    :value => 'NYC123'
+  }
+
+  tracking_url_parameters = {
+    :parameters => [season_parameter, promo_code_parameter]
+  }
+
+  text_ad = {
+    :xsi_type => 'TextAd',
+    :headline => 'Luxury Cruise to Mars',
+    :description1 => 'Visit the Red Planet in style.',
+    :description2 => 'Low-gravity fun for everyone!',
+    :display_url => 'www.example.com',
+    # Specify a tracking URL for 3rd party tracking provider. You may specify
+    # one at customer, campaign, ad group, ad, criterion, or feed item levels.
+    :tracking_url_template => 'http://tracker.example.com/' +
+        '?season={_season}&promocode={_promocode}&u={lpurl}',
+    :url_custom_parameters => tracking_url_parameters,
+    # Specify a list of final URLs. This field cannot be set if :url field
+    # is set. This may be specified at ad, criterion, and feed item levels.
+    :final_urls => [
+      'http://www.example.com/cruise/space/',
+      'http://www.example.com/locations/mars/'
+    ],
+    # Specify a list of final mobile URLs. This field cannot be set if :url
+    # field is set. This may be specificed at ad, criterion, and
+    # feed item levels.
+    :final_mobile_urls => [
+      'http://mobile.example.com/cruise/space/',
+      'http://mobile.example.com/locations/mars/'
+    ]
+  }
+
+  operation = {
+    :operator => 'ADD',
+    :operand => {:ad_group_id => ad_group_id, :ad => text_ad}
+  }
+
+  # Add ads.
+  response = ad_group_ad_srv.mutate([operation])
+  if response and response[:value]
+    response[:value].each do |ad|
+      text_ad = ad[:ad]
+      puts "Ad with ID %d and displayUrl '%s' was added." %
+          [text_ad[:id], text_ad[:display_url]]
+      puts "\tFinal URLs: %s" % [text_ad[:final_urls].join(', ')]
+      puts "\tFinal Mobile URLs: %s" % [text_ad[:final_mobile_urls].join(', ')]
+      puts "\tTracking URL template: %s" % [text_ad[:tracking_url_template]]
+      custom_parameters =
+          text_ad[:url_custom_parameters][:parameters].map do |custom_parameter|
+            "%s=%s" % [custom_parameter[:key], custom_parameter[:value]]
+          end
+      puts "\tCustom parameters: %s" % [custom_parameters.join(', ')]
+    end
+  else
+    raise StandardError, 'No ads were added.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201509
+
+  begin
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    add_text_ad_with_upgraded_urls(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/v201509/advanced_operations/create_and_attach_shared_keyword_set.rb

@@ -0,0 +1,141 @@
+#!/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 creates a shared list of negative broad match keywords, it then
+# attaches them to a campaign.
+
+require 'adwords_api'
+require 'date'
+
+def create_and_attach_shared_keyword_set(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')
+
+  shared_set_srv = adwords.service(:SharedSetService, API_VERSION)
+  shared_criterion_srv = adwords.service(:SharedCriterionService, API_VERSION)
+  campaign_shared_set_srv =
+      adwords.service(:CampaignSharedSetService, API_VERSION)
+
+  # Keywords to create a shared set of.
+  keywords = ['mars cruise', 'mars hotels']
+
+  # Create shared negative keyword set.
+  shared_set = {
+    :name => 'API Negative keyword list - %d' % (Time.new.to_f * 1000).to_i,
+    :type => 'NEGATIVE_KEYWORDS'
+  }
+
+  # Add shared set.
+  response = shared_set_srv.mutate([
+      {:operator => 'ADD', :operand => shared_set}
+  ])
+
+  if response and response[:value]
+    shared_set = response[:value].first
+    shared_set_id = shared_set[:shared_set_id]
+    puts "Shared set with ID %d and name '%s' was successfully added." %
+        [shared_set_id, shared_set[:name]]
+  else
+    raise StandardError, 'No shared set was added'
+  end
+
+  # Add negative keywords to shared set.
+  shared_criteria = keywords.map do |keyword|
+    {
+      :criterion => {
+        :xsi_type => 'Keyword',
+        :text => keyword,
+        :match_type => 'BROAD'
+      },
+      :negative => true,
+      :shared_set_id => shared_set_id
+    }
+  end
+
+  operations = shared_criteria.map do |criterion|
+    {:operator => 'ADD', :operand => criterion}
+  end
+
+  response = shared_criterion_srv.mutate(operations)
+  if response and response[:value]
+    response[:value].each do |shared_criterion|
+      puts "Added shared criterion ID %d '%s' to shared set with ID %d." %
+          [shared_criterion[:criterion][:id],
+           shared_criterion[:criterion][:text],
+           shared_criterion[:shared_set_id]]
+    end
+  else
+    raise StandardError, 'No shared keyword was added'
+  end
+
+  # Attach the articles to the campaign.
+  campaign_set = {
+    :campaign_id => campaign_id,
+    :shared_set_id => shared_set_id
+  }
+
+  response = campaign_shared_set_srv.mutate([
+    {:operator => 'ADD', :operand => campaign_set}
+  ])
+  if response and response[:value]
+    campaign_shared_set = response[:value].first
+    puts 'Shared set ID %d was attached to campaign ID %d' %
+        [campaign_shared_set[:shared_set_id], campaign_shared_set[:campaign_id]]
+  else
+    raise StandardError, 'No campaign shared set was added'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201509
+
+  begin
+    # Campaign ID to attach shared keyword set to.
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+
+    create_and_attach_shared_keyword_set(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