google-adwords-api 0.7.0 → 0.7.1

data/examples/v201209/basic_operations/add_keywords.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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 multiple keywords to a given ad group. To
+# create an ad group, run add_ad_group.rb.
+#
+# Tags: AdGroupCriterionService.mutate
+
+require 'adwords_api'
+
+def add_keywords(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_criterion_srv =
+      adwords.service(:AdGroupCriterionService, API_VERSION)
+
+  # Create keywords.
+  # 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.
+  keywords = [
+    {:xsi_type => 'BiddableAdGroupCriterion',
+     :ad_group_id => ad_group_id,
+     :criterion => {
+       :xsi_type => 'Keyword',
+       :text => 'mars cruise',
+       :match_type => 'BROAD'
+     },
+     # Optional fields:
+     :user_status => 'PAUSED',
+     :destination_url => 'http://example.com/mars'
+    },
+    {:xsi_type => 'BiddableAdGroupCriterion',
+     :ad_group_id => ad_group_id,
+     :criterion => {
+       :xsi_type => 'Keyword',
+       :text => 'space hotel',
+       :match_type => 'BROAD'}}
+  ]
+
+  # Create 'ADD' operations.
+  operations = keywords.map do |keyword|
+    {:operator => 'ADD', :operand => keyword}
+  end
+
+  # Add keywords.
+  response = ad_group_criterion_srv.mutate(operations)
+  if response and response[:value]
+    ad_group_criteria = response[:value]
+    puts "Added %d keywords to ad group ID %d:" %
+        [ad_group_criteria.length, ad_group_id]
+    ad_group_criteria.each do |ad_group_criterion|
+      puts "\tKeyword ID is %d and type is '%s'" %
+          [ad_group_criterion[:criterion][:id],
+           ad_group_criterion[:criterion][:type]]
+    end
+  else
+    raise StandardError, 'No keywords were added.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201209
+
+  begin
+    # Ad group ID to add keywords to.
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    add_keywords(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/v201209/basic_operations/add_text_ads.rb

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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 text ads to a given ad group. To create an
+# ad group, run add_ad_group.rb.
+#
+# Tags: AdGroupAdService.mutate
+
+require 'adwords_api'
+
+def add_text_ads(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 text ads.
+  # 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.
+  text_ads = [
+    {
+      :xsi_type => 'TextAd',
+      :headline => 'Luxury Cruise to Mars',
+      :description1 => 'Visit the Red Planet in style.',
+      :description2 => 'Low-gravity fun for everyone!',
+      :url => 'http://www.example.com',
+      :display_url => 'www.example.com'
+    },
+    {
+      :xsi_type => 'TextAd',
+      :headline => 'Luxury Cruise to Mars',
+      :description1 => 'Enjoy your stay at Red Planet.',
+      :description2 => 'Buy your tickets now!',
+      :url => 'http://www.example.com',
+      :display_url => 'www.example.com'
+    }
+  ]
+
+  # Create ad 'ADD' operations.
+  text_ad_operations = text_ads.map do |text_ad|
+    {:operator => 'ADD',
+     :operand => {:ad_group_id => ad_group_id, :ad => text_ad}}
+  end
+
+  # Add ads.
+  response = ad_group_ad_srv.mutate(text_ad_operations)
+  if response and response[:value]
+    ads = response[:value]
+    puts "Added %d 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
+  else
+    raise StandardError, 'No ads were added.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201209
+
+  begin
+    # Ad group ID to add text ads to.
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    add_text_ads(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/v201209/basic_operations/delete_ad.rb

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# 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 deletes an ad using the 'REMOVE' operator. To get ads, run
+# get_text_ads.rb.
+#
+# Tags: AdGroupAdService.mutate
+
+require 'adwords_api'
+
+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
+
+  # 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)
+
+  # Prepare for deleting ad.
+  operation = {
+    :operator => 'REMOVE',
+    :operand => {
+      :ad_group_id => ad_group_id,
+      :ad => {
+        :xsi_type => 'Ad',
+        :id => ad_id
+      }
+    }
+  }
+
+  # 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
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201209
+
+  begin
+    # IDs of an ad to delete and its ad group.
+    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)
+
+  # 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/v201209/basic_operations/delete_ad_group.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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 deletes an ad group by setting the status to 'DELETED'. To get ad
+# groups, run get_ad_groups.rb.
+#
+# Tags: AdGroupService.mutate
+
+require 'adwords_api'
+
+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
+
+  # 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)
+
+  # Retrieve the ad group to obtain its name. This is optional but recommended
+  # to keep deleted objects searchable. In production the name is already known
+  # in most cases.
+  selector = {
+    :fields => ['Id', 'Name'],
+    :predicates => [
+      {:field => 'Id', :operator => 'EQUALS', :values => [ad_group_id]}
+    ]
+  }
+  result = ad_group_srv.get(selector)
+
+  if result.nil? or result[:entries].empty?
+    raise StandardError, "Ad group with ID %d was not found." % ad_group_id
+  end
+
+  # We recommend renaming object on delete to avoid name conflicts later.
+  ad_group_name = result[:entries].first[:name]
+  ad_group_name += Time.now.strftime(" (deleted on %Y-%m-%d %H:%M:%S)")
+
+  # Prepare for deleting ad group.
+  operation = {
+    :operator => 'SET',
+    :operand => {
+      :id => ad_group_id,
+      :name => ad_group_name,
+      :status => 'DELETED'
+    }
+  }
+
+  # Delete ad group.
+  response = ad_group_srv.mutate([operation])
+  if response and response[:value]
+    ad_group = response[:value].first
+    puts "Ad group ID %d was successfully deleted and renamed to '%s'." %
+       [ad_group[:id], ad_group[:name]]
+  else
+    puts 'No ad group was updated.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201209
+
+  begin
+    # ID of an ad group to delete.
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    delete_ad_group(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/v201209/basic_operations/delete_campaign.rb

@@ -0,0 +1,103 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.dklimkin@gmail.com (Danial Klimkin)
+#
+# 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 deletes a campaign by setting the status to 'DELETED'. To get
+# campaigns, run get_campaigns.rb.
+#
+# Tags: CampaignService.mutate
+
+require 'adwords_api'
+
+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
+
+  # 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')
+
+  campaign_srv = adwords.service(:CampaignService, API_VERSION)
+
+  # Retrieve the campaign to obtain its name. This is optional but recommended
+  # to keep deleted objects searchable. In production the name is already known
+  # in most cases.
+  selector = {
+    :fields => ['Id', 'Name'],
+    :predicates => [
+      {:field => 'Id', :operator => 'EQUALS', :values => [campaign_id]}
+    ]
+  }
+  result = campaign_srv.get(selector)
+
+  if result.nil? or result[:entries].empty?
+    raise StandardError, "Campaign with ID %d was not found." % campaign_id
+  end
+
+  # We recommend renaming object on delete to avoid name conflicts later.
+  campaign_name = result[:entries].first[:name]
+  campaign_name += Time.now.strftime(" (deleted on %Y-%m-%d %H:%M:%S)")
+
+  # Prepare for deleting campaign.
+  operation = {
+    :operator => 'SET',
+    :operand => {
+      :id => campaign_id,
+      :name => campaign_name,
+      :status => 'DELETED',
+    }
+  }
+
+  # Delete campaign.
+  response = campaign_srv.mutate([operation])
+
+  if response and response[:value]
+    campaign = response[:value].first
+    puts "Campaign ID %d was renamed to '%s' and deleted." %
+        [campaign[:id], campaign[:name]]
+  else
+    puts 'No campaign was updated.'
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201209
+
+  begin
+    # ID of a campaign to delete.
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+    delete_campaign(campaign_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