RubyGems - google-adwords-api - Versions diffs - 0.6.2 → 0.6.3 - Mend

google-adwords-api 0.6.2 → 0.6.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (247) hide show

data/lib/adwords_api/report_utils.rb CHANGED

@@ -77,6 +77,43 @@ module AdwordsApi
       return nil
     end
+    # Downloads and returns a report with AWQL.
+    #
+    # Args:
+    # - report_query: query for the report as string
+    # - format: format for the report as string
+    # - cid: optional customer ID to run report against
+    #
+    # Returns:
+    # - report body
+    #
+    # Raises:
+    # - AdwordsApi::Errors::ReportError if a server-side error has occurred
+    #
+    def download_report_with_awql(report_query, format, cid = nil)
+      return get_report_response_with_awql(report_query, format, cid).body
+    end
+    # Downloads a report with AWQL and saves it to a file.
+    #
+    # Args:
+    # - report_query: query for the report as string
+    # - format: format for the report as string
+    # - path: path to save report to
+    # - cid: optional customer ID to run report against
+    #
+    # Returns:
+    # - nil
+    #
+    # Raises:
+    # - AdwordsApi::Errors::ReportError if server-side error occurred
+    #
+    def download_report_as_file_with_awql(report_query, format, path, cid = nil)
+      report_body = download_report_with_awql(report_query, format, cid)
+      save_to_file(report_body, path)
+      return nil
+    end
     private
     # Minimal set of required fields for report definition.
@@ -98,10 +135,22 @@ module AdwordsApi
     def get_report_response(report_definition, cid)
       definition_text = get_report_definition_text(report_definition)
       data = '__rdxml=%s' % CGI.escape(definition_text)
+      return make_adhoc_request(data, cid)
+    end
+    # Send POST request for a report with AWQL and returns Response object.
+    def get_report_response_with_awql(report_query, format, cid)
+      data = '__rdquery=%s&__fmt=%s' %
+          [CGI.escape(report_query), CGI.escape(format)]
+      return make_adhoc_request(data, cid)
+    end
+    # Makes request and AdHoc service and returns response.
+    def make_adhoc_request(data, cid)
       url = @api.api_config.adhoc_report_download_url(
           @api.config.read('service.environment'), @version)
       headers = get_report_request_headers(url, cid)
-      log_request(url, headers, definition_text)
+      log_request(url, headers, data)
       response = AdsCommon::Http.post_response(url, data, @api.config, headers)
       check_for_errors(response)
       return response

data/lib/adwords_api/v201109/ad_extension_override_service.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:41.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:22:17.
 require 'ads_common/savon_service'
 require 'adwords_api/v201109/ad_extension_override_service_registry'

data/lib/adwords_api/v201109/ad_extension_override_service_registry.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:41.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:22:17.
 require 'adwords_api/errors'

data/lib/adwords_api/v201109/ad_group_ad_service.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:42.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:22:21.
 require 'ads_common/savon_service'
 require 'adwords_api/v201109/ad_group_ad_service_registry'

data/lib/adwords_api/v201109/ad_group_ad_service_registry.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:42.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:22:21.
 require 'adwords_api/errors'

data/lib/adwords_api/v201109/ad_group_criterion_service.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:44.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:22:25.
 require 'ads_common/savon_service'
 require 'adwords_api/v201109/ad_group_criterion_service_registry'

data/lib/adwords_api/v201109/ad_group_criterion_service_registry.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:44.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:22:25.
 require 'adwords_api/errors'

data/lib/adwords_api/v201109/ad_group_service.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:45.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:22:35.
 require 'ads_common/savon_service'
 require 'adwords_api/v201109/ad_group_service_registry'

data/lib/adwords_api/v201109/ad_group_service_registry.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:45.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:22:35.
 require 'adwords_api/errors'

data/lib/adwords_api/v201109/ad_param_service.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:46.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:22:38.
 require 'ads_common/savon_service'
 require 'adwords_api/v201109/ad_param_service_registry'

data/lib/adwords_api/v201109/ad_param_service_registry.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:46.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:22:38.
 require 'adwords_api/errors'

data/lib/adwords_api/v201109/alert_service.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:47.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:22:40.
 require 'ads_common/savon_service'
 require 'adwords_api/v201109/alert_service_registry'

data/lib/adwords_api/v201109/alert_service_registry.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:47.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:22:40.
 require 'adwords_api/errors'

data/lib/adwords_api/v201109/budget_order_service.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:48.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:22:43.
 require 'ads_common/savon_service'
 require 'adwords_api/v201109/budget_order_service_registry'

data/lib/adwords_api/v201109/budget_order_service_registry.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:48.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:22:43.
 require 'adwords_api/errors'

data/lib/adwords_api/v201109/bulk_mutate_job_service.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:50.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:22:49.
 require 'ads_common/savon_service'
 require 'adwords_api/v201109/bulk_mutate_job_service_registry'

data/lib/adwords_api/v201109/bulk_mutate_job_service_registry.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:50.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:22:49.
 require 'adwords_api/errors'

data/lib/adwords_api/v201109/campaign_ad_extension_service.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:53.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:22:55.
 require 'ads_common/savon_service'
 require 'adwords_api/v201109/campaign_ad_extension_service_registry'

data/lib/adwords_api/v201109/campaign_ad_extension_service_registry.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:53.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:22:55.
 require 'adwords_api/errors'

data/lib/adwords_api/v201109/campaign_criterion_service.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:55.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:22:58.
 require 'ads_common/savon_service'
 require 'adwords_api/v201109/campaign_criterion_service_registry'

data/lib/adwords_api/v201109/campaign_criterion_service_registry.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:55.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:22:58.
 require 'adwords_api/errors'

data/lib/adwords_api/v201109/campaign_service.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:56.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:23:02.
 require 'ads_common/savon_service'
 require 'adwords_api/v201109/campaign_service_registry'

data/lib/adwords_api/v201109/campaign_service_registry.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:57.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:23:02.
 require 'adwords_api/errors'

data/lib/adwords_api/v201109/campaign_target_service.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:58.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:23:05.
 require 'ads_common/savon_service'
 require 'adwords_api/v201109/campaign_target_service_registry'

data/lib/adwords_api/v201109/campaign_target_service_registry.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:58.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:23:05.
 require 'adwords_api/errors'

data/lib/adwords_api/v201109/constant_data_service.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:59.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:23:08.
 require 'ads_common/savon_service'
 require 'adwords_api/v201109/constant_data_service_registry'

data/lib/adwords_api/v201109/constant_data_service_registry.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:33:59.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:23:08.
 require 'adwords_api/errors'

data/lib/adwords_api/v201109/conversion_tracker_service.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:34:00.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:23:11.
 require 'ads_common/savon_service'
 require 'adwords_api/v201109/conversion_tracker_service_registry'

data/lib/adwords_api/v201109/conversion_tracker_service_registry.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:34:00.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:23:11.
 require 'adwords_api/errors'

data/lib/adwords_api/v201109/create_account_service.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:34:01.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:23:13.
 require 'ads_common/savon_service'
 require 'adwords_api/v201109/create_account_service_registry'

data/lib/adwords_api/v201109/create_account_service_registry.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:34:01.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:23:13.
 require 'adwords_api/errors'

data/lib/adwords_api/v201109/customer_sync_service.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:34:01.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:23:15.
 require 'ads_common/savon_service'
 require 'adwords_api/v201109/customer_sync_service_registry'

data/lib/adwords_api/v201109/customer_sync_service_registry.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:34:01.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:23:15.
 require 'adwords_api/errors'

data/lib/adwords_api/v201109/data_service.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:34:02.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:23:17.
 require 'ads_common/savon_service'
 require 'adwords_api/v201109/data_service_registry'

data/lib/adwords_api/v201109/data_service_registry.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:34:02.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:23:17.
 require 'adwords_api/errors'

data/lib/adwords_api/v201109/experiment_service.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:34:03.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:23:20.
 require 'ads_common/savon_service'
 require 'adwords_api/v201109/experiment_service_registry'

data/lib/adwords_api/v201109/experiment_service_registry.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:34:03.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:23:20.
 require 'adwords_api/errors'

data/lib/adwords_api/v201109/geo_location_service.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:34:03.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:23:23.
 require 'ads_common/savon_service'
 require 'adwords_api/v201109/geo_location_service_registry'

data/lib/adwords_api/v201109/geo_location_service_registry.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:34:03.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:23:23.
 require 'adwords_api/errors'

data/lib/adwords_api/v201109/info_service.rb CHANGED

@@ -5,7 +5,7 @@
 # Copyright:: Copyright 2012, Google Inc. All Rights Reserved.
 # License:: Licensed under the Apache License, Version 2.0.
 #
-# Code generated by AdsCommon library 0.7.1 on 2012-06-05 17:34:04.
+# Code generated by AdsCommon library 0.7.3 on 2012-07-04 07:23:26.
 require 'ads_common/savon_service'
 require 'adwords_api/v201109/info_service_registry'