google-adx-buyer-api 0.4.4 → 0.4.5

data/examples/v201109/campaign_management/add_placements_in_bulk.rb

@@ -1,151 +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 code sample illustrates how to perform asynchronous requests using the
-# MutateJobService.
-#
-# Tags: MutateJobService.mutate, MutateJobService.get,
-#       MutateJobService.getResult
-
-require 'adwords_api'
-
-def add_placements_in_bulk(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')
-
-  mutate_job_srv = adwords.service(:MutateJobService, API_VERSION)
-
-  # Create AdGroupCriterionOperations to add placements.
-  operations = (1..PLACEMENT_NUMBER).map do |index|
-    # Add small fraction of invalid URLs to demonstrate errors.
-    url = (rand(10) == 0) ? 'invalid-url' : 'http://mars.google.com/'
-    {:xsi_type => 'AdGroupCriterionOperation',
-     :operator => 'ADD',
-     :operand => {
-         :xsi_type => 'BiddableAdGroupCriterion',
-         :ad_group_id => ad_group_id,
-         :criterion => {
-             :xsi_type => 'Placement',
-             :url => url
-         }}}
-  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 = :v201109
-  RETRY_INTERVAL = 30
-  RETRIES_COUNT = 30
-  PLACEMENT_NUMBER = 100
-
-  begin
-    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-    add_placements_in_bulk(ad_group_id)
-
-  # 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/v201109/campaign_management/get_all_disapproved_ads.rb

@@ -1,92 +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 retrieve all the disapproved ads in a given
-# ad group. To add ads, run add_thirdparty_redirect_ad.rb.
-#
-# Tags: AdGroupAdService.get
-
-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', 'DisapprovalReasons'],
-    :ordering => [{:field => 'Id', :sort_order => 'ASCENDING'}],
-    :predicates => [
-      {:field => 'AdGroupId', :operator => 'IN', :values => [ad_group_id]},
-      {
-        :field => 'CreativeApprovalStatus',
-        :operator => 'IN',
-        :values => ['DISAPPROVED']
-      }
-    ]
-  }
-  response = ad_group_ad_srv.get(selector)
-  if response and response[:entries]
-    ad_group_ads = response[:entries]
-    puts "Ad group ##{ad_group_id} has #{ad_group_ads.length} " +
-        "disapproved ad(s)."
-    ad_group_ads.each do |ad_group_ad|
-      puts "  Ad with id #{ad_group_ad[:ad][:id]} and type " +
-          "#{ad_group_ad[:ad][:xsi_type]} was disapproved for the following " +
-          "reasons:"
-      ad_group_ad[:ad][:disapproval_reasons].each do |reason|
-        puts "    #{reason}"
-      end
-    end
-  else
-    puts "No disapproved ads found for ad group ID %d" % ad_group_id
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201109
-
-  begin
-    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-    get_all_disapproved_ads(ad_group_id)
-
-  # 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/v201109/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 = :v201109
-  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

data/examples/v201109/error_handling/handle_partial_failures.rb

@@ -1,117 +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 demonstrates how to handle partial failures.
-#
-# Tags: AdGroupCriterionService.mutate
-
-require 'adwords_api'
-require 'adwords_api/utils'
-
-def handle_partial_failures(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_criterion_srv =
-      adwords.service(:AdGroupCriterionService, API_VERSION)
-
-  # Set partial failures flag.
-  adwords.partial_failure = true
-
-  # Create placements
-  urls = ['http://mars.google.com', 'http:/mars.google.com', 'mars.google.com']
-  placements = urls.map do |url|
-    {
-      # 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 => 'Placement',
-      :url => url
-    }
-  end
-
-  # Create biddable ad group criteria and operations.
-  operations = placements.map do |placement|
-    {
-      :operator => 'ADD',
-      :operand => {
-        :xsi_type => 'BiddableAdGroupCriterion',
-        :ad_group_id => ad_group_id,
-        :criterion => placement
-      }
-    }
-  end
-
-  # Add placements.
-  response = ad_group_criterion_srv.mutate(operations)
-  ad_group_criteria = response[:value]
-  ad_group_criteria.each do |ad_group_criterion|
-    if ad_group_criterion[:criterion]
-      puts ("Placement for ad group ID %d }, placement ID %d " +
-            "and URL '%s' was added.") %
-          [ad_group_criterion[:ad_group_id],
-           ad_group_criterion[:criterion][:id],
-           ad_group_criterion[:criterion][:url]]
-    end
-  end
-
-  # Check partial failures.
-  if response and response[:partial_failure_errors]
-    response[:partial_failure_errors].each do |error|
-      operation_index = AdwordsApi::Utils.operation_index_for_error(error)
-      if operation_index
-        ad_group_criterion = operations[operation_index][:operand]
-        puts "Placement for ad group ID %d and URL '%s' triggered an error: " %
-            [ad_group_criterion[:ad_group_id],
-             ad_group_criterion[:criterion][:text]]
-        puts "\t%s" % error[:error_string]
-      end
-    end
-  end
-end
-
-if __FILE__ == $0
-  API_VERSION = :v201109
-
-  begin
-    ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-    handle_partial_failures(ad_group_id)
-
-  # 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