google-adwords-api 0.18.1 → 0.18.3

data/lib/adwords_api/batch_job_utils.rb

@@ -114,6 +114,7 @@ module AdwordsApi
     def put_incremental_operations(
         operations, batch_job_url, total_content_length = 0,
         is_last_request = false)
+      @api.utils_reporter.batch_job_utils_used()
       headers = DEFAULT_HEADERS
       soap_operations = generate_soap_operations(operations)
       request_body = soap_operations.join
@@ -163,6 +164,7 @@ module AdwordsApi
     # - the results of the batch job, as a ruby hash, or nil if none yet exist
     #
     def get_job_results(batch_job_url)
+      @api.utils_reporter.batch_job_utils_used()
       xml_response = AdsCommon::Http.get_response(batch_job_url, @api.config)
       begin
         return sanitize_result(

data/lib/adwords_api/report_utils.rb

@@ -194,7 +194,7 @@ module AdwordsApi
     # specification.
     REPORT_DEFINITION_ORDER = {
       :root => [:selector, :report_name, :report_type, :date_range_type,
-          :download_format, :include_zero_impressions],
+          :download_format],
       :selector => [:fields, :predicates, :date_range, :ordering, :paging],
       :predicates => [:field, :operator, :values],
       :ordering => [:field, :sort_order],
@@ -218,6 +218,7 @@ module AdwordsApi
 
     # Makes request and AdHoc service and returns response.
     def make_adhoc_request(data, cid, &block)
+      @api.utils_reporter.report_utils_used()
       url = @api.api_config.adhoc_report_download_url(
           @api.config.read('service.environment'), @version)
       headers = get_report_request_headers(url, cid)

data/lib/adwords_api/utils_reporter.rb

@@ -0,0 +1,46 @@
+# Encoding: utf-8
+#
+# Copyright:: Copyright 2016, 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.
+#
+# Contains methods to help configure the user agent string to report on utility
+# usage.
+
+require 'adwords_api/credential_handler'
+
+module AdwordsApi
+  class UtilsReporter
+    # Default constructor.
+    #
+    # Args:
+    # - credential_handler: The CredentialHandler being used by the current
+    # AdwordsApi instance.
+    def initialize(credential_handler)
+      @credential_handler = credential_handler
+    end
+
+    # A callback method from report utils to indicate that it has been used,
+    # and that its usage should be recorded in the next user agent string.
+    def report_utils_used()
+      @credential_handler.include_in_user_agent("ReportDownloader")
+    end
+
+    # A callback method from batch job utils to indicate that it has been used,
+    # and that its usage should be recorded in the next user agent string.
+    def batch_job_utils_used()
+      @credential_handler.include_in_user_agent("BatchJobHelper")
+    end
+  end
+end