google-adwords-api 0.13.2 → 0.14.0

data/examples/v201402/campaign_management/promote_experiment.rb

@@ -1,85 +0,0 @@
-#!/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 promotes an experiment, which permanently applies all the
-# experiment changes made to its related ad groups, criteria and ads.
-#
-# Tags: ExperimentService.mutate
-
-require 'adwords_api'
-
-def promote_experiment(experiment_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)
-
-  # Prepare for updating experiment.
-  operation = {
-    :operator => 'SET',
-    :operand => {
-      :id => experiment_id,
-      :status => 'PROMOTED',
-    }
-  }
-
-  # Update experiment.
-  response = experiment_srv.mutate([operation])
-  experiment = response[:value].first
-  puts "Experiment with name '%s' and ID %d was promoted." %
-      [experiment[:name], experiment[:id]]
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201402
-
-  begin
-    experiment_id = 'INSERT_EXPERIMENT_ID_HERE'.to_i
-    promote_experiment(experiment_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/v201402/campaign_management/set_ad_parameters.rb

@@ -1,122 +0,0 @@
-#!/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 illustrates how to create a text ad with ad parameters. To add an
-# ad group, run add_ad_group.rb. To add a keyword, run add_keywords.rb.
-#
-# Tags: AdGroupAdService.mutate, AdParamService.mutate
-
-require 'adwords_api'
-
-def set_ad_parameters(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')
-
-  ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
-  ad_param_srv = adwords.service(:AdParamService, API_VERSION)
-
-  # Prepare for adding ad.
-  ad_operation = {
-    :operator => 'ADD',
-    :operand => {
-      :ad_group_id => ad_group_id,
-      :ad => {
-        # 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 => 'TextAd',
-        :headline => 'Luxury Mars Cruises',
-        :description1 => 'Low-gravity fun for {param1:cheap}.',
-        :description2 => 'Only {param2:a few} seats left!',
-        :url => 'http://www.example.com',
-        :display_url => 'www.example.com'
-      }
-    }
-  }
-
-  # Add ad.
-  response = ad_group_ad_srv.mutate([ad_operation])
-  ad = response[:value].first[:ad]
-  puts "Text ad ID %d was successfully added." % ad[:id]
-
-  # Prepare for setting ad parameters.
-  price_operation = {
-    :operator => 'SET',
-    :operand => {
-      :ad_group_id => ad_group_id,
-      :criterion_id => criterion_id,
-      :param_index => 1,
-      :insertion_text => '$100'
-    }
-  }
-
-  seat_operation = {
-    :operator => 'SET',
-    :operand => {
-      :ad_group_id => ad_group_id,
-      :criterion_id => criterion_id,
-      :param_index => 2,
-      :insertion_text => '50'
-    }
-  }
-
-  # Set ad parameters.
-  response = ad_param_srv.mutate([price_operation, seat_operation])
-  puts 'Parameters were successfully updated.'
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201402
-
-  begin
-    # IDs of ad group and criterion to set ad parameter for.
-    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-    criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
-    set_ad_parameters(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/v201402/campaign_management/set_criterion_bid_modifier.rb

@@ -1,108 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# Copyright:: Copyright 2013, 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 sets a bid modifier for the mobile platform on given campaign.
-# To get campaigns, run get_campaigns.rb.
-#
-# Tags: CampaignCriterionService.mutate
-
-require 'adwords_api'
-
-def set_criterion_bid_modifier(campaign_id, bid_modifier)
-  # 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_criterion_srv =
-      adwords.service(:CampaignCriterionService, API_VERSION)
-
-  # Create campaign criterion with modified bid.
-  campaign_criterion = {
-    :campaign_id => campaign_id,
-    # Mobile platform. The ID can be found in the documentation.
-    # https://developers.google.com/adwords/api/docs/appendix/platforms
-    :criterion => {
-      :xsi_type => 'Platform',
-      :id => 30001
-    },
-    :bid_modifier => bid_modifier
-  }
-
-  # Create operation.
-  operation = {
-    :operator => 'SET',
-    :operand => campaign_criterion
-  }
-
-  response = campaign_criterion_srv.mutate([operation])
-
-  if response and response[:value]
-    criteria = response[:value]
-    criteria.each do |campaign_criterion|
-      criterion = campaign_criterion[:criterion]
-      puts ("Campaign criterion with campaign ID %d, criterion ID %d was " +
-          "updated with bid modifier %f.") % [campaign_criterion[:campaign_id],
-          criterion[:id], campaign_criterion[:bid_modifier]]
-    end
-  else
-    puts 'No criteria were returned.'
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201402
-
-  begin
-    # ID of a campaign to use mobile bid modifier for.
-    campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-
-    # Bid modifier to set.
-    bid_modifier = 1.5
-
-    set_criterion_bid_modifier(campaign_id, bid_modifier)
-
-  # 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/v201402/campaign_management/validate_text_ad.rb

@@ -1,114 +0,0 @@
-#!/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 shows how to use the 'validate only' header. No objects will be
-# created, but exceptions will still be thrown.
-#
-# Tags: CampaignService.mutate
-
-require 'adwords_api'
-
-def validate_text_ad(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)
-
-  # Enable 'validate only' option.
-  adwords.validate_only = true
-
-  # Prepare for adding text ad.
-  operation = {
-    :operator => 'ADD',
-    :operand => {
-      :ad_group_id => ad_group_id,
-      :ad => {
-        :xsi_type => 'TextAd',
-        :headline => 'Luxury Cruise to Mars',
-        :description1 => 'Visit the Red Planet in style.',
-        :description2 => 'Low-gravity fun for everyone!',
-        :url => 'http://www.example.com',
-        :display_url => 'www.example.com'
-      }
-    }
-  }
-
-  # Validate text ad add operation.
-  response = ad_group_ad_srv.mutate([operation])
-  if response and response[:value]
-    ad = response[:value].first
-    puts "Unexpected ad creation! Name '%s', ID %d and status '%s'." %
-        [campaign[:name], campaign[:id], campaign[:status]]
-  else
-    puts 'Text ad validated, no error thrown and no ad created.'
-  end
-
-  # Now let's check an invalid ad using extra punctuation to trigger an error.
-  operation[:operand][:ad][:headline] = 'Luxury Cruise to Mars!!!!!'
-
-  # Validate text ad add operation.
-  begin
-    response = ad_group_ad_srv.mutate([operation])
-    if response and response[:value]
-      ad = response[:value].first
-      raise StandardError, ("Unexpected ad creation! Name '%s', ID %d and " +
-          "status '%s'.") % [campaign[:name], campaign[:id], campaign[:status]]
-    end
-  rescue AdwordsApi::Errors::ApiException => e
-    puts "Validation correctly failed with an exception: %s" % e.class
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201402
-
-  begin
-    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-    validate_text_ad(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  " +
-        '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/v201402/error_handling/handle_captcha_challenge.rb

@@ -1,93 +0,0 @@
-#!/usr/bin/env ruby
-# Encoding: utf-8
-#
-# Author:: api.dklimkin@gmail.com (Danial Klimkin)
-#
-# 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 handle 'CAPTCHA required' authorization
-# errors. Refer to the best practices guide on how to avoid this error:
-#
-# http://code.google.com/apis/adwords/docs/guides/bestpractices.html#auth_tokens
-
-require 'adwords_api'
-
-def handle_captcha_challenge()
-  # Initialize token variable.
-  logintoken = nil
-
-  # This code will repeatedly request authToken from the server until it gets
-  # a CAPTCHA challenge request. It is here for illustration purposes only
-  # and should never be used in a real application.
-  begin
-    MAX_RETRIES.times do |retry_number|
-      puts "Running request %d of %d..." % [retry_number + 1, MAX_RETRIES]
-      # Forcing library to request a new authorization token.
-      adwords = AdwordsApi::Api.new
-      auth_token = adwords.authorize()
-    end
-    # Still no challenge, make sure ClientLogin authorization is used.
-    raise StandardError, "Failed to get challenge after %d requests." %
-        MAX_RETRIES
-  rescue AdsCommon::Errors::CaptchaRequiredError => e
-    logintoken = e.captcha_token
-  end
-
-  puts "CaptchaRequiredError occurred. To recover download the image and type" +
-      " the CAPTCHA below: %s\n" % e.captcha_url
-  puts 'Enter code or ENTER to retry: '
-  logincaptcha = gets.chomp
-
-  # Initialize variable for extra parameters.
-  credentials = {}
-  if logincaptcha and !logincaptcha.empty?
-    credentials[:logincaptcha] = logincaptcha
-    credentials[:logintoken] = logintoken
-  end
-
-  begin
-    adwords = AdwordsApi::Api.new
-    auth_token = adwords.authorize(credentials)
-    puts "Successfully retrieved authToken: " + auth_token
-  rescue AdsCommon::Errors::CaptchaRequiredError => e
-    puts 'Invalid CAPTCHA text entered.'
-    raise e
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201402
-  MAX_RETRIES = 500
-
-  begin
-    handle_captcha_challenge()
-
-  # 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