google-adx-buyer-api 0.2.0 → 0.4.0

data/examples/v201109/perform_mutate_job.rb

@@ -0,0 +1,151 @@
+#!/usr/bin/ruby
+#
+# 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 code sample illustrates how to perform asynchronous requests using the
+# MutateJobService.
+#
+# Tags: MutateJobService.mutate, MutateJobService.get,
+#       MutateJobService.getResult
+
+require 'rubygems'
+require 'adwords_api'
+
+API_VERSION = :v201109
+RETRY_INTERVAL = 30
+RETRIES_COUNT = 30
+PLACEMENT_NUMBER = 100
+
+def perform_mutate_job()
+  # 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')
+
+  mutate_job_srv = adwords.service(:MutateJobService, API_VERSION)
+
+  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+
+  # Create AdGroupCriterionOperations to add placements.
+  operations = (1..PLACEMENT_NUMBER).map do |index|
+    url = (rand(10) == 0) ? 'invalid-url' : 'http://mars.google.com/'
+    {:xsi_type => 'AdGroupCriterionOperation',
+     :operator => 'ADD',
+     :operand => {
+         :xsi_type => 'BiddableAdGroupCriterion',
+         :ad_group_id => ad_group_id,
+         :criterion => {
+             :xsi_type => 'Placement',
+             :url => url
+         }}}
+  end
+
+  # You can specify up to 3 job IDs that must successfully complete before
+  # this job can be processed.
+  policy = {:prerequisite_job_ids => []}
+
+  # Call mutate to create a new job.
+  response = mutate_job_srv.mutate(operations, policy)
+
+  raise StandardError, 'Failed to submit a job; aborting.' unless response
+
+  job_id = response[:id]
+  puts "Job ID %d was successfully created." % job_id
+
+  # Creating selector to retrive hob status and wait for it to complete.
+  selector = {
+      :xsi_type => 'BulkMutateJobSelector',
+      :job_ids => [job_id]
+  }
+
+  status = nil
+
+  # Poll for job status until it's finished.
+  puts 'Retrieving job status...'
+  RETRIES_COUNT.times do |retry_attempt|
+    job_status_response = mutate_job_srv.get(selector)
+    if job_status_response
+      status = job_status_response.first[:status]
+      case status
+        when 'FAILED'
+          raise StandardError, "Job failed with reason: '%s'" %
+              job_status_response.first[:failure_reason]
+        when 'COMPLETED'
+          puts "[%d] Job finished with status '%s'" % [retry_attempt, status]
+          break
+        else
+          puts "[%d] Current status is '%s', waiting %d seconds to retry..." %
+              [retry_attempt, status, RETRY_INTERVAL]
+          sleep(RETRY_INTERVAL)
+      end
+    else
+      raise StandardError, 'Error retrieving job status; aborting.'
+    end
+  end
+
+  if status == 'COMPLETED'
+    # Get the job result. Here we re-use the same selector.
+    result_response = mutate_job_srv.get_result(selector)
+
+    if result_response and result_response[:simple_mutate_result]
+      results = result_response[:simple_mutate_result][:results]
+      if results
+        results.each_with_index do |result, index|
+          result_message = result.include?(:place_holder) ?
+              'FAILED' : 'SUCCEEDED'
+          puts "Operation [%d] - %s" % [index, result_message]
+        end
+      end
+      errors = result_response[:simple_mutate_result][:errors]
+      if errors
+        errors.each do |error|
+          puts "Error, reason: '%s', trigger: '%s', field path: '%s'" %
+            [error[:reason], error[:trigger], error[:field_path]]
+        end
+      end
+    else
+      raise StandardError, 'Error retrieving job results; aborting.'
+    end
+  else
+    puts "Job failed to complete after %d retries" % RETRY_COUNT
+  end
+end
+
+if __FILE__ == $0
+  begin
+    perform_mutate_job()
+
+  # 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/{v201101/promote_experiment.rb → v201109/update_ad.rb}

@@ -17,50 +17,57 @@
 #           See the License for the specific language governing permissions and
 #           limitations under the License.
 #
-# This example promotes an experiment, which permanently applies all the
-# experiment changes made to its related ad groups, criteria and ads. To get
-# experiments, run get_all_experiments.rb.
+# This example illustrates how to update an ad, setting its status to 'PAUSED'.
+# To create ads, run add_ads.rb.
 #
-# Tags: ExperimentService.mutate
+# Tags: AdGroupAdService.mutate
 
 require 'rubygems'
 gem 'google-adwords-api'
 require 'adwords_api'
 
-API_VERSION = :v201101
+API_VERSION = :v201109
 
-def promote_experiment()
+def update_ad()
   # 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)
 
-  experiment_id = 'INSERT_EXPERIMENT_ID_HERE'.to_i
+  # 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')
 
-  # Prepare for updating experiment.
+  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 => {
-      :id => experiment_id,
-      :status => 'PROMOTED',
+      :ad_group_id => ad_group_id,
+      :status => 'PAUSED',
+      :ad => {
+        :id => ad_id
+      }
     }
   }
 
-  # Update experiment.
-  response = experiment_srv.mutate([operation])
-  experiment = response[:value].first
-  puts 'Experiment with name "%s" and id %d was promoted.' %
-      [experiment[:name], experiment[: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
-    promote_experiment()
+    update_ad()
 
   # Connection error. Likely transitory.
   rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e

data/examples/v201109/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 = :v201109
+
+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
+
+  # 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)
+
+  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
+  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/v201109/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 = :v201109
+
+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
+
+  # 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)
+
+  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 => 'ManualCPMAdGroupCriterionBids',
+        :max_cpm => {
+          :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_cpm][:amount][:micro_amount]]
+  else
+    puts 'No criteria were updated.'
+  end
+end
+
+if __FILE__ == $0
+  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

data/examples/v201109/update_campaign.rb

@@ -0,0 +1,93 @@
+#!/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 a campaign, setting its budget delivery
+# to 'ACCELERATED'. To create a campaign, run add_campaign.rb.
+#
+# Tags: CampaignService.mutate
+
+require 'rubygems'
+gem 'google-adwords-api'
+require 'adwords_api'
+
+API_VERSION = :v201109
+
+def update_campaign()
+  # 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)
+
+  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+
+  # Prepare for updating campaign.
+  operation = {
+    :operator => 'SET',
+    :operand => {
+      :id => campaign_id,
+      :budget => {
+        :delivery_method => 'ACCELERATED'
+      }
+    }
+  }
+
+  # Update campaign.
+  response = campaign_srv.mutate([operation])
+  if response and response[:value]
+    campaign = response[:value].first
+    puts 'Campaign id %d successfully updated, delivery method set to %s.' %
+        [campaign[:id], campaign[:budget][:delivery_method]]
+  else
+    puts 'No campaigns were updated.'
+  end
+end
+
+if __FILE__ == $0
+  begin
+    update_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