google-adwords-api 0.1.0

data/examples/v201101/set_ad_params.rb

@@ -0,0 +1,124 @@
+#!/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 a text ad with ad parameters. To add an
+# ad group, run add_ad_group.rb. To add an ad group criterion, run
+# add_ad_group_criterion.rb.
+#
+# Tags: AdGroupAdService.mutate, AdParamService.mutate
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201101
+
+def set_ad_params()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
+  ad_param_srv = adwords.service(:AdParamService, API_VERSION)
+
+  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+  criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
+
+  # Prepare for adding ad.
+  ad_operation = {
+    :operator => 'ADD',
+    :operand => {
+      :ad_group_id => ad_group_id,
+      :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.
+        :xsi_type => 'TextAd',
+        :headline => 'Luxury Mars Cruises',
+        :description1 => 'Low-gravity fun for {param1:cheap}.',
+        :description2 => 'Only {param2:a few} seats left!',
+        :url => 'http://www.example.com',
+        :display_url => 'www.example.com'
+      }
+    }
+  }
+
+  # Add ad.
+  response = ad_group_ad_srv.mutate([ad_operation])
+  ad = response[:value].first[:ad]
+  puts 'Text ad id %d was successfully added.' % ad[:id]
+
+  # Prepare for setting ad parameters.
+  price_operation = {
+    :operator => 'SET',
+    :operand => {
+      :ad_group_id => ad_group_id,
+      :criterion_id => criterion_id,
+      :param_index => 1,
+      :insertion_text => "$100"
+    }
+  }
+
+  seat_operation = {
+    :operator => 'SET',
+    :operand => {
+      :ad_group_id => ad_group_id,
+      :criterion_id => criterion_id,
+      :param_index => 2,
+      :insertion_text => "50"
+    }
+  }
+
+  # Set ad parameters.
+  response = ad_param_srv.mutate([price_operation, seat_operation])
+  puts 'Parameters were successfully updated.'
+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
+    set_ad_params()
+
+  # 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/set_campaign_targets.rb

@@ -0,0 +1,111 @@
+#!/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 adds geo, language and network targeting to an existing campaign.
+# To create a campaign, run add_campaign.rb.
+#
+# Tags: CampaignTargetService.mutate
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201101
+
+def set_campaign_targets()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  campaign_target_srv = adwords.service(:CampaignTargetService, API_VERSION)
+
+  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+
+  # Language targeting.
+  language_operation = {
+    :operator => 'SET',
+    :operand => {
+      :xsi_type => 'LanguageTargetList',
+      :campaign_id => campaign_id,
+      :targets => [{:language_code => 'fr'}, {:language_code => 'ja'}]
+     }
+  }
+
+  # Geo targeting.
+  geo_operation = {
+    :operator => 'SET',
+    :operand => {
+      :xsi_type => 'GeoTargetList',
+      :campaign_id => campaign_id,
+      :targets => [
+        {
+          :xsi_type => 'CountryTarget',
+          :excluded => false,
+          :country_code => 'US'
+        },
+        {
+          :xsi_type => 'CountryTarget',
+          :excluded => false,
+          :country_code => 'JP'
+        }
+      ]
+    }
+  }
+
+  # Set campaign targeting.
+  response = campaign_target_srv.mutate([language_operation, geo_operation])
+  targets = response[:value]
+  targets.each do |target|
+    puts "Campaign target of type #{target[:xsi_type]} for campaign id " +
+        "#{target[:campaign_id]} was set."
+  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
+    set_campaign_targets()
+
+  # 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_ad.rb

@@ -0,0 +1,95 @@
+#!/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 an ad, setting its status to 'PAUSED'.
+# To create ads, run add_ads.rb.
+#
+# Tags: AdGroupAdService.mutate
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201101
+
+def update_ad()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  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 updating ad.
+  operation = {
+    :operator => 'SET',
+    :operand => {
+      :ad_group_id => ad_group_id,
+      :status => 'PAUSED',
+      :ad => {
+        :id => ad_id
+      }
+    }
+  }
+
+  # Update ad.
+  response = ad_group_ad_srv.mutate([operation])
+  if response and response[:value]
+    ad = response[:value].first
+    puts 'Ad id %d was successfully updated, status set to %s.' %
+        [ad[:ad][:id], ad[:status]]
+  else
+    puts 'No ads 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_ad()
+
+  # 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_ad_group.rb

@@ -0,0 +1,90 @@
+#!/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 an ad group, setting its status to
+# 'PAUSED'. To create an ad group, run add_ad_group.rb.
+#
+# Tags: AdGroupService.mutate
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201101
+
+def update_ad_group()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
+
+  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+
+  # Prepare for updating ad group.
+  operation = {
+    :operator => 'SET',
+    :operand => {
+      :status => 'PAUSED',
+      :id => ad_group_id
+    }
+  }
+
+  # Update 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 updated.' % ad_group[:id]
+  else
+    puts 'No ad groups 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_ad_group()
+
+  # 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_ad_group_criterion.rb

@@ -0,0 +1,108 @@
+#!/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 an ad group criterion, setting its
+# bid. To create an ad group criterion, run add_ad_group_criterion.rb.
+#
+# Tags: AdGroupCriterionService.mutate
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201101
+
+def update_ad_group_criterion()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  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 updating ad group criterion.
+  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 => 'BiddableAdGroupCriterion',
+      :ad_group_id => ad_group_id,
+      :criterion => {
+        :id => criterion_id
+      },
+      :bids => {
+        :xsi_type => 'ManualCPCAdGroupCriterionBids',
+        :max_cpc => {
+          :amount => {
+            :micro_amount => 1000000
+          }
+        }
+      }
+    }
+  }
+
+  # Update criterion.
+  response = ad_group_criterion_srv.mutate([operation])
+  if response and response[:value]
+    ad_group_criterion = response[:value].first
+    puts 'Criterion id %d was successfully updated, bid set to %d.' %
+        [ad_group_criterion[:criterion][:id],
+         ad_group_criterion[:bids][:max_cpc][:amount][:micro_amount]]
+  else
+    puts 'No criteria 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_ad_group_criterion()
+
+  # 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