google-adwords-api 0.12.0 → 0.12.1

data/examples/v201406/misc/get_all_images_and_videos.rb

@@ -0,0 +1,108 @@
+#!/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 retrieve all images and videos. To upload an
+# image, run upload_image.rb. To upload video, see:
+#   http://adwords.google.com/support/aw/bin/answer.py?hl=en&answer=39454.
+#
+# Tags: MediaService.get
+
+require 'adwords_api'
+
+def get_all_images_and_videos()
+  # 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')
+
+  media_srv = adwords.service(:MediaService, API_VERSION)
+
+  # Get all the images and videos.
+  selector = {
+    :fields => ['MediaId', 'Height', 'Width', 'MimeType', 'Urls'],
+    :ordering => [
+      {:field => 'MediaId', :sort_order => 'ASCENDING'}
+    ],
+    :predicates => [
+      {:field => 'Type', :operator => 'IN', :values => ['IMAGE', 'VIDEO']}
+    ],
+    :paging => {
+      :start_index => 0,
+      :number_results => PAGE_SIZE
+    }
+  }
+
+  # Set initial values.
+  offset, page = 0, {}
+
+  begin
+    page = media_srv.get(selector)
+    if page[:entries]
+      page[:entries].each do |entry|
+        full_dimensions = entry[:dimensions]['FULL']
+        puts "Entry ID %d with dimensions %dx%d and MIME type is '%s'" %
+            [entry[:media_id], full_dimensions[:height],
+             full_dimensions[:width], entry[:mime_type]]
+      end
+      # Increment values to request the next page.
+      offset += PAGE_SIZE
+      selector[:paging][:start_index] = offset
+    end
+  end while page[:total_num_entries] > offset
+
+  if page.include?(:total_num_entries)
+    puts "\tFound %d entries." % page[:total_num_entries]
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201406
+  PAGE_SIZE = 500
+
+  begin
+    get_all_images_and_videos()
+
+  # 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/v201406/misc/setup_oauth2.rb

@@ -0,0 +1,88 @@
+#!/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 set up OAuth2.0 authentication credentials.
+#
+# Tags: CampaignService.get
+
+require 'adwords_api'
+
+def setup_oauth2()
+  # 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')
+
+  # You can call authorize explicitly to obtain the access token. Otherwise, it
+  # will be invoked automatically on the first API call.
+  # There are two ways to provide verification code, first one is via the block:
+  token = adwords.authorize() do |auth_url|
+    puts "Hit Auth error, please navigate to URL:\n\t%s" % auth_url
+    print 'log in and type the verification code: '
+    verification_code = gets.chomp
+    verification_code
+  end
+  if token
+    print "\nWould you like to update your adwords_api.yml to save " +
+        "OAuth2 credentials? (y/N): "
+    response = gets.chomp
+    if ('y'.casecmp(response) == 0) or ('yes'.casecmp(response) == 0)
+      adwords.save_oauth2_token(token)
+      puts 'OAuth2 token is now saved to ~/adwords_api.yml and will be ' +
+          'automatically used by the library.'
+    end
+  end
+
+  # Alternatively, you can provide one within the parameters:
+  # token = adwords.authorize({:oauth2_verification_code => verification_code})
+
+  # Note, 'token' is a Hash. Its value is not used in this example. If you need
+  # to be able to access the API in offline mode, with no user present, you
+  # should persist it to be used in subsequent invocations like this:
+  # adwords.authorize({:oauth2_token => token})
+
+  # No exception thrown - we are good to make a request.
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201406
+
+  begin
+    setup_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/v201406/misc/upload_image.rb

@@ -0,0 +1,97 @@
+#!/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 uploads an image. To get images, run get_all_images.rb.
+#
+# Tags: MediaService.upload
+
+require 'adwords_api'
+require 'base64'
+
+def upload_image()
+  # 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')
+
+  media_srv = adwords.service(:MediaService, API_VERSION)
+
+  # Create image.
+  image_url =
+      'http://www.google.com/intl/en/adwords/select/images/samples/inline.jpg'
+  # This utility method retrieves the contents of a URL using all of the config
+  # options provided to the Api object.
+  image_data = AdsCommon::Http.get(image_url, adwords.config)
+  base64_image_data = Base64.encode64(image_data)
+  image = {
+    # 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 => 'Image',
+    :data => base64_image_data,
+    :type => 'IMAGE'
+  }
+
+  # Upload image.
+  response = media_srv.upload([image])
+  if response and !response.empty?
+    ret_image = response.first
+    full_dimensions = ret_image[:dimensions]['FULL']
+    puts ("Image with ID %d, dimensions %dx%d and MIME type '%s' uploaded " +
+        "successfully.") % [ret_image[:media_id], full_dimensions[:height],
+         full_dimensions[:width], ret_image[:mime_type]]
+  else
+    puts 'No images uploaded.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201406
+
+  begin
+    upload_image()
+
+  # 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/v201406/misc/use_oauth2_jwt.rb

@@ -0,0 +1,97 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2012, 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 use OAuth2.0 authentication method with
+# Service Account (JWT). For this example to work, your Service Account must be
+# a Google Apps for Business Account.
+#
+# See https://developers.google.com/adwords/api/docs/guides/service-accounts
+# for more information.
+#
+# Tags: CampaignService.get
+
+require 'adwords_api'
+
+def use_oauth2_jwt()
+  # 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')
+
+  # Option 1: provide key filename as authentication -> oauth2_keyfile in the
+  #           configuration file. No additional code is necessary.
+  # To provide a file name at runtime, use authorize:
+  # adwords.authorize({:oauth2_keyfile => key_filename})
+
+  # Option 2: retrieve key manually and create OpenSSL::PKCS12 object.
+  # key_filename = 'INSERT_FILENAME_HERE'
+  # key_secret = 'INSERT_SECRET_HERE'
+  # key_file_data = File.read(key_filename)
+  # key = OpenSSL::PKCS12.new(key_file_data, key_secret).key
+  # adwords.authorize({:oauth2_key => key})
+
+  # Now you can make API calls.
+  campaign_srv = adwords.service(:CampaignService, API_VERSION)
+
+  # Get all the campaigns for this account; empty selector.
+  selector = {
+    :fields => ['Id', 'Name', 'Status'],
+    :ordering => [
+      {:field => 'Name', :sort_order => 'ASCENDING'}
+    ]
+  }
+
+  response = campaign_srv.get(selector)
+  if response and response[:entries]
+    campaigns = response[:entries]
+    campaigns.each do |campaign|
+      puts "Campaign ID %d, name '%s' and status '%s'" %
+          [campaign[:id], campaign[:name], campaign[:status]]
+    end
+  else
+    puts 'No campaigns were found.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201406
+
+  begin
+    use_oauth2_jwt()
+
+  # 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/v201406/optimization/estimate_keyword_traffic.rb

@@ -0,0 +1,137 @@
+#!/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 gets keyword traffic estimates.
+#
+# Tags: TrafficEstimatorService.get
+
+require 'adwords_api'
+
+def estimate_keyword_traffic()
+  # 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')
+
+  traffic_estimator_srv = adwords.service(:TrafficEstimatorService, API_VERSION)
+
+  # Create keywords. Up to 2000 keywords can be passed in a single request.
+  keywords = [
+      # 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 => 'Keyword', :text => 'mars cruise', :match_type => 'BROAD'},
+    {:xsi_type => 'Keyword', :text => 'cheap cruise', :match_type => 'PHRASE'},
+    {:xsi_type => 'Keyword', :text => 'cruise', :match_type => 'EXACT'},
+    {:xsi_type => 'Keyword', :text => 'moon walk', :match_type => 'BROAD'}
+  ]
+
+  # Create a keyword estimate request for each keyword.
+  keyword_requests = keywords.map {|keyword| {:keyword => keyword}}
+
+  # Negative keywords don't return estimates, but adjust the estimates of the
+  # other keywords in the hypothetical ad group. To specify a negative keyword
+  # set the is_negative field to true.
+  keyword_requests[3][:is_negative] = true
+
+  # Create ad group estimate requests.
+  ad_group_request = {
+      :keyword_estimate_requests => keyword_requests,
+      :max_cpc => {
+          :micro_amount => 1000000
+      }
+  }
+
+  # Create campaign estimate requests.
+  campaign_request = {
+      :ad_group_estimate_requests => [ad_group_request],
+      # Set targeting criteria. Only locations and languages are supported.
+      :criteria => [
+          {:xsi_type => 'Location', :id => 2840}, # United States
+          {:xsi_type => 'Language', :id => 1000}  # English
+      ]
+  }
+
+  # Create selector and retrieve reults.
+  selector = {:campaign_estimate_requests => [campaign_request]}
+  response = traffic_estimator_srv.get(selector)
+
+  if response and response[:campaign_estimates]
+    campaign_estimates = response[:campaign_estimates]
+    keyword_estimates =
+        campaign_estimates.first[:ad_group_estimates].first[:keyword_estimates]
+    keyword_estimates.each_with_index do |estimate, index|
+      keyword = keyword_requests[index][:keyword]
+
+      # Find the mean of the min and max values.
+      mean_avg_cpc = (estimate[:min][:average_cpc][:micro_amount] +
+                      estimate[:max][:average_cpc][:micro_amount]) / 2
+      mean_avg_position = (estimate[:min][:average_position] +
+                           estimate[:max][:average_position]) / 2
+      mean_clicks = (estimate[:min][:clicks_per_day] +
+                     estimate[:max][:clicks_per_day]) / 2
+      mean_total_cost = (estimate[:min][:total_cost][:micro_amount] +
+                         estimate[:max][:total_cost][:micro_amount]) / 2
+
+      puts "Results for the keyword with text '%s' and match type %s:" %
+          [keyword[:text], keyword[:match_type]]
+      puts "\tEstimated average CPC: %d" % mean_avg_cpc
+      puts "\tEstimated ad position: %.2f" % mean_avg_position
+      puts "\tEstimated daily clicks: %d" % mean_clicks
+      puts "\tEstimated daily cost: %d" % mean_total_cost
+    end
+  else
+    puts 'No traffic estimates were returned.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201406
+
+  begin
+    estimate_keyword_traffic()
+
+  # 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/v201406/optimization/get_keyword_bid_simulations.rb

@@ -0,0 +1,100 @@
+#!/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 gets bid landscapes for a keyword. To get keywords, run
+# get_keywords.rb.
+#
+# Tags: DataService.getCriterionBidLandscape
+
+require 'adwords_api'
+
+def get_criterion_bid_landscapes(ad_group_id, keyword_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')
+
+  data_srv = adwords.service(:DataService, API_VERSION)
+
+  # Get keyword bid landscape.
+  selector = {
+    :fields => ['AdGroupId', 'CriterionId', 'StartDate', 'EndDate', 'Bid',
+        'LocalClicks', 'LocalCost', 'MarginalCpc', 'LocalImpressions'],
+    :predicates => [
+      {:field => 'AdGroupId', :operator => 'IN', :values => [ad_group_id]},
+      {:field => 'CriterionId', :operator => 'IN', :values => [keyword_id]},
+    ]
+  }
+  page = data_srv.get_criterion_bid_landscape(selector)
+  if page and page[:entries]
+    puts "Bid landscape(s) retrieved: %d." % [page[:entries].length]
+    page[:entries].each do |bid_landscape|
+      puts ("Retrieved keyword bid landscape with ad group ID %d" +
+          ", keyword ID %d, start date '%s', end date '%s'" +
+          ", with landscape points:") %
+          [bid_landscape[:ad_group_id], bid_landscape[:criterion_id],
+           bid_landscape[:start_date], bid_landscape[:end_date]]
+      bid_landscape[:landscape_points].each do |point|
+        puts "\t%d => clicks: %d, cost: %d, marginalCpc: %d, impressions: %d" %
+            [point[:bid][:micro_amount], point.clicks,
+             point[:cost][:micro_amount], point[:marginal_cpc][:micro_amount],
+             point[:impressions]]
+      end
+    end
+  else
+    puts 'No bid landscapes retrieved.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201406
+
+  begin
+    ad_group_id = 'INSERT_ADGROUP_ID_HERE'.to_i
+    keyword_id = 'INSERT_KEYWORD_ID_HERE'.to_i
+    get_criterion_bid_landscapes(ad_group_id, keyword_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