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,97 @@
|
|
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 uploads an image. To get images, run get_all_images.rb.
|
21
|
+
#
|
22
|
+
# Tags: MediaService.upload
|
23
|
+
|
24
|
+
require 'rubygems'
|
25
|
+
gem 'google-adwords-api'
|
26
|
+
require 'adwords_api'
|
27
|
+
require 'base64'
|
28
|
+
|
29
|
+
API_VERSION = :v201003
|
30
|
+
|
31
|
+
def upload_image()
|
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
|
+
media_srv = adwords.service(:MediaService, API_VERSION)
|
36
|
+
|
37
|
+
# Create image.
|
38
|
+
image_url = 'https://sandbox.google.com/sandboximages/image.jpg'
|
39
|
+
# This utility method retrieves the contents of a URL using all of the config
|
40
|
+
# options provided to the Api object.
|
41
|
+
image_data = AdsCommon::Http.get(image_url, adwords.config)
|
42
|
+
base64_image_data = Base64.encode64(image_data)
|
43
|
+
image = {
|
44
|
+
# The 'xsi_type' field allows you to specify the xsi:type of the object
|
45
|
+
# being created. It's only necessary when you must provide an explicit
|
46
|
+
# type that the client library can't infer.
|
47
|
+
:xsi_type => 'Image',
|
48
|
+
:data => base64_image_data,
|
49
|
+
:media_type_db => 'IMAGE'
|
50
|
+
}
|
51
|
+
|
52
|
+
# Upload image.
|
53
|
+
response = media_srv.upload([image])
|
54
|
+
if response and !response.empty?
|
55
|
+
ret_image = response.first
|
56
|
+
dimensions = AdwordsApi::Utils.map(ret_image[:dimensions])
|
57
|
+
puts "Image with id #{ret_image[:media_id]}, dimensions " +
|
58
|
+
"#{dimensions['FULL'][:height]}x#{dimensions['FULL'][:width]} " +
|
59
|
+
"and MIME type \"#{ret_image[:mime_type]}\" uploaded successfully."
|
60
|
+
else
|
61
|
+
puts "No images uploaded."
|
62
|
+
end
|
63
|
+
end
|
64
|
+
|
65
|
+
if __FILE__ == $0
|
66
|
+
# To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
|
67
|
+
# variable to 'true'. This can be done either from your operating system
|
68
|
+
# environment or via code, as done below.
|
69
|
+
ENV['ADWORDSAPI_DEBUG'] = 'false'
|
70
|
+
|
71
|
+
begin
|
72
|
+
upload_image()
|
73
|
+
|
74
|
+
# Connection error. Likely transitory.
|
75
|
+
rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
|
76
|
+
puts 'Connection Error: %s' % e
|
77
|
+
puts 'Source: %s' % e.backtrace.first
|
78
|
+
|
79
|
+
# API Error.
|
80
|
+
rescue AdwordsApi::Errors::ApiException => e
|
81
|
+
puts 'API Exception caught.'
|
82
|
+
puts 'Message: %s' % e.message
|
83
|
+
puts 'Code: %d' % e.code if e.code
|
84
|
+
puts 'Trigger: %s' % e.trigger if e.trigger
|
85
|
+
puts 'Errors:'
|
86
|
+
if e.errors
|
87
|
+
e.errors.each_with_index do |error, index|
|
88
|
+
puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
|
89
|
+
error.each_pair do |field, value|
|
90
|
+
if field != :xsi_type
|
91
|
+
puts ' %s: %s' % [field, value]
|
92
|
+
end
|
93
|
+
end
|
94
|
+
end
|
95
|
+
end
|
96
|
+
end
|
97
|
+
end
|
@@ -0,0 +1,98 @@
|
|
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 create an ad group. To create a campaign, run
|
21
|
+
# add_campaign.rb.
|
22
|
+
#
|
23
|
+
# Tags: AdGroupService.mutate
|
24
|
+
|
25
|
+
require 'rubygems'
|
26
|
+
gem 'google-adwords-api'
|
27
|
+
require 'adwords_api'
|
28
|
+
|
29
|
+
API_VERSION = :v201008
|
30
|
+
|
31
|
+
def add_ad_group()
|
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
|
+
ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
|
36
|
+
|
37
|
+
campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
|
38
|
+
|
39
|
+
# Prepare for adding ad group.
|
40
|
+
operation = {
|
41
|
+
:operator => 'ADD',
|
42
|
+
:operand => {
|
43
|
+
:name => 'Earth to Mars Cruises #%s' % (Time.new.to_f * 1000).to_i,
|
44
|
+
:status => 'ENABLED',
|
45
|
+
:campaign_id => campaign_id,
|
46
|
+
:bids => {
|
47
|
+
# The 'xsi_type' field allows you to specify the xsi:type of the object
|
48
|
+
# being created. It's only necessary when you must provide an explicit
|
49
|
+
# type that the client library can't infer.
|
50
|
+
:xsi_type => 'ManualCPMAdGroupBids',
|
51
|
+
:max_cpc => {
|
52
|
+
:amount => {
|
53
|
+
:micro_amount => 10000000
|
54
|
+
}
|
55
|
+
}
|
56
|
+
},
|
57
|
+
}
|
58
|
+
}
|
59
|
+
|
60
|
+
# Add ad group.
|
61
|
+
response = ad_group_srv.mutate([operation])
|
62
|
+
ad_group = response[:value].first
|
63
|
+
puts 'Ad group id %d was successfully added.' % ad_group[:id]
|
64
|
+
end
|
65
|
+
|
66
|
+
if __FILE__ == $0
|
67
|
+
# To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
|
68
|
+
# variable to 'true'. This can be done either from your operating system
|
69
|
+
# environment or via code, as done below.
|
70
|
+
ENV['ADWORDSAPI_DEBUG'] = 'false'
|
71
|
+
|
72
|
+
begin
|
73
|
+
add_ad_group()
|
74
|
+
|
75
|
+
# Connection error. Likely transitory.
|
76
|
+
rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
|
77
|
+
puts 'Connection Error: %s' % e
|
78
|
+
puts 'Source: %s' % e.backtrace.first
|
79
|
+
|
80
|
+
# API Error.
|
81
|
+
rescue AdwordsApi::Errors::ApiException => e
|
82
|
+
puts 'API Exception caught.'
|
83
|
+
puts 'Message: %s' % e.message
|
84
|
+
puts 'Code: %d' % e.code if e.code
|
85
|
+
puts 'Trigger: %s' % e.trigger if e.trigger
|
86
|
+
puts 'Errors:'
|
87
|
+
if e.errors
|
88
|
+
e.errors.each_with_index do |error, index|
|
89
|
+
puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
|
90
|
+
error.each_pair do |field, value|
|
91
|
+
if field != :xsi_type
|
92
|
+
puts ' %s: %s' % [field, value]
|
93
|
+
end
|
94
|
+
end
|
95
|
+
end
|
96
|
+
end
|
97
|
+
end
|
98
|
+
end
|
@@ -0,0 +1,100 @@
|
|
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 add a criterion to a given ad group. To create
|
21
|
+
# an ad group, run add_ad_group.rb.
|
22
|
+
#
|
23
|
+
# Tags: AdGroupCriterionService.mutate
|
24
|
+
|
25
|
+
require 'rubygems'
|
26
|
+
gem 'google-adwords-api'
|
27
|
+
require 'adwords_api'
|
28
|
+
|
29
|
+
API_VERSION = :v201008
|
30
|
+
|
31
|
+
def add_ad_group_criteria()
|
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
|
+
ad_group_criterion_srv =
|
36
|
+
adwords.service(:AdGroupCriterionService, API_VERSION)
|
37
|
+
|
38
|
+
ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
|
39
|
+
|
40
|
+
# Create placement.
|
41
|
+
plc_operation = {
|
42
|
+
:operator => 'ADD',
|
43
|
+
:operand => {
|
44
|
+
:xsi_type => 'BiddableAdGroupCriterion',
|
45
|
+
:ad_group_id => ad_group_id,
|
46
|
+
:criterion => {
|
47
|
+
:xsi_type => 'Placement',
|
48
|
+
:url => 'http://mars.google.com'
|
49
|
+
}
|
50
|
+
}
|
51
|
+
}
|
52
|
+
|
53
|
+
# Add criteria.
|
54
|
+
response = ad_group_criterion_srv.mutate([plc_operation])
|
55
|
+
if response and response[:value]
|
56
|
+
ad_group_criteria = response[:value]
|
57
|
+
puts "Added #{ad_group_criteria.length} criteria to ad group " +
|
58
|
+
"#{ad_group_id}."
|
59
|
+
ad_group_criteria.each do |ad_group_criterion|
|
60
|
+
puts " Criterion id is #{ad_group_criterion[:criterion][:id]} and " +
|
61
|
+
"type is #{ad_group_criterion[:criterion][:xsi_type]}."
|
62
|
+
end
|
63
|
+
else
|
64
|
+
puts "No criteria were added."
|
65
|
+
end
|
66
|
+
end
|
67
|
+
|
68
|
+
if __FILE__ == $0
|
69
|
+
# To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
|
70
|
+
# variable to 'true'. This can be done either from your operating system
|
71
|
+
# environment or via code, as done below.
|
72
|
+
ENV['ADWORDSAPI_DEBUG'] = 'false'
|
73
|
+
|
74
|
+
begin
|
75
|
+
add_ad_group_criteria()
|
76
|
+
|
77
|
+
# Connection error. Likely transitory.
|
78
|
+
rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
|
79
|
+
puts 'Connection Error: %s' % e
|
80
|
+
puts 'Source: %s' % e.backtrace.first
|
81
|
+
|
82
|
+
# API Error.
|
83
|
+
rescue AdwordsApi::Errors::ApiException => e
|
84
|
+
puts 'API Exception caught.'
|
85
|
+
puts 'Message: %s' % e.message
|
86
|
+
puts 'Code: %d' % e.code if e.code
|
87
|
+
puts 'Trigger: %s' % e.trigger if e.trigger
|
88
|
+
puts 'Errors:'
|
89
|
+
if e.errors
|
90
|
+
e.errors.each_with_index do |error, index|
|
91
|
+
puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
|
92
|
+
error.each_pair do |field, value|
|
93
|
+
if field != :xsi_type
|
94
|
+
puts ' %s: %s' % [field, value]
|
95
|
+
end
|
96
|
+
end
|
97
|
+
end
|
98
|
+
end
|
99
|
+
end
|
100
|
+
end
|
@@ -0,0 +1,110 @@
|
|
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 add an image ad to a given ad group. To create
|
21
|
+
# an ad group, run add_ad_group.rb.
|
22
|
+
#
|
23
|
+
# Tags: AdGroupAdService.mutate
|
24
|
+
|
25
|
+
require 'rubygems'
|
26
|
+
gem 'google-adwords-api'
|
27
|
+
require 'adwords_api'
|
28
|
+
require 'base64'
|
29
|
+
|
30
|
+
API_VERSION = :v201008
|
31
|
+
|
32
|
+
def add_ads()
|
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
|
+
ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
|
37
|
+
|
38
|
+
ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
|
39
|
+
|
40
|
+
# Retrieve image and encode it.
|
41
|
+
image_url = 'https://sandbox.google.com/sandboximages/image.jpg'
|
42
|
+
# This utility method retrieves the contents of a URL using all of the config
|
43
|
+
# options provided to the Api object.
|
44
|
+
image_data = AdsCommon::Http.get(image_url, adwords.config)
|
45
|
+
base64_image_data = Base64.encode64(image_data)
|
46
|
+
|
47
|
+
# Create image ad.
|
48
|
+
image_ad_operation = {
|
49
|
+
:operator => 'ADD',
|
50
|
+
:operand => {
|
51
|
+
:ad_group_id => ad_group_id,
|
52
|
+
:ad => {
|
53
|
+
:xsi_type => 'ImageAd',
|
54
|
+
:name => 'Cruise to mars image ad #%s' % (Time.new.to_f * 1000).to_i,
|
55
|
+
:url => 'http://www.example.com',
|
56
|
+
:display_url => 'www.example.com',
|
57
|
+
:image => {
|
58
|
+
:data => base64_image_data
|
59
|
+
}
|
60
|
+
}
|
61
|
+
}
|
62
|
+
}
|
63
|
+
|
64
|
+
# Add ad.
|
65
|
+
response = ad_group_ad_srv.mutate([image_ad_operation])
|
66
|
+
if response and response[:value]
|
67
|
+
ads = response[:value]
|
68
|
+
puts "Added #{ads.length} ad(s) to ad group #{ad_group_id}."
|
69
|
+
ads.each do |ad|
|
70
|
+
puts " Ad id is #{ad[:ad][:id]}, type is #{ad[:ad][:xsi_type]} and " +
|
71
|
+
"status is \"#{ad[:status]}\"."
|
72
|
+
end
|
73
|
+
else
|
74
|
+
puts "No ads were added."
|
75
|
+
end
|
76
|
+
end
|
77
|
+
|
78
|
+
if __FILE__ == $0
|
79
|
+
# To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
|
80
|
+
# variable to 'true'. This can be done either from your operating system
|
81
|
+
# environment or via code, as done below.
|
82
|
+
ENV['ADWORDSAPI_DEBUG'] = 'false'
|
83
|
+
|
84
|
+
begin
|
85
|
+
add_ads()
|
86
|
+
|
87
|
+
# Connection error. Likely transitory.
|
88
|
+
rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
|
89
|
+
puts 'Connection Error: %s' % e
|
90
|
+
puts 'Source: %s' % e.backtrace.first
|
91
|
+
|
92
|
+
# API Error.
|
93
|
+
rescue AdwordsApi::Errors::ApiException => e
|
94
|
+
puts 'API Exception caught.'
|
95
|
+
puts 'Message: %s' % e.message
|
96
|
+
puts 'Code: %d' % e.code if e.code
|
97
|
+
puts 'Trigger: %s' % e.trigger if e.trigger
|
98
|
+
puts 'Errors:'
|
99
|
+
if e.errors
|
100
|
+
e.errors.each_with_index do |error, index|
|
101
|
+
puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
|
102
|
+
error.each_pair do |field, value|
|
103
|
+
if field != :xsi_type
|
104
|
+
puts ' %s: %s' % [field, value]
|
105
|
+
end
|
106
|
+
end
|
107
|
+
end
|
108
|
+
end
|
109
|
+
end
|
110
|
+
end
|
@@ -0,0 +1,101 @@
|
|
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 create a campaign.
|
21
|
+
#
|
22
|
+
# Tags: CampaignService.mutate
|
23
|
+
|
24
|
+
require 'rubygems'
|
25
|
+
gem 'google-adwords-api'
|
26
|
+
require 'adwords_api'
|
27
|
+
|
28
|
+
API_VERSION = :v201008
|
29
|
+
|
30
|
+
def add_campaign()
|
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
|
+
campaign_srv = adwords.service(:CampaignService, API_VERSION)
|
35
|
+
|
36
|
+
# Prepare for adding campaign.
|
37
|
+
operation = {
|
38
|
+
:operator => 'ADD',
|
39
|
+
:operand => {
|
40
|
+
:name => 'Interplanetary Cruise #%s' % (Time.new.to_f * 1000).to_i,
|
41
|
+
:status => 'PAUSED',
|
42
|
+
:bidding_strategy => {
|
43
|
+
# The 'xsi_type' field allows you to specify the xsi:type of the object
|
44
|
+
# being created. It's only necessary when you must provide an explicit
|
45
|
+
# type that the client library can't infer.
|
46
|
+
:xsi_type => 'ManualCPM'
|
47
|
+
},
|
48
|
+
:budget => {
|
49
|
+
:period => 'DAILY',
|
50
|
+
:amount => {
|
51
|
+
:micro_amount => 50000000
|
52
|
+
},
|
53
|
+
:delivery_method => 'STANDARD'
|
54
|
+
}
|
55
|
+
}
|
56
|
+
}
|
57
|
+
|
58
|
+
# Add campaign.
|
59
|
+
response = campaign_srv.mutate([operation])
|
60
|
+
if response and response[:value]
|
61
|
+
campaign = response[:value].first
|
62
|
+
puts 'Campaign with name "%s" and id %d was added.' %
|
63
|
+
[campaign[:name], campaign[:id]]
|
64
|
+
else
|
65
|
+
puts 'No campaigns were added.'
|
66
|
+
end
|
67
|
+
end
|
68
|
+
|
69
|
+
if __FILE__ == $0
|
70
|
+
# To enable logging of SOAP requests, set the ADWORDSAPI_DEBUG environment
|
71
|
+
# variable to 'true'. This can be done either from your operating system
|
72
|
+
# environment or via code, as done below.
|
73
|
+
ENV['ADWORDSAPI_DEBUG'] = 'false'
|
74
|
+
|
75
|
+
begin
|
76
|
+
add_campaign()
|
77
|
+
|
78
|
+
# Connection error. Likely transitory.
|
79
|
+
rescue Errno::ECONNRESET, SOAP::HTTPStreamError, SocketError => e
|
80
|
+
puts 'Connection Error: %s' % e
|
81
|
+
puts 'Source: %s' % e.backtrace.first
|
82
|
+
|
83
|
+
# API Error.
|
84
|
+
rescue AdwordsApi::Errors::ApiException => e
|
85
|
+
puts 'API Exception caught.'
|
86
|
+
puts 'Message: %s' % e.message
|
87
|
+
puts 'Code: %d' % e.code if e.code
|
88
|
+
puts 'Trigger: %s' % e.trigger if e.trigger
|
89
|
+
puts 'Errors:'
|
90
|
+
if e.errors
|
91
|
+
e.errors.each_with_index do |error, index|
|
92
|
+
puts ' %d. Error type is %s. Fields:' % [index + 1, error[:xsi_type]]
|
93
|
+
error.each_pair do |field, value|
|
94
|
+
if field != :xsi_type
|
95
|
+
puts ' %s: %s' % [field, value]
|
96
|
+
end
|
97
|
+
end
|
98
|
+
end
|
99
|
+
end
|
100
|
+
end
|
101
|
+
end
|