google-adwords-api 0.15.1 → 0.15.2

data/examples/v201506/reporting/download_criteria_report_with_awql.rb

@@ -0,0 +1,95 @@
+#!/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 [ENABLED, PAUSED] ' +
+      'DURING %s' % date_range
+
+  # Optional: Set the configuration of the API instance to suppress header,
+  # column name, or summary rows in the report output. You can also configure
+  # this in your adwords_api.yml configuration file.
+  adwords.skip_report_header = false
+  adwords.skip_column_header = false
+  adwords.skip_report_summary = false
+  # Enable to allow rows with zero impressions to show.
+  adwords.include_zero_impressions = true
+
+  # 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 = :v201506
+
+  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)
+
+  # 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::ReportError => e
+    puts 'Reporting Error: %s' % e.message
+  end
+end

data/examples/v201506/reporting/get_report_fields.rb

@@ -0,0 +1,79 @@
+#!/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 = :v201506
+
+  begin
+    report_type = 'INSERT_REPORT_TYPE_HERE'
+    get_report_fields(report_type)
+
+  # 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/v201506/reporting/parallel_report_download.rb

@@ -0,0 +1,168 @@
+#!/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
+# for all accounts in hierarchy in multiple parallel threads. This example
+# needs to be run against an MCC account.
+
+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']}
+
+  graph = 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', 'AdGroupId', 'Impressions', 'Clicks', 'Cost'],
+        # Predicates are optional.
+        :predicates => {
+          :field => 'AdGroupStatus',
+          :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 = :v201506
+  # 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()
+
+  # 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::ReportError => e
+    puts 'Reporting Error: %s' % e.message
+  end
+end

data/examples/v201506/shopping_campaigns/add_product_partition_tree.rb

@@ -0,0 +1,269 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.mcloonan@gmail.com (Michael Cloonan)
+#
+# Copyright:: Copyright 2014, 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 creates a ProductPartition tree.
+
+require 'adwords_api'
+
+class ProductPartitionHelper
+  attr_reader :operations
+
+  def initialize(ad_group_id)
+    # The next temporary criterion ID to be used.
+    #
+    # When creating our tree we need to specify the parent-child relationships
+    # between nodes. However, until a criterion has been created on the server
+    # we do not have a criterionId with which to refer to it.
+    #
+    # Instead we can specify temporary IDs that are specific to a single mutate
+    # request. Once the criteria have been created they are assigned an ID as
+    # normal and the temporary ID will no longer refer to it.
+    #
+    # A valid temporary ID is any negative integer.
+    @next_id = -1
+
+    # The set of mutate operations needed to create the current tree.
+    @operations = []
+
+    # The ID of the AdGroup that we wish to attach the partition tree to.
+    @ad_group_id = ad_group_id
+  end
+
+  def create_subdivision(parent = nil, value = nil)
+    division = {
+      :xsi_type => 'ProductPartition',
+      :partition_type => 'SUBDIVISION',
+      :id => @next_id
+    }
+
+    @next_id -= 1
+
+    unless parent.nil? || value.nil?
+      division[:parent_criterion_id] = parent[:id]
+      division[:case_value] = value
+    end
+
+    ad_group_criterion = {
+      :xsi_type => 'BiddableAdGroupCriterion',
+      :ad_group_id => @ad_group_id,
+      :criterion => division
+    }
+
+    create_add_operation(ad_group_criterion)
+
+    return division
+  end
+
+  def create_unit(parent = nil, value = nil, bid_amount = nil)
+    unit = {
+      :xsi_type => 'ProductPartition',
+      :partition_type => 'UNIT'
+    }
+
+    unless parent.nil? || value.nil?
+      unit[:parent_criterion_id] = parent[:id]
+      unit[:case_value] = value
+    end
+
+    ad_group_criterion = {}
+    if bid_amount && bid_amount > 0
+      bidding_strategy_configuration = {
+        :bids => [{
+          :xsi_type => 'CpcBid',
+          :bid => {
+            :xsi_type => 'Money',
+            :micro_amount => bid_amount
+          }
+        }]
+      }
+      ad_group_criterion[:xsi_type] = 'BiddableAdGroupCriterion'
+      ad_group_criterion[:bidding_strategy_configuration] =
+          bidding_strategy_configuration
+    else
+      ad_group_criterion[:xsi_type] = 'NegativeAdGroupCriterion'
+    end
+    ad_group_criterion[:ad_group_id] = @ad_group_id
+    ad_group_criterion[:criterion] = unit
+
+    create_add_operation(ad_group_criterion)
+
+    return unit
+  end
+
+  private
+
+  def create_add_operation(ad_group_criterion)
+    operation = {
+      :operator => 'ADD',
+      :operand => ad_group_criterion
+    }
+
+    @operations << operation
+  end
+end
+
+def display_tree(node, children, level = 0)
+  value = ''
+  type = ''
+
+  if node[:case_value]
+    type = node[:case_value][:product_dimension_type]
+
+    value = case type
+    when 'ProductCanonicalCondition'
+      node[:case_value][:condition]
+    when 'ProductBiddingCategory'
+      "%s(%s)" % [node[:case_value][:type], node[:case_value][:value]]
+    else
+      node[:case_value][:value]
+    end
+  end
+
+  puts "%sid: %s, type: %s, value: %s" %
+      [' ' * level, node[:id], type, value]
+
+  children[node[:id]].each do |child_node|
+    display_tree(child_node, children, level + 1)
+  end
+end
+
+def add_product_partition_tree(ad_group_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')
+
+  ad_group_criterion_srv =
+      adwords.service(:AdGroupCriterionService, API_VERSION)
+
+  helper = ProductPartitionHelper.new(ad_group_id)
+
+  root = helper.create_subdivision()
+
+  new_product_canonical_condition = {
+    :xsi_type => 'ProductCanonicalCondition',
+    :condition => 'NEW'
+  }
+
+  used_product_canonical_condition = {
+    :xsi_type => 'ProductCanonicalCondition',
+    :condition => 'USED'
+  }
+
+  other_product_canonical_condition = {
+    :xsi_type => 'ProductCanonicalCondition'
+  }
+
+  helper.create_unit(root, new_product_canonical_condition, 200000)
+  helper.create_unit(root, used_product_canonical_condition, 100000)
+  other_condition =
+      helper.create_subdivision(root, other_product_canonical_condition)
+
+  cool_product_brand = {
+    :xsi_type => 'ProductBrand',
+    :value => 'CoolBrand'
+  }
+
+  cheap_product_brand = {
+    :xsi_type => 'ProductBrand',
+    :value => 'CheapBrand'
+  }
+
+  other_product_brand = {
+    :xsi_type => 'ProductBrand'
+  }
+
+  helper.create_unit(other_condition, cool_product_brand, 900000)
+  helper.create_unit(other_condition, cheap_product_brand, 10000)
+  other_brand = helper.create_subdivision(other_condition, other_product_brand)
+
+  # The value for the bidding category is a fixed ID for the 'Luggage & Bags'
+  # category. You can retrieve IDs for categories from the ConstantDataService.
+  # See the get_product_taxonomy example for more details.
+  luggage_category = {
+    :xsi_type => 'ProductBiddingCategory',
+    :type => 'BIDDING_CATEGORY_L1',
+    :value => '-5914235892932915235'
+  }
+
+  generic_category = {
+    :xsi_type => 'ProductBiddingCategory',
+    :type => 'BIDDING_CATEGORY_L1'
+  }
+
+  helper.create_unit(other_brand, luggage_category, 750000)
+  helper.create_unit(other_brand, generic_category, 110000)
+
+  # Make the mutate request.
+  result = ad_group_criterion_srv.mutate(helper.operations)
+
+  children = {}
+  root_node = nil
+  # For each criterion, make an array containing each of its children.
+  # We always create the parent before the child, so we can rely on that here.
+  result[:value].each do |criterion|
+    children[criterion[:criterion][:id]] = []
+
+    if criterion[:criterion][:parent_criterion_id]
+      children[criterion[:criterion][:parent_criterion_id]] <<
+          criterion[:criterion]
+    else
+      root_node = criterion[:criterion]
+    end
+  end
+
+  display_tree(root_node, children)
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201506
+
+  begin
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+
+    add_product_partition_tree(ad_group_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