google-adwords-api 0.1.2 → 0.2.0

data/examples/v201101/get_bulk_mutate_job.rb

@@ -32,6 +32,11 @@ def get_all_bulk_mutate_jobs()
   # 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')
+
   bulk_mutate_job_srv = adwords.service(:BulkMutateJobService, API_VERSION)
 
   # Replace with valid values of your account.
@@ -72,11 +77,6 @@ def get_all_bulk_mutate_jobs()
 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_bulk_mutate_jobs()
 

data/examples/v201101/get_campaign_alerts.rb

@@ -32,6 +32,11 @@ def get_campaign_alerts()
   # 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')
+
   alert_srv = adwords.service(:AlertService, API_VERSION)
 
   # Create the selector.
@@ -69,11 +74,6 @@ def get_campaign_alerts()
 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_campaign_alerts()
 

data/examples/v201101/get_conversion_optimizer_eligibility.rb

@@ -33,6 +33,11 @@ def get_conversion_optimizer_eligibility()
   # 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
@@ -68,11 +73,6 @@ def get_conversion_optimizer_eligibility()
 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_conversion_optimizer_eligibility()
 

data/examples/v201101/get_criterion_bid_landscape.rb

@@ -32,6 +32,11 @@ def get_criterion_bid_landscapes()
   # 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')
+
   data_srv = adwords.service(:DataService, API_VERSION)
 
   ad_group_id = 'INSERT_ADGROUP_ID_HERE'.to_i
@@ -68,11 +73,6 @@ def get_criterion_bid_landscapes()
 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_criterion_bid_landscapes()
 

data/examples/v201101/get_geo_location_info.rb

@@ -32,6 +32,11 @@ def get_geo_location_info()
   # 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')
+
   geo_location_srv = adwords.service(:GeoLocationService, API_VERSION)
 
   selector = {
@@ -74,11 +79,6 @@ def get_geo_location_info()
 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_geo_location_info()
 

data/examples/v201101/get_keyword_opportunities.rb

@@ -32,6 +32,11 @@ def get_keyword_opportunities()
   # 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')
+
   bulk_opportunity_srv = adwords.service(:BulkOpportunityService, API_VERSION)
 
   # Construct selector object.
@@ -69,11 +74,6 @@ def get_keyword_opportunities()
 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_keyword_opportunities()
 

data/examples/v201101/get_method_cost.rb

@@ -32,6 +32,11 @@ def get_method_cost()
   # 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')
+
   info_srv = adwords.service(:InfoService, API_VERSION)
 
   date = Time.now
@@ -62,11 +67,6 @@ def get_method_cost()
 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_method_cost()
 

data/examples/v201101/get_operation_count.rb

@@ -32,6 +32,11 @@ def get_operation_count()
   # 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')
+
   info_srv = adwords.service(:InfoService, API_VERSION)
 
   selector = {
@@ -54,11 +59,6 @@ def get_operation_count()
 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_operation_count()
 

data/examples/v201101/get_related_keywords.rb

@@ -26,15 +26,20 @@ gem 'google-adwords-api'
 require 'adwords_api'
 
 API_VERSION = :v201101
+PAGE_SIZE = 100
 
 def get_related_keywords()
   # 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')
+
   targeting_idea_srv = adwords.service(:TargetingIdeaService, API_VERSION)
 
-  results_per_page = 10
-  keyword_text = 'space cruise'
+  keyword_text = 'INSERT_KEYWORD_TEXT_HERE'
 
   # Construct selector object.
   selector = {
@@ -53,39 +58,35 @@ def get_related_keywords()
     }],
     :paging => {
       :start_index => 0,
-      :number_results => results_per_page
+      :number_results => PAGE_SIZE
     }
   }
 
-  # Perform request.
+  # Define initial values.
+  offset = 0
   results = []
-  index = 0
-  while true
+
+  begin
+    # Perform request.
     page = targeting_idea_srv.get(selector)
-    if page and page[:entries]
-      results += page[:entries]
-    end
-    break if page[:total_num_entries] <= index
-    index += results_per_page
-    selector[:paging][:start_index] = index
-  end
+    results += page[:entries] if page and page[:entries]
+
+    # Prepare next page request.
+    offset += PAGE_SIZE
+    selector[:paging][:start_index] = offset
+  end while offset < page[:total_num_entries]
 
   # Display results.
   results.each do |result|
     data = AdwordsApi::Utils.map(result[:data])
     keyword = data['CRITERION'][:value]
-    puts " Found keyword with text \"%s\" and match type \"%s\"" %
+    puts "Found keyword with text \"%s\" and match type \"%s\"" %
         [keyword[:text], keyword[:match_type]]
   end
   puts "Total keywords related to \"%s\": %d." % [keyword_text, results.length]
 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_related_keywords()
 

data/examples/v201101/get_related_placements.rb

@@ -27,15 +27,20 @@ gem 'google-adwords-api'
 require 'adwords_api'
 
 API_VERSION = :v201101
+PAGE_SIZE = 100
 
 def get_related_placements()
   # 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')
+
   targeting_idea_srv = adwords.service(:TargetingIdeaService, API_VERSION)
 
-  results_per_page = 10
-  url = 'mars.google.com'
+  url = 'INSERT_PLACEMENT_URL_HERE'
 
   # Construct selector.
   selector = {
@@ -52,39 +57,35 @@ def get_related_placements()
     }],
     :paging => {
       :start_index => 0,
-      :number_results => results_per_page
+      :number_results => PAGE_SIZE
     }
   }
 
-  # Perform request.
+  # Define initial values.
+  offset = 0
   results = []
-  index = 0
-  while true
+
+  begin
+    # Perform request.
     page = targeting_idea_srv.get(selector)
-    if page and page[:entries]
-      results += page[:entries]
-    end
-    break if page[:total_num_entries] <= index
-    index += results_per_page
-    selector[:paging][:start_index] = index
-  end
+    results += page[:entries] if page and page[:entries]
+
+    # Prepare next page request.
+    offset += PAGE_SIZE
+    selector[:paging][:start_index] = offset
+  end while offset < page[:total_num_entries]
 
   # Display results.
   results.each do |result|
     data = AdwordsApi::Utils.map(result[:data])
     placement = data['CRITERION'][:value]
-    puts " Related content keywords found at URL \"%s\"" % placement[:url]
+    puts "Related content keywords found at URL [%s]" % placement[:url]
   end
-  puts "Total urls found with content keywords related to keywords at " +
-      " \"#{url}\": #{results.length}."
+  puts "Total URLs found with keywords related to keywords at [%s]: %d." %
+      [url, results.length]
 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_related_placements()
 

data/examples/v201101/get_report_fields.rb

@@ -31,6 +31,11 @@ def get_report_fields()
   # 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)
 
   report_type = 'INSERT_REPORT_TYPE_HERE'
@@ -47,11 +52,6 @@ def get_report_fields()
 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_report_fields()
 

data/examples/v201101/get_total_usage_units_per_month.rb

@@ -32,6 +32,11 @@ def get_total_usage_units_per_month()
   # 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')
+
   info_srv = adwords.service(:InfoService, API_VERSION)
 
   selector = {
@@ -49,11 +54,6 @@ def get_total_usage_units_per_month()
 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_total_usage_units_per_month()
 

data/examples/v201101/get_traffic_estimates.rb

@@ -32,6 +32,11 @@ def get_traffic_estimates()
   # 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')
+
   traffic_estimator_srv = adwords.service(:TrafficEstimatorService, API_VERSION)
 
   # Create keywords. Up to 2000 keywords can be passed in a single request.
@@ -123,11 +128,6 @@ def get_traffic_estimates()
 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_traffic_estimates()
 

data/examples/v201101/get_unit_count.rb

@@ -32,6 +32,11 @@ def get_unit_count()
   # 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')
+
   info_srv = adwords.service(:InfoService, API_VERSION)
 
   selector = {
@@ -54,11 +59,6 @@ def get_unit_count()
 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_unit_count()