google-adwords-api 0.4.0 → 0.4.1

data/examples/v201101/download_mcc_report.rb

@@ -1,113 +0,0 @@
-#!/usr/bin/ruby
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2010, 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 and downloads a report from a report definition using MCC
-# (cross-client) feature. To create a report definition, run
-# add_mcc_report_definition.rb.
-#
-# Please note: This feature is still under development and may change before it
-# is released.
-#
-# Tags: ReportDefinitionService
-
-require 'rubygems'
-require 'adwords_api'
-require 'pp'
-
-API_VERSION = :v201101
-MAX_RETRIES = 10
-RETRY_INTERVAL = 30
-
-def download_mcc_report()
-  # 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_definition_id = 'INSERT_REPORT_ID_HERE'.to_i
-
-  # Poll for the report.
-  report_data = poll_for_report(report_def_srv, report_definition_id)
-
-  # Check the response code.
-  case report_data[:code]
-    when 301
-      puts "Acquired report data of size: %d" % report_data[:report_data].size
-    when 500
-      puts "Received a failure: %s" % report_data[:body]['failureReason']
-      if report_data[:body]['failures']
-        puts "Failures info:"
-        pp report_data[:body]['failures']
-      end
-    else
-      puts "Report returned with unexpected code %d and body: %s" % [
-        report_data[:code], report_data[:body]]
-  end
-end
-
-def poll_for_report(report_def_srv, report_definition_id)
-  # Initially run with query_token = 'new'.
-  query_token = 'new'
-
-  MAX_RETRIES.times do |retry_count|
-    # Acquire report or report status with "download_mcc_report" extension
-    # method.
-    report_data = report_def_srv.download_mcc_report(report_definition_id,
-        query_token)
-    if report_data[:body]
-      # Save query id for following queries.
-      query_token = report_data[:body]['queryToken']
-      # Print current query status.
-      puts "Received a status update: %s" % report_data[:body]['state']
-    end
-    if report_data[:code] == 200
-      puts "Try %d/%d: still processing, retry in %d seconds..." % [
-          retry_count + 1, MAX_RETRIES, RETRY_INTERVAL]
-      sleep(RETRY_INTERVAL)
-    else
-      return report_data
-    end
-  end
-end
-
-if __FILE__ == $0
-  begin
-    download_mcc_report()
-
-  # 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/download_mcc_report_as_file.rb

@@ -1,114 +0,0 @@
-#!/usr/bin/ruby
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2010, 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 and saves a report from a report definition using MCC
-# (cross-client) feature to a given path. To create a report definition, run
-# add_mcc_report_definition.rb.
-#
-# Please note: This feature is still under development and may change before it
-# is released.
-#
-# Tags: ReportDefinitionService
-
-require 'rubygems'
-require 'adwords_api'
-require 'pp'
-
-API_VERSION = :v201101
-MAX_RETRIES = 10
-RETRY_INTERVAL = 30
-
-def download_mcc_report_as_file()
-  # 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_definition_id = 'INSERT_REPORT_ID_HERE'.to_i
-  file_name = 'INSERT_OUTPUT_FILE_NAME_HERE'
-
-  # Poll for the report.
-  report_data = poll_for_report(report_def_srv, report_definition_id, file_name)
-
-  # Check the response code.
-  case report_data[:code]
-    when 301
-      puts "Saved report into a file: %s" % file_name
-    when 500
-      puts "Received a failure: %s" % report_data[:body]['failureReason']
-      if report_data[:body]['failures']
-        puts "Failures info:"
-        pp report_data[:body]['failures']
-      end
-    else
-      puts "Report returned with unexpected code %d and body: %s" % [
-        report_data[:code], report_data[:body]]
-  end
-end
-
-def poll_for_report(report_def_srv, report_definition_id, file_name)
-  # Initially run with query_token = 'new'.
-  query_token = 'new'
-
-  MAX_RETRIES.times do |retry_count|
-    # Acquire report or report status with "download_mcc_report_as_file"
-    # extension method.
-    report_data = report_def_srv.download_mcc_report_as_file(
-        report_definition_id, query_token, file_name)
-    if report_data[:body]
-      # Save query id for following queries.
-      query_token = report_data[:body]['queryToken']
-      # Print current query status.
-      puts "Received a status update: %s" % report_data[:body]['state']
-    end
-    if report_data[:code] == 200
-      puts "Try %d/%d: still processing, retry in %d seconds..." % [
-          retry_count + 1, MAX_RETRIES, RETRY_INTERVAL]
-      sleep(RETRY_INTERVAL)
-    else
-      return report_data
-    end
-  end
-end
-
-if __FILE__ == $0
-  begin
-    download_mcc_report_as_file()
-
-  # 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/lib/adwords_api/v13/traffic_estimator_service.rb

@@ -1,44 +0,0 @@
-#!/usr/bin/ruby
-# This is auto-generated code, changes will be overwritten.
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
-# License:: Licensed under the Apache License,Version 2.0 (the "License").
-#
-# Code generated by AdsCommon library 0.5.0 on 2011-07-19 18:50:04.
-
-require 'ads_common/savon_service'
-require 'adwords_api/v13/traffic_estimator_service_registry'
-
-module AdwordsApi; module V13; module TrafficEstimatorService
-  class TrafficEstimatorService < AdsCommon::SavonService
-    def initialize(api, endpoint)
-      namespace = 'https://adwords.google.com/api/adwords/v13'
-      super(api, endpoint, namespace, :v13)
-    end
-
-    def check_keyword_traffic(*args)
-      return execute_action('check_keyword_traffic', args)
-    end
-
-    def estimate_ad_group_list(*args)
-      return execute_action('estimate_ad_group_list', args)
-    end
-
-    def estimate_campaign_list(*args)
-      return execute_action('estimate_campaign_list', args)
-    end
-
-    def estimate_keyword_list(*args)
-      return execute_action('estimate_keyword_list', args)
-    end
-
-    private
-
-    def get_service_registry()
-      return TrafficEstimatorServiceRegistry
-    end
-
-    def get_module()
-      return AdwordsApi::V13::TrafficEstimatorService
-    end
-  end
-end; end; end

data/lib/adwords_api/v13/traffic_estimator_service_registry.rb

@@ -1,39 +0,0 @@
-#!/usr/bin/ruby
-# This is auto-generated code, changes will be overwritten.
-# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
-# License:: Licensed under the Apache License,Version 2.0 (the "License").
-#
-# Code generated by AdsCommon library 0.5.0 on 2011-07-19 18:50:04.
-
-module AdwordsApi; module V13; module TrafficEstimatorService
-  class TrafficEstimatorServiceRegistry
-    TRAFFICESTIMATORSERVICE_METHODS = {:check_keyword_traffic=>{:input=>[{:type=>"KeywordTrafficRequest", :max_occurs=>:unbounded, :name=>:requests}], :output=>{:fields=>[{:type=>"KeywordTraffic", :max_occurs=>:unbounded, :name=>:check_keyword_traffic_return}], :name=>"check_keyword_traffic_response"}}, :estimate_ad_group_list=>{:input=>[{:type=>"AdGroupRequest", :max_occurs=>:unbounded, :name=>:ad_group_requests}], :output=>{:fields=>[{:type=>"AdGroupEstimate", :max_occurs=>:unbounded, :name=>:estimate_ad_group_list_return}], :name=>"estimate_ad_group_list_response"}}, :estimate_campaign_list=>{:input=>[{:type=>"CampaignRequest", :max_occurs=>:unbounded, :name=>:campaign_requests}], :output=>{:fields=>[{:type=>"CampaignEstimate", :max_occurs=>:unbounded, :name=>:estimate_campaign_list_return}], :name=>"estimate_campaign_list_response"}}, :estimate_keyword_list=>{:input=>[{:type=>"KeywordRequest", :max_occurs=>:unbounded, :name=>:keyword_requests}], :output=>{:fields=>[{:type=>"KeywordEstimate", :max_occurs=>:unbounded, :name=>:estimate_keyword_list_return}], :name=>"estimate_keyword_list_response"}}}
-    TRAFFICESTIMATORSERVICE_TYPES = {:MetroTargets=>{:fields=>[{:type=>"string", :max_occurs=>:unbounded, :name=>:excluded_metros, :min_occurs=>0}, {:type=>"string", :max_occurs=>:unbounded, :name=>:metros, :min_occurs=>0}]}, :Circle=>{:fields=>[{:type=>"int", :name=>:latitude_micro_degrees}, {:type=>"int", :name=>:longitude_micro_degrees}, {:type=>"int", :name=>:radius_meters}]}, :ProximityTargets=>{:fields=>[{:type=>"Circle", :max_occurs=>:unbounded, :name=>:circles}]}, :NetworkTarget=>{:fields=>[{:type=>"NetworkType", :max_occurs=>:unbounded, :name=>:network_types, :min_occurs=>0}]}, :AdGroupEstimate=>{:fields=>[{:type=>"int", :name=>:id, :min_occurs=>0}, {:type=>"KeywordEstimate", :max_occurs=>:unbounded, :name=>:keyword_estimates}]}, :KeywordEstimate=>{:fields=>[{:type=>"long", :name=>:id, :min_occurs=>0}, {:type=>"float", :name=>:lower_avg_position}, {:type=>"float", :name=>:lower_clicks_per_day}, {:type=>"long", :name=>:lower_cpc}, {:type=>"float", :name=>:upper_avg_position}, {:type=>"float", :name=>:upper_clicks_per_day}, {:type=>"long", :name=>:upper_cpc}]}, :CityTargets=>{:fields=>[{:type=>"string", :max_occurs=>:unbounded, :name=>:cities, :min_occurs=>0}, {:type=>"string", :max_occurs=>:unbounded, :name=>:excluded_cities, :min_occurs=>0}]}, :RegionTargets=>{:fields=>[{:type=>"string", :max_occurs=>:unbounded, :name=>:excluded_regions, :min_occurs=>0}, {:type=>"string", :max_occurs=>:unbounded, :name=>:regions, :min_occurs=>0}]}, :GeoTarget=>{:fields=>[{:type=>"CityTargets", :name=>:city_targets, :min_occurs=>0}, {:type=>"CountryTargets", :name=>:country_targets, :min_occurs=>0}, {:type=>"MetroTargets", :name=>:metro_targets, :min_occurs=>0}, {:type=>"ProximityTargets", :name=>:proximity_targets, :min_occurs=>0}, {:type=>"RegionTargets", :name=>:region_targets, :min_occurs=>0}, {:type=>"boolean", :name=>:target_all}]}, :CountryTargets=>{:fields=>[{:type=>"string", :max_occurs=>:unbounded, :name=>:countries, :min_occurs=>0}, {:type=>"string", :max_occurs=>:unbounded, :name=>:excluded_countries, :min_occurs=>0}]}, :LanguageTarget=>{:fields=>[{:type=>"string", :max_occurs=>:unbounded, :name=>:languages}]}, :CampaignEstimate=>{:fields=>[{:type=>"AdGroupEstimate", :max_occurs=>:unbounded, :name=>:ad_group_estimates}, {:type=>"int", :name=>:id, :min_occurs=>0}]}, :KeywordRequest=>{:fields=>[{:type=>"long", :name=>:id, :min_occurs=>0}, {:type=>"long", :name=>:max_cpc, :min_occurs=>0}, {:type=>"boolean", :name=>:negative, :min_occurs=>0}, {:type=>"string", :name=>:text, :min_occurs=>0}, {:type=>"KeywordType", :name=>:type, :min_occurs=>0}]}, :AdGroupRequest=>{:fields=>[{:type=>"long", :name=>:id, :min_occurs=>0}, {:type=>"KeywordRequest", :max_occurs=>:unbounded, :name=>:keyword_requests}, {:type=>"long", :name=>:max_cpc, :min_occurs=>0}]}, :KeywordTrafficRequest=>{:fields=>[{:type=>"string", :name=>:keyword_text}, {:type=>"KeywordType", :name=>:keyword_type}, {:type=>"string", :name=>:language, :min_occurs=>0}]}, :CampaignRequest=>{:fields=>[{:type=>"AdGroupRequest", :max_occurs=>:unbounded, :name=>:ad_group_requests}, {:type=>"GeoTarget", :name=>:geo_targeting, :min_occurs=>0}, {:type=>"int", :name=>:id, :min_occurs=>0}, {:type=>"LanguageTarget", :name=>:language_targeting, :min_occurs=>0}, {:type=>"NetworkTarget", :name=>:network_targeting, :min_occurs=>0}]}}
-    TRAFFICESTIMATORSERVICE_NAMESPACES = []
-
-    def self.get_method_signature(method_name)
-      return TRAFFICESTIMATORSERVICE_METHODS[method_name.to_sym]
-    end
-
-    def self.get_type_signature(type_name)
-      return TRAFFICESTIMATORSERVICE_TYPES[type_name.to_sym]
-    end
-
-    def self.get_namespace(index)
-      return TRAFFICESTIMATORSERVICE_NAMESPACES[index]
-    end
-  end
-
-  class ApiException < AdwordsApi::Errors::ApiException
-    attr_reader :code  # int
-    attr_reader :errors  # ApiError
-    attr_reader :internal  # boolean
-    attr_reader :message  # string
-    attr_reader :trigger  # string
-    def initialize(exception_fault)
-      @array_fields ||= []
-      @array_fields << 'errors'
-      super(exception_fault)
-    end
-  end
-end; end; end