google-adwords-api 0.6.3 → 0.7.0

data/ChangeLog

@@ -1,3 +1,7 @@
+0.7.0:
+  - MapEntry structures are returned as Hashes now (#26).
+  - Require google-ads-common 0.8.0 or later from now on.
+
 0.6.3:
   - Support and examples for v201206.
 

data/examples/v201109/misc/get_all_images_and_videos.rb

@@ -25,7 +25,6 @@
 # Tags: MediaService.get
 
 require 'adwords_api'
-require 'adwords_api/utils'
 
 def get_all_images_and_videos()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
@@ -60,10 +59,10 @@ def get_all_images_and_videos()
     page = media_srv.get(selector)
     if page[:entries]
       page[:entries].each do |entry|
-        dimensions = AdwordsApi::Utils.map(entry[:dimensions])
+        full_dimensions = entry[:dimensions]['FULL']
         puts "Entry ID %d with dimensions %dx%d and MIME type is '%s'" %
-            [entry[:media_id], dimensions['FULL'][:height],
-             dimensions['FULL'][:width], entry[:mime_type]]
+            [entry[:media_id], full_dimensions[:height],
+             full_dimensions[:width], entry[:mime_type]]
       end
       # Increment values to request the next page.
       offset += PAGE_SIZE

data/examples/v201109/misc/upload_image.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
@@ -23,7 +23,6 @@
 # Tags: MediaService.upload
 
 require 'adwords_api'
-require 'adwords_api/utils'
 require 'base64'
 
 def upload_image()
@@ -57,12 +56,12 @@ def upload_image()
   response = media_srv.upload([image])
   if response and !response.empty?
     ret_image = response.first
-    dimensions = AdwordsApi::Utils.map(ret_image[:dimensions])
-    puts "Image with id #{ret_image[:media_id]}, dimensions " +
-        "#{dimensions['FULL'][:height]}x#{dimensions['FULL'][:width]} " +
-        "and MIME type \"#{ret_image[:mime_type]}\" uploaded successfully."
+    full_dimensions = ret_image[:dimensions]['FULL']
+    puts ("Image with ID %d, dimensions %dx%d and MIME type '%s' uploaded " +
+        "successfully.") % [ret_image[:media_id], full_dimensions[:height],
+         full_dimensions[:width], ret_image[:mime_type]]
   else
-    puts "No images uploaded."
+    puts 'No images uploaded.'
   end
 end
 

data/examples/v201109/optimization/get_keyword_ideas.rb

@@ -23,7 +23,6 @@
 # Tags: TargetingIdeaService.get
 
 require 'adwords_api'
-require 'adwords_api/utils'
 
 def get_keyword_ideas(keyword_text)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
@@ -73,7 +72,7 @@ def get_keyword_ideas(keyword_text)
 
   # Display results.
   results.each do |result|
-    data = AdwordsApi::Utils.map(result[:data])
+    data = result[:data]
     keyword = data['CRITERION'][:value]
     puts "Found keyword with text '%s' and match type '%s'" %
         [keyword[:text], keyword[:match_type]]

data/examples/v201109/optimization/get_placement_ideas.rb

@@ -24,7 +24,6 @@
 # Tags: TargetingIdeaService.get
 
 require 'adwords_api'
-require 'adwords_api/utils'
 
 def get_placement_ideas(url)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
@@ -72,8 +71,7 @@ def get_placement_ideas(url)
 
   # Display results.
   results.each do |result|
-    data = AdwordsApi::Utils.map(result[:data])
-    placement = data['CRITERION'][:value]
+    placement = result[:data]['CRITERION'][:value]
     puts "Related placement found at URL [%s]" % placement[:url]
   end
   puts "Total URLs found with keywords related to keywords at [%s]: %d." %

data/examples/v201109_1/misc/get_all_images_and_videos.rb

@@ -25,7 +25,6 @@
 # Tags: MediaService.get
 
 require 'adwords_api'
-require 'adwords_api/utils'
 
 def get_all_images_and_videos()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
@@ -60,10 +59,10 @@ def get_all_images_and_videos()
     page = media_srv.get(selector)
     if page[:entries]
       page[:entries].each do |entry|
-        dimensions = AdwordsApi::Utils.map(entry[:dimensions])
+        full_dimensions = entry[:dimensions]['FULL']
         puts "Entry ID %d with dimensions %dx%d and MIME type is '%s'" %
-            [entry[:media_id], dimensions['FULL'][:height],
-             dimensions['FULL'][:width], entry[:mime_type]]
+            [entry[:media_id], full_dimensions[:height],
+             full_dimensions[:width], entry[:mime_type]]
       end
       # Increment values to request the next page.
       offset += PAGE_SIZE

data/examples/v201109_1/misc/upload_image.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
@@ -23,7 +23,6 @@
 # Tags: MediaService.upload
 
 require 'adwords_api'
-require 'adwords_api/utils'
 require 'base64'
 
 def upload_image()
@@ -57,12 +56,12 @@ def upload_image()
   response = media_srv.upload([image])
   if response and !response.empty?
     ret_image = response.first
-    dimensions = AdwordsApi::Utils.map(ret_image[:dimensions])
-    puts "Image with id #{ret_image[:media_id]}, dimensions " +
-        "#{dimensions['FULL'][:height]}x#{dimensions['FULL'][:width]} " +
-        "and MIME type \"#{ret_image[:mime_type]}\" uploaded successfully."
+    full_dimensions = ret_image[:dimensions]['FULL']
+    puts ("Image with ID %d, dimensions %dx%d and MIME type '%s' uploaded " +
+        "successfully.") % [ret_image[:media_id], full_dimensions[:height],
+         full_dimensions[:width], ret_image[:mime_type]]
   else
-    puts "No images uploaded."
+    puts 'No images uploaded.'
   end
 end
 

data/examples/v201109_1/optimization/get_keyword_ideas.rb

@@ -23,7 +23,6 @@
 # Tags: TargetingIdeaService.get
 
 require 'adwords_api'
-require 'adwords_api/utils'
 
 def get_keyword_ideas(keyword_text)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
@@ -74,7 +73,7 @@ def get_keyword_ideas(keyword_text)
 
   # Display results.
   results.each do |result|
-    data = AdwordsApi::Utils.map(result[:data])
+    data = result[:data]
     keyword = data['CRITERION'][:value]
     puts "Found keyword with text '%s' and match type '%s'" %
         [keyword[:text], keyword[:match_type]]

data/examples/v201109_1/optimization/get_placement_ideas.rb

@@ -24,7 +24,6 @@
 # Tags: TargetingIdeaService.get
 
 require 'adwords_api'
-require 'adwords_api/utils'
 
 def get_placement_ideas(url)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
@@ -72,8 +71,7 @@ def get_placement_ideas(url)
 
   # Display results.
   results.each do |result|
-    data = AdwordsApi::Utils.map(result[:data])
-    placement = data['CRITERION'][:value]
+    placement = result[:data]['CRITERION'][:value]
     puts "Related placement found at URL [%s]" % placement[:url]
   end
   puts "Total URLs found with keywords related to keywords at [%s]: %d." %

data/examples/v201206/misc/get_all_images_and_videos.rb

@@ -25,7 +25,6 @@
 # Tags: MediaService.get
 
 require 'adwords_api'
-require 'adwords_api/utils'
 
 def get_all_images_and_videos()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
@@ -60,10 +59,10 @@ def get_all_images_and_videos()
     page = media_srv.get(selector)
     if page[:entries]
       page[:entries].each do |entry|
-        dimensions = AdwordsApi::Utils.map(entry[:dimensions])
+        full_dimensions = entry[:dimensions]['FULL']
         puts "Entry ID %d with dimensions %dx%d and MIME type is '%s'" %
-            [entry[:media_id], dimensions['FULL'][:height],
-             dimensions['FULL'][:width], entry[:mime_type]]
+            [entry[:media_id], full_dimensions[:height],
+             full_dimensions[:width], entry[:mime_type]]
       end
       # Increment values to request the next page.
       offset += PAGE_SIZE

data/examples/v201206/misc/upload_image.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 # Encoding: utf-8
 #
-# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
 #
 # Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
 #
@@ -23,7 +23,6 @@
 # Tags: MediaService.upload
 
 require 'adwords_api'
-require 'adwords_api/utils'
 require 'base64'
 
 def upload_image()
@@ -57,12 +56,12 @@ def upload_image()
   response = media_srv.upload([image])
   if response and !response.empty?
     ret_image = response.first
-    dimensions = AdwordsApi::Utils.map(ret_image[:dimensions])
-    puts "Image with id #{ret_image[:media_id]}, dimensions " +
-        "#{dimensions['FULL'][:height]}x#{dimensions['FULL'][:width]} " +
-        "and MIME type \"#{ret_image[:mime_type]}\" uploaded successfully."
+    full_dimensions = ret_image[:dimensions]['FULL']
+    puts ("Image with ID %d, dimensions %dx%d and MIME type '%s' uploaded " +
+        "successfully.") % [ret_image[:media_id], full_dimensions[:height],
+         full_dimensions[:width], ret_image[:mime_type]]
   else
-    puts "No images uploaded."
+    puts 'No images uploaded.'
   end
 end
 

data/examples/v201206/optimization/get_keyword_ideas.rb

@@ -23,7 +23,6 @@
 # Tags: TargetingIdeaService.get
 
 require 'adwords_api'
-require 'adwords_api/utils'
 
 def get_keyword_ideas(keyword_text)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
@@ -73,7 +72,7 @@ def get_keyword_ideas(keyword_text)
 
   # Display results.
   results.each do |result|
-    data = AdwordsApi::Utils.map(result[:data])
+    data = result[:data]
     keyword = data['KEYWORD_TEXT'][:value]
     puts "Found keyword with text '%s'" % keyword
     products_and_services = data['CATEGORY_PRODUCTS_AND_SERVICES'][:value]

data/examples/v201206/optimization/get_placement_ideas.rb

@@ -24,7 +24,6 @@
 # Tags: TargetingIdeaService.get
 
 require 'adwords_api'
-require 'adwords_api/utils'
 
 def get_placement_ideas(url)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
@@ -72,8 +71,7 @@ def get_placement_ideas(url)
 
   # Display results.
   results.each do |result|
-    data = AdwordsApi::Utils.map(result[:data])
-    placement = data['CRITERION'][:value]
+    placement = result[:data]['CRITERION'][:value]
     puts "Related placement found at URL [%s]" % placement[:url]
   end
   puts "Total URLs found with keywords related to keywords at [%s]: %d." %

data/examples/v201206/reporting/parallel_report_download.rb

@@ -35,21 +35,21 @@ def parallel_report_download()
   # adwords.logger = Logger.new('adwords_xml.log')
 
   # Determine list of customer IDs to retrieve report for. For this example we
-  # will use ServicedAccountService to get all IDs in hierarchy.
+  # will use ManagedCustomerService to get all IDs in hierarchy.
 
-  serviced_account_srv = adwords.service(:ServicedAccountService, API_VERSION)
+  managed_customer_srv = adwords.service(:ManagedCustomerService, API_VERSION)
 
   # Get the account hierarchy for this account.
-  selector = {:enable_paging => false}
+  selector = {:fields => ['CustomerId']}
 
   # Run the request at the MCC level.
-  graph = adwords.use_mcc() {serviced_account_srv.get(selector)}
+  graph = adwords.use_mcc() {managed_customer_srv.get(selector)}
 
   # Using queue to balance load between threads.
   queue = Queue.new()
 
-  if graph and graph[:accounts] and !graph[:accounts].empty?
-    graph[:accounts].each {|account| queue << account[:customer_id]}
+  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
@@ -76,7 +76,7 @@ def parallel_report_download()
       :include_zero_impressions => false
   }
 
-  puts "Retrieving %d reports with %d threads:" % [queue.size, THREADS]
+  puts 'Retrieving %d reports with %d threads:' % [queue.size, THREADS]
 
   reports_succeeded = Queue.new()
   reports_failed = Queue.new()
@@ -92,7 +92,7 @@ def parallel_report_download()
         cid = queue_mutex.synchronize {(queue.empty?) ? nil : queue.pop(true)}
         if cid
           retry_count = 0
-          file_name = "adgroup_%010d.csv" % cid
+          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]
@@ -105,8 +105,8 @@ def parallel_report_download()
               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])
+              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
@@ -150,10 +150,10 @@ if __FILE__ == $0
 
   # HTTP errors.
   rescue AdsCommon::Errors::HttpError => e
-    puts "HTTP Error: %s" % e
+    puts 'HTTP Error: %s' % e
 
   # API errors.
   rescue AdwordsApi::Errors::ReportError => e
-    puts "Reporting Error: %s" % e.message
+    puts 'Reporting Error: %s' % e.message
   end
 end

data/lib/adwords_api.rb

@@ -54,24 +54,20 @@ module AdwordsApi
     # - auth_handler: instance of an AdsCommon::Auth::BaseHandler subclass to
     #   handle authentication
     # - version: intended API version
-    # - namespace: namespace to use as default for body
+    # - header_ns: header namespace
+    # - default_ns: default namespace
     #
     # Returns:
-    # - a list of SOAP header handlers; one per provided header
+    # - SOAP header handler
     #
-    def soap_header_handler(auth_handler, version, namespace)
+    def soap_header_handler(auth_handler, version, header_ns, default_ns)
       auth_method = @config.read('authentication.method', :CLIENTLOGIN)
-      handler = case auth_method
-        when :CLIENTLOGIN
-          auth_ns = api_config.client_login_config(:AUTH_NAMESPACE_PREAMBLE) +
-              version.to_s
-          AdwordsApi::ClientLoginHeaderHandler.new(
-              @credential_handler, auth_handler, namespace, auth_ns, version)
-        when :OAUTH, :OAUTH2
-          AdsCommon::SavonHeaders::OAuthHeaderHandler.new(
-              @credential_handler, auth_handler, namespace, version)
+      handler_class = case auth_method
+        when :CLIENTLOGIN then AdwordsApi::ClientLoginHeaderHandler
+        when :OAUTH, :OAUTH2 then AdsCommon::SavonHeaders::OAuthHeaderHandler
       end
-      return handler
+      return handler_class.new(@credential_handler, auth_handler, header_ns,
+                                  default_ns, version)
     end
 
     # Helper method to provide a simple way of doing an MCC-level operation

data/lib/adwords_api/api_config.rb

@@ -142,12 +142,14 @@ module AdwordsApi
     @@environment_config = {
       :PRODUCTION => {
         :oauth_scope => 'https://adwords.google.com/api/adwords/',
+        :header_ns => 'https://adwords.google.com/api/adwords/cm/',
         :v201109 => 'https://adwords.google.com/api/adwords/',
         :v201109_1 => 'https://adwords.google.com/api/adwords/',
         :v201206 => 'https://adwords.google.com/api/adwords/'
       },
       :SANDBOX => {
         :oauth_scope => 'https://adwords-sandbox.google.com/api/adwords/',
+        :header_ns => 'https://adwords.google.com/api/adwords/cm/',
         :v201109 => 'https://adwords-sandbox.google.com/api/adwords/',
         :v201109_1 => 'https://adwords-sandbox.google.com/api/adwords/',
         :v201206 => 'https://adwords-sandbox.google.com/api/adwords/'
@@ -240,7 +242,6 @@ module AdwordsApi
       [:v201206, :MediaService] => 'cm/',
       [:v201206, :MutateJobService] => 'cm/',
       [:v201206, :ReportDefinitionService] => 'cm/',
-      [:v201206, :ServicedAccountService] => 'mcm/',
       [:v201206, :TargetingIdeaService] => 'o/',
       [:v201206, :TrafficEstimatorService] => 'o/',
       [:v201206, :UserListService] => 'cm/',
@@ -251,8 +252,6 @@ module AdwordsApi
     # Auth constants for ClientLogin method.
     @@client_login_config = {
       :AUTH_SERVER => 'https://www.google.com',
-      :AUTH_NAMESPACE_PREAMBLE =>
-          'https://adwords.google.com/api/adwords/cm/',
       :LOGIN_SERVICE_NAME => 'adwords'
     }
 

data/lib/adwords_api/client_login_header_handler.rb

@@ -23,55 +23,8 @@ require 'ads_common/savon_headers/base_header_handler'
 
 module AdwordsApi
   class ClientLoginHeaderHandler < AdsCommon::SavonHeaders::BaseHeaderHandler
-    # Initializes a header handler.
-    #
-    # Args:
-    #  - credential_handler: a header with credential data
-    #  - auth_handler: a header with auth data
-    #  - element_name: an API-specific name of header element
-    #  - namespace: default namespace to use
-    #  - auth_namespace: namespace to use for auth headers
-    #  - version: services version
-    #
-    def initialize(credential_handler, auth_handler, namespace, auth_namespace,
-                   version)
-      super(credential_handler, auth_handler, namespace, version)
-      @auth_namespace = auth_namespace
-    end
-
-    # Enriches soap object with API-specific headers like namespaces, login
-    # credentials etc. Sets the default namespace for the body to the one
-    # specified in initializer.
-    #
-    # Args:
-    #  - request: a HTTPI Request for extra configuration (unused)
-    #  - soap: a Savon soap object to fill fields in
-    #
-    # Returns:
-    #  - modified soap structure
-    #
-    def prepare_request(request, soap)
-      super(request, soap)
-      soap.header[:attributes!] ||= {}
-      header_name = prepend_namespace(get_header_element_name())
-      soap.header[:attributes!][header_name] ||= {}
-      soap.header[:attributes!][header_name]['xmlns'] = @auth_namespace
-      return soap
-    end
 
     private
-    # Skips namespace prefixes for all elements except top level. Use default
-    # (inherited) prefixing for the top level key.
-    #
-    # Args:
-    #  - str: String to prepend with a namespace
-    #
-    # Returns:
-    #  - String with a namespace
-    #
-    def prepend_namespace(str)
-      return get_header_element_name().eql?(str) ? super(str) : str
-    end
 
     # Generates AdWords API specific request header with ClientLogin data.
     def generate_request_header()