google-adwords-api 0.4.5 → 0.5.0

data/examples/v201003/get_related_keywords.rb

@@ -1,108 +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 retrieves keywords that are related to a given keyword.
-#
-# Tags: TargetingIdeaService.get
-
-require 'rubygems'
-require 'adwords_api'
-require 'adwords_api/utils'
-
-API_VERSION = :v201003
-PAGE_SIZE = 100
-
-def get_related_keywords()
-  # 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')
-
-  targeting_idea_srv = adwords.service(:TargetingIdeaService, API_VERSION)
-
-  keyword_text = 'INSERT_KEYWORD_TEXT_HERE'
-
-  # Construct selector object.
-  selector = {
-    :idea_type => 'KEYWORD',
-    :request_type => 'IDEAS',
-    :requested_attribute_types => ['KEYWORD'],
-    :search_parameters => [{
-      # 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 => 'RelatedToKeywordSearchParameter',
-      :keywords => [{
-        :text => keyword_text,
-        :match_type => 'EXACT'
-      }]
-    }],
-    :paging => {
-      :start_index => 0,
-      :number_results => PAGE_SIZE
-    }
-  }
-
-  # Define initial values.
-  offset = 0
-  results = []
-
-  begin
-    # Perform request.
-    page = targeting_idea_srv.get(selector)
-    results += page[:entries] if page and page[:entries]
-
-    # Prepare next page request.
-    offset += PAGE_SIZE
-    selector[:paging][:start_index] = offset
-  end while offset < page[:total_num_entries]
-
-  # Display results.
-  results.each do |result|
-    data = AdwordsApi::Utils.map(result[:data])
-    keyword = data['KEYWORD'][:value]
-    puts "Found keyword with text \"%s\" and match type \"%s\"" %
-        [keyword[:text], keyword[:match_type]]
-  end
-  puts "Total keywords related to \"%s\": %d." % [keyword_text, results.length]
-end
-
-if __FILE__ == $0
-  begin
-    get_related_keywords()
-
-  # 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/v201003/get_related_placements.rb

@@ -1,107 +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 retrieves URLs that have content keywords related to a given
-# website.
-#
-# Tags: TargetingIdeaService.get
-
-require 'rubygems'
-require 'adwords_api'
-require 'adwords_api/utils'
-
-API_VERSION = :v201003
-PAGE_SIZE = 100
-
-def get_related_placements()
-  # 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')
-
-  targeting_idea_srv = adwords.service(:TargetingIdeaService, API_VERSION)
-
-  url = 'INSERT_PLACEMENT_URL_HERE'
-
-  # Construct selector.
-  selector = {
-    :idea_type => 'PLACEMENT',
-    :request_type => 'IDEAS',
-    :requested_attribute_types => ['PLACEMENT'],
-    :search_parameters => [{
-      # 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 => 'RelatedToUrlSearchParameter',
-      :urls => [url],
-      :include_sub_urls => false
-    }],
-    :paging => {
-      :start_index => 0,
-      :number_results => PAGE_SIZE
-    }
-  }
-
-  # Define initial values.
-  offset = 0
-  results = []
-
-  begin
-    # Perform request.
-    page = targeting_idea_srv.get(selector)
-    results += page[:entries] if page and page[:entries]
-
-    # Prepare next page request.
-    offset += PAGE_SIZE
-    selector[:paging][:start_index] = offset
-  end while offset < page[:total_num_entries]
-
-  # Display results.
-  results.each do |result|
-    data = AdwordsApi::Utils.map(result[:data])
-    placement = data['PLACEMENT'][:value]
-    puts "Related content keywords found at URL [%s]" % placement[:url]
-  end
-  puts "Total URLs found with keywords related to keywords at [%s]: %d." %
-      [url, results.length]
-end
-
-if __FILE__ == $0
-  begin
-    get_related_placements()
-
-  # 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/v201003/get_report_fields.rb

@@ -1,72 +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 gets the list of possible report fields for a report type.
-#
-# Tags: ReportDefinitionService.getReportFields
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201003
-
-def get_report_fields()
-  # 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')
-
-  report_def_srv = adwords.service(:ReportDefinitionService, API_VERSION)
-
-  report_type = 'INSERT_REPORT_TYPE_HERE'
-
-  # Get report fields.
-  fields = report_def_srv.get_report_fields(report_type)
-  if fields
-    puts 'Report type \'%s\' contains the following fields:' % report_type
-    fields.each do |field|
-      puts ' - %s (%s)' % [field[:field_name], field[:field_type]]
-      puts '  := [%s]' % field[:enum_values].join(', ') if field[:enum_values]
-    end
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_report_fields()
-
-  # 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/v201003/get_total_usage_units_per_month.rb

@@ -1,74 +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 retrieve the total number of API units that
-# can be used by the developer token making the call, for the current month.
-#
-# Tags: InfoService.get
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201003
-
-def get_total_usage_units_per_month()
-  # 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')
-
-  info_srv = adwords.service(:InfoService, API_VERSION)
-
-  selector = {
-    :api_usage_type => 'TOTAL_USAGE_API_UNITS_PER_MONTH'
-  }
-
-  # Get the usage info.
-  adwords.use_mcc do
-    info = info_srv.get(selector)
-    if info
-      puts 'The total number of API units available this month is %d.' %
-          info[:cost]
-    end
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_total_usage_units_per_month()
-
-  # 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/v201003/get_unit_count.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 illustrates how to retrieve the number of API units recorded for
-# the developer token being used to make this call over the given date range.
-#
-# Tags: InfoService.get
-
-require 'rubygems'
-require 'adwords_api'
-
-API_VERSION = :v201003
-
-def get_unit_count()
-  # 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')
-
-  info_srv = adwords.service(:InfoService, API_VERSION)
-
-  selector = {
-    :api_usage_type => 'UNIT_COUNT',
-    :date_range => {
-      :min => Time.now.strftime('%Y%m01'),
-      :max => Time.now.strftime('%Y%m%d')
-    }
-  }
-
-  # Get the unit info.
-  adwords.use_mcc do
-    info = info_srv.get(selector)
-    if info
-      puts 'The total number of units consumed from %s to %s is %d.' %
-          [selector[:date_range][:min], selector[:date_range][:max],
-          info[:cost]]
-    end
-  end
-end
-
-if __FILE__ == $0
-  begin
-    get_unit_count()
-
-  # 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/v201003/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 = :v201003
-
-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