google-adwords-api 0.20.0 → 0.20.1

data/examples/v201607/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 = :v201607
+  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/v201607/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 = :v201607
+
+  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

data/examples/v201607/campaign_management/get_all_disapproved_ads_with_awql.rb

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Copyright:: Copyright 2012, 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 with AWQL. To add ads, run add_text_ads.rb.
+
+require 'adwords_api'
+
+def get_all_disapproved_ads_with_awql(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.
+  query = ('SELECT Id, AdGroupAdDisapprovalReasons ' +
+      'WHERE AdGroupId = %d AND AdGroupCreativeApprovalStatus = DISAPPROVED ' +
+      'ORDER BY Id') % ad_group_id
+
+  response = ad_group_ad_srv.query(query)
+  if response and response[:entries]
+    puts 'Ad group ID %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 ID %d.' % ad_group_id
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201607
+
+  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_with_awql(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

data/examples/v201607/campaign_management/get_campaigns_by_label.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Copyright:: Copyright 2014, 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 gets all campaigns with a specific label. To add a label
+# to campaigns, run add_campaign_labels.rb.
+
+require 'adwords_api'
+
+def get_campaigns_by_label(label_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')
+
+  campaign_srv = adwords.service(:CampaignService, API_VERSION)
+
+  # Get all the ad groups for this campaign.
+  selector = {
+    :fields => ['Id', 'Name', 'Labels'],
+    :ordering => [{:field => 'Name', :sort_order => 'ASCENDING'}],
+    :predicates => [
+      {
+        :field => 'Labels',
+        # Labels filtering is performed by ID. You can use CONTAINS_ANY to
+        # select campaigns with any of the label IDs, CONTAINS_ALL to select
+        # campaigns with all of the label IDs, or CONTAINS_NONE to select
+        # campaigns with none of the label IDs.
+        :operator => 'CONTAINS_ANY',
+        :values => [label_id]
+      }
+    ],
+    :paging => {
+      :start_index => 0,
+      :number_results => PAGE_SIZE
+    }
+  }
+
+  # Set initial values.
+  offset, page = 0, {}
+
+  begin
+    page = campaign_srv.get(selector)
+    if page[:entries]
+      page[:entries].each do |campaign|
+        label_string = campaign[:labels].map do |label|
+          '%d/"%s"' % [label[:id], label[:name]]
+        end.join(', ')
+        puts 'Campaign found with name "%s" and ID %d and labels: %s.' %
+            [campaign[:name], campaign[:id], label_string]
+      end
+      # Increment values to request the next page.
+      offset += PAGE_SIZE
+      selector[:paging][:start_index] = offset
+    end
+  end while page[:total_num_entries] > offset
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201607
+  PAGE_SIZE = 500
+
+  begin
+    # Label ID to get campaigns for.
+    label_id = 'INSERT_LABEL_ID_HERE'.to_i
+    get_campaigns_by_label(label_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/v201607/campaign_management/graduate_trial.rb

@@ -0,0 +1,106 @@
+#!/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 graduate a trial.
+#
+# 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 graduate_trial(trial_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)
+  budget_srv = adwords.service(:BudgetService, API_VERSION)
+
+  # To graduate a trial, you must specify a different budget from the base
+  # campaign. The base campaign (in order to have had a trial based on it)
+  # must have a non-shared budget, so it cannot be shared with the new
+  # independent campaign created by graduation.
+  budget = {
+    :name => 'Budget #%d' % (Time.new.to_f * 1000).to_i,
+    :amount => {:micro_amount => 50000000},
+    :delivery_method => 'STANDARD'
+  }
+  budget_operation = {:operator => 'ADD', :operand => budget}
+
+  # Add budget.
+  return_budget = budget_srv.mutate([budget_operation])
+  budget_id = return_budget[:value].first[:budget_id]
+
+  trial = {
+    :id => trial_id,
+    :budget_id => budget_id,
+    :status => 'GRADUATED'
+  }
+
+  trial_operation = {:operator => 'SET', :operand => trial}
+
+  # Update the trial.
+  return_trial = trial_srv.mutate([trial_operation])
+  trial = return_trial[:value].first
+
+  # Graduation is a synchronous operation, so the campaign is already ready.
+  # If you promote instead, make sure to see the polling scheme demonstrated
+  # in add_trial.rb to wait for the asynchronous operation to finish.
+  puts ("Trial ID %d graduated. Campaign %d was given a new budget ID %d and" +
+      "is no longer dependent on this trial.") %
+      [trial[:id], trial[:trial_campaign_id], budget_id]
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201607
+
+  begin
+    trial_id = 'INSERT_TRIAL_ID_HERE'.to_i
+
+    graduate_trial(trial_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
+