#!/usr/bin/ruby # # Author:: api.sgomes@gmail.com (Sérgio Gomes) # # Copyright:: Copyright 2009, 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 ad groups for a campaign. To # create an ad group, run add_ad_group.rb. require 'rubygems' gem 'soap4r', '= 1.5.8' require 'adwords4r' def get_all_ad_groups() # AdWords::AdWordsCredentials.new will read a credentials file from # ENV['HOME']/adwords.properties when called without parameters. adwords = AdWords::API.new # Use the latest version for all services latest = AdWords::Service.latest_version ad_group_srv = adwords.get_service('AdGroup', latest) campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i # Get all the ad groups for this campaign # The 'module' method being called here provides a shortcut to the # module containing the classes for this service. This helps us avoid # typing the full class name every time we need to create an object, # e.g. AdWords::V200909::AdGroupService::AdGroupSelector selector = ad_group_srv.module::AdGroupSelector.new selector.campaignId = campaign_id response = ad_group_srv.get(selector) if response and response.rval and response.rval.entries ad_groups = response.rval.entries puts "Campaign ##{campaign_id} has #{ad_groups.length} ad group(s)." ad_groups.each do |ad_group| puts " Ad group name is \"#{ad_group.name}\" and id is #{ad_group.id}." end else puts "No ad groups found for campaign ##{campaign_id}." end end if __FILE__ == $0 # To enable logging of SOAP requests, set the ADWORDS4R_DEBUG environment # variable to 'true'. This can be done either from your operating system # environment or via code, as done below. ENV['ADWORDS4R_DEBUG'] = 'false' begin get_all_ad_groups() # 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 AdWords::Error::ApiError => e puts 'SOAP Error: %s (code: %d)' % [e.soap_faultstring_ex, e.code_ex] puts 'Trigger: %s' % e.trigger_ex unless e.trigger_ex.nil? puts 'Source: %s' % e.backtrace.first end end