google-adwords-api 0.8.2 → 0.9.0

data/examples/v201206/reporting/download_criteria_report.rb

@@ -1,79 +0,0 @@
-#!/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 and downloads an Ad Hoc report from a XML report definition.
-
-require 'adwords_api'
-
-def download_criteria_report(file_name)
-  # 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')
-
-  # Get report utilities for the version.
-  report_utils = adwords.report_utils(API_VERSION)
-
-  # Define report definition. You can also pass your own XML text as a string.
-  report_definition = {
-    :selector => {
-      :fields => ['CampaignId', 'AdGroupId', 'Id', 'Criteria', 'CriteriaType',
-          'Impressions', 'Clicks', 'Cost'],
-      # Predicates are optional.
-      :predicates => {
-        :field => 'Status',
-        :operator => 'IN',
-        :values => ['ACTIVE', 'PAUSED']
-      }
-    },
-    :report_name => 'Last 7 days CRITERIA_PERFORMANCE_REPORT',
-    :report_type => 'CRITERIA_PERFORMANCE_REPORT',
-    :download_format => 'CSV',
-    :date_range_type => 'LAST_7_DAYS',
-    # Enable to get rows with zero impressions.
-    :include_zero_impressions => false
-  }
-
-  # Download report, using "download_report_as_file" utility method.
-  # To retrieve the report as return value, use "download_report" method.
-  report_utils.download_report_as_file(report_definition, file_name)
-  puts "Report was downloaded to '%s'." % file_name
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201206
-
-  begin
-    # File name to write report to.
-    file_name = 'INSERT_OUTPUT_FILE_NAME_HERE'
-    download_criteria_report(file_name)
-
-  # HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
-
-  # API errors.
-  rescue AdwordsApi::Errors::ReportError => e
-    puts "Reporting Error: %s" % e.message
-  end
-end

data/examples/v201206/reporting/download_criteria_report_with_awql.rb

@@ -1,78 +0,0 @@
-#!/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 gets an Ad Hoc report using AdWords Query Language.
-# See AWQL guide for more details:
-#   https://developers.google.com/adwords/api/docs/guides/awql
-
-require 'date'
-
-require 'adwords_api'
-
-def download_criteria_report_with_awql(file_name, report_format)
-  # 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')
-
-  # Get report utilities for the version.
-  report_utils = adwords.report_utils(API_VERSION)
-
-  # Prepare a date range for the last week. Instead you can use 'LAST_7_DAYS'.
-  date_range = '%s,%s' % [
-      DateTime.parse((Date.today - 7).to_s).strftime('%Y%m%d'),
-      DateTime.parse((Date.today - 1).to_s).strftime('%Y%m%d')
-  ]
-
-  # Define report definition. You can also pass your own XML text as a string.
-  report_query = 'SELECT CampaignId, AdGroupId, Id, Criteria, CriteriaType, ' +
-      'Impressions, Clicks, Cost FROM CRITERIA_PERFORMANCE_REPORT ' +
-      'WHERE Status IN [ACTIVE, PAUSED] ' +
-      'DURING %s' % date_range
-
-  # Download report, using "download_report_as_file_with_awql" utility method.
-  # To retrieve the report as return value, use "download_report_with_awql"
-  # method.
-  report_utils.download_report_as_file_with_awql(report_query, report_format,
-                                                 file_name)
-  puts "Report was downloaded to '%s'." % file_name
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201206
-
-  begin
-    # File name to write report to.
-    file_name = 'INSERT_OUTPUT_FILE_NAME_HERE'
-    report_format = 'CSV'
-    download_criteria_report_with_awql(file_name, report_format)
-
-  # HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts 'HTTP Error: %s' % e
-
-  # API errors.
-  rescue AdwordsApi::Errors::ReportError => e
-    puts 'Reporting Error: %s' % e.message
-  end
-end

data/examples/v201206/reporting/get_campaign_stats.rb

@@ -1,105 +0,0 @@
-#!/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 gets various statistics for campaigns that received at least one
-# impression during the last week. To get campaigns, run get_campaigns.rb.
-#
-# Tags: CampaignService.get
-
-require 'adwords_api'
-require 'date'
-
-def get_campaign_stats()
-  # 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')
-
-  campaign_srv = adwords.service(:CampaignService, API_VERSION)
-
-  # Prepare start and end date for the last week.
-  start_date = DateTime.parse((Date.today - 7).to_s).strftime("%Y%m%d")
-  end_date = DateTime.parse((Date.today - 1).to_s).strftime("%Y%m%d")
-
-  # Get all the campaigns for this account.
-  selector = {
-    :fields => ['Id', 'Name', 'Impressions', 'Clicks', 'Cost', 'Ctr'],
-    :predicates => [
-      {:field => 'Impressions', :operator => 'GREATER_THAN', :values => [0]}
-    ],
-    :date_range => {:min => start_date, :max => end_date},
-    :paging => {
-      :start_index => 0,
-      :number_results => PAGE_SIZE
-    }
-  }
-
-  # Set initial values.
-  offset, page = 0, {}
-
-  begin
-    page = campaign_srv.get(selector)
-    if page[:entries]
-      page[:entries].each do |campaign|
-        puts ("Campaign with ID %d, name '%s' had the following stats during" +
-            " the last week: ") % [campaign[:id], campaign[:name]]
-        stats = campaign[:campaign_stats]
-        puts "\tImpressions: %d" % stats[:impressions]
-        puts "\tClicks:      %d" % stats[:clicks]
-        puts "\tCost:        %.2f" % (stats[:cost][:micro_amount] / 1000000)
-        puts "\tCTR:         %.2f%%" % (stats[:ctr] * 100)
-      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 "Total number of campaigns found: %d." % [page[:total_num_entries]]
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201206
-  PAGE_SIZE = 500
-
-  begin
-    get_campaign_stats()
-
-  # 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/v201206/reporting/get_report_fields.rb

@@ -1,71 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# 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 'adwords_api'
-
-def get_report_fields(report_type)
-  # 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)
-
-  # 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
-  API_VERSION = :v201206
-
-  begin
-    report_type = 'INSERT_REPORT_TYPE_HERE'
-    get_report_fields(report_type)
-
-  # 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/v201206/reporting/parallel_report_download.rb

@@ -1,162 +0,0 @@
-#!/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 and downloads an Ad Hoc report from a XML report definition.
-#
-# Note: This code example uses MCC-level calls and won't work with Test
-# Accounts, see: https://developers.google.com/adwords/api/docs/test-accounts
-
-require 'thread'
-
-require 'adwords_api'
-require 'adwords_api/utils'
-
-def parallel_report_download()
-  # 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')
-
-  # Determine list of customer IDs to retrieve report for. For this example we
-  # will use ManagedCustomerService to get all IDs in hierarchy.
-
-  managed_customer_srv = adwords.service(:ManagedCustomerService, API_VERSION)
-
-  # Get the account hierarchy for this account.
-  selector = {:fields => ['CustomerId']}
-
-  # Run the request at the MCC level.
-  graph = adwords.use_mcc() {managed_customer_srv.get(selector)}
-
-  # Using queue to balance load between threads.
-  queue = Queue.new()
-
-  if graph and graph[:entries] and !graph[:entries].empty?
-    graph[:entries].each {|account| queue << account[:customer_id]}
-  else
-    raise StandardError, 'Can not retrieve any customer ID'
-  end
-
-  # Get report utilities for the version.
-  report_utils = adwords.report_utils(API_VERSION)
-
-  # Define report definition. You can also pass your own XML text as a string.
-  report_definition = {
-    :selector => {
-        :fields => ['CampaignId', 'Id', 'Impressions', 'Clicks', 'Cost'],
-        # Predicates are optional.
-        :predicates => {
-          :field => 'Status',
-          :operator => 'IN',
-          :values => ['ENABLED', 'PAUSED']
-        }
-      },
-      :report_name => 'Custom ADGROUP_PERFORMANCE_REPORT',
-      :report_type => 'ADGROUP_PERFORMANCE_REPORT',
-      :download_format => 'CSV',
-      :date_range_type => 'LAST_7_DAYS',
-      # Enable to get rows with zero impressions.
-      :include_zero_impressions => false
-  }
-
-  puts 'Retrieving %d reports with %d threads:' % [queue.size, THREADS]
-
-  reports_succeeded = Queue.new()
-  reports_failed = Queue.new()
-
-  # Creating a mutex to control access to the queue.
-  queue_mutex = Mutex.new
-
-  # Start all the threads.
-  threads = (1..THREADS).map do |thread_id|
-    Thread.new(report_definition) do |local_def|
-      cid = nil
-      begin
-        cid = queue_mutex.synchronize {(queue.empty?) ? nil : queue.pop(true)}
-        if cid
-          retry_count = 0
-          file_name = 'adgroup_%010d.csv' % cid
-          puts "[%2d/%d] Loading report for customer ID %s into '%s'..." %
-              [thread_id, retry_count,
-               AdwordsApi::Utils.format_id(cid), file_name]
-          begin
-            report_utils.download_report_as_file(local_def, file_name, cid)
-            reports_succeeded << {:cid => cid, :file_name => file_name}
-          rescue AdwordsApi::Errors::ReportError => e
-            if e.http_code == 500 && retry_count < MAX_RETRIES
-              retry_count += 1
-              sleep(retry_count * BACKOFF_FACTOR)
-              retry
-            else
-              puts(('Report failed for customer ID %s with code %d after %d ' +
-                  'retries.') % [cid, e.http_code, retry_count + 1])
-              reports_failed <<
-                {:cid => cid, :http_code => e.http_code, :message => e.message}
-            end
-          end
-        end
-      end while (cid != nil)
-    end
-  end
-
-  # Wait for all threads to finish.
-  threads.each { |aThread|  aThread.join }
-
-  puts 'Download completed, results:'
-  puts 'Successful reports:'
-  while !reports_succeeded.empty? do
-    result = reports_succeeded.pop()
-    puts "\tClient ID %s => '%s'" %
-        [AdwordsApi::Utils.format_id(result[:cid]), result[:file_name]]
-  end
-  puts 'Failed reports:'
-  while !reports_failed.empty? do
-    result = reports_failed.pop()
-    puts "\tClient ID %s => Code: %d, Message: '%s'" %
-        [AdwordsApi::Utils.format_id(result[:cid]),
-         result[:http_code], result[:message]]
-  end
-  puts 'End of results.'
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201206
-  # Number of parallel threads to spawn.
-  THREADS = 10
-  # Maximum number of retries for 500 errors.
-  MAX_RETRIES = 5
-  # Timeout between retries in seconds.
-  BACKOFF_FACTOR = 5
-
-  begin
-    parallel_report_download()
-
-  # HTTP errors.
-  rescue AdsCommon::Errors::HttpError => e
-    puts 'HTTP Error: %s' % e
-
-  # API errors.
-  rescue AdwordsApi::Errors::ReportError => e
-    puts 'Reporting Error: %s' % e.message
-  end
-end