google-adwords-api 0.4.0 → 0.4.1

data/examples/v201008/add_user_list.rb

@@ -38,7 +38,7 @@ def add_user_list()
   user_list_srv = adwords.service(:UserListService, 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 => {
@@ -58,7 +58,7 @@ def 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.' %
+    puts "User list with name '%s' and ID %d was added." %
         [user_list[:name], user_list[:id]]
   else
     puts 'No user lists were added.'

data/examples/v201008/check_campaigns.rb

@@ -45,7 +45,7 @@ def check_campaigns()
   operation = {
     :operator => 'ADD',
     :operand => {
-      :name => 'Interplanetary Cruise #%s' % (Time.new.to_f * 1000).to_i,
+      :name => "Interplanetary Cruise #%d" % (Time.new.to_f * 1000).to_i,
       :status => 'PAUSED',
       :bidding_strategy => {
         # The 'xsi_type' field allows you to specify the xsi:type of the object
@@ -68,8 +68,8 @@ def check_campaigns()
   if response and response[:value]
     campaigns = response[:value]
     campaigns.each do |campaign|
-      puts "Unexpected campaign creation! Name \"#{campaign[:name]}\", id " +
-          "#{campaign[:id]} and status is \"#{campaign[:status]}\"."
+      puts "Unexpected campaign creation! Name '#{campaign[:name]}', ID " +
+          "#{campaign[:id]} and status is '#{campaign[:status]}'."
     end
   else
     puts 'No campaigns created.'
@@ -80,7 +80,7 @@ def check_campaigns()
   operation = {
     :operator => 'ADD',
     :operand => {
-      :name => 'Interplanetary Cruise #%s' % (Time.new.to_f * 1000).to_i,
+      :name => "Interplanetary Cruise #%d" % (Time.new.to_f * 1000).to_i,
       :status => 'PAUSED',
       :bidding_strategy => nil,
       :budget => {

data/examples/v201008/get_account_hierarchy.rb

@@ -39,24 +39,21 @@ def get_account_hierarchy()
 
   serviced_account_srv = adwords.service(:ServicedAccountService, API_VERSION)
 
-  # Get the account hierarchy for this account.
-  selector = {
-    :service_types => ['UI_AND_API', 'API_ONLY'],
-    :enable_paging => false
-  }
+  # Create selector to get all accounts with no paging.
+  selector = {:enable_paging => false}
 
   graph = nil
 
   # Run with MCC account.
   adwords.use_mcc do
+    # Get the account hierarchy for this account.
     graph = serviced_account_srv.get(selector)
   end
 
   if graph
     # Display the accounts.
     account_number = graph[:accounts] ? graph[:accounts].size : 0
-    puts "There are %d customers under this account hierarchy." %
-        account_number
+    puts "There are %d customers under this account hierarchy." % account_number
     if graph[:accounts]
       graph[:accounts].each_with_index do |account, index|
         puts "#{index + 1}) Customer id: " +
@@ -71,10 +68,10 @@ def get_account_hierarchy()
 
       # Display the links.
       graph[:links].each do |link|
-        puts "There is a #{link[:type_of_link]} link of type " +
-            "#{link[:service_type]} from " +
-            "#{AdwordsApi::Utils.format_id(link[:manager_id][:id])} to " +
-            "#{AdwordsApi::Utils.format_id(link[:client_id][:id])}"
+        puts "There is a '%s' link from %s to %s" %
+            [link[:type_of_link],
+             AdwordsApi::Utils.format_id(link[:manager_id][:id]),
+             AdwordsApi::Utils.format_id(link[:client_id][:id])]
       end
     end
   else

data/examples/v201101/add_ad_group.rb

@@ -44,7 +44,7 @@ def add_ad_group()
   operation = {
     :operator => 'ADD',
     :operand => {
-      :name => 'Earth to Mars Cruises #%s' % (Time.new.to_f * 1000).to_i,
+      :name => "Earth to Mars Cruises #%d" % (Time.new.to_f * 1000).to_i,
       :status => 'ENABLED',
       :campaign_id => campaign_id,
       :bids => {
@@ -64,7 +64,7 @@ def add_ad_group()
   # Add ad group.
   response = ad_group_srv.mutate([operation])
   ad_group = response[:value].first
-  puts 'Ad group id %d was successfully added.' % ad_group[:id]
+  puts "Ad group ID %d was successfully added." % ad_group[:id]
 end
 
 if __FILE__ == $0

data/examples/v201101/add_ads.rb

@@ -78,7 +78,7 @@ def add_ads()
       :ad_group_id => ad_group_id,
       :ad => {
         :xsi_type => 'ImageAd',
-        :name => 'Cruise to mars image ad #%s' % (Time.new.to_f * 1000).to_i,
+        :name => "Cruise to mars image ad #%d" % (Time.new.to_f * 1000).to_i,
         :url => 'http://www.example.com',
         :display_url => 'www.example.com',
         :image => {
@@ -92,7 +92,7 @@ def add_ads()
   template_ad_operation = {
     :operator => 'ADD',
     :operand => {
-      :adGroupId => ad_group_id,
+      :ad_group_id => ad_group_id,
       :ad => {
         :xsi_type => 'TemplateAd',
         :template_id => 9,
@@ -100,7 +100,7 @@ def add_ads()
           :width => 300,
           :height => 250
         },
-        :name => 'Mars cruise video ad #%s' % (Time.new.to_f * 1000).to_i,
+        :name => "Mars cruise video ad #%d" % (Time.new.to_f * 1000).to_i,
         :display_url => 'www.example.com',
         :url => 'http://www.example.com',
         :template_elements => [{
@@ -144,11 +144,11 @@ def add_ads()
     ads = response[:value]
     puts "Added #{ads.length} ad(s) to ad group #{ad_group_id}."
     ads.each do |ad|
-      puts "  Ad id is #{ad[:ad][:id]}, type is #{ad[:ad][:xsi_type]} and " +
-          "status is \"#{ad[:status]}\"."
+      puts "  Ad ID is #{ad[:ad][:id]}, type is '#{ad[:ad][:xsi_type]}' and " +
+          "status is '#{ad[:status]}'."
     end
   else
-    puts "No ads were added."
+    puts 'No ads were added.'
   end
 end
 

data/examples/v201101/add_campaign.rb

@@ -41,7 +41,7 @@ def add_campaign()
   operation = {
     :operator => 'ADD',
     :operand => {
-      :name => 'Interplanetary Cruise #%s' % (Time.new.to_f * 1000).to_i,
+      :name => "Interplanetary Cruise #%d" % (Time.new.to_f * 1000).to_i,
       :status => 'PAUSED',
       :bidding_strategy => {
         # The 'xsi_type' field allows you to specify the xsi:type of the object
@@ -70,7 +70,7 @@ def add_campaign()
   response = campaign_srv.mutate([operation])
   if response and response[:value]
     campaign = response[:value].first
-    puts 'Campaign with name "%s" and id %d was added.' %
+    puts "Campaign with name '%s' and ID %d was added." %
         [campaign[:name], campaign[:id]]
   else
     puts 'No campaigns were added.'

data/examples/v201101/add_conversion.rb

@@ -45,7 +45,7 @@ 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',
@@ -58,9 +58,9 @@ def 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."
+    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

data/examples/v201101/add_experiment.rb

@@ -53,16 +53,16 @@ def add_experiment()
     :operator => 'ADD',
     :operand => {
       :campaign_id => campaign_id,
-      :name => 'Interplanetary Experiment #%s' % (Time.new.to_f * 1000).to_i,
+      :name => "Interplanetary Experiment #%d" % (Time.new.to_f * 1000).to_i,
       :query_percentage => 10,
-      :start_date_time => Time.now.strftime("%Y%m%d %H%M%S")
+      :start_date_time => Time.now.strftime('%Y%m%d %H%M%S')
     }
   }
 
   # Add experiment.
   response = experiment_srv.mutate([operation])
   experiment = response[:value].first
-  puts 'Experiment with name "%s" and id %d was added.' %
+  puts "Experiment with name '%s' and ID %d was added." %
       [experiment[:name], experiment[:id]]
 
   experiment_id = experiment[:id]
@@ -93,7 +93,7 @@ def add_experiment()
   # Update ad group.
   response = ad_group_srv.mutate([operation])
   ad_group = response[:value].first
-  puts 'Ad group id %d was updated for the experiment.' % ad_group[:id]
+  puts "Ad group ID %d was updated for the experiment." % ad_group[:id]
 
   # Setup ad group criterion for the experiment.
   ad_group_criterion = {
@@ -126,7 +126,7 @@ def add_experiment()
   # Update criterion.
   response = ad_group_criterion_srv.mutate([operation])
   criterion = response[:value].first
-  puts 'Criterion id %d was successfully updated for the experiment.' %
+  puts "Criterion ID %d was successfully updated for the experiment." %
       [criterion[:criterion][:id]]
 
 end

data/examples/v201101/add_keywords_performance_report_definition.rb

@@ -59,7 +59,7 @@ def add_keywords_performance_report_definition()
           :max => end_date
         }
       },
-      :report_name => 'Keywords performance report #%s' %
+      :report_name => "Keywords performance report #%d" %
           (Time.new.to_f * 1000).to_i,
       :report_type => 'KEYWORDS_PERFORMANCE_REPORT',
       :date_range_type => 'CUSTOM_DATE',
@@ -71,7 +71,7 @@ def add_keywords_performance_report_definition()
   response = report_def_srv.mutate([operation])
   if response
     response.each do |report_definition|
-      puts 'Report definition with name \'%s\' and id \'%s\' was added' %
+      puts "Report definition with name '%s' and ID %d was added." %
           [report_definition[:report_name], report_definition[:id]]
     end
   end

data/examples/v201101/add_user_list.rb

@@ -40,7 +40,7 @@ def add_user_list()
   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 => {
@@ -77,12 +77,12 @@ def add_user_list()
         conversions = conv_tracker_response[:entries]
       end
     end
-    puts 'User list with name "%s" and id %d was added.' %
+    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" %
+        puts "Conversion type code snipped associated to the list:\n\t\t%s\n" %
           conversion[:snippet]
       end
     end

data/examples/v201101/check_campaigns.rb

@@ -45,7 +45,7 @@ def check_campaigns()
   operation = {
     :operator => 'ADD',
     :operand => {
-      :name => 'Interplanetary Cruise #%s' % (Time.new.to_f * 1000).to_i,
+      :name => "Interplanetary Cruise #%d" % (Time.new.to_f * 1000).to_i,
       :status => 'PAUSED',
       :bidding_strategy => {
         # The 'xsi_type' field allows you to specify the xsi:type of the object
@@ -68,8 +68,8 @@ def check_campaigns()
   if response and response[:value]
     campaigns = response[:value]
     campaigns.each do |campaign|
-      puts "Unexpected campaign creation! Name \"#{campaign[:name]}\", id " +
-          "#{campaign[:id]} and status is \"#{campaign[:status]}\"."
+      puts "Unexpected campaign creation! Name '#{campaign[:name]}', ID " +
+          "#{campaign[:id]} and status is '#{campaign[:status]}'."
     end
   else
     puts 'No campaigns created.'
@@ -80,7 +80,7 @@ def check_campaigns()
   operation = {
     :operator => 'ADD',
     :operand => {
-      :name => 'Interplanetary Cruise #%s' % (Time.new.to_f * 1000).to_i,
+      :name => "Interplanetary Cruise #%d" % (Time.new.to_f * 1000).to_i,
       :status => 'PAUSED',
       :bidding_strategy => nil,
       :budget => {

data/examples/v201101/get_account_hierarchy.rb

@@ -39,16 +39,14 @@ def get_account_hierarchy()
 
   serviced_account_srv = adwords.service(:ServicedAccountService, API_VERSION)
 
-  # Get the account hierarchy for this account.
-  selector = {
-    :service_types => ['UI_AND_API', 'API_ONLY'],
-    :enable_paging => false
-  }
+  # Create selector to get all accounts with no paging.
+  selector = {:enable_paging => false}
 
   graph = nil
 
   # Run with MCC account.
   adwords.use_mcc do
+    # Get the account hierarchy for this account.
     graph = serviced_account_srv.get(selector)
   end
 
@@ -71,10 +69,10 @@ def get_account_hierarchy()
 
       # Display the links.
       graph[:links].each do |link|
-        puts "There is a #{link[:type_of_link]} link of type " +
-            "#{link[:service_type]} from " +
-            "#{AdwordsApi::Utils.format_id(link[:manager_id][:id])} to " +
-            "#{AdwordsApi::Utils.format_id(link[:client_id][:id])}"
+        puts "There is a '%s' link from %s to %s"  %
+            [link[:type_of_link],
+             AdwordsApi::Utils.format_id(link[:manager_id][:id]),
+             AdwordsApi::Utils.format_id(link[:client_id][:id])]
       end
     end
   else

data/examples/v201109/add_ad_extension_override.rb

@@ -0,0 +1,82 @@
+#!/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 override an ad extension for a specific ad, by
+# creating an ad extension override. To create a campaign, run add_campaign.rb.
+# To create an ad, run add_ads.rb.
+#
+# Tags: AdExtensionOverrideService.mutate
+
+require 'rubygems'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+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)
+
+  ad_id = 'INSERT_AD_ID_HERE'.to_i
+  campaign_ad_extension_id = 'INSERT_CAMPAIGN_AD_EXTENSION_ID_HERE'.to_i
+
+  # Create operation.
+  operation = {
+    :operator => 'ADD',
+    :operand => {
+      :ad_id => ad_id,
+      :ad_extension => {
+        :id => campaign_ad_extension_id
+      }
+    }
+  }
+
+  # Add override.
+  response = ad_ext_override_srv.mutate([operation])
+  ad_ext_override = response[:value].first
+  puts 'Ad extension override was successfully added.'
+end
+
+if __FILE__ == $0
+  begin
+    add_ad_extension_override()
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue AdwordsApi::Errors::ApiException => e
+    puts "Message: %s" % e.message
+    puts 'Errors:'
+    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
+end

data/examples/v201109/add_ad_group.rb

@@ -0,0 +1,89 @@
+#!/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 create an ad group. To create a campaign, run
+# add_campaign.rb.
+#
+# Tags: AdGroupService.mutate
+
+require 'rubygems'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+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
+
+  # Prepare for adding ad group.
+  operation = {
+    :operator => 'ADD',
+    :operand => {
+      :name => "Earth to Mars Cruises #%d" % (Time.new.to_f * 1000).to_i,
+      :status => 'ENABLED',
+      :campaign_id => campaign_id,
+      :bids => {
+        # 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 => 'ManualCPCAdGroupBids',
+        :keyword_max_cpc => {
+          :amount => {
+            :micro_amount => 10000000
+          }
+        }
+      },
+    }
+  }
+
+  # Add ad group.
+  response = ad_group_srv.mutate([operation])
+  ad_group = response[:value].first
+  puts "Ad group ID %d was successfully added." % ad_group[:id]
+end
+
+if __FILE__ == $0
+  begin
+    add_ad_group()
+
+  # HTTP errors.
+  rescue AdsCommon::Errors::HttpError => e
+    puts "HTTP Error: %s" % e
+
+  # API errors.
+  rescue AdwordsApi::Errors::ApiException => e
+    puts "Message: %s" % e.message
+    puts 'Errors:'
+    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
+end