google-adwords-api 0.16.1 → 0.17.0

data/examples/v201509/campaign_management/add_complete_campaigns_using_batch_job.rb

@@ -0,0 +1,362 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Copyright:: Copyright 2015, 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 use BatchJobService to create a complete
+# campaign, including ad groups and keywords.
+
+require 'adwords_api'
+
+def add_complete_campaigns_using_batch_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')
+
+  batch_job_srv = adwords.service(:BatchJobService, API_VERSION)
+  batch_job_utils = adwords.batch_job_utils(API_VERSION)
+
+  # Create a BatchJob.
+  add_op = {
+    :operator => 'ADD',
+    :operand => {}
+  }
+
+  response = batch_job_srv.mutate([add_op])
+  batch_job = response[:value].first
+
+  # Get the upload URL from the new job.
+  upload_url = batch_job[:upload_url][:url]
+  puts "Created BatchJob with ID %d, status '%s', and upload URL %s." %
+      [batch_job[:id], batch_job[:status], upload_url]
+
+  # Create a temporary ID generator that will produce a sequence of descending
+  # negative numbers.
+  temp_id_generator = TempIdGenerator.new()
+
+  # Create an array of hashed operations generated from the batch_job_utils.
+  hashed_operations = []
+
+  # Create an operation to create a new budget.
+  budget_operation = build_budget_operation(temp_id_generator)
+  hashed_operations += batch_job_utils.generate_soap_operations(
+      [budget_operation])
+
+  # Create operations to create new campaigns.
+  campaign_operations = build_campaign_operations(
+      temp_id_generator, budget_operation)
+  hashed_operations += batch_job_utils.generate_soap_operations(
+      campaign_operations)
+
+  # Create operations to create new negative keyword criteria for each
+  # campaign.
+  hashed_operations += batch_job_utils.generate_soap_operations(
+      build_campaign_criterion_operations(campaign_operations))
+
+  # Create operations to create new ad groups.
+  ad_group_operations = build_ad_group_operations(
+      temp_id_generator, campaign_operations)
+  hashed_operations += batch_job_utils.generate_soap_operations(
+      ad_group_operations)
+
+  # Create operations to create new ad group criteria (keywords).
+  hashed_operations += batch_job_utils.generate_soap_operations(
+      build_ad_group_criterion_operations(ad_group_operations))
+
+  # Create operations to create new ad group ads (text ads).
+  hashed_operations += batch_job_utils.generate_soap_operations(
+      build_ad_group_ad_operations(ad_group_operations))
+
+  # Use the batch_job_utils to upload all operations.
+  batch_job_utils.post_soap_operations(hashed_operations, upload_url)
+  puts "Uploaded %d operations for batch job with ID %d." %
+      [hashed_operations.size, batch_job[:id]]
+
+  # Poll for completion of the batch job using an exponential back off.
+  poll_attempts = 0
+  is_pending = true
+  selector = {
+    :fields => ['Id', 'Status', 'DownloadUrl', 'ProcessingErrors',
+        'ProgressStats'],
+    :predicates => [{
+      :field => 'Id',
+      :operator => 'IN',
+      :values => [batch_job[:id]]
+    }]
+  }
+
+  begin
+    sleep_seconds = 30 * (2 ** poll_attempts)
+    puts "Sleeping %d seconds" % sleep_seconds
+    sleep(sleep_seconds)
+
+    batch_job = batch_job_srv.get(selector)[:entries].first
+
+    puts "Batch job ID %d has status '%s'." %
+        [batch_job[:id], batch_job[:status]]
+
+    poll_attempts += 1
+    is_pending = PENDING_STATUSES.include?(batch_job[:status])
+  end while is_pending and poll_attempts < MAX_POLL_ATTEMPTS
+
+  if is_pending
+    raise StandardError,
+        "Job is still in pending state after polling %d times." %
+        MAX_POLL_ATTEMPTS
+  end
+
+  unless batch_job[:processing_errors].nil?
+    batch_job[:processing_errors].each_with_index do |processing_error, i|
+      puts ("Processing error [%d]: errorType=%s, trigger=%s, errorString=%s" +
+          "fieldPath=%s, reason=%s") % [i, processing_error[:api_error_type],
+          processing_error[:trigger], processing_error[:error_string],
+          processing_error[:field_path], processing_error[:reason]]
+    end
+  end
+
+  unless batch_job[:download_url].nil? or batch_job[:download_url][:url].nil?
+    mutate_response = batch_job_utils.get_job_results(
+        batch_job[:download_url][:url])
+    puts "Downloaded results from '%s':" % batch_job[:download_url][:url]
+    mutate_response.each do |mutate_result|
+      outcome = "FAILURE"
+      outcome = "SUCCESS" if mutate_result[:error_list].nil?
+      puts "  Operation [%d] - %s" % [mutate_result[:index], outcome]
+    end
+  end
+end
+
+# Custom class to generate temporary negative IDs for created entities to
+# reference each other.
+class TempIdGenerator
+  def initialize()
+    @counter = -1
+  end
+
+  def next()
+    ret = @counter
+    @counter -= 1
+    return ret
+  end
+end
+
+def get_time_microseconds()
+  return (Time.now.to_f * 1000000).to_i
+end
+
+def build_budget_operation(temp_id_generator)
+  budget = {
+    :budget_id => temp_id_generator.next,
+    :name => "Interplanetary Cruise %d" % get_time_microseconds(),
+    :amount => {
+      :micro_amount => 50000000
+    },
+    :delivery_method => 'STANDARD',
+    :period => 'DAILY'
+  }
+  budget_operation = {
+    # The xsi_type of the operation can usually be guessed by the API because
+    # a given service only handles one type of operation. However, batch jobs
+    # process operations of different types, so the xsi_type must always be
+    # explicitly defined for these operations.
+    :xsi_type => 'BudgetOperation',
+    :operator => 'ADD',
+    :operand => budget
+  }
+  return budget_operation
+end
+
+def build_campaign_operations(temp_id_generator, budget_operation)
+  budget_id = budget_operation[:operand][:budget_id]
+
+  operations = []
+  NUMBER_OF_CAMPAIGNS_TO_ADD.times do
+    campaign = {
+      :name => "Batch Campaign %s" % get_time_microseconds(),
+      :status => 'PAUSED',
+      :id => temp_id_generator.next,
+      :advertising_channel_type => 'SEARCH',
+      :budget => {
+        :budget_id => budget_id
+      },
+      :bidding_strategy_configuration => {
+        :bidding_strategy_type => 'MANUAL_CPC',
+        # You can optionally provide a bidding scheme in place of the type.
+        :bidding_scheme => {
+          :xsi_type => 'ManualCpcBiddingScheme',
+          :enhanced_cpc_enabled => false
+        }
+      }
+    }
+    operation = {
+      :xsi_type => 'CampaignOperation',
+      :operator => 'ADD',
+      :operand => campaign
+    }
+    operations << operation
+  end
+
+  return operations
+end
+
+def build_campaign_criterion_operations(campaign_operations)
+  operations = []
+  campaign_operations.each do |campaign_operation|
+    keyword = {
+      :xsi_type => 'Keyword',
+      :match_type => 'BROAD',
+      :text => 'venus'
+    }
+    negative_criterion = {
+      :xsi_type => 'NegativeCampaignCriterion',
+      :campaign_id => campaign_operation[:operand][:id],
+      :criterion => keyword
+    }
+    operation = {
+      :xsi_type => 'CampaignCriterionOperation',
+      :operator => 'ADD',
+      :operand => negative_criterion
+    }
+    operations << operation
+  end
+
+  return operations
+end
+
+def build_ad_group_operations(temp_id_generator, campaign_operations)
+  operations = []
+  campaign_operations.each do |campaign_operation|
+    NUMBER_OF_ADGROUPS_TO_ADD.times do
+      ad_group = {
+        :campaign_id => campaign_operation[:operand][:id],
+        :id => temp_id_generator.next,
+        :name => "Batch Ad Group %s" % get_time_microseconds(),
+        :bidding_strategy_configuration => {
+          :bids => [
+            {
+              :xsi_type => 'CpcBid',
+              :bid => {:micro_amount => 10000000}
+            }
+          ]
+        }
+      }
+      operation = {
+        :xsi_type => 'AdGroupOperation',
+        :operator => 'ADD',
+        :operand => ad_group
+      }
+      operations << operation
+    end
+  end
+
+  return operations
+end
+
+def build_ad_group_criterion_operations(ad_group_operations)
+  operations = []
+  ad_group_operations.each do |ad_group_operation|
+    NUMBER_OF_KEYWORDS_TO_ADD.times do |i|
+      text = "mars%d" % i
+
+      # Make 50% of keywords invalid to demonstrate error handling.
+      text = text + "!!!" if i % 2 == 0
+      keyword = {
+        :xsi_type => 'Keyword',
+        :text => text,
+        :match_type => 'BROAD'
+      }
+      biddable_criterion = {
+        :xsi_type => 'BiddableAdGroupCriterion',
+        :ad_group_id => ad_group_operation[:operand][:id],
+        :criterion => keyword
+      }
+      operation = {
+        :xsi_type => 'AdGroupCriterionOperation',
+        :operator => 'ADD',
+        :operand => biddable_criterion
+      }
+      operations << operation
+    end
+  end
+
+  return operations
+end
+
+def build_ad_group_ad_operations(ad_group_operations)
+  operations = []
+  ad_group_operations.each do |ad_group_operation|
+    text_ad = {
+      :xsi_type => 'TextAd',
+      :headline => 'Luxury Cruise to Mars',
+      :description1 => 'Visit the Red Planet in style.',
+      :description2 => 'Low-gravity fun for everyone!',
+      :display_url => 'www.example.com',
+      :final_urls => ['http://www.example.com/1']
+    }
+    ad_group_ad = {
+      :ad_group_id => ad_group_operation[:operand][:id],
+      :ad => text_ad
+    }
+    operation = {
+      :xsi_type => 'AdGroupAdOperation',
+      :operator => 'ADD',
+      :operand => ad_group_ad
+    }
+    operations << operation
+  end
+
+  return operations
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201509
+  NUMBER_OF_CAMPAIGNS_TO_ADD = 2
+  NUMBER_OF_ADGROUPS_TO_ADD = 2
+  NUMBER_OF_KEYWORDS_TO_ADD = 5
+  MAX_POLL_ATTEMPTS = 5
+  PENDING_STATUSES = ['ACTIVE', 'AWAITING_FILE']
+
+  begin
+    add_complete_campaigns_using_batch_job()
+
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
+
+  # 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/v201509/campaign_management/add_experiment.rb

@@ -0,0 +1,162 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# 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_campaigns.rb. To get ad groups,
+# run get_ad_groups.rb. To get keywords, run get_keywords.rb.
+
+require 'adwords_api'
+require 'date'
+
+def add_experiment(campaign_id, ad_group_id, criterion_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')
+
+  experiment_srv = adwords.service(:ExperimentService, API_VERSION)
+  ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
+  ad_group_criterion_srv =
+      adwords.service(:AdGroupCriterionService, API_VERSION)
+
+  # Prepare for adding experiment.
+  operation = {
+    :operator => 'ADD',
+    :operand => {
+      :campaign_id => campaign_id,
+      :name => "Interplanetary Experiment #%d" % (Time.new.to_f * 1000).to_i,
+      :query_percentage => 10,
+      :start_date_time => Time.now.strftime('%Y%m%d %H%M%S'),
+      # Optional fields:
+      :status => 'ENABLED',
+      :end_date_time =>
+         DateTime.parse((Date.today + 30).to_s).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
+  API_VERSION = :v201509
+
+  begin
+    # IDs of the required objects.
+    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
+    add_experiment(campaign_id, ad_group_id, criterion_id)
+
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
+
+  # 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/v201509/campaign_management/add_keywords_in_bulk.rb

@@ -0,0 +1,153 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# 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 add many keywords using asynchronous
+# requests and MutateJobService.
+
+require 'adwords_api'
+
+def add_keywords_in_bulk()
+  # 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 keywords.
+  operations = (1..KEYWORD_NUMBER).map do |index|
+    {:xsi_type => 'AdGroupCriterionOperation',
+     :operator => 'ADD',
+     :operand => {
+       :xsi_type => 'BiddableAdGroupCriterion',
+       :ad_group_id => ad_group_id,
+       :criterion => {
+         :xsi_type => 'Keyword',
+         :match_type => 'BROAD',
+         :text => "mars%d" % index}}}
+  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
+  API_VERSION = :v201509
+  RETRY_INTERVAL = 30
+  RETRIES_COUNT = 30
+  KEYWORD_NUMBER = 100
+
+  begin
+    add_keywords_in_bulk()
+
+  # Authorization error.
+  rescue AdsCommon::Errors::OAuth2VerificationRequired => e
+    puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
+        "OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
+        "to retrieve and store OAuth2 tokens."
+    puts "See this wiki page for more details:\n\n  " +
+        'https://github.com/googleads/google-api-ads-ruby/wiki/OAuth2'
+
+  # 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