google-adx-buyer-api 0.4.0 → 0.4.1

data/examples/v201109/{get_all_campaigns.rb → misc/use_oauth.rb}

@@ -1,6 +1,7 @@
-#!/usr/bin/ruby
+#!/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.
 #
@@ -17,17 +18,13 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example illustrates how to retrieve all the campaigns for an account.
+# This example illustrates how to use OAuth authentication method.
 #
 # Tags: CampaignService.get
 
-require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-def get_all_campaigns()
+def use_oauth()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -41,45 +38,59 @@ def get_all_campaigns()
   # Get all the campaigns for this account; empty selector.
   selector = {
     :fields => ['Id', 'Name', 'Status'],
-    :ordering => [{:field => 'Name', :sort_order => 'ASCENDING'}]
+    :ordering => [
+      {:field => 'Name', :sort_order => 'ASCENDING'}
+    ]
   }
-  response = campaign_srv.get(selector)
+
+  retry_count = 0
+
+  begin
+    response = campaign_srv.get(selector)
+  rescue AdsCommon::Errors::OAuthVerificationRequired => e
+    if retry_count < MAX_RETRIES
+      puts "Hit Auth error, please navigate to URL:\n\t%s" % e.oauth_url
+      print 'log in and type the verification code: '
+      verification_code = gets.chomp
+      adwords.credential_handler.set_credential(
+          :oauth_verification_code, verification_code)
+      retry_count += 1
+      retry
+    else
+      raise AdsCommon::Errors::AuthError, 'Failed to authenticate.'
+    end
+  end
 
   if response and response[:entries]
     campaigns = response[:entries]
     campaigns.each do |campaign|
-      puts "Campaign name is \"#{campaign[:name]}\", id is #{campaign[:id]} " +
-          "and status is \"#{campaign[:status]}\"."
+      puts "Campaign ID %d, name '%s' and status '%s'" %
+          [campaign[:id], campaign[:name], campaign[:status]]
     end
   else
-    puts "No campaigns were found."
+    puts 'No campaigns were found.'
   end
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+  MAX_RETRIES = 3
+
   begin
-    get_all_campaigns()
+    use_oauth()
 
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
 
-  # API Error.
+  # API errors.
   rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts "Message: %s" % e.message
     puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
       end
     end
   end

data/examples/{v201003/get_related_placements.rb → v201109/optimization/get_placement_ideas.rb}

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.sgomes@gmail.com (Sérgio Gomes)
 #
@@ -22,13 +23,10 @@
 #
 # Tags: TargetingIdeaService.get
 
-require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
+require 'adwords_api/utils'
 
-API_VERSION = :v201003
-
-def get_related_placements()
+def get_placement_ideas(url)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -39,14 +37,11 @@ def get_related_placements()
 
   targeting_idea_srv = adwords.service(:TargetingIdeaService, API_VERSION)
 
-  results_per_page = 10
-  url = 'mars.google.com'
-
   # Construct selector.
   selector = {
     :idea_type => 'PLACEMENT',
     :request_type => 'IDEAS',
-    :requested_attribute_types => ['PLACEMENT'],
+    :requested_attribute_types => ['CRITERION'],
     :search_parameters => [{
       # The 'xsi_type' field allows you to specify the xsi:type of the object
       # being created. It's only necessary when you must provide an explicit
@@ -57,54 +52,54 @@ def get_related_placements()
     }],
     :paging => {
       :start_index => 0,
-      :number_results => results_per_page
+      :number_results => PAGE_SIZE
     }
   }
 
+  # Define initial values.
+  offset = 0
   results = []
-  index = 0
+
   begin
-    selector[:paging][:start_index] = index
     # Perform request.
     page = targeting_idea_srv.get(selector)
     results += page[:entries] if page and page[:entries]
-    index += results_per_page
-  end while index < page[:total_num_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['PLACEMENT'][:value]
-    puts "Related content keywords found at URL \"%s\"" % placement[:url]
+    placement = data['CRITERION'][:value]
+    puts "Related placement 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
+  API_VERSION = :v201109
+  PAGE_SIZE = 100
+
   begin
-    get_related_placements()
+    url = 'INSERT_PLACEMENT_URL_HERE'
+    get_placement_ideas(url)
 
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
 
-  # API Error.
+  # API errors.
   rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts "Message: %s" % e.message
     puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
       end
     end
   end

data/examples/{v201008/add_user_list.rb → v201109/remarketing/add_audience.rb}

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.sgomes@gmail.com (Sérgio Gomes)
 #
@@ -17,17 +18,14 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example illustrates how to create a user list.
+# This example illustrates how to create a user list (a.k.a. Audience) and shows
+# its associated conversion tracker code snippet.
 #
-# Tags: UserListService.mutate
+# Tags: UserListService.mutate, ConversionTrackerService.get
 
-require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 
-API_VERSION = :v201008
-
-def add_user_list()
+def add_audience()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -37,9 +35,10 @@ def add_user_list()
   # adwords.logger = Logger.new('adwords_xml.log')
 
   user_list_srv = adwords.service(:UserListService, API_VERSION)
+  conv_tracker_srv = adwords.service(:ConversionTrackerService, API_VERSION)
 
   # Prepare for adding remarketing user list.
-  name = 'Mars cruise customers #%s' % (Time.new.to_f * 1000).to_i
+  name = "Mars cruise customers #%d" % (Time.new.to_f * 1000).to_i
   operation = {
     :operator => 'ADD',
     :operand => {
@@ -51,45 +50,61 @@ def add_user_list()
       :description => 'A list of mars cruise customers in the last year',
       :status => 'OPEN',
       :membership_life_span => 365,
-      :conversion_types => [{:name => name}]
+      :conversion_types => [{:name => name}],
+      # Optional field.
+      :status => 'OPEN'
     }
   }
 
   # Add user list.
   response = user_list_srv.mutate([operation])
-  if response and response[:value]
-    user_list = response[:value].first
-    puts 'User list with name "%s" and id %d was added.' %
-        [user_list[:name], user_list[:id]]
-  else
-    puts 'No user lists were added.'
+  user_list = response[:value].first
+
+  # Get conversion snippets.
+  if user_list and user_list[:conversion_types]
+    conversion_ids = user_list[:conversion_types].map {|type| type[:id]}
+    selector = {
+      # We're actually interested in the 'Snippet' field, which is returned
+      # automatically.
+      :fields => ['Id'],
+      :predicates => [
+        {:field => 'Id', :operator => 'IN', :values => conversion_ids}
+      ]
+    }
+    conv_tracker_response = conv_tracker_srv.get(selector)
+    if conv_tracker_response and conv_tracker_response[:entries]
+      conversions = conv_tracker_response[:entries]
+    end
+  end
+  puts "User list with name '%s' and ID %d was added." %
+      [user_list[:name], user_list[:id]]
+  # Display user list associated conversion code snippets.
+  if conversions
+    conversions.each do |conversion|
+      puts "Conversion type code snipped associated to the list:\n\t\t%s\n" %
+        conversion[:snippet]
+    end
   end
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    add_user_list()
+    add_audience()
 
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
 
-  # API Error.
+  # API errors.
   rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts "Message: %s" % e.message
     puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
       end
     end
   end

data/examples/v201109/{add_conversion.rb → remarketing/add_conversion_tracker.rb}

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.sgomes@gmail.com (Sérgio Gomes)
 #
@@ -17,17 +18,13 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example illustrates how to add an AdWords conversion.
+# This example illustrates how to add an AdWords conversion tracker.
 #
 # Tags: ConversionTrackerService.mutate
 
-require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-def add_conversion()
+def add_conversion_tracker()
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -46,51 +43,50 @@ def add_conversion()
       # being created. It's only necessary when you must provide an explicit
       # type that the client library can't infer.
       :xsi_type => 'AdWordsConversionTracker',
-      :name => 'Earth to Mars Cruises Conversion #%s' %
+      :name => "Earth to Mars Cruises Conversion #%d" %
           (Time.new.to_f * 1000).to_i,
       :category => 'DEFAULT',
       :markup_language => 'HTML',
       :http_protocol => 'HTTP',
-      :text_format => 'HIDDEN'
+      :text_format => 'HIDDEN',
+      # Optional fields:
+      :status => 'ENABLED',
+      :viewthrough_lookback_window => 15,
+      :viewthrough_conversion_de_dup_search => true,
+      :is_product_ads_chargeable => true,
+      :product_ads_chargeable_conversion_window => 15,
+      :conversion_page_language => 'en',
+      :background_color => '#0000FF',
+      :user_revenue_value => 'someJavascriptVariable'
     }
   }
 
   # Add conversion.
   response = conv_tracker_srv.mutate([operation])
-  if response and response[:value]
-    conversion = response[:value].first
-    puts "Conversion with id #{conversion[:id]}, name " +
-        "\"#{conversion[:name]}\", status \"#{conversion[:status]}\" and " +
-        " category \"#{conversion[:category]}\" was added."
-  else
-    puts 'No conversions were added.'
-  end
+  conversion = response[:value].first
+  puts ("Conversion with ID %d, name '%s', status '%s' and category '%s'" +
+      " was added.") % [conversion[:id], conversion[:name],
+                        conversion[:status], conversion[:category]]
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    add_conversion()
+    add_conversion_tracker()
 
-  # Connection error. Likely transitory.
-  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
-    puts 'Connection Error: %s' % e
-    puts 'Source: %s' % e.backtrace.first
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
 
-  # API Error.
+  # API errors.
   rescue AdwordsApi::Errors::ApiException => e
-    puts 'API Exception caught.'
-    puts 'Message: %s' % e.message
-    puts 'Code: %d' % e.code if e.code
-    puts 'Trigger: %s' % e.trigger if e.trigger
+    puts "Message: %s" % e.message
     puts 'Errors:'
-    if e.errors
-      e.errors.each_with_index do |error, index|
-        puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
-        error.each_pair do |field, value|
-          if field != :xsi_type
-            puts '     %s: %s' % [field, value]
-          end
-        end
+    e.errors.each_with_index do |error, index|
+      puts "\tError [%d]:" % (index + 1)
+      error.each do |field, value|
+        puts "\t\t%s: %s" % [field, value]
       end
     end
   end