google-adwords-api 0.18.1 → 0.18.3

data/examples/v201603/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 = :v201603
+
+  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/v201603/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 = :v201603
+
+  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/v201603/campaign_management/add_trial.rb

@@ -0,0 +1,142 @@
+#!/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 trial and wait for it to complete.
+#
+# 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_trial(draft_id, 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')
+
+  trial_srv = adwords.service(:TrialService, API_VERSION)
+  trial_async_error_srv = adwords.service(:TrialAsyncErrorService, API_VERSION)
+
+  trial = {
+    :draft_id => draft_id,
+    :base_campaign_id => base_campaign_id,
+    :name => 'Test Trial #%d' % (Time.new.to_f * 1000).to_i,
+    :traffic_split_percent => 50
+  }
+  trial_operation = {:operator => 'ADD', :operand => trial}
+
+  trial_result = trial_srv.mutate([trial_operation])
+
+  trial_id = trial_result[:value].first[:id]
+
+  # Since creating a trial is asynchronous, we have to poll it to wait for
+  # it to finish.
+  selector = {
+    :fields => ['Id', 'Status', 'BaseCampaignId', 'TrialCampaignId'],
+    :predicates => [
+      :field => 'Id', :operator => 'IN', :values => [trial_id]
+    ]
+  }
+
+  poll_attempts = 0
+  is_pending = true
+  trial = nil
+  begin
+    sleep_seconds = 30 * (2 ** poll_attempts)
+    puts "Sleeping for %d seconds" % sleep_seconds
+    sleep(sleep_seconds)
+
+    trial = trial_srv.get(selector)[:entries].first
+
+    puts "Trial ID %d has status '%s'" % [trial[:id], trial[:status]]
+
+    poll_attempts += 1
+    is_pending = (trial[:status] == 'CREATING')
+  end while is_pending and poll_attempts < MAX_POLL_ATTEMPTS
+
+  if trial[:status] == 'ACTIVE'
+    # The trial creation was successful.
+    puts "Trial created with id %d and trial campaign id %d" %
+        [trial[:id], trial[:trial_campaign_id]]
+  elsif trial[:status] == 'CREATION_FAILED'
+    # The trial creation failed, and errors can be fetched from the
+    # TrialAsyncErrorService.
+    selector = {
+      :fields => ['TrialId', 'AsyncError'],
+      :predicates => [
+        {:field => 'TrialId', :operator => 'IN', :values => [trial[:id]]}
+      ]
+    }
+
+    errors = trial_async_error_srv.get(selector)[:entries]
+
+    if errors.nil?
+      puts "Could not retrieve errors for trial %d" % trial[:id]
+    else
+      puts "Could not create trial due to the following errors:"
+      errors.each_with_index do |error, i|
+        puts "Error #%d: %s" % [i, error[:async_error]]
+      end
+    end
+  else
+    # Most likely, the trial is still being created. You can continue polling,
+    # but we have limited the number of attempts in the example.
+    puts ("Timed out waiting to create trial from draft %d with base " +
+        "campaign %d") % [draft_id, base_campaign_id]
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201603
+  MAX_POLL_ATTEMPTS = 6
+
+  begin
+    draft_id = 'INSERT_DRAFT_ID_HERE'.to_i
+    base_campaign_id = 'INSERT_BASE_CAMPAIGN_ID_HERE'.to_i
+
+    add_trial(draft_id, 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/v201603/campaign_management/get_all_disapproved_ads.rb

@@ -0,0 +1,97 @@
+#!/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 illustrates how to retrieve all the disapproved ads in a given
+# ad group. To add ads, run add_text_ads.rb.
+
+require 'adwords_api'
+
+def get_all_disapproved_ads(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')
+
+  ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
+
+  # Get all the disapproved ads for this campaign.
+  selector = {
+    :fields => ['Id', 'AdGroupAdDisapprovalReasons'],
+    :ordering => [{:field => 'Id', :sort_order => 'ASCENDING'}],
+    :predicates => [
+      {:field => 'AdGroupId', :operator => 'IN', :values => [ad_group_id]},
+      {
+        :field => 'AdGroupCreativeApprovalStatus',
+        :operator => 'IN',
+        :values => ['DISAPPROVED']
+      }
+    ]
+  }
+  response = ad_group_ad_srv.get(selector)
+  if response and response[:entries]
+    puts 'Ad group %d has %d disapproved ad(s).' %
+        [ad_group_id, response[:total_num_entries]]
+    response[:entries].each do |ad_group_ad|
+      puts ("\tAd with ID %d and type '%s' was disapproved for the following " +
+          'reasons:') % [ad_group_ad[:ad][:id], ad_group_ad[:ad][:xsi_type]]
+      if ad_group_ad.include?(:disapproval_reasons)
+        ad_group_ad[:disapproval_reasons].each {|reason| puts "\t\t%s" % reason}
+      else
+        puts "\t\tReason not provided."
+      end
+    end
+  else
+    puts 'No disapproved ads found for ad group %d.' % ad_group_id
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201603
+
+  begin
+    # ID of an ad group to get disapproved ads for.
+    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
+    get_all_disapproved_ads(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