google-adwords-api 0.1.2 → 0.2.0

data/ChangeLog

@@ -1,3 +1,8 @@
+0.2.0:
+  - Better support for UTF reports in download extensions.
+  - Require google-ads-common 0.4.0 or later from now on.
+  - Consolidated log output to single Logger, see README.
+
 0.1.2:
   - Support for cross-client MCC reports.
   - Documented library use for DoubleClick Ad Exchange Buyer API.

data/README

@@ -30,7 +30,7 @@ which is installed automatically as a dependency.
 The following gem libraries are required:
 - soap4r v1.5.8
 - httpclient v2.1.2 or greater
-- google-ads-common v0.2.1 or later.
+- google-ads-common v0.4.0 or later.
 
 
 == 2 - Using the client library:
@@ -63,11 +63,11 @@ You can also pass API a manually constructed config hash like:
          :developer_token => 'DEVELOPER_TOKEN',
          :user_agent => 'Ruby Sample',
          :password => 'PASSWORD',
-         :email => 'user@domain.com'
+         :email => 'user@domain.com',
          :client_email => 'user2@domain.com'
      },
      :service => {
-       :environment => 'Production'
+       :environment => 'PRODUCTION'
      }
    })
 
@@ -119,7 +119,7 @@ Disabling Ruby names is an experimental feature, and it is not recommended.
 In order to use the sandbox, make sure that the 'environment' parameter under
 'service' in the configuration is set to Sandbox.
    config[:service] = {
-     :environment => 'Sandbox'
+     :environment => 'SANDBOX'
    }
 
 
@@ -127,29 +127,26 @@ In order to use the sandbox, make sure that the 'environment' parameter under
 
 It is often useful to see a trace of the raw SOAP XML being sent and received.
 The quickest way of achieving this when debugging your application is by setting
-the ADWORDSAPI_DEBUG environment variable to TRUE; e.g. in the bash shell:
-   $ export ADWORDSAPI_DEBUG=true
-or from your Ruby code:
-   ENV['ADWORDSAPI_DEBUG'] = 'true'
+the library.log_level configuration variable to 'DEBUG':
+   config[:library] = {
+     :log_level => 'DEBUG'
+   }
+or via configuration file (see example).
 
 This will output the SOAP XML to stderr, which will usually show up in your
 terminal window.
 
-There's also the option of logging requests and XML to files. In order to enable
-this, you should use the log_to_file method of the loggers inside your
-AdwordsApi::Api object:
+There's also an option of logging requests and XML to a file. In order to enable
+this, you should create a standard Logger object and pass it to the library:
+   require 'logger'
+   logger = Logger.new('path/to/log_filename')
+   logger.level = Logger::DEBUG
    adwords = AdwordsApi::Api.new
-   adwords.request_logger.log_to_file
-   adwords.xml_logger.log_to_file
-
-The first logs the units spent and the requests made, whereas the second logs
-the full SOAP XML being sent and received over the wire. These will be written
-to the current directory by default, but you can specify another directory as an
-optional parameter to log_to_file:
-   adwords.request_logger.log_to_file('/var/log/my_app/')
-   adwords.xml_logger.log_to_file('/var/log/my_app/')
+   adwords.logger = logger
 
-The files will be named request_info and soap_xml, respectively.
+Request details and units spend are logged at the INFO log level, while raw HTTP
+headers and XML dumps are logged at the DEBUG log level. For more details on
+using Logger refer to the Ruby Logger documentation.
 
 
 = Docs for Developers

data/Rakefile

@@ -36,7 +36,7 @@ $GEM_NAME = 'google-adwords-api'
 $API_NAME = 'AdWords API'
 $CURRENT_VERSION = AdwordsApi::ApiConfig::CLIENT_LIB_VERSION
 $PRODDIR = 'adwords_api'
-$ADS_COMMON_VERSION = '~> 0.2.1'
+$ADS_COMMON_VERSION = '~> 0.4.0'
 
 # Configure module / namespace
 $MODULE = AdwordsApi

data/adwords_api.yml

@@ -18,3 +18,5 @@
   # If your proxy connection requires authentication, make sure to include it in
   # the URL, e.g.: http://user:password@proxy_hostname:8080/path
   # :proxy: INSERT_PROXY_HERE
+:library:
+  :log_level: INFO

data/examples/v200909/add_ad_extension_override.rb

@@ -33,6 +33,11 @@ def add_ad_extension_override()
   # 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_ext_override_srv =
       adwords.service(:AdExtensionOverrideService, API_VERSION)
 
@@ -57,11 +62,6 @@ def add_ad_extension_override()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     add_ad_extension_override()
 

data/examples/v200909/add_ad_group.rb

@@ -32,6 +32,11 @@ def add_ad_group()
   # 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_srv = adwords.service(:AdGroupService, API_VERSION)
 
   campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
@@ -64,11 +69,6 @@ def add_ad_group()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     add_ad_group()
 

data/examples/v200909/add_ad_group_criteria.rb

@@ -32,8 +32,13 @@ def add_ad_group_criteria()
   # 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)
+  adwords.service(:AdGroupCriterionService, API_VERSION)
 
   ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
 
@@ -83,11 +88,6 @@ def add_ad_group_criteria()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     add_ad_group_criteria()
 

data/examples/v200909/add_ads.rb

@@ -33,6 +33,11 @@ def add_ads()
   # 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_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
 
   ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
@@ -57,7 +62,8 @@ def add_ads()
   }
 
   # Retrieve image and encode it.
-  image_url = 'https://sandbox.google.com/sandboximages/image.jpg'
+  image_url =
+      'http://www.google.com/intl/en/adwords/select/images/samples/inline.jpg'
   # This utility method retrieves the contents of a URL using all of the config
   # options provided to the Api object.
   image_data = AdsCommon::Http.get(image_url, adwords.config)
@@ -95,11 +101,6 @@ def add_ads()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     add_ads()
 

data/examples/v200909/add_campaign.rb

@@ -31,6 +31,11 @@ def add_campaign()
   # 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 for adding campaign.
@@ -67,11 +72,6 @@ def add_campaign()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     add_campaign()
 

data/examples/v200909/add_campaign_ad_extension.rb

@@ -32,6 +32,11 @@ def add_campaign_ad_extension()
   # 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_ad_ext_srv =
       adwords.service(:CampaignAdExtensionService, API_VERSION)
   geo_location_srv = adwords.service(:GeoLocationService, API_VERSION)
@@ -96,11 +101,6 @@ def add_campaign_ad_extension()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     add_campaign_ad_extension()
 

data/examples/v200909/add_negative_campaign_criterion.rb

@@ -32,6 +32,11 @@ def add_negative_campaign_criterion()
   # 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_criterion_srv =
       adwords.service(:CampaignCriterionService, API_VERSION)
 
@@ -62,11 +67,6 @@ def add_negative_campaign_criterion()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     add_negative_campaign_criterion()
 

data/examples/v200909/check_campaigns.rb

@@ -32,6 +32,11 @@ def check_campaigns()
   # 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)
 
   # Enable 'validate only'
@@ -98,11 +103,6 @@ def check_campaigns()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     check_campaigns()
 

data/examples/v200909/delete_ad.rb

@@ -32,6 +32,11 @@ def delete_ad()
   # 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_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
 
   ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
@@ -60,11 +65,6 @@ def delete_ad()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     delete_ad()
 

data/examples/v200909/delete_ad_group.rb

@@ -32,6 +32,11 @@ def delete_ad_group()
   # 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_srv = adwords.service(:AdGroupService, API_VERSION)
 
   ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
@@ -52,11 +57,6 @@ def delete_ad_group()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     delete_ad_group()
 

data/examples/v200909/delete_ad_group_criterion.rb

@@ -32,6 +32,11 @@ def delete_ad_group_criterion()
   # 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)
 
@@ -61,11 +66,6 @@ def delete_ad_group_criterion()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     delete_ad_group_criterion()
 

data/examples/v200909/delete_campaign.rb

@@ -32,6 +32,11 @@ def delete_campaign()
   # 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)
 
   campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
@@ -53,11 +58,6 @@ def delete_campaign()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     delete_campaign()
 

data/examples/v200909/get_all_active_ad_group_criteria.rb

@@ -32,6 +32,11 @@ def get_all_active_ad_group_criteria()
   # 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)
 
@@ -59,11 +64,6 @@ def get_all_active_ad_group_criteria()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     get_all_active_ad_group_criteria()
 

data/examples/v200909/get_all_ad_extension_overrides.rb

@@ -33,6 +33,11 @@ def get_all_ad_extension_overrides()
   # 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_ext_override_srv =
       adwords.service(:AdExtensionOverrideService, API_VERSION)
 
@@ -57,11 +62,6 @@ def get_all_ad_extension_overrides()
 end
 
 if __FILE__ == $0
-  # To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
-  # variable to 'true'. This can be done either from your operating system
-  # environment or via code, as done below.
-  ENV['ADWORDSAPI_DEBUG'] = 'false'
-
   begin
     get_all_ad_extension_overrides()