google-adwords-api 0.1.0

data/examples/v201101/add_ad_group.rb

@@ -0,0 +1,98 @@
+#!/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'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201101
+
+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
+  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 #%s' % (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
+  # 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_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/add_ad_group_criteria.rb

@@ -0,0 +1,117 @@
+#!/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 a criterion to a given ad group. To create
+# an ad group, run add_ad_group.rb.
+#
+# Tags: AdGroupCriterionService.mutate
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201101
+
+def add_ad_group_criteria()
+  # 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
+
+  # Create keyword.
+  kwd_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 => 'BiddableAdGroupCriterion',
+      :ad_group_id => ad_group_id,
+      :criterion => {
+        :xsi_type => 'Keyword',
+        :text => 'mars cruise',
+        :match_type => 'BROAD'
+      }
+    }
+  }
+
+  # Create placement.
+  plc_operation = {
+    :operator => 'ADD',
+    :operand => {
+      :xsi_type => 'BiddableAdGroupCriterion',
+      :ad_group_id => ad_group_id,
+      :criterion => {
+        :xsi_type => 'Placement',
+        :url => 'http://mars.google.com'
+      }
+    }
+  }
+
+  # Add criteria.
+  response = ad_group_criterion_srv.mutate([kwd_operation, plc_operation])
+  if response and response[:value]
+    ad_group_criteria = response[:value]
+    puts "Added #{ad_group_criteria.length} criteria to ad group " +
+        "#{ad_group_id}."
+    ad_group_criteria.each do |ad_group_criterion|
+      puts "  Criterion id is #{ad_group_criterion[:criterion][:id]} and " +
+          "type is #{ad_group_criterion[:criterion][:xsi_type]}."
+    end
+  else
+    puts "No criteria 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_ad_group_criteria()
+
+  # 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_ads.rb

@@ -0,0 +1,182 @@
+#!/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 a text ad, an image ad and template (Click
+# to Play Video) ad to a given ad group. To create an ad group, run
+# add_ad_group.rb. To get all videos, run get_all_videos.rb. To upload video,
+# see http://adwords.google.com/support/aw/bin/answer.py?hl=en&answer=39454 .
+#
+# Tags: AdGroupAdService.mutate
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+require 'base64'
+
+API_VERSION = :v201101
+
+def add_ads()
+  # 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
+  video_media_id = 'INSERT_VIDEO_MEDIA_ID_HERE'.to_i
+
+  # Create text ad.
+  text_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 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',
+      }
+    }
+  }
+
+  # Retrieve image and encode it.
+  image_url = 'https://sandbox.google.com/sandboximages/image.jpg'
+  # This utility method retrieves the contents of a URL using all of the config
+  # options provided to the Api object.
+  image_data = AdsCommon::Http.get(image_url, adwords.config)
+  base64_image_data = Base64.encode64(image_data)
+
+  # Create image ad.
+  image_ad_operation = {
+    :operator => 'ADD',
+    :operand => {
+      :ad_group_id => ad_group_id,
+      :ad => {
+        :xsi_type => 'ImageAd',
+        :name => 'Cruise to mars image ad #%s' % (Time.new.to_f * 1000).to_i,
+        :url => 'http://www.example.com',
+        :display_url => 'www.example.com',
+        :image => {
+          :data => base64_image_data
+        }
+      }
+    }
+  }
+
+  # Create template ad, using the Click to Play Video template (id 9).
+  template_ad_operation = {
+    :operator => 'ADD',
+    :operand => {
+      :adGroupId => ad_group_id,
+      :ad => {
+        :xsi_type => 'TemplateAd',
+        :template_id => 9,
+        :dimensions => {
+          :width => 300,
+          :height => 250
+        },
+        :name => 'Mars cruise video ad #%s' % (Time.new.to_f * 1000).to_i,
+        :display_url => 'www.example.com',
+        :url => 'http://www.example.com',
+        :template_elements => [{
+          :unique_name => 'adData',
+          :fields => [
+            {
+              :name => 'startImage',
+              :type => 'IMAGE',
+              :field_media => {
+                :xsi_type => 'Image',
+                :type => 'IMAGE',
+                :name => 'StartingImage',
+                :data => base64_image_data  # Reusing the same image data
+              }
+            },
+            {
+              :name => 'displayUrlColor',
+              :type => 'ENUM',
+              :field_text => '#ffffff'
+            },
+            {
+              :name => 'video',
+              :type => 'VIDEO',
+              :field_media => {
+                :xsi_type => 'Video',
+                :type => 'VIDEO',
+                :name => 'video',
+                :media_id => video_media_id
+              }
+            }
+          ]
+        }]
+      }
+    }
+  }
+
+  # Add ads.
+  response = ad_group_ad_srv.mutate([text_ad_operation, image_ad_operation,
+    template_ad_operation])
+  if response and response[:value]
+    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]}\"."
+    end
+  else
+    puts "No ads 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_ads()
+
+  # 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_campaign.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 create a campaign.
+#
+# Tags: CampaignService.mutate
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201101
+
+def add_campaign()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  campaign_srv = adwords.service(:CampaignService, API_VERSION)
+
+  # Prepare for adding campaign.
+  operation = {
+    :operator => 'ADD',
+    :operand => {
+      :name => 'Interplanetary Cruise #%s' % (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
+        # being created. It's only necessary when you must provide an explicit
+        # type that the client library can't infer.
+        :xsi_type => 'ManualCPC'
+      },
+      :budget => {
+        :period => 'DAILY',
+        :amount => {
+          :micro_amount => 50000000
+        },
+        :delivery_method => 'STANDARD'
+      },
+      # Set the campaign network options to Search and Search Network.
+      :network_setting => {
+        :target_google_search => true,
+        :target_search_network => true,
+        :target_content_network => false,
+        :target_content_contextual => false
+      }
+    }
+  }
+
+  # 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.' %
+        [campaign[:name], campaign[:id]]
+  else
+    puts 'No campaigns 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_campaign()
+
+  # 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