google-adwords-api 0.4.0 → 0.4.1

data/examples/v201109/get_report_fields.rb

@@ -0,0 +1,72 @@
+#!/usr/bin/ruby
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# 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 the list of possible report fields for a report type.
+#
+# Tags: ReportDefinitionService.getReportFields
+
+require 'rubygems'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+def get_report_fields()
+  # 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')
+
+  report_def_srv = adwords.service(:ReportDefinitionService, API_VERSION)
+
+  report_type = 'INSERT_REPORT_TYPE_HERE'
+
+  # Get report fields.
+  fields = report_def_srv.get_report_fields(report_type)
+  if fields
+    puts 'Report type \'%s\' contains the following fields:' % report_type
+    fields.each do |field|
+      puts ' - %s (%s)' % [field[:field_name], field[:field_type]]
+      puts '  := [%s]' % field[:enum_values].join(', ') if field[:enum_values]
+    end
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_report_fields()
+
+  # 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/v201109/get_total_usage_units_per_month.rb

@@ -0,0 +1,74 @@
+#!/usr/bin/ruby
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# 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 the total number of API units that
+# can be used by the developer token making the call, for the current month.
+#
+# Tags: InfoService.get
+
+require 'rubygems'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+def get_total_usage_units_per_month()
+  # 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')
+
+  info_srv = adwords.service(:InfoService, API_VERSION)
+
+  selector = {
+    :api_usage_type => 'TOTAL_USAGE_API_UNITS_PER_MONTH'
+  }
+
+  # Get the usage info.
+  adwords.use_mcc do
+    info = info_srv.get(selector)
+    if info
+      puts 'The total number of API units available this month is %d.' %
+          info[:cost]
+    end
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_total_usage_units_per_month()
+
+  # 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/v201109/get_traffic_estimates.rb

@@ -0,0 +1,129 @@
+#!/usr/bin/ruby
+#
+# 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 'rubygems'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+def get_traffic_estimates()
+  # 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
+  begin
+    get_traffic_estimates()
+
+  # 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/v201109/get_unit_count.rb

@@ -0,0 +1,81 @@
+#!/usr/bin/ruby
+#
+# 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 the number of API units recorded for
+# the developer token over the given date range as well as for the current call.
+#
+# Tags: InfoService.get
+
+require 'rubygems'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+def get_unit_count()
+  # 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')
+
+  info_srv = adwords.service(:InfoService, API_VERSION)
+
+  start_date = Time.now.strftime('%Y%m01')
+  end_date = Time.now.strftime('%Y%m%d')
+
+  selector = {
+    :api_usage_type => 'UNIT_COUNT',
+    :date_range => {
+      :min => start_date,
+      :max => end_date
+    }
+  }
+
+  # Get the unit info.
+  adwords.use_mcc do
+    info_srv.get(selector) do |header, response|
+      puts "Total number of units consumed from %s to %s is %d." %
+          [start_date, end_date, response[:cost]]
+      puts "Number of units consumed by this request is %d" % header[:units]
+    end
+  end
+end
+
+if __FILE__ == $0
+  begin
+    get_unit_count()
+
+  # 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/v201109/handle_partial_failures.rb

@@ -0,0 +1,127 @@
+#!/usr/bin/ruby
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# 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 demonstrates how to handle partial failures.
+#
+# Tags: AdGroupCriterionService.mutate
+
+require 'rubygems'
+require 'adwords_api'
+require 'adwords_api/utils'
+
+API_VERSION = :v201109
+
+def handle_partial_failures()
+  # 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_criterion_srv =
+      adwords.service(:AdGroupCriterionService, API_VERSION)
+
+  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+
+  # Set partial failures flag.
+  adwords.partial_failure = true
+
+  # Create keywords.
+  keyword_text = ['mars cruise', 'inv@lid cruise', 'venus cruise',
+                  'b(a)d keyword cruise']
+  keywords = []
+  keyword_text.each do |text|
+    keyword = {
+      # 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',
+      :match_type => 'BROAD',
+      :text => text
+    }
+    keywords << keyword
+  end
+
+  # Create biddable ad group criteria and operations.
+  operations = []
+  keywords.each do |kwd|
+    operation = {
+      :operator => 'ADD',
+      :operand => {
+        :xsi_type => 'BiddableAdGroupCriterion',
+        :ad_group_id => ad_group_id,
+        :criterion => kwd
+      }
+    }
+    operations << operation
+  end
+
+  # Add criteria.
+  response = ad_group_criterion_srv.mutate(operations)
+  if response and response[:value]
+    ad_group_criteria = response[:value]
+    ad_group_criteria.each do |ad_group_criterion|
+      if ad_group_criterion[:criterion]
+        puts "Ad group criterion with ad group id " +
+           "#{ad_group_criterion[:ad_group_id]}, criterion id "+
+           "#{ad_group_criterion[:criterion][:id]} and keyword \"" +
+           "#{ad_group_criterion[:criterion][:text]}\" was added."
+      end
+    end
+  else
+    puts "No criteria were added."
+  end
+
+  # Check partial failures.
+  if response and response[:partial_failure_errors]
+    response[:partial_failure_errors].each do |error|
+      operation_index = AdwordsApi::Utils.operation_index_for_error(error)
+      if operation_index
+        ad_group_criterion = operations[operation_index][:operand]
+        puts "Ad group criterion with ad group id " +
+            "#{ad_group_criterion[:ad_group_id]} and keyword \"" +
+            "#{ad_group_criterion[:criterion][:text]}\" triggered an error " +
+            "for the following reason: \"#{error[:error_string]}\"."
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  begin
+    handle_partial_failures()
+
+  # 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