/adx_buyer_api/examples/v201109/get_all_ad_group_criteria.rb
https://code.google.com/ · Ruby · 98 lines · 57 code · 10 blank · 31 comment · 9 complexity · d65c7d92cd9ce1b1ab76a8eef93cab88 MD5 · raw file
- #!/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 all the criteria for an ad group.
- # To add criteria to an existing ad group, run add_ad_group_criteria.rb.
- #
- # Tags: AdGroupCriterionService.get
- require 'rubygems'
- gem 'google-adwords-api'
- require 'adwords_api'
- API_VERSION = :v201109
- def get_all_ad_group_criteria()
- # 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)
- ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
- # Get all the criteria for this ad group.
- selector = {
- :fields => ['Id'],
- :ordering => [{
- :field => 'AdGroupId',
- :sort_order => 'ASCENDING'
- }],
- :predicates => [{
- :field => 'AdGroupId',
- :operator => 'IN',
- :values => [ad_group_id]
- }]
- }
- response = ad_group_criterion_srv.get(selector)
- if response and response[:entries]
- ad_group_criteria = response[:entries]
- puts "Ad group ##{ad_group_id} has #{ad_group_criteria.length} criteria."
- ad_group_criteria.each do |ad_group_criterion|
- puts " Criterion id is #{ad_group_criterion[:criterion][:id]} and " +
- "type is #{ad_group_criterion[:criterion][:xsi_type]}."
- end
- else
- puts "No criteria found for ad group ##{ad_group_id}."
- end
- end
- if __FILE__ == $0
- begin
- get_all_ad_group_criteria()
- # Connection error. Likely transitory.
- rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
- puts 'Connection Error: %s' % e
- puts 'Source: %s' % e.backtrace.first
- # API Error.
- rescue AdwordsApi::Errors::ApiException => e
- puts 'API Exception caught.'
- puts 'Message: %s' % e.message
- puts 'Code: %d' % e.code if e.code
- puts 'Trigger: %s' % e.trigger if e.trigger
- puts 'Errors:'
- if e.errors
- e.errors.each_with_index do |error, index|
- puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
- error.each_pair do |field, value|
- if field != :xsi_type
- puts ' %s: %s' % [field, value]
- end
- end
- end
- end
- end
- end