google-adwords-api 0.4.5 → 0.5.0

data/examples/v201008/handle_policy_violation_error.rb

@@ -1,138 +0,0 @@
-#!/usr/bin/ruby
-#
-# 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 demonstrates how to handle policy violation errors. To create
-# an ad group, run add_ad_group.rb.
-#
-# Tags: AdGroupAdService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-require 'adwords_api/utils'
-
-API_VERSION = :v201008
-
-def handle_policy_violation_error()
-  # 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_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-
-  # Create text ad.
-  text_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 => 'Mars Cruise!!!',
-        :description1 => 'Visit the Red Planet in style.',
-        :description2 => 'Low-gravity fun for everyone!',
-        :url => 'http://www.example.com',
-        :display_url => 'www.example.com',
-      }
-    }
-  }
-
-  operations = [text_ad_operation]
-
-  # Validate ad.
-  begin
-    # Enable "validate only" for the length of this block
-    adwords.validate_only do
-      ad_group_ad_srv.mutate(operations)
-    end
-    puts 'Validation successful, no errors returned.'
-  rescue AdwordsApi::Errors::ApiException => e
-    e.errors.each do |error|
-      if error[:xsi_type] == 'PolicyViolationError'
-        operation_index = AdwordsApi::Utils.operation_index_for_error(error)
-        operation = operations[operation_index]
-        puts "Ad with headline '%s' violated %s policy '%s'." %
-            [operation[:operand][:ad][:headline],
-             error[:is_exemptable] ? 'exemptable' : 'non-exemptable',
-             error[:external_policy_name]]
-        if error[:is_exemptable]
-          # Add exemption request to the operation.
-          puts "Adding exemption request for policy name '%s' on text '%s'." %
-              [error[:key][:policy_name], error[:key][:violating_text]]
-          unless operation[:exemption_requests]
-            operation[:exemption_requests] = []
-          end
-          operation[:exemption_requests] << {
-            :key => error[:key]
-          }
-        else
-          # Remove non-exemptable operation
-          puts "Removing the operation from the request."
-          operations.delete(operation)
-        end
-      else
-        # Non-policy error returned, re-throw exception.
-        raise e
-      end
-    end
-  end
-
-  # Add ads.
-  if operations.size > 0
-    response = ad_group_ad_srv.mutate(operations)
-    if response and response[:value]
-      ads = response[:value]
-      puts "Added #{ads.length} ad(s) to ad group #{ad_group_id}."
-      ads.each do |ad|
-        puts "  Ad id is #{ad[:ad][:id]}, type is #{ad[:ad][:xsi_type]} and " +
-            "status is \"#{ad[:status]}\"."
-      end
-    else
-      puts "No ads were added."
-    end
-  end
-end
-
-if __FILE__ == $0
-  begin
-    handle_policy_violation_error()
-
-  # 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/v201008/perform_bulk_mutate_job.rb

@@ -1,212 +0,0 @@
-#!/usr/bin/ruby
-#
-# Author:: sgomes@google.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 code sample illustrates how to perform asynchronous requests using the
-# BulkMutateJobService.
-#
-# Tags: BulkMutateJobService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-def perform_bulk_mutate_job()
-  # 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')
-
-  bulk_mutate_job_srv = adwords.service(:BulkMutateJobService, API_VERSION)
-
-  campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-
-  # Create an AdGroupAdOperation to add a text ad.
-  text_ad_operation = {
-    # 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 => 'AdGroupAdOperation',
-    :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',
-      }
-    }
-  }
-
-  # Create an operation stream for the ad.
-  ad_stream = {
-    :scoping_entity_id => {
-      :type => 'CAMPAIGN_ID',
-      :value => campaign_id
-    },
-    :operations => [text_ad_operation]
-  }
-
-  # Create AdGroupCriterionOperations to add keywords.
-  kwd_operations = []
-  1.upto(100) do |index|
-    kwd_operation = {
-      :xsi_type => 'AdGroupCriterionOperation',
-      :operator => 'ADD',
-      :operand => {
-        :xsi_type => 'BiddableAdGroupCriterion',
-        :ad_group_id => ad_group_id,
-        :criterion => {
-          :xsi_type => 'Keyword',
-          :match_type => 'BROAD',
-          :text => 'mars%s' % index
-        }
-      }
-    }
-    kwd_operations << kwd_operation
-  end
-
-  # Create an operation stream for the keywords.
-  kwd_stream = {
-    :scoping_entity_id => {
-      :type => 'CAMPAIGN_ID',
-      :value => campaign_id
-    },
-    :operations => kwd_operations
-  }
-
-  # Create a BulkMutateJobService operation with the first part of the job.
-  job_operation_1 = {
-    :xsi_type => 'JobOperation',
-    # We're using ADD here because we're creating a new job.
-    :operator => 'ADD',
-    :operand => {
-      :xsi_type => 'BulkMutateJob',
-      :num_request_parts => 2,
-      :request => {
-        # The part index is zero-based.
-        :part_index => 0,
-        :operation_streams => [ad_stream]
-      }
-    }
-  }
-
-  # Call mutate() to create a new job by uploading the first part.
-  response_1 = bulk_mutate_job_srv.mutate(job_operation_1)
-  job_id = response_1[:id]
-  puts 'Job id %d was successfully created.' % job_id
-
-  # Similarly, create the next part of the job.
-  job_operation_2 = {
-    :xsi_type => 'JobOperation',
-    # We're using SET now because we're adding a new part to an existing job.
-    # Using ADD again would create a new job altogether.
-    :operator => 'SET',
-    :operand => {
-      :xsi_type => 'BulkMutateJob',
-      :num_request_parts => 2,
-      # Use the ID from the job we added.
-      :id => job_id,
-      :request => {
-        # Second part, hence index 1.
-        :part_index => 1,
-        :operation_streams => [kwd_stream]
-      }
-    }
-  }
-
-  # And call mutate() to upload the second part. Since this is the final part,
-  # the job is automatically cleared for execution.
-  response_2  = bulk_mutate_job_srv.mutate(job_operation_2)
-  puts 'Second part of job %d successfully submitted.' % job_id
-
-  # Wait for the job to complete.
-  selector = {
-    :job_ids => [job_id]
-  }
-  sleep_interval = 10
-  status = nil
-  get_response = nil
-  while status != 'COMPLETED' && status != 'FAILED'
-    unless status.nil?
-      puts "Current status is #{status}, waiting #{sleep_interval} seconds"
-      sleep(sleep_interval) unless status.nil?
-    end
-    get_response = bulk_mutate_job_srv.get(selector)
-    if get_response and get_response.size > 0
-      status = get_response.first[:status]
-    else
-      puts 'Error retrieving job status; aborting.'
-      exit
-    end
-  end
-
-  if status == 'COMPLETED'
-    puts 'Job completed!'
-    # Retrieve the results for the parts.
-    0.upto(job_operation_1[:operand][:num_request_parts] - 1) do |part_index|
-      selector = {
-        :job_ids => [job_id],
-        # Retrieve results for the current part.
-        :result_part_index => part_index
-      }
-      results = bulk_mutate_job_srv.get(selector)
-      if results
-        results.each do |result|
-          puts 'Part %d/%d of job #%d has successfully completed' %
-              [part_index + 1, job_operation_1[:operand][:num_request_parts],
-               job_id]
-        end
-      else
-        puts 'Error retrieving job results; aborting.'
-        exit
-      end
-    end
-  else
-    puts 'Job failed: ' + get_response.first[:failure_reason]
-  end
-end
-
-if __FILE__ == $0
-  begin
-    perform_bulk_mutate_job()
-
-  # 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/v201008/promote_experiment.rb

@@ -1,79 +0,0 @@
-#!/usr/bin/ruby
-#
-# 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. To get
-# experiments, run get_all_experiments.rb.
-#
-# Tags: ExperimentService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-def promote_experiment()
-  # 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)
-
-  experiment_id = 'INSERT_EXPERIMENT_ID_HERE'.to_i
-
-  # 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
-  begin
-    promote_experiment()
-
-  # 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/v201008/set_ad_params.rb

@@ -1,115 +0,0 @@
-#!/usr/bin/ruby
-#
-# 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 an ad group criterion, run
-# add_ad_group_criterion.rb.
-#
-# Tags: AdGroupAdService.mutate, AdParamService.mutate
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201008
-
-def set_ad_params()
-  # 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)
-
-  ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
-  criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
-
-  # 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
-  begin
-    set_ad_params()
-
-  # 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