google-adwords-api 0.19.0 → 0.19.1

data/examples/v201605/campaign_management/add_draft.rb

@@ -0,0 +1,114 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Copyright:: Copyright 2016, 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 draft and access its associated
+# draft campaign.
+#
+# See the Campaign Drafts and Experiments guide for more information:
+# https://developers.google.com/adwords/api/docs/guides/campaign-drafts-experiments
+
+require 'adwords_api'
+require 'date'
+
+def add_draft(base_campaign_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')
+
+  draft_srv = adwords.service(:DraftService, API_VERSION)
+
+  draft = {
+    :base_campaign_id => base_campaign_id,
+    :draft_name => 'Test Draft #%d' % (Time.new.to_f * 1000).to_i
+  }
+  draft_operation = {:operator => 'ADD', :operand => draft}
+
+  draft_result = draft_srv.mutate([draft_operation])
+
+  draft = draft_result[:value].first
+  draft_id = draft[:draft_id]
+  draft_campaign_id = draft[:draft_campaign_id]
+
+  puts "Draft with id %d and base campaign %d and draft campaign %d created" %
+      [draft_id, draft[:base_campaign_id], draft_campaign_id]
+
+  # Once the draft is created, you can modify the draft campaign as if it
+  # were a real campaign. For example, you may add criteria, adjust bids,
+  # or even include additional ads. Adding a criterion is shown here.
+  campaign_criterion_srv =
+      adwords.service(:CampaignCriterionService, API_VERSION)
+
+  criterion = {
+    :xsi_type => 'Language',
+    :id => 1003 # Spanish
+  }
+
+  criterion_operation = {
+    # Make sure to use the draft_campaign_id when modifying the virtual draft
+    # campaign.
+    :operator => 'ADD',
+    :operand => {
+      :campaign_id => draft_campaign_id,
+      :criterion => criterion
+    }
+  }
+
+  criterion_result = campaign_criterion_srv.mutate([criterion_operation])
+
+  criterion = criterion_result[:value].first
+
+  puts "Draft updated to include criteria in campaign %d" % draft_campaign_id
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201605
+
+  begin
+    base_campaign_id = 'INSERT_BASE_CAMPAIGN_ID_HERE'.to_i
+
+    add_draft(base_campaign_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/v201605/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 = :v201605
+
+  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/v201605/campaign_management/add_keywords_using_incremental_batch_job.rb

@@ -0,0 +1,210 @@
+#!/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 example illustrates how to perform multiple requests using the
+# BatchJobService using incremental uploads.
+
+require 'adwords_api'
+
+def add_keywords_using_incremental_batch_job(ad_group_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')
+
+  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]
+
+  # Upload #1
+  incremental_helper = batch_job_utils.start_incremental_upload(upload_url)
+  operations = create_keyword_operations(ad_group_id)
+  incremental_helper.upload(operations)
+
+  # Upload #2
+  operations = create_keyword_operations(ad_group_id)
+  incremental_helper.upload(operations)
+
+  # Upload #3
+  operations = create_keyword_operations(ad_group_id)
+  incremental_helper.upload(operations, true)
+
+  # Poll for completion of the batch job using an exponential back off.
+  poll_attempts = 0
+  is_pending = true
+  cancel_requested = false
+  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 for %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])
+
+    if is_pending && !cancel_requested && poll_attempts == MAX_POLL_ATTEMPTS
+      batch_job[:status] = 'CANCELING'
+
+      set_op = {
+        :operator => 'SET',
+        :operand => batch_job
+      }
+
+      # Only request cancellation once per job.
+      cancel_requested = true
+
+      begin
+        batch_job = batch_job_srv.mutate([set_op])[:value].first
+        puts "Requested cancellation of batch job with ID %d" % batch_job[:id]
+      rescue AdwordsApi::Errors::ApiException => e
+        if !e.message.nil? && e.message.include?('INVALID_STATE_CHANGE')
+          puts ("Attempt to cancel batch job with ID %d was rejected " +
+              "because the job already completed or was canceled.") %
+              batch_job[:id]
+          next
+        end
+        raise e
+      end
+    end
+  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
+
+  if batch_job[:status] == 'CANCELED'
+    puts "Job was canceled before completion."
+    return
+  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
+
+def create_keyword_operations(ad_group_id)
+  operations = []
+  KEYWORD_COUNT.times do |i|
+    text = "keyword %d" % i
+
+    # Make 10% of keywords invalid to demonstrate error handling.
+    text = text + "!!!" if i % 10 == 0
+    keyword = {
+      :xsi_type => 'Keyword',
+      :text => text,
+      :match_type => 'BROAD'
+    }
+    biddable_criterion = {
+      :xsi_type => 'BiddableAdGroupCriterion',
+      :ad_group_id => ad_group_id,
+      :criterion => keyword
+    }
+    operation = {
+      :xsi_type => 'AdGroupCriterionOperation',
+      :operator => 'ADD',
+      :operand => biddable_criterion
+    }
+    operations << operation
+  end
+
+  return operations
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201605
+  KEYWORD_COUNT = 100
+  MAX_POLL_ATTEMPTS = 5
+  PENDING_STATUSES = ['ACTIVE', 'AWAITING_FILE', 'CANCELING']
+
+  begin
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+
+    add_keywords_using_incremental_batch_job(ad_group_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