google-adwords-api 0.13.1 → 0.13.2

data/examples/v201409/campaign_management/add_campaign_labels.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# Author:: api.mcloonan@gmail.com (Michael Cloonan)
+#
+# 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 adds a label to multiple campaigns.
+#
+# Tags: CampaignService.mutateLabel
+
+require 'adwords_api'
+
+def add_campaign_labels(campaign_ids, 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)
+
+  operations = campaign_ids.map do |campaign_id|
+    {
+      :operator => 'ADD',
+      :operand => {:campaign_id => campaign_id, :label_id => label_id}
+    }
+  end
+
+  response = campaign_srv.mutate_label(operations)
+  if response and response[:value]
+    response[:value].each do |campaign_label|
+      puts "Campaign label for campaign ID %d and label ID %d was added.\n" %
+          [campaign_label[:campaign_id], campaign_label[:label_id]]
+    end
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201409
+
+  begin
+    campaign_id_1 = 'INSERT_CAMPAIGN_ID_1_HERE'.to_i
+    campaign_id_2 = 'INSERT_CAMPAIGN_ID_2_HERE'.to_i
+    label_id = 'INSERT_LABEL_ID_HERE'.to_i
+    add_campaign_labels([campaign_id_1, campaign_id_2], 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  " +
+        'http://code.google.com/p/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/v201409/campaign_management/add_experiment.rb

@@ -0,0 +1,166 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# 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 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.
+#
+# Tags: ExperimentService.mutate
+
+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 = :v201409
+
+  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  " +
+        'http://code.google.com/p/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/v201409/campaign_management/add_keywords_in_bulk.rb

@@ -0,0 +1,158 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# 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 add many keywords using asynchronous
+# requests and MutateJobService.
+#
+# Tags: MutateJobService.mutate, MutateJobService.get
+# Tags: MutateJobService.getResult
+
+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 = :v201409
+  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  " +
+        'http://code.google.com/p/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/v201409/campaign_management/add_location_extension.rb

@@ -0,0 +1,125 @@
+#!/usr/bin/env ruby
+# Encoding: utf-8
+#
+# 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 example illustrates how to create a location ad extension for an existing
+# campaign. To create a campaign, run add_campaign.rb.
+#
+# Tags: GeoLocationService.get, CampaignAdExtensionService.mutate
+
+require 'adwords_api'
+
+def add_location_extension(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')
+
+  campaign_ad_ext_srv =
+      adwords.service(:CampaignAdExtensionService, API_VERSION)
+  geo_location_srv = adwords.service(:GeoLocationService, API_VERSION)
+
+  selector = {
+    :addresses => [
+      {
+        :street_address => '1600 Amphitheatre Parkway',
+        :city_name => 'Mountain View',
+        :province_code => 'CA',
+        :postal_code => '94043',
+        :country_code => 'US'
+      },
+      {
+        :street_address => "38 Avenue de l'Opéra",
+        :city_name => 'Paris',
+        :postal_code => '75002',
+        :country_code => 'FR'
+      }
+    ]
+  }
+
+  # Get the geo location info for the various addresses and build a list of
+  # operations with that information.
+  locations = geo_location_srv.get(selector)
+  raise StandardError, 'Unable to retrieve geo locations.' if locations.nil?
+
+  operations = locations.map do |location|
+    {:operator => 'ADD',
+     :operand => {
+       :campaign_id => campaign_id,
+       :status => 'ENABLED',
+       :ad_extension => {
+         # 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 => 'LocationExtension',
+         :address => location[:address],
+         :geo_point => location[:geo_point],
+         :encoded_location => location[:encoded_location],
+         :source => 'ADWORDS_FRONTEND',
+         # Optional fields:
+         #:company_name => 'ACME Inc.',
+         #:phone_number => '+1-650-253-0000'
+       }
+     }
+    }
+  end
+
+  # Add location ad extensions.
+  response = campaign_ad_ext_srv.mutate(operations)
+  response[:value].each do |extension|
+    puts "Location extension ID %d and status '%s' successfully added." %
+        [extension[:ad_extension][:id], extension[:status]]
+  end
+end
+
+if __FILE__ == $0
+  API_VERSION = :v201409
+
+  begin
+    # ID of campaign to add location extension to.
+    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
+    add_location_extension(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  " +
+        'http://code.google.com/p/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