google-adwords-api 0.1.0 → 0.1.1

data/Rakefile

@@ -56,7 +56,7 @@ end
 $GEM_DESCRIPTION = description
 $GEM_AUTHORS = ['Sergio Gomes']
 $GEM_EMAIL = 'api.sgomes@gmail.com'
-$GEM_HOMEPAGE = 'http://code.google.com/p/google-api-adwords-ruby/'
+$GEM_HOMEPAGE = 'http://code.google.com/p/google-api-ads-ruby/'
 
 
 # Configure code generation for the AdWords API client library.

data/examples/v201101/add_conversion.rb

@@ -0,0 +1,97 @@
+#!/usr/bin/ruby
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+#
+# License:: Licensed under the Apache License, Version 2.0 (the "License");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+# This example illustrates how to add an AdWords conversion.
+#
+# Tags: ConversionTrackerService.mutate
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201101
+
+def add_conversion()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  conv_tracker_srv = adwords.service(:ConversionTrackerService, API_VERSION)
+
+  # Prepare for adding conversion.
+  operation = {
+    :operator => 'ADD',
+    :operand => {
+      # 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
+      # type that the client library can't infer.
+      :xsi_type => 'AdWordsConversionTracker',
+      :name => 'Earth to Mars Cruises Conversion #%s' %
+          (Time.new.to_f * 1000).to_i,
+      :category => 'DEFAULT',
+      :markup_language => 'HTML',
+      :http_protocol => 'HTTP',
+      :text_format => 'HIDDEN'
+    }
+  }
+
+  # 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
+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_conversion()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  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 '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
+      end
+    end
+  end
+end

data/examples/v201101/add_user_list.rb

@@ -17,9 +17,10 @@
 #           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 and show its associated
+# conversion tracker code snippet.
 #
-# Tags: UserListService.mutate
+# Tags: UserListService.mutate, ConversionTrackerService.get
 
 require 'rubygems'
 gem 'google-adwords-api'
@@ -32,6 +33,7 @@ def add_user_list()
   # when called without parameters.
   adwords = AdwordsApi::Api.new
   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
@@ -54,8 +56,32 @@ def add_user_list()
   response = user_list_srv.mutate([operation])
   if response and response[:value]
     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%s\n" %
+          conversion[:snippet]
+      end
+    end
   else
     puts 'No user lists were added.'
   end

data/examples/v201101/get_all_conversions.rb

@@ -0,0 +1,88 @@
+#!/usr/bin/ruby
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+#
+# License:: Licensed under the Apache License, Version 2.0 (the "License");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+# This example gets all conversions in the account. To add conversions, run
+# add_conversion.rb.
+#
+# Tags: ConversionTrackerService.get
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201101
+
+def get_all_conversions()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  conv_tracker_srv = adwords.service(:ConversionTrackerService, API_VERSION)
+
+  # Get all conversions.
+  selector = {
+    :fields => ['Id', 'Name', 'Status', 'Category'],
+    :ordering => [{:field => 'Name', :sort_order => 'ASCENDING'}],
+  }
+  response = conv_tracker_srv.get(selector)
+  if response and response[:entries]
+    conversions = response[:entries]
+    puts "#{conversions.length} conversions(s) found."
+    conversions.each do |conversion|
+      puts "  Conversion with id \"#{conversion[:id]}\", status \"" +
+          "#{conversion[:status]}\" and category \"#{conversion[:category]}\"" +
+          " was found. Code snippet: \n#{conversion[:snippet]}\n"
+    end
+  else
+    puts "No conversions found."
+  end
+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_conversions()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  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 '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
+      end
+    end
+  end
+end

data/examples/v201101/get_keyword_opportunities.rb

@@ -0,0 +1,103 @@
+#!/usr/bin/ruby
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+#
+# License:: Licensed under the Apache License, Version 2.0 (the "License");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+# This example reads all the keyword opportunities for the customer.
+#
+# Tags: BulkOpportunityService.get
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201101
+PAGE_SIZE = 20
+
+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
+  bulk_opportunity_srv = adwords.service(:BulkOpportunityService, API_VERSION)
+
+  # Construct selector object.
+  selector = {
+    :requested_attribute_types => ['KEYWORD', 'IDEA_TYPE'],
+    :paging => {
+      :start_index => 0,
+      :number_results => PAGE_SIZE
+    }
+  }
+
+  # Perform request.
+  ideas = []
+  index = 0
+  begin
+    page = bulk_opportunity_srv.get(selector)
+    if page and page[:entries]
+      page[:entries].each do |entry|
+        ideas += entry[:opportunity_ideas] if entry[:opportunity_ideas]
+      end
+    end
+    break if page[:total_num_entries] <= index
+    index += PAGE_SIZE
+    selector[:paging][:start_index] = index
+  end while page[:total_num_entries] > index
+
+  # Display results.
+  ideas.each do |idea|
+    data = AdwordsApi::Utils.map(idea[:data])
+    keyword = data['KEYWORD'][:value][:text]
+    idea_type = data['IDEA_TYPE'][:value]
+    puts " Found opportunity idea of type \"%s\": \"%s\"" % [idea_type, keyword]
+  end
+  puts "Total opportunity ideas: %d." % [ideas.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_keyword_opportunities()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  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 '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
+      end
+    end
+  end
+end

data/examples/v201101/update_conversion.rb

@@ -0,0 +1,96 @@
+#!/usr/bin/ruby
+#
+# Author:: api.sgomes@gmail.com (Sérgio Gomes)
+#
+# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
+#
+# License:: Licensed under the Apache License, Version 2.0 (the "License");
+#           you may not use this file except in compliance with the License.
+#           You may obtain a copy of the License at
+#
+#           http://www.apache.org/licenses/LICENSE-2.0
+#
+#           Unless required by applicable law or agreed to in writing, software
+#           distributed under the License is distributed on an "AS IS" BASIS,
+#           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+#           implied.
+#           See the License for the specific language governing permissions and
+#           limitations under the License.
+#
+# This example illustrates how to update a conversion by setting its status to
+# 'DISABLED'. To get conversions, run get_all_conversions.rb.
+#
+# Tags: ConversionTrackerService.mutate
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201101
+
+def update_conversion()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  conv_tracker_srv = adwords.service(:ConversionTrackerService, API_VERSION)
+
+  conversion_id = 'INSERT_CONVERSION_ID_HERE'.to_i
+
+  # Prepare for updating conversion.
+  operation = {
+    :operator => 'SET',
+    :operand => {
+      # 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
+      # type that the client library can't infer.
+      :xsi_type => 'AdWordsConversionTracker',
+      :id => conversion_id,
+      :status => 'DISABLED'
+    }
+  }
+
+  # Update 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 disabled."
+  else
+    puts 'No conversions were updated.'
+  end
+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
+    update_conversion()
+
+  # Connection error. Likely transitory.
+  rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
+    puts 'Connection Error: %s' % e
+    puts 'Source: %s' % e.backtrace.first
+
+  # API Error.
+  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 '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
+      end
+    end
+  end
+end