google-adx-buyer-api 0.4.0 → 0.4.1

data/examples/v201109/basic_operations/add_thirdparty_redirect_ad.rb

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# Copyright:: Copyright 2012, 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 code example adds a third party redirect ad to an ad group. To create an
+# ad group, run add_ad_group.rb.
+#
+# Tags: AdGroupAdService.mutate
+
+require 'adwords_api'
+
+def add_thirdparty_redirect_ad(ad_group_id)
+  # 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_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
+
+  # Create third party redirect ad.
+  # 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.
+  redirect_ad = {
+    :xsi_type => 'ThirdPartyRedirectAd',
+    :name => 'Example third party ad %d' % (Time.new.to_f * 1000).to_i,
+    :url => 'http://www.example.com',
+    :dimensions => {
+      :height => 250,
+      :width => 300
+    },
+    # This field normally contains the javascript ad tag.
+    :snippet =>
+        '<img src="https://sandbox.google.com/sandboximages/image.jpg"/>',
+    :impression_beacon_url => 'http://www.examples.com/beacon',
+    :certified_vendor_format_id => 119,
+    :is_cookie_targeted => false,
+    :is_user_interest_targeted => false,
+    :is_tagged => false
+  }
+
+  # Create an operation to add the ad.
+  operation = {
+    :operator => 'ADD',
+    :operand => {
+      :ad_group_id => ad_group_id,
+      :ad => redirect_ad
+    }
+  }
+
+  # Add third party redirect ad. Multiple operations could be passed as an
+  # array.
+  response = ad_group_ad_srv.mutate([operation])
+  ads = response[:value]
+  puts "Added %d third party redirect ad(s) to ad group ID %d:" %
+      [ads.length, ad_group_id]
+  ads.each do |ad|
+    puts "\tAd ID %d, type '%s' and status '%s'" %
+        [ad[:ad][:id], ad[:ad][:ad_type], ad[:status]]
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201109
+
+  begin
+    # Ad group ID to add text ads to.
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    add_thirdparty_redirect_ad(ad_group_id)
+
+  # 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/{v201008 → v201109/basic_operations}/delete_ad.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.
 #
@@ -18,17 +19,13 @@
 #           limitations under the License.
 #
 # This example deletes an ad using the 'REMOVE' operator. To get ads,
-# run get_all_ads.rb.
+# run get_thirdparty_redirect_ads.rb.
 #
 # Tags: AdGroupAdService.mutate
 
-require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 
-API_VERSION = :v201008
-
-def delete_ad()
+def delete_ad(ad_group_id, ad_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -39,9 +36,6 @@ def delete_ad()
 
   ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
 
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-  ad_id = 'INSERT_AD_ID_HERE'.to_i
-
   # Prepare for deleting ad.
   operation = {
     :operator => 'REMOVE',
@@ -56,38 +50,30 @@ def delete_ad()
 
   # Delete ad.
   response = ad_group_ad_srv.mutate([operation])
-  if response and response[:value]
-    ad = response[:value].first
-    puts 'Ad id %d was successfully deleted.' % ad[:ad][:id]
-  else
-    puts 'No ads were deleted.'
-  end
+  ad = response[:value].first
+  puts "Ad ID %d was successfully deleted." % ad[:ad][:id]
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    delete_ad()
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    ad_id = 'INSERT_AD_ID_HERE'.to_i
+    delete_ad(ad_group_id, ad_id)
 
-  # 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/{v201101 → v201109/basic_operations}/delete_ad_group.rb

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.sgomes@gmail.com (Sérgio Gomes)
 #
@@ -18,17 +19,13 @@
 #           limitations under the License.
 #
 # This example deletes an ad group by setting the status to 'DELETED'.
-# To get ad groups, run get_all_ad_groups.rb.
+# To get ad groups, run get_ad_groups.rb.
 #
 # Tags: AdGroupService.mutate
 
-require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 
-API_VERSION = :v201101
-
-def delete_ad_group()
+def delete_ad_group(ad_group_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -39,8 +36,6 @@ def delete_ad_group()
 
   ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
 
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-
   # Prepare for deleting ad group.
   operation = {
     :operator => 'SET',
@@ -53,33 +48,28 @@ def delete_ad_group()
   # Delete ad group.
   response = ad_group_srv.mutate([operation])
   ad_group = response[:value].first
-  puts 'Ad group id %d was successfully deleted.' % ad_group[:id]
+  puts "Ad group ID %d was successfully deleted." % ad_group[:id]
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    delete_ad_group()
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    delete_ad_group(ad_group_id)
 
-  # 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/{delete_campaign.rb → basic_operations/delete_campaign.rb}

@@ -1,4 +1,5 @@
-#!/usr/bin/ruby
+#!/usr/bin/env ruby
+# Encoding: utf-8
 #
 # Author:: api.sgomes@gmail.com (Sérgio Gomes)
 #
@@ -18,17 +19,13 @@
 #           limitations under the License.
 #
 # This example deletes a campaign by setting the status to 'DELETED'. To get
-# campaigns, run get_all_campaigns.rb.
+# campaigns, run get_campaigns.rb.
 #
 # Tags: CampaignService.mutate
 
-require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 
-API_VERSION = :v201109
-
-def delete_campaign()
+def delete_campaign(campaign_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -39,8 +36,6 @@ def delete_campaign()
 
   campaign_srv = adwords.service(:CampaignService, API_VERSION)
 
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
   # Prepare for deleting campaign.
   operation = {
     :operator => 'SET',
@@ -53,34 +48,29 @@ def delete_campaign()
   # Delete campaign.
   response = campaign_srv.mutate([operation])
   campaign = response[:value].first
-  puts 'Campaign with name "%s" and id %d was deleted.' %
+  puts "Campaign with name '%s' and ID %d was deleted." %
       [campaign[:name], campaign[:id]]
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    delete_campaign()
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+    delete_campaign(campaign_id)
 
-  # 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/delete_ad_group_criterion.rb → v201109/basic_operations/delete_placement.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,18 +18,14 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example deletes an ad group criterion using the 'REMOVE' operator. To
-# get ad group criteria, run get_all_ad_group_criteria.rb.
+# This example deletes a placement using the 'REMOVE' operator. To get list of
+# placements, run get_placements.rb.
 #
 # Tags: AdGroupCriterionService.mutate
 
-require 'rubygems'
-gem 'google-adwords-api'
 require 'adwords_api'
 
-API_VERSION = :v201008
-
-def delete_ad_group_criterion()
+def delete_placement(ad_group_id, criterion_id)
   # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
   # when called without parameters.
   adwords = AdwordsApi::Api.new
@@ -40,10 +37,7 @@ def delete_ad_group_criterion()
   ad_group_criterion_srv =
       adwords.service(:AdGroupCriterionService, API_VERSION)
 
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-  criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
-
-  # Prepare for deleting ad group criterion.
+  # Prepare for deleting placement.
   operation = {
     :operator => 'REMOVE',
     :operand => {
@@ -58,37 +52,34 @@ def delete_ad_group_criterion()
     }
   }
 
-  # Delete criterion.
+  # Delete placement.
   response = ad_group_criterion_srv.mutate([operation])
   ad_group_criterion = response[:value].first
-  puts 'Criterion id %d was successfully deleted.' %
+  puts "Placement ID %d was successfully deleted." %
       ad_group_criterion[:criterion][:id]
 end
 
 if __FILE__ == $0
+  API_VERSION = :v201109
+
   begin
-    delete_ad_group_criterion()
+    # IDs of criterion to delete and its ad group.
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
+    delete_placement(ad_group_id, criterion_id)
 
-  # 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