google-adwords-api 0.4.5 → 0.5.0

data/examples/v201101/get_related_placements.rb

@@ -1,107 +0,0 @@
-#!/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 retrieves URLs that have content keywords related to a given
-# website.
-#
-# Tags: TargetingIdeaService.get
-
-require 'rubygems'
-require 'adwords_api'
-require 'adwords_api/utils'
-
-API_VERSION = :v201101
-PAGE_SIZE = 100
-
-def get_related_placements()
-  # 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')
-
-  targeting_idea_srv = adwords.service(:TargetingIdeaService, API_VERSION)
-
-  url = 'INSERT_PLACEMENT_URL_HERE'
-
-  # Construct selector.
-  selector = {
-    :idea_type => 'PLACEMENT',
-    :request_type => 'IDEAS',
-    :requested_attribute_types => ['CRITERION'],
-    :search_parameters => [{
-      # 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 => 'RelatedToUrlSearchParameter',
-      :urls => [url],
-      :include_sub_urls => false
-    }],
-    :paging => {
-      :start_index => 0,
-      :number_results => PAGE_SIZE
-    }
-  }
-
-  # Define initial values.
-  offset = 0
-  results = []
-
-  begin
-    # Perform request.
-    page = targeting_idea_srv.get(selector)
-    results += page[:entries] if page and page[:entries]
-
-    # Prepare next page request.
-    offset += PAGE_SIZE
-    selector[:paging][:start_index] = offset
-  end while offset < page[:total_num_entries]
-
-  # Display results.
-  results.each do |result|
-    data = AdwordsApi::Utils.map(result[:data])
-    placement = data['CRITERION'][:value]
-    puts "Related content keywords found at URL [%s]" % placement[:url]
-  end
-  puts "Total URLs found with keywords related to keywords at [%s]: %d." %
-      [url, results.length]
-end
-
-if __FILE__ == $0
-  begin
-    get_related_placements()
-
-  # 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/v201101/get_report_fields.rb

@@ -1,72 +0,0 @@
-#!/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 = :v201101
-
-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/v201101/get_total_usage_units_per_month.rb

@@ -1,74 +0,0 @@
-#!/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 = :v201101
-
-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/v201101/get_traffic_estimates.rb

@@ -1,148 +0,0 @@
-#!/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 keyword traffic estimates.
-#
-# Tags: TrafficEstimatorService.get
-
-require 'rubygems'
-require 'adwords_api'
-require 'pp'
-
-API_VERSION = :v201101
-
-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'
-    }
-  ]
-
-  # Create a keyword estimate request for each keyword.
-  keyword_requests = []
-  keywords.each do |keyword|
-    request = {
-      :keyword => keyword
-    }
-    keyword_requests << request
-  end
-
-  # 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],
-    :targets => [
-      {
-        :xsi_type => 'CountryTarget',
-        :country_code => 'US'
-      },
-      {
-        :xsi_type => 'LanguageTarget',
-        :language_code => 'en'
-      }
-    ]
-  }
-
-  # 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 #{keyword[:text]} and match " +
-          "type #{keyword[:match_type]}:"
-      puts "  Estimated average CPC: %d" % mean_avg_cpc
-      puts "  Estimated ad position: %.2f" % mean_avg_position
-      puts "  Estimated daily clicks: %d" % mean_clicks
-      puts "  Estimated 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/v201101/get_unit_count.rb

@@ -1,79 +0,0 @@
-#!/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 number of API units recorded for
-# the developer token being used to make this call over the given date range.
-#
-# Tags: InfoService.get
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201101
-
-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)
-
-  selector = {
-    :api_usage_type => 'UNIT_COUNT',
-    :date_range => {
-      :min => Time.now.strftime('%Y%m01'),
-      :max => Time.now.strftime('%Y%m%d')
-    }
-  }
-
-  # Get the unit info.
-  adwords.use_mcc do
-    info = info_srv.get(selector)
-    if info
-      puts 'The total number of units consumed from %s to %s is %d.' %
-          [selector[:date_range][:min], selector[:date_range][:max],
-          info[:cost]]
-    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