google-adx-buyer-api 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- data/COPYING +201 -0
- data/ChangeLog +2 -0
- data/README +208 -0
- data/Rakefile +50 -0
- data/examples/v201003/add_ad_group.rb +98 -0
- data/examples/v201003/add_ad_group_criteria.rb +100 -0
- data/examples/v201003/add_ads.rb +110 -0
- data/examples/v201003/add_campaign.rb +101 -0
- data/examples/v201003/add_negative_campaign_criterion.rb +95 -0
- data/examples/v201003/add_placement_performance_report_definition.rb +108 -0
- data/examples/v201003/check_campaigns.rb +132 -0
- data/examples/v201003/delete_ad.rb +94 -0
- data/examples/v201003/delete_ad_group.rb +86 -0
- data/examples/v201003/delete_ad_group_criterion.rb +95 -0
- data/examples/v201003/delete_campaign.rb +87 -0
- data/examples/v201003/download_report.rb +71 -0
- data/examples/v201003/get_all_active_ad_group_criteria.rb +93 -0
- data/examples/v201003/get_all_ad_group_criteria.rb +91 -0
- data/examples/v201003/get_all_ad_groups.rb +88 -0
- data/examples/v201003/get_all_ads.rb +91 -0
- data/examples/v201003/get_all_campaign_targets.rb +83 -0
- data/examples/v201003/get_all_campaigns.rb +83 -0
- data/examples/v201003/get_all_disapproved_ads.rb +94 -0
- data/examples/v201003/get_all_images.rb +88 -0
- data/examples/v201003/get_all_paused_campaigns.rb +86 -0
- data/examples/v201003/get_all_report_definitions.rb +84 -0
- data/examples/v201003/get_criterion_bid_landscape.rb +105 -0
- data/examples/v201003/get_geo_location_info.rb +108 -0
- data/examples/v201003/get_related_placements.rb +111 -0
- data/examples/v201003/get_report_fields.rb +81 -0
- data/examples/v201003/perform_bulk_mutate_job.rb +222 -0
- data/examples/v201003/set_campaign_targets.rb +124 -0
- data/examples/v201003/update_ad.rb +95 -0
- data/examples/v201003/update_ad_group.rb +90 -0
- data/examples/v201003/update_ad_group_criterion.rb +108 -0
- data/examples/v201003/update_campaign.rb +92 -0
- data/examples/v201003/upload_image.rb +97 -0
- data/examples/v201008/add_ad_group.rb +98 -0
- data/examples/v201008/add_ad_group_criteria.rb +100 -0
- data/examples/v201008/add_ads.rb +110 -0
- data/examples/v201008/add_campaign.rb +101 -0
- data/examples/v201008/add_experiment.rb +162 -0
- data/examples/v201008/add_negative_campaign_criterion.rb +95 -0
- data/examples/v201008/add_placement_performance_report_definition.rb +108 -0
- data/examples/v201008/add_user_list.rb +96 -0
- data/examples/v201008/check_campaigns.rb +132 -0
- data/examples/v201008/delete_ad.rb +94 -0
- data/examples/v201008/delete_ad_group.rb +86 -0
- data/examples/v201008/delete_ad_group_criterion.rb +95 -0
- data/examples/v201008/delete_bulk_mutate_job.rb +96 -0
- data/examples/v201008/delete_campaign.rb +87 -0
- data/examples/v201008/delete_experiment.rb +87 -0
- data/examples/v201008/delete_user_list.rb +87 -0
- data/examples/v201008/download_report.rb +71 -0
- data/examples/v201008/get_all_account_changes.rb +144 -0
- data/examples/v201008/get_all_active_ad_group_criteria.rb +93 -0
- data/examples/v201008/get_all_ad_group_criteria.rb +91 -0
- data/examples/v201008/get_all_ad_groups.rb +88 -0
- data/examples/v201008/get_all_ads.rb +91 -0
- data/examples/v201008/get_all_campaign_targets.rb +83 -0
- data/examples/v201008/get_all_campaigns.rb +83 -0
- data/examples/v201008/get_all_disapproved_ads.rb +94 -0
- data/examples/v201008/get_all_experiments.rb +93 -0
- data/examples/v201008/get_all_images.rb +88 -0
- data/examples/v201008/get_all_paused_campaigns.rb +86 -0
- data/examples/v201008/get_all_report_definitions.rb +84 -0
- data/examples/v201008/get_all_user_lists.rb +84 -0
- data/examples/v201008/get_bulk_mutate_job.rb +106 -0
- data/examples/v201008/get_campaign_alerts.rb +103 -0
- data/examples/v201008/get_criterion_bid_landscape.rb +105 -0
- data/examples/v201008/get_geo_location_info.rb +108 -0
- data/examples/v201008/get_related_placements.rb +114 -0
- data/examples/v201008/get_report_fields.rb +81 -0
- data/examples/v201008/perform_bulk_mutate_job.rb +222 -0
- data/examples/v201008/promote_experiment.rb +88 -0
- data/examples/v201008/set_campaign_targets.rb +124 -0
- data/examples/v201008/update_ad.rb +95 -0
- data/examples/v201008/update_ad_group.rb +90 -0
- data/examples/v201008/update_ad_group_criterion.rb +108 -0
- data/examples/v201008/update_campaign.rb +93 -0
- data/examples/v201008/update_user_list.rb +91 -0
- data/examples/v201008/upload_image.rb +97 -0
- data/examples/v201101/add_ad_group.rb +98 -0
- data/examples/v201101/add_ad_group_criteria.rb +100 -0
- data/examples/v201101/add_ads.rb +110 -0
- data/examples/v201101/add_campaign.rb +108 -0
- data/examples/v201101/add_conversion.rb +97 -0
- data/examples/v201101/add_experiment.rb +162 -0
- data/examples/v201101/add_negative_campaign_criterion.rb +95 -0
- data/examples/v201101/add_placement_performance_report_definition.rb +108 -0
- data/examples/v201101/add_rtb_campaign.rb +113 -0
- data/examples/v201101/add_user_list.rb +122 -0
- data/examples/v201101/check_campaigns.rb +132 -0
- data/examples/v201101/delete_ad.rb +94 -0
- data/examples/v201101/delete_ad_group.rb +86 -0
- data/examples/v201101/delete_ad_group_criterion.rb +95 -0
- data/examples/v201101/delete_bulk_mutate_job.rb +96 -0
- data/examples/v201101/delete_campaign.rb +87 -0
- data/examples/v201101/delete_experiment.rb +87 -0
- data/examples/v201101/delete_user_list.rb +87 -0
- data/examples/v201101/download_report.rb +71 -0
- data/examples/v201101/get_ad_group_bid_landscape.rb +103 -0
- data/examples/v201101/get_all_account_changes.rb +146 -0
- data/examples/v201101/get_all_active_ad_group_criteria.rb +106 -0
- data/examples/v201101/get_all_ad_group_criteria.rb +97 -0
- data/examples/v201101/get_all_ad_groups.rb +94 -0
- data/examples/v201101/get_all_ads.rb +99 -0
- data/examples/v201101/get_all_campaign_targets.rb +83 -0
- data/examples/v201101/get_all_campaigns.rb +86 -0
- data/examples/v201101/get_all_conversions.rb +88 -0
- data/examples/v201101/get_all_disapproved_ads.rb +102 -0
- data/examples/v201101/get_all_experiments.rb +98 -0
- data/examples/v201101/get_all_images.rb +90 -0
- data/examples/v201101/get_all_paused_campaigns.rb +92 -0
- data/examples/v201101/get_all_report_definitions.rb +84 -0
- data/examples/v201101/get_all_user_lists.rb +87 -0
- data/examples/v201101/get_bulk_mutate_job.rb +106 -0
- data/examples/v201101/get_campaign_alerts.rb +103 -0
- data/examples/v201101/get_criterion_bid_landscape.rb +102 -0
- data/examples/v201101/get_geo_location_info.rb +108 -0
- data/examples/v201101/get_related_placements.rb +114 -0
- data/examples/v201101/get_report_fields.rb +81 -0
- data/examples/v201101/perform_bulk_mutate_job.rb +222 -0
- data/examples/v201101/promote_experiment.rb +88 -0
- data/examples/v201101/set_campaign_targets.rb +111 -0
- data/examples/v201101/update_ad.rb +95 -0
- data/examples/v201101/update_ad_group.rb +90 -0
- data/examples/v201101/update_ad_group_criterion.rb +108 -0
- data/examples/v201101/update_campaign.rb +93 -0
- data/examples/v201101/update_conversion.rb +96 -0
- data/examples/v201101/update_user_list.rb +91 -0
- data/examples/v201101/upload_image.rb +97 -0
- metadata +208 -0
@@ -0,0 +1,102 @@
|
|
1
|
+
#!/usr/bin/ruby
|
2
|
+
#
|
3
|
+
# Author:: api.sgomes@gmail.com (Sérgio Gomes)
|
4
|
+
#
|
5
|
+
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
6
|
+
#
|
7
|
+
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
8
|
+
# you may not use this file except in compliance with the License.
|
9
|
+
# You may obtain a copy of the License at
|
10
|
+
#
|
11
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
12
|
+
#
|
13
|
+
# Unless required by applicable law or agreed to in writing, software
|
14
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
15
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
16
|
+
# implied.
|
17
|
+
# See the License for the specific language governing permissions and
|
18
|
+
# limitations under the License.
|
19
|
+
#
|
20
|
+
# This example gets a bid landscapes for a criterion. To get criteria, run
|
21
|
+
# get_all_ad_group_criteria.rb.
|
22
|
+
#
|
23
|
+
# Tags: DataService.getCriterionBidLandscape
|
24
|
+
|
25
|
+
require 'rubygems'
|
26
|
+
gem 'google-adwords-api'
|
27
|
+
require 'adwords_api'
|
28
|
+
|
29
|
+
API_VERSION = :v201101
|
30
|
+
|
31
|
+
def get_criterion_bid_landscapes()
|
32
|
+
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
33
|
+
# when called without parameters.
|
34
|
+
adwords = AdwordsApi::Api.new
|
35
|
+
data_srv = adwords.service(:DataService, API_VERSION)
|
36
|
+
|
37
|
+
ad_group_id = 'INSERT_ADGROUP_ID_HERE'.to_i
|
38
|
+
criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
|
39
|
+
|
40
|
+
# Get criterion bid landscape.
|
41
|
+
selector = {
|
42
|
+
:fields => ["AdGroupId", "CriterionId", "StartDate", "EndDate", "Bid",
|
43
|
+
"LocalClicks", "LocalCost", "MarginalCpc", "LocalImpressions"],
|
44
|
+
:predicates => [
|
45
|
+
{:field => 'AdGroupId', :operator => 'IN', :values => [ad_group_id]},
|
46
|
+
{:field => 'CriterionId', :operator => 'IN', :values => [criterion_id]},
|
47
|
+
]
|
48
|
+
}
|
49
|
+
page = data_srv.get_criterion_bid_landscape(selector)
|
50
|
+
if page and page[:entries]
|
51
|
+
puts "#{page[:entries].length} bid landscape(s) retrieved."
|
52
|
+
page[:entries].each do |bid_landscape|
|
53
|
+
puts "Retrieved criterion bid landscape with ad group id " +
|
54
|
+
"'#{bid_landscape[:ad_group_id]}', criterion id " +
|
55
|
+
"'#{bid_landscape[:criterion_id]}', start date " +
|
56
|
+
"'#{bid_landscape[:start_date]}', end date "+
|
57
|
+
"'#{bid_landscape[:end_date]}', with landscape points:"
|
58
|
+
bid_landscape[:landscape_points].each do |point|
|
59
|
+
puts " #{point[:bid][:micro_amount]} => clicks: #{point.clicks}, " +
|
60
|
+
"cost: #{point[:cost][:micro_amount]}, marginalCpc: " +
|
61
|
+
"#{point[:marginal_cpc][:micro_amount]}, impressions: " +
|
62
|
+
"#{point[:impressions]}"
|
63
|
+
end
|
64
|
+
end
|
65
|
+
else
|
66
|
+
puts "No bid landscapes retrieved."
|
67
|
+
end
|
68
|
+
end
|
69
|
+
|
70
|
+
if __FILE__ == $0
|
71
|
+
# To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
|
72
|
+
# variable to 'true'. This can be done either from your operating system
|
73
|
+
# environment or via code, as done below.
|
74
|
+
ENV['ADWORDSAPI_DEBUG'] = 'false'
|
75
|
+
|
76
|
+
begin
|
77
|
+
get_criterion_bid_landscapes()
|
78
|
+
|
79
|
+
# Connection error. Likely transitory.
|
80
|
+
rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
|
81
|
+
puts 'Connection Error: %s' % e
|
82
|
+
puts 'Source: %s' % e.backtrace.first
|
83
|
+
|
84
|
+
# API Error.
|
85
|
+
rescue AdwordsApi::Errors::ApiException => e
|
86
|
+
puts 'API Exception caught.'
|
87
|
+
puts 'Message: %s' % e.message
|
88
|
+
puts 'Code: %d' % e.code if e.code
|
89
|
+
puts 'Trigger: %s' % e.trigger if e.trigger
|
90
|
+
puts 'Errors:'
|
91
|
+
if e.errors
|
92
|
+
e.errors.each_with_index do |error, index|
|
93
|
+
puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
|
94
|
+
error.each_pair do |field, value|
|
95
|
+
if field != :xsi_type
|
96
|
+
puts ' %s: %s' % [field, value]
|
97
|
+
end
|
98
|
+
end
|
99
|
+
end
|
100
|
+
end
|
101
|
+
end
|
102
|
+
end
|
@@ -0,0 +1,108 @@
|
|
1
|
+
#!/usr/bin/ruby
|
2
|
+
#
|
3
|
+
# Author:: api.sgomes@gmail.com (Sérgio Gomes)
|
4
|
+
#
|
5
|
+
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
6
|
+
#
|
7
|
+
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
8
|
+
# you may not use this file except in compliance with the License.
|
9
|
+
# You may obtain a copy of the License at
|
10
|
+
#
|
11
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
12
|
+
#
|
13
|
+
# Unless required by applicable law or agreed to in writing, software
|
14
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
15
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
16
|
+
# implied.
|
17
|
+
# See the License for the specific language governing permissions and
|
18
|
+
# limitations under the License.
|
19
|
+
#
|
20
|
+
# This example illustrates how to retrieve geo location information for
|
21
|
+
# addresses.
|
22
|
+
#
|
23
|
+
# Tags: GeoLocationService.get
|
24
|
+
|
25
|
+
require 'rubygems'
|
26
|
+
gem 'google-adwords-api'
|
27
|
+
require 'adwords_api'
|
28
|
+
|
29
|
+
API_VERSION = :v201101
|
30
|
+
|
31
|
+
def get_geo_location_info()
|
32
|
+
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
33
|
+
# when called without parameters.
|
34
|
+
adwords = AdwordsApi::Api.new
|
35
|
+
geo_location_srv = adwords.service(:GeoLocationService, API_VERSION)
|
36
|
+
|
37
|
+
selector = {
|
38
|
+
:addresses => [
|
39
|
+
{
|
40
|
+
:street_address => '1600 Amphitheatre Parkway',
|
41
|
+
:city_name => 'Mountain View',
|
42
|
+
:province_code => 'US-CA',
|
43
|
+
:province_name => 'California',
|
44
|
+
:postal_code => '94043',
|
45
|
+
:country_code => 'US'
|
46
|
+
},
|
47
|
+
{
|
48
|
+
:street_address => '76 Ninth Avenue',
|
49
|
+
:city_name => 'New York',
|
50
|
+
:province_code => 'US-NY',
|
51
|
+
:province_name => 'New York',
|
52
|
+
:postal_code => '10011',
|
53
|
+
:country_code => 'US'
|
54
|
+
},
|
55
|
+
{
|
56
|
+
:street_address => '五四大街1号, Beijing东城区',
|
57
|
+
:country_code => 'CN'
|
58
|
+
}
|
59
|
+
]
|
60
|
+
}
|
61
|
+
|
62
|
+
# Get the geo location info for the various addresses.
|
63
|
+
locations = geo_location_srv.get(selector)
|
64
|
+
|
65
|
+
if locations
|
66
|
+
locations.each do |location|
|
67
|
+
puts "Address \"#{location[:address][:street_address]}\" has latitude " +
|
68
|
+
"#{location[:geo_point][:latitude_in_micro_degrees]} and " +
|
69
|
+
"longitude #{location[:geo_point][:longitude_in_micro_degrees]}."
|
70
|
+
end
|
71
|
+
else
|
72
|
+
puts "No geo locations were returned."
|
73
|
+
end
|
74
|
+
end
|
75
|
+
|
76
|
+
if __FILE__ == $0
|
77
|
+
# To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
|
78
|
+
# variable to 'true'. This can be done either from your operating system
|
79
|
+
# environment or via code, as done below.
|
80
|
+
ENV['ADWORDSAPI_DEBUG'] = 'false'
|
81
|
+
|
82
|
+
begin
|
83
|
+
get_geo_location_info()
|
84
|
+
|
85
|
+
# Connection error. Likely transitory.
|
86
|
+
rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
|
87
|
+
puts 'Connection Error: %s' % e
|
88
|
+
puts 'Source: %s' % e.backtrace.first
|
89
|
+
|
90
|
+
# API Error.
|
91
|
+
rescue AdwordsApi::Errors::ApiException => e
|
92
|
+
puts 'API Exception caught.'
|
93
|
+
puts 'Message: %s' % e.message
|
94
|
+
puts 'Code: %d' % e.code if e.code
|
95
|
+
puts 'Trigger: %s' % e.trigger if e.trigger
|
96
|
+
puts 'Errors:'
|
97
|
+
if e.errors
|
98
|
+
e.errors.each_with_index do |error, index|
|
99
|
+
puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
|
100
|
+
error.each_pair do |field, value|
|
101
|
+
if field != :xsi_type
|
102
|
+
puts ' %s: %s' % [field, value]
|
103
|
+
end
|
104
|
+
end
|
105
|
+
end
|
106
|
+
end
|
107
|
+
end
|
108
|
+
end
|
@@ -0,0 +1,114 @@
|
|
1
|
+
#!/usr/bin/ruby
|
2
|
+
#
|
3
|
+
# Author:: api.sgomes@gmail.com (Sérgio Gomes)
|
4
|
+
#
|
5
|
+
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
6
|
+
#
|
7
|
+
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
8
|
+
# you may not use this file except in compliance with the License.
|
9
|
+
# You may obtain a copy of the License at
|
10
|
+
#
|
11
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
12
|
+
#
|
13
|
+
# Unless required by applicable law or agreed to in writing, software
|
14
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
15
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
16
|
+
# implied.
|
17
|
+
# See the License for the specific language governing permissions and
|
18
|
+
# limitations under the License.
|
19
|
+
#
|
20
|
+
# This example retrieves URLs that have content keywords related to a given
|
21
|
+
# website.
|
22
|
+
#
|
23
|
+
# Tags: TargetingIdeaService.get
|
24
|
+
|
25
|
+
require 'rubygems'
|
26
|
+
gem 'google-adwords-api'
|
27
|
+
require 'adwords_api'
|
28
|
+
|
29
|
+
API_VERSION = :v201101
|
30
|
+
|
31
|
+
def get_related_placements()
|
32
|
+
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
33
|
+
# when called without parameters.
|
34
|
+
adwords = AdwordsApi::Api.new
|
35
|
+
targeting_idea_srv = adwords.service(:TargetingIdeaService, API_VERSION)
|
36
|
+
|
37
|
+
results_per_page = 10
|
38
|
+
url = 'mars.google.com'
|
39
|
+
|
40
|
+
# Construct selector.
|
41
|
+
selector = {
|
42
|
+
:idea_type => 'PLACEMENT',
|
43
|
+
:request_type => 'IDEAS',
|
44
|
+
:requested_attribute_types => ['CRITERION'],
|
45
|
+
:search_parameters => [{
|
46
|
+
# The 'xsi_type' field allows you to specify the xsi:type of the object
|
47
|
+
# being created. It's only necessary when you must provide an explicit
|
48
|
+
# type that the client library can't infer.
|
49
|
+
:xsi_type => 'RelatedToUrlSearchParameter',
|
50
|
+
:urls => [url],
|
51
|
+
:include_sub_urls => false
|
52
|
+
}],
|
53
|
+
:paging => {
|
54
|
+
:start_index => 0,
|
55
|
+
:number_results => results_per_page
|
56
|
+
}
|
57
|
+
}
|
58
|
+
|
59
|
+
# Perform request.
|
60
|
+
results = []
|
61
|
+
index = 0
|
62
|
+
while true
|
63
|
+
page = targeting_idea_srv.get(selector)
|
64
|
+
if page and page[:entries]
|
65
|
+
results += page[:entries]
|
66
|
+
end
|
67
|
+
break if page[:total_num_entries] <= index
|
68
|
+
index += results_per_page
|
69
|
+
selector[:paging][:start_index] = index
|
70
|
+
end
|
71
|
+
|
72
|
+
# Display results.
|
73
|
+
results.each do |result|
|
74
|
+
data = AdwordsApi::Utils.map(result[:data])
|
75
|
+
placement = data['CRITERION'][:value]
|
76
|
+
puts " Related content keywords found at URL \"%s\"" % placement[:url]
|
77
|
+
end
|
78
|
+
puts "Total urls found with content keywords related to keywords at " +
|
79
|
+
" \"#{url}\": #{results.length}."
|
80
|
+
end
|
81
|
+
|
82
|
+
if __FILE__ == $0
|
83
|
+
# To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
|
84
|
+
# variable to 'true'. This can be done either from your operating system
|
85
|
+
# environment or via code, as done below.
|
86
|
+
ENV['ADWORDSAPI_DEBUG'] = 'false'
|
87
|
+
|
88
|
+
begin
|
89
|
+
get_related_placements()
|
90
|
+
|
91
|
+
# Connection error. Likely transitory.
|
92
|
+
rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
|
93
|
+
puts 'Connection Error: %s' % e
|
94
|
+
puts 'Source: %s' % e.backtrace.first
|
95
|
+
|
96
|
+
# API Error.
|
97
|
+
rescue AdwordsApi::Errors::ApiException => e
|
98
|
+
puts 'API Exception caught.'
|
99
|
+
puts 'Message: %s' % e.message
|
100
|
+
puts 'Code: %d' % e.code if e.code
|
101
|
+
puts 'Trigger: %s' % e.trigger if e.trigger
|
102
|
+
puts 'Errors:'
|
103
|
+
if e.errors
|
104
|
+
e.errors.each_with_index do |error, index|
|
105
|
+
puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
|
106
|
+
error.each_pair do |field, value|
|
107
|
+
if field != :xsi_type
|
108
|
+
puts ' %s: %s' % [field, value]
|
109
|
+
end
|
110
|
+
end
|
111
|
+
end
|
112
|
+
end
|
113
|
+
end
|
114
|
+
end
|
@@ -0,0 +1,81 @@
|
|
1
|
+
#!/usr/bin/ruby
|
2
|
+
#
|
3
|
+
# Author:: api.sgomes@gmail.com (Sérgio Gomes)
|
4
|
+
#
|
5
|
+
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
6
|
+
#
|
7
|
+
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
8
|
+
# you may not use this file except in compliance with the License.
|
9
|
+
# You may obtain a copy of the License at
|
10
|
+
#
|
11
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
12
|
+
#
|
13
|
+
# Unless required by applicable law or agreed to in writing, software
|
14
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
15
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
16
|
+
# implied.
|
17
|
+
# See the License for the specific language governing permissions and
|
18
|
+
# limitations under the License.
|
19
|
+
#
|
20
|
+
# This example gets the list of possible report fields for a report type.
|
21
|
+
#
|
22
|
+
# Tags: ReportDefinitionService.getReportFields
|
23
|
+
|
24
|
+
require 'rubygems'
|
25
|
+
gem 'google-adwords-api'
|
26
|
+
require 'adwords_api'
|
27
|
+
|
28
|
+
API_VERSION = :v201101
|
29
|
+
|
30
|
+
def get_report_fields()
|
31
|
+
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
32
|
+
# when called without parameters.
|
33
|
+
adwords = AdwordsApi::Api.new
|
34
|
+
report_def_srv = adwords.service(:ReportDefinitionService, API_VERSION)
|
35
|
+
|
36
|
+
report_type = 'INSERT_REPORT_TYPE_HERE'
|
37
|
+
|
38
|
+
# Get report fields.
|
39
|
+
fields = report_def_srv.get_report_fields(report_type)
|
40
|
+
if fields
|
41
|
+
puts 'Report type \'%s\' contains the following fields:' % report_type
|
42
|
+
fields.each do |field|
|
43
|
+
puts ' - %s (%s)' % [field[:field_name], field[:field_type]]
|
44
|
+
puts ' := [%s]' % field[:enum_values].join(', ') if field[:enum_values]
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
|
49
|
+
if __FILE__ == $0
|
50
|
+
# To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
|
51
|
+
# variable to 'true'. This can be done either from your operating system
|
52
|
+
# environment or via code, as done below.
|
53
|
+
ENV['ADWORDSAPI_DEBUG'] = 'false'
|
54
|
+
|
55
|
+
begin
|
56
|
+
get_report_fields()
|
57
|
+
|
58
|
+
# Connection error. Likely transitory.
|
59
|
+
rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
|
60
|
+
puts 'Connection Error: %s' % e
|
61
|
+
puts 'Source: %s' % e.backtrace.first
|
62
|
+
|
63
|
+
# API Error.
|
64
|
+
rescue AdwordsApi::Errors::ApiException => e
|
65
|
+
puts 'API Exception caught.'
|
66
|
+
puts 'Message: %s' % e.message
|
67
|
+
puts 'Code: %d' % e.code if e.code
|
68
|
+
puts 'Trigger: %s' % e.trigger if e.trigger
|
69
|
+
puts 'Errors:'
|
70
|
+
if e.errors
|
71
|
+
e.errors.each_with_index do |error, index|
|
72
|
+
puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
|
73
|
+
error.each_pair do |field, value|
|
74
|
+
if field != :xsi_type
|
75
|
+
puts ' %s: %s' % [field, value]
|
76
|
+
end
|
77
|
+
end
|
78
|
+
end
|
79
|
+
end
|
80
|
+
end
|
81
|
+
end
|
@@ -0,0 +1,222 @@
|
|
1
|
+
#!/usr/bin/ruby
|
2
|
+
#
|
3
|
+
# Author:: sgomes@google.com (Sérgio Gomes)
|
4
|
+
#
|
5
|
+
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
6
|
+
#
|
7
|
+
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
8
|
+
# you may not use this file except in compliance with the License.
|
9
|
+
# You may obtain a copy of the License at
|
10
|
+
#
|
11
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
12
|
+
#
|
13
|
+
# Unless required by applicable law or agreed to in writing, software
|
14
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
15
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
16
|
+
# implied.
|
17
|
+
# See the License for the specific language governing permissions and
|
18
|
+
# limitations under the License.
|
19
|
+
#
|
20
|
+
# This code sample illustrates how to perform asynchronous requests using the
|
21
|
+
# BulkMutateJobService.
|
22
|
+
#
|
23
|
+
# Tags: BulkMutateJobService.mutate
|
24
|
+
|
25
|
+
require 'rubygems'
|
26
|
+
gem 'google-adwords-api'
|
27
|
+
require 'adwords_api'
|
28
|
+
|
29
|
+
API_VERSION = :v201101
|
30
|
+
ITEM_COUNT = 100
|
31
|
+
|
32
|
+
def perform_bulk_mutate_job()
|
33
|
+
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
34
|
+
# when called without parameters.
|
35
|
+
adwords = AdwordsApi::Api.new
|
36
|
+
bulk_mutate_job_srv = adwords.service(:BulkMutateJobService, API_VERSION)
|
37
|
+
|
38
|
+
campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
|
39
|
+
ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
|
40
|
+
|
41
|
+
# Prepare image data and encode it.
|
42
|
+
image_url = 'https://sandbox.google.com/sandboximages/image.jpg'
|
43
|
+
image_data = AdsCommon::Http.get(image_url, adwords.config)
|
44
|
+
base64_image_data = Base64.encode64(image_data)
|
45
|
+
|
46
|
+
# Create AdGroupAdOperations to add ads.
|
47
|
+
ads_operations = Array.new(ITEM_COUNT) do |index|
|
48
|
+
ads_operation = {
|
49
|
+
:xsi_type => 'AdGroupAddOperation',
|
50
|
+
:operator => 'ADD',
|
51
|
+
:operand => {
|
52
|
+
:ad_group_id => ad_group_id
|
53
|
+
:ad => {
|
54
|
+
:xsi_type => 'ImageAd',
|
55
|
+
:name => "My Image Ad %d" % index,
|
56
|
+
:url => "http://www.example.com/%d" % index,
|
57
|
+
:display_url => "www.example.com",
|
58
|
+
:image => {
|
59
|
+
:data => base64_image_data
|
60
|
+
}
|
61
|
+
}
|
62
|
+
}
|
63
|
+
}
|
64
|
+
end
|
65
|
+
|
66
|
+
# Create an operation stream for the ads.
|
67
|
+
ads_stream = {
|
68
|
+
:scoping_entity_id => {
|
69
|
+
:type => 'CAMPAIGN_ID',
|
70
|
+
:value => campaign_id
|
71
|
+
},
|
72
|
+
:operations => ads_operations
|
73
|
+
}
|
74
|
+
|
75
|
+
# Create a placement in this ad group for ads.
|
76
|
+
plc_operation = {
|
77
|
+
:xsi_type => 'AdGroupCriterionOperation',
|
78
|
+
:operator => 'ADD',
|
79
|
+
:operand => {
|
80
|
+
:xsi_type => 'BiddableAdGroupCriterion',
|
81
|
+
:ad_group_id => ad_group_id,
|
82
|
+
:criterion => {
|
83
|
+
:xsi_type => 'Placement',
|
84
|
+
:url => "http://mars.google.com"
|
85
|
+
}
|
86
|
+
}
|
87
|
+
}
|
88
|
+
|
89
|
+
# Create an operation stream for the placement.
|
90
|
+
plc_stream = {
|
91
|
+
:scoping_entity_id => {
|
92
|
+
:type => 'CAMPAIGN_ID',
|
93
|
+
:value => campaign_id
|
94
|
+
},
|
95
|
+
:operations => [plc_operation]
|
96
|
+
}
|
97
|
+
|
98
|
+
# Create a BulkMutateJobService operation with the first part of the job.
|
99
|
+
job_operation_1 = {
|
100
|
+
:xsi_type => 'JobOperation',
|
101
|
+
# We're using ADD here because we're creating a new job.
|
102
|
+
:operator => 'ADD',
|
103
|
+
:operand => {
|
104
|
+
:xsi_type => 'BulkMutateJob',
|
105
|
+
:num_request_parts => 2,
|
106
|
+
:request => {
|
107
|
+
# The part index is zero-based.
|
108
|
+
:part_index => 0,
|
109
|
+
:operation_streams => [ads_stream]
|
110
|
+
}
|
111
|
+
}
|
112
|
+
}
|
113
|
+
|
114
|
+
# Call mutate() to create a new job by uploading the first part.
|
115
|
+
response_1 = bulk_mutate_job_srv.mutate(job_operation_1)
|
116
|
+
job_id = response_1[:id]
|
117
|
+
puts 'Job id %d was successfully created.' % job_id
|
118
|
+
|
119
|
+
# Similarly, create the next part of the job.
|
120
|
+
job_operation_2 = {
|
121
|
+
:xsi_type => 'JobOperation',
|
122
|
+
# We're using SET now because we're adding a new part to an existing job.
|
123
|
+
# Using ADD again would create a new job altogether.
|
124
|
+
:operator => 'SET',
|
125
|
+
:operand => {
|
126
|
+
:xsi_type => 'BulkMutateJob',
|
127
|
+
:num_request_parts => 2,
|
128
|
+
# Use the ID from the job we added.
|
129
|
+
:id => job_id,
|
130
|
+
:request => {
|
131
|
+
# Second part, hence index 1.
|
132
|
+
:part_index => 1,
|
133
|
+
:operation_streams => [plc_stream]
|
134
|
+
}
|
135
|
+
}
|
136
|
+
}
|
137
|
+
|
138
|
+
# And call mutate() to upload the second part. Since this is the final part,
|
139
|
+
# the job is automatically cleared for execution.
|
140
|
+
response_2 = bulk_mutate_job_srv.mutate(job_operation_2)
|
141
|
+
puts 'Second part of job %d successfully submitted.' % job_id
|
142
|
+
|
143
|
+
# Wait for the job to complete.
|
144
|
+
selector = {
|
145
|
+
:job_ids => [job_id]
|
146
|
+
}
|
147
|
+
sleep_interval = 10
|
148
|
+
status = nil
|
149
|
+
get_response = nil
|
150
|
+
while status != 'COMPLETED' && status != 'FAILED'
|
151
|
+
unless status.nil?
|
152
|
+
puts "Current status is #{status}, waiting #{sleep_interval} seconds"
|
153
|
+
sleep(sleep_interval) unless status.nil?
|
154
|
+
end
|
155
|
+
get_response = bulk_mutate_job_srv.get(selector)
|
156
|
+
if get_response and get_response.size > 0
|
157
|
+
status = get_response.first[:status]
|
158
|
+
else
|
159
|
+
puts 'Error retrieving job status; aborting.'
|
160
|
+
exit
|
161
|
+
end
|
162
|
+
end
|
163
|
+
|
164
|
+
if status == 'COMPLETED'
|
165
|
+
puts 'Job completed!'
|
166
|
+
# Retrieve the results for the parts.
|
167
|
+
0.upto(job_operation_1[:operand][:num_request_parts] - 1) do |part_index|
|
168
|
+
selector = {
|
169
|
+
:job_ids => [job_id],
|
170
|
+
# Retrieve results for the current part.
|
171
|
+
:result_part_index => part_index
|
172
|
+
}
|
173
|
+
results = bulk_mutate_job_srv.get(selector)
|
174
|
+
if results
|
175
|
+
results.each do |result|
|
176
|
+
puts 'Part %d/%d of job #%d has successfully completed' %
|
177
|
+
[part_index + 1, job_operation_1[:operand][:num_request_parts],
|
178
|
+
job_id]
|
179
|
+
end
|
180
|
+
else
|
181
|
+
puts 'Error retrieving job results; aborting.'
|
182
|
+
exit
|
183
|
+
end
|
184
|
+
end
|
185
|
+
else
|
186
|
+
puts 'Job failed: ' + get_response.first[:failure_reason]
|
187
|
+
end
|
188
|
+
end
|
189
|
+
|
190
|
+
if __FILE__ == $0
|
191
|
+
# To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
|
192
|
+
# variable to 'true'. This can be done either from your operating system
|
193
|
+
# environment or via code, as done below.
|
194
|
+
ENV['ADWORDSAPI_DEBUG'] = 'false'
|
195
|
+
|
196
|
+
begin
|
197
|
+
perform_bulk_mutate_job()
|
198
|
+
|
199
|
+
# Connection error. Likely transitory.
|
200
|
+
rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
|
201
|
+
puts 'Connection Error: %s' % e
|
202
|
+
puts 'Source: %s' % e.backtrace.first
|
203
|
+
|
204
|
+
# API Error.
|
205
|
+
rescue AdwordsApi::Errors::ApiException => e
|
206
|
+
puts 'API Exception caught.'
|
207
|
+
puts 'Message: %s' % e.message
|
208
|
+
puts 'Code: %d' % e.code if e.code
|
209
|
+
puts 'Trigger: %s' % e.trigger if e.trigger
|
210
|
+
puts 'Errors:'
|
211
|
+
if e.errors
|
212
|
+
e.errors.each_with_index do |error, index|
|
213
|
+
puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
|
214
|
+
error.each_pair do |field, value|
|
215
|
+
if field != :xsi_type
|
216
|
+
puts ' %s: %s' % [field, value]
|
217
|
+
end
|
218
|
+
end
|
219
|
+
end
|
220
|
+
end
|
221
|
+
end
|
222
|
+
end
|