google-adwords-api 0.1.0

data/examples/v201008/add_campaign.rb

@@ -0,0 +1,101 @@
+#!/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 = :v201008
+
+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'
+      }
+    }
+  }
+
+  # 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

data/examples/v201008/add_campaign_ad_extension.rb

@@ -0,0 +1,130 @@
+#!/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 ad extension for an existing
+# campaign. To create a campaign, run add_campaign.rb.
+#
+# Tags: GeoLocationService.get, CampaignAdExtensionService.mutate
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201008
+
+def add_campaign_ad_extension()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  campaign_ad_ext_srv =
+      adwords.service(:CampaignAdExtensionService, API_VERSION)
+  geo_location_srv = adwords.service(:GeoLocationService, API_VERSION)
+
+  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+
+  selector = {
+    :addresses => [
+      {
+        :street_address => '1600 Amphitheatre Parkway',
+        :city_name => 'Mountain View',
+        :province_code => 'CA',
+        :postal_code => '94043',
+        :country_code => 'US'
+      },
+      {
+        :street_address => "38 Avenue de l'Opéra",
+        :city_name => 'Paris',
+        :postal_code => '75002',
+        :country_code => 'FR'
+      }
+    ]
+  }
+
+  # Get the geo location info for the various addresses and build the operations
+  # with that information.
+  locations = geo_location_srv.get(selector)
+  if locations
+    operations = []
+    locations.each do |location|
+      operation = {
+        :operator => 'ADD',
+        :operand => {
+          :campaign_id => campaign_id,
+          :status => 'ACTIVE',
+          :ad_extension => {
+            # 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 => 'LocationExtension',
+            :address => location[:address],
+            :geo_point => location[:geo_point],
+            :encoded_location => location[:encoded_location],
+            :source => 'ADWORDS_FRONTEND'
+          }
+        }
+      }
+      operations << operation
+    end
+  else
+    puts "Unable to retrieve geo locations."
+    exit
+  end
+
+  # Add campaign ad extensions.
+  response = campaign_ad_ext_srv.mutate(operations)
+  extensions = response[:value]
+  extensions.each do |extension|
+    puts "Campaign extension id #{extension[:ad_extension][:id]} and status " +
+        "#{extension[:status]} successfully 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_ad_extension()
+
+  # 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/v201008/add_experiment.rb

@@ -0,0 +1,162 @@
+#!/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 creates an experiment using a query percentage of 10, which
+# defines what fraction of auctions should go to the control split (90%) vs.
+# the experiment split (10%), then adds experimental bid changes for criteria
+# and ad groups. To get campaigns, run get_all_campaigns.rb. To get ad groups,
+# run get_all_ad_groups.rb. To get criteria, run get_all_ad_group_criteria.rb.
+#
+# Tags: ExperimentService.mutate
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201008
+
+def add_experiment()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  experiment_srv = adwords.service(:ExperimentService, API_VERSION)
+  ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
+  ad_group_criterion_srv =
+      adwords.service(:AdGroupCriterionService, API_VERSION)
+
+  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+  criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
+
+  # Prepare for adding experiment.
+  operation = {
+    :operator => 'ADD',
+    :operand => {
+      :campaign_id => campaign_id,
+      :name => 'Interplanetary Experiment #%s' % (Time.new.to_f * 1000).to_i,
+      :query_percentage => 10,
+      :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.' %
+      [experiment[:name], experiment[:id]]
+
+  experiment_id = experiment[:id]
+
+  # Setup ad group for the experiment.
+  ad_group = {
+    :id => ad_group_id,
+    # Set experiment data for the ad group.
+    :experiment_data => {
+      :experiment_id => experiment_id,
+      :experiment_delta_status => 'MODIFIED',
+      # Bid multiplier rule that will modify ad group bid for the experiment.
+      :experiment_bid_multipliers => {
+        :xsi_type => 'ManualCPCAdGroupExperimentBidMultipliers',
+        :max_cpc_multiplier => {
+          :multiplier => 1.5
+        }
+      }
+    }
+  }
+
+  # Prepare for updating ad group.
+  operation = {
+    :operator => 'SET',
+    :operand => ad_group
+  }
+
+  # 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]
+
+  # Setup ad group criterion for the experiment.
+  ad_group_criterion = {
+    :xsi_type => 'BiddableAdGroupCriterion',
+    :ad_group_id => ad_group_id,
+    :criterion => {
+      :id => criterion_id
+    },
+    # Set experiment data for the criterion.
+    :experiment_data => {
+      :xsi_type => 'BiddableAdGroupCriterionExperimentData',
+      :experiment_id => experiment_id,
+      :experiment_delta_status => 'MODIFIED',
+      # Bid multiplier rule that will modify criterion bid for the experiment.
+      :experiment_bid_multiplier => {
+        :xsi_type => 'ManualCPCAdGroupCriterionExperimentBidMultiplier',
+        :max_cpc_multiplier => {
+          :multiplier => 1.5
+        }
+      }
+    }
+  }
+
+  # Prepare for updating ad group criterion.
+  operation = {
+    :operator => 'SET',
+    :operand => ad_group_criterion
+  }
+
+  # Update criterion.
+  response = ad_group_criterion_srv.mutate([operation])
+  criterion = response[:value].first
+  puts 'Criterion id %d was successfully updated for the experiment.' %
+      [criterion[:criterion][: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_experiment()
+
+  # 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/v201008/add_keywords_performance_report_definition.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 adds a keywords performance report. To get ad groups, run
+# get_all_ad_groups.rb. To get report fields, run get_report_fields.rb.
+#
+# Tags: ReportDefinitionService.mutate
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201008
+
+def add_keywords_performance_report_definition()
+  # AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
+  # when called without parameters.
+  adwords = AdwordsApi::Api.new
+  report_def_srv = adwords.service(:ReportDefinitionService, API_VERSION)
+
+  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+  start_date = 'INSERT_START_DATE_HERE'
+  end_date = 'INSERT_END_DATE_HERE'
+
+  # Prepare for adding report definition.
+  operation = {
+    :operator => 'ADD',
+    :operand => {
+      :selector => {
+        :fields => ['AdGroupId', 'Id', 'KeywordText', 'KeywordMatchType',
+                    'Impressions', 'Clicks', 'Cost'],
+        :predicates => [{
+          :operator => 'EQUALS',
+          :field => 'AdGroupId',
+          :values => [ad_group_id]
+        }],
+        :date_range => {
+          :min => start_date,
+          :max => end_date
+        }
+      },
+      :report_name => 'Keywords performance report #%s' %
+          (Time.new.to_f * 1000).to_i,
+      :report_type => 'KEYWORDS_PERFORMANCE_REPORT',
+      :date_range_type => 'CUSTOM_DATE',
+      :download_format => 'XML'
+    }
+  }
+
+  # Add 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' %
+          [report_definition[:report_name], report_definition[:id]]
+    end
+  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_keywords_performance_report_definition()
+
+  # 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