google-adwords-api 0.8.2 → 0.9.0
Sign up to get free protection for your applications and to get access to all the features.
- data/ChangeLog +6 -0
- data/README +3 -3
- data/examples/{v201206/basic_operations/delete_ad_group.rb → v201209/adwords_for_video/add_video_campaign.rb} +41 -40
- data/examples/{v201206/basic_operations/pause_ad.rb → v201209/adwords_for_video/find_videos.rb} +33 -25
- data/examples/{v201206/basic_operations/get_keywords.rb → v201209/adwords_for_video/get_keyword_criteria.rb} +24 -27
- data/examples/{v201206/basic_operations/get_campaigns_with_awql.rb → v201209/adwords_for_video/get_targeting_groups.rb} +26 -18
- data/examples/{v201206/basic_operations/get_ad_groups.rb → v201209/adwords_for_video/get_video_campaign_criteria.rb} +22 -21
- data/examples/v201209/adwords_for_video/get_video_campaign_stats.rb +126 -0
- data/examples/{v201206/basic_operations/get_campaigns.rb → v201209/adwords_for_video/get_video_campaigns.rb} +16 -15
- data/examples/v201302/advanced_operations/create_and_attach_shared_keyword_set.rb +139 -0
- data/examples/v201302/advanced_operations/find_and_remove_criteria_from_shared_set.rb +173 -0
- data/lib/adwords_api/api_config.rb +17 -59
- data/lib/adwords_api/report_utils.rb +3 -19
- data/lib/adwords_api/{v201206/ad_param_service.rb → v201209/video_ad_service.rb} +8 -8
- data/lib/adwords_api/v201209/video_ad_service_registry.rb +46 -0
- data/lib/adwords_api/{v201206/campaign_ad_extension_service.rb → v201209/video_campaign_criterion_service.rb} +8 -8
- data/lib/adwords_api/v201209/video_campaign_criterion_service_registry.rb +47 -0
- data/lib/adwords_api/{v201206/bulk_mutate_job_service.rb → v201209/video_campaign_service.rb} +8 -8
- data/lib/adwords_api/v201209/video_campaign_service_registry.rb +46 -0
- data/lib/adwords_api/v201209/video_service.rb +42 -0
- data/lib/adwords_api/v201209/video_service_registry.rb +46 -0
- data/lib/adwords_api/{v201206/ad_group_ad_service.rb → v201209/video_targeting_group_criterion_service.rb} +8 -12
- data/lib/adwords_api/v201209/video_targeting_group_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/{v201206/ad_extension_override_service.rb → v201209/video_targeting_group_service.rb} +8 -8
- data/lib/adwords_api/v201209/video_targeting_group_service_registry.rb +46 -0
- data/lib/adwords_api/v201302/ad_group_feed_service.rb +1 -1
- data/lib/adwords_api/v201302/ad_group_feed_service_registry.rb +2 -2
- data/lib/adwords_api/v201302/campaign_feed_service.rb +1 -1
- data/lib/adwords_api/v201302/campaign_feed_service_registry.rb +2 -2
- data/lib/adwords_api/v201302/feed_item_service.rb +1 -1
- data/lib/adwords_api/v201302/feed_item_service_registry.rb +3 -4
- data/lib/adwords_api/v201302/feed_service.rb +1 -1
- data/lib/adwords_api/v201302/feed_service_registry.rb +4 -5
- data/lib/adwords_api/{v201206/user_list_service.rb → v201302/shared_set_service.rb} +9 -9
- data/lib/adwords_api/v201302/shared_set_service_registry.rb +47 -0
- data/lib/adwords_api/version.rb +1 -1
- data/test/adwords_api/test_report_utils.rb +0 -89
- data/test/examples/v201302/test_advanced_operations.rb +10 -0
- data/test/templates/v201209/basic_operations_get_campaigns.def +1 -1
- data/test/templates/v201302/basic_operations_get_campaigns.def +1 -1
- data/test/templates/v201302/misc_use_oauth2_jwt.def +131 -0
- data/test/test_utils.rb +6 -2
- metadata +26 -121
- data/examples/v201206/account_management/create_account.rb +0 -87
- data/examples/v201206/account_management/get_account_alerts.rb +0 -114
- data/examples/v201206/account_management/get_account_changes.rb +0 -137
- data/examples/v201206/account_management/get_account_hierarchy.rb +0 -95
- data/examples/v201206/account_management/get_client_customer_id.rb +0 -88
- data/examples/v201206/account_management/get_client_unit_usage.rb +0 -90
- data/examples/v201206/basic_operations/add_ad_groups.rb +0 -136
- data/examples/v201206/basic_operations/add_campaigns.rb +0 -151
- data/examples/v201206/basic_operations/add_keywords.rb +0 -108
- data/examples/v201206/basic_operations/add_text_ads.rb +0 -105
- data/examples/v201206/basic_operations/delete_ad.rb +0 -85
- data/examples/v201206/basic_operations/delete_campaign.rb +0 -103
- data/examples/v201206/basic_operations/delete_keyword.rb +0 -90
- data/examples/v201206/basic_operations/get_text_ads.rb +0 -106
- data/examples/v201206/basic_operations/update_ad_group.rb +0 -81
- data/examples/v201206/basic_operations/update_campaign.rb +0 -84
- data/examples/v201206/basic_operations/update_keyword.rb +0 -99
- data/examples/v201206/campaign_management/add_experiment.rb +0 -158
- data/examples/v201206/campaign_management/add_keywords_in_bulk.rb +0 -150
- data/examples/v201206/campaign_management/add_location_extension.rb +0 -117
- data/examples/v201206/campaign_management/add_location_extension_override.rb +0 -83
- data/examples/v201206/campaign_management/get_all_disapproved_ads.rb +0 -93
- data/examples/v201206/campaign_management/get_all_disapproved_ads_with_awql.rb +0 -84
- data/examples/v201206/campaign_management/promote_experiment.rb +0 -77
- data/examples/v201206/campaign_management/set_ad_parameters.rb +0 -114
- data/examples/v201206/campaign_management/validate_text_ad.rb +0 -106
- data/examples/v201206/error_handling/handle_captcha_challenge.rb +0 -93
- data/examples/v201206/error_handling/handle_partial_failures.rb +0 -126
- data/examples/v201206/error_handling/handle_policy_violation_error.rb +0 -137
- data/examples/v201206/error_handling/handle_two_factor_authorization_error.rb +0 -88
- data/examples/v201206/misc/get_all_images_and_videos.rb +0 -100
- data/examples/v201206/misc/upload_image.rb +0 -89
- data/examples/v201206/misc/use_oauth2.rb +0 -97
- data/examples/v201206/optimization/estimate_keyword_traffic.rb +0 -129
- data/examples/v201206/optimization/get_keyword_bid_simulations.rb +0 -92
- data/examples/v201206/optimization/get_keyword_ideas.rb +0 -114
- data/examples/v201206/optimization/get_placement_ideas.rb +0 -104
- data/examples/v201206/remarketing/add_audience.rb +0 -115
- data/examples/v201206/remarketing/add_conversion_tracker.rb +0 -97
- data/examples/v201206/reporting/download_criteria_report.rb +0 -79
- data/examples/v201206/reporting/download_criteria_report_with_awql.rb +0 -78
- data/examples/v201206/reporting/get_campaign_stats.rb +0 -105
- data/examples/v201206/reporting/get_report_fields.rb +0 -71
- data/examples/v201206/reporting/parallel_report_download.rb +0 -162
- data/examples/v201206/targeting/add_campaign_targeting_criteria.rb +0 -118
- data/examples/v201206/targeting/get_campaign_targeting_criteria.rb +0 -102
- data/examples/v201206/targeting/get_targetable_languages_and_carriers.rb +0 -86
- data/examples/v201206/targeting/lookup_location.rb +0 -104
- data/lib/adwords_api/v201206/ad_extension_override_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/ad_group_ad_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/ad_group_criterion_service.rb +0 -42
- data/lib/adwords_api/v201206/ad_group_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/ad_group_service.rb +0 -42
- data/lib/adwords_api/v201206/ad_group_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/ad_param_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/alert_service.rb +0 -34
- data/lib/adwords_api/v201206/alert_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/budget_order_service.rb +0 -42
- data/lib/adwords_api/v201206/budget_order_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/bulk_mutate_job_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/campaign_ad_extension_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/campaign_criterion_service.rb +0 -42
- data/lib/adwords_api/v201206/campaign_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/campaign_service.rb +0 -42
- data/lib/adwords_api/v201206/campaign_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/constant_data_service.rb +0 -62
- data/lib/adwords_api/v201206/constant_data_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/conversion_tracker_service.rb +0 -38
- data/lib/adwords_api/v201206/conversion_tracker_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/customer_service.rb +0 -34
- data/lib/adwords_api/v201206/customer_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/customer_sync_service.rb +0 -34
- data/lib/adwords_api/v201206/customer_sync_service_registry.rb +0 -47
- data/lib/adwords_api/v201206/data_service.rb +0 -38
- data/lib/adwords_api/v201206/data_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/experiment_service.rb +0 -38
- data/lib/adwords_api/v201206/experiment_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/geo_location_service.rb +0 -34
- data/lib/adwords_api/v201206/geo_location_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/info_service.rb +0 -34
- data/lib/adwords_api/v201206/info_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/location_criterion_service.rb +0 -34
- data/lib/adwords_api/v201206/location_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/managed_customer_service.rb +0 -38
- data/lib/adwords_api/v201206/managed_customer_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/media_service.rb +0 -38
- data/lib/adwords_api/v201206/media_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/mutate_job_service.rb +0 -42
- data/lib/adwords_api/v201206/mutate_job_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/report_definition_service.rb +0 -34
- data/lib/adwords_api/v201206/report_definition_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/targeting_idea_service.rb +0 -38
- data/lib/adwords_api/v201206/targeting_idea_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/traffic_estimator_service.rb +0 -34
- data/lib/adwords_api/v201206/traffic_estimator_service_registry.rb +0 -46
- data/lib/adwords_api/v201206/user_list_service_registry.rb +0 -46
- data/test/examples/v201206/test_account_management.rb +0 -60
- data/test/examples/v201206/test_basic_operations.rb +0 -177
- data/test/examples/v201206/test_campaign_management.rb +0 -124
- data/test/examples/v201206/test_error_handling.rb +0 -63
- data/test/examples/v201206/test_misc.rb +0 -39
- data/test/examples/v201206/test_optimization.rb +0 -63
- data/test/examples/v201206/test_remarketing.rb +0 -39
- data/test/examples/v201206/test_reporting.rb +0 -84
- data/test/examples/v201206/test_targeting.rb +0 -60
- data/test/examples/v201206/utils.rb +0 -244
- data/test/suite_exampletests_v201206.rb +0 -37
@@ -1,81 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
# Encoding: utf-8
|
3
|
-
#
|
4
|
-
# Author:: api.sgomes@gmail.com (Sérgio Gomes)
|
5
|
-
#
|
6
|
-
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
7
|
-
#
|
8
|
-
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
9
|
-
# you may not use this file except in compliance with the License.
|
10
|
-
# You may obtain a copy of the License at
|
11
|
-
#
|
12
|
-
# http://www.apache.org/licenses/LICENSE-2.0
|
13
|
-
#
|
14
|
-
# Unless required by applicable law or agreed to in writing, software
|
15
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
16
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
17
|
-
# implied.
|
18
|
-
# See the License for the specific language governing permissions and
|
19
|
-
# limitations under the License.
|
20
|
-
#
|
21
|
-
# This example illustrates how to update an ad group, setting its status to
|
22
|
-
# 'PAUSED'. To create an ad group, run add_ad_group.rb.
|
23
|
-
#
|
24
|
-
# Tags: AdGroupService.mutate
|
25
|
-
|
26
|
-
require 'adwords_api'
|
27
|
-
|
28
|
-
def update_ad_group(ad_group_id)
|
29
|
-
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
30
|
-
# when called without parameters.
|
31
|
-
adwords = AdwordsApi::Api.new
|
32
|
-
|
33
|
-
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
34
|
-
# the configuration file or provide your own logger:
|
35
|
-
# adwords.logger = Logger.new('adwords_xml.log')
|
36
|
-
|
37
|
-
ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
|
38
|
-
|
39
|
-
# Prepare for updating ad group.
|
40
|
-
operation = {
|
41
|
-
:operator => 'SET',
|
42
|
-
:operand => {
|
43
|
-
:status => 'PAUSED',
|
44
|
-
:id => ad_group_id
|
45
|
-
}
|
46
|
-
}
|
47
|
-
|
48
|
-
# Update ad group.
|
49
|
-
response = ad_group_srv.mutate([operation])
|
50
|
-
if response and response[:value]
|
51
|
-
ad_group = response[:value].first
|
52
|
-
puts 'Ad group id %d was successfully updated.' % ad_group[:id]
|
53
|
-
else
|
54
|
-
puts 'No ad groups were updated.'
|
55
|
-
end
|
56
|
-
end
|
57
|
-
|
58
|
-
if __FILE__ == $0
|
59
|
-
API_VERSION = :v201206
|
60
|
-
|
61
|
-
begin
|
62
|
-
# ID of an ad group to update.
|
63
|
-
ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
|
64
|
-
update_ad_group(ad_group_id)
|
65
|
-
|
66
|
-
# HTTP errors.
|
67
|
-
rescue AdsCommon::Errors::HttpError => e
|
68
|
-
puts "HTTP Error: %s" % e
|
69
|
-
|
70
|
-
# API errors.
|
71
|
-
rescue AdwordsApi::Errors::ApiException => e
|
72
|
-
puts "Message: %s" % e.message
|
73
|
-
puts 'Errors:'
|
74
|
-
e.errors.each_with_index do |error, index|
|
75
|
-
puts "\tError [%d]:" % (index + 1)
|
76
|
-
error.each do |field, value|
|
77
|
-
puts "\t\t%s: %s" % [field, value]
|
78
|
-
end
|
79
|
-
end
|
80
|
-
end
|
81
|
-
end
|
@@ -1,84 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
# Encoding: utf-8
|
3
|
-
#
|
4
|
-
# Author:: api.sgomes@gmail.com (Sérgio Gomes)
|
5
|
-
#
|
6
|
-
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
7
|
-
#
|
8
|
-
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
9
|
-
# you may not use this file except in compliance with the License.
|
10
|
-
# You may obtain a copy of the License at
|
11
|
-
#
|
12
|
-
# http://www.apache.org/licenses/LICENSE-2.0
|
13
|
-
#
|
14
|
-
# Unless required by applicable law or agreed to in writing, software
|
15
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
16
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
17
|
-
# implied.
|
18
|
-
# See the License for the specific language governing permissions and
|
19
|
-
# limitations under the License.
|
20
|
-
#
|
21
|
-
# This example illustrates how to update a campaign, setting its budget delivery
|
22
|
-
# to 'ACCELERATED'. To create a campaign, run add_campaign.rb.
|
23
|
-
#
|
24
|
-
# Tags: CampaignService.mutate
|
25
|
-
|
26
|
-
require 'adwords_api'
|
27
|
-
|
28
|
-
def update_campaign(campaign_id)
|
29
|
-
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
30
|
-
# when called without parameters.
|
31
|
-
adwords = AdwordsApi::Api.new
|
32
|
-
|
33
|
-
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
34
|
-
# the configuration file or provide your own logger:
|
35
|
-
# adwords.logger = Logger.new('adwords_xml.log')
|
36
|
-
|
37
|
-
campaign_srv = adwords.service(:CampaignService, API_VERSION)
|
38
|
-
|
39
|
-
# Prepare for updating campaign.
|
40
|
-
operation = {
|
41
|
-
:operator => 'SET',
|
42
|
-
:operand => {
|
43
|
-
:id => campaign_id,
|
44
|
-
:budget => {
|
45
|
-
:delivery_method => 'ACCELERATED'
|
46
|
-
}
|
47
|
-
}
|
48
|
-
}
|
49
|
-
|
50
|
-
# Update campaign.
|
51
|
-
response = campaign_srv.mutate([operation])
|
52
|
-
if response and response[:value]
|
53
|
-
campaign = response[:value].first
|
54
|
-
puts 'Campaign id %d successfully updated, delivery method set to %s.' %
|
55
|
-
[campaign[:id], campaign[:budget][:delivery_method]]
|
56
|
-
else
|
57
|
-
puts 'No campaigns were updated.'
|
58
|
-
end
|
59
|
-
end
|
60
|
-
|
61
|
-
if __FILE__ == $0
|
62
|
-
API_VERSION = :v201206
|
63
|
-
|
64
|
-
begin
|
65
|
-
# ID of a campaign to update.
|
66
|
-
campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
|
67
|
-
update_campaign(campaign_id)
|
68
|
-
|
69
|
-
# HTTP errors.
|
70
|
-
rescue AdsCommon::Errors::HttpError => e
|
71
|
-
puts "HTTP Error: %s" % e
|
72
|
-
|
73
|
-
# API errors.
|
74
|
-
rescue AdwordsApi::Errors::ApiException => e
|
75
|
-
puts "Message: %s" % e.message
|
76
|
-
puts 'Errors:'
|
77
|
-
e.errors.each_with_index do |error, index|
|
78
|
-
puts "\tError [%d]:" % (index + 1)
|
79
|
-
error.each do |field, value|
|
80
|
-
puts "\t\t%s: %s" % [field, value]
|
81
|
-
end
|
82
|
-
end
|
83
|
-
end
|
84
|
-
end
|
@@ -1,99 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
# Encoding: utf-8
|
3
|
-
#
|
4
|
-
# Author:: api.dklimkin@gmail.com (Danial Klimkin)
|
5
|
-
#
|
6
|
-
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
7
|
-
#
|
8
|
-
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
9
|
-
# you may not use this file except in compliance with the License.
|
10
|
-
# You may obtain a copy of the License at
|
11
|
-
#
|
12
|
-
# http://www.apache.org/licenses/LICENSE-2.0
|
13
|
-
#
|
14
|
-
# Unless required by applicable law or agreed to in writing, software
|
15
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
16
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
17
|
-
# implied.
|
18
|
-
# See the License for the specific language governing permissions and
|
19
|
-
# limitations under the License.
|
20
|
-
#
|
21
|
-
# This example updates the bid of a keyword. To create a keyword, run
|
22
|
-
# add_keywords.rb.
|
23
|
-
#
|
24
|
-
# Tags: AdGroupCriterionService.mutate
|
25
|
-
|
26
|
-
require 'adwords_api'
|
27
|
-
|
28
|
-
def update_keyword(ad_group_id, criterion_id)
|
29
|
-
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
30
|
-
# when called without parameters.
|
31
|
-
adwords = AdwordsApi::Api.new
|
32
|
-
|
33
|
-
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
34
|
-
# the configuration file or provide your own logger:
|
35
|
-
# adwords.logger = Logger.new('adwords_xml.log')
|
36
|
-
|
37
|
-
ad_group_criterion_srv =
|
38
|
-
adwords.service(:AdGroupCriterionService, API_VERSION)
|
39
|
-
|
40
|
-
# Prepare for updating a keyword.
|
41
|
-
operation = {
|
42
|
-
:operator => 'SET',
|
43
|
-
:operand => {
|
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 => 'BiddableAdGroupCriterion',
|
48
|
-
:ad_group_id => ad_group_id,
|
49
|
-
:criterion => {
|
50
|
-
:id => criterion_id
|
51
|
-
},
|
52
|
-
:bids => {
|
53
|
-
:xsi_type => 'ManualCPCAdGroupCriterionBids',
|
54
|
-
:max_cpc => {
|
55
|
-
:amount => {
|
56
|
-
:micro_amount => 1000000
|
57
|
-
}
|
58
|
-
}
|
59
|
-
}
|
60
|
-
}
|
61
|
-
}
|
62
|
-
|
63
|
-
# Update criterion.
|
64
|
-
response = ad_group_criterion_srv.mutate([operation])
|
65
|
-
if response and response[:value]
|
66
|
-
ad_group_criterion = response[:value].first
|
67
|
-
puts "Keyword ID %d was successfully updated, bid set to %d." %
|
68
|
-
[ad_group_criterion[:criterion][:id],
|
69
|
-
ad_group_criterion[:bids][:max_cpc][:amount][:micro_amount]]
|
70
|
-
else
|
71
|
-
puts 'No keywords were updated.'
|
72
|
-
end
|
73
|
-
end
|
74
|
-
|
75
|
-
if __FILE__ == $0
|
76
|
-
API_VERSION = :v201206
|
77
|
-
|
78
|
-
begin
|
79
|
-
# IDs of a criterion to update and its ad group.
|
80
|
-
ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
|
81
|
-
criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
|
82
|
-
update_keyword(ad_group_id, criterion_id)
|
83
|
-
|
84
|
-
# HTTP errors.
|
85
|
-
rescue AdsCommon::Errors::HttpError => e
|
86
|
-
puts "HTTP Error: %s" % e
|
87
|
-
|
88
|
-
# API errors.
|
89
|
-
rescue AdwordsApi::Errors::ApiException => e
|
90
|
-
puts "Message: %s" % e.message
|
91
|
-
puts 'Errors:'
|
92
|
-
e.errors.each_with_index do |error, index|
|
93
|
-
puts "\tError [%d]:" % (index + 1)
|
94
|
-
error.each do |field, value|
|
95
|
-
puts "\t\t%s: %s" % [field, value]
|
96
|
-
end
|
97
|
-
end
|
98
|
-
end
|
99
|
-
end
|
@@ -1,158 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
# Encoding: utf-8
|
3
|
-
#
|
4
|
-
# Author:: api.sgomes@gmail.com (Sérgio Gomes)
|
5
|
-
#
|
6
|
-
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
7
|
-
#
|
8
|
-
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
9
|
-
# you may not use this file except in compliance with the License.
|
10
|
-
# You may obtain a copy of the License at
|
11
|
-
#
|
12
|
-
# http://www.apache.org/licenses/LICENSE-2.0
|
13
|
-
#
|
14
|
-
# Unless required by applicable law or agreed to in writing, software
|
15
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
16
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
17
|
-
# implied.
|
18
|
-
# See the License for the specific language governing permissions and
|
19
|
-
# limitations under the License.
|
20
|
-
#
|
21
|
-
# This example creates an experiment using a query percentage of 10, which
|
22
|
-
# defines what fraction of auctions should go to the control split (90%) vs.
|
23
|
-
# the experiment split (10%), then adds experimental bid changes for criteria
|
24
|
-
# and ad groups. To get campaigns, run get_campaigns.rb. To get ad groups,
|
25
|
-
# run get_ad_groups.rb. To get keywords, run get_keywords.rb.
|
26
|
-
#
|
27
|
-
# Tags: ExperimentService.mutate
|
28
|
-
|
29
|
-
require 'adwords_api'
|
30
|
-
require 'date'
|
31
|
-
|
32
|
-
def add_experiment(campaign_id, ad_group_id, criterion_id)
|
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
|
-
|
37
|
-
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
38
|
-
# the configuration file or provide your own logger:
|
39
|
-
# adwords.logger = Logger.new('adwords_xml.log')
|
40
|
-
|
41
|
-
experiment_srv = adwords.service(:ExperimentService, API_VERSION)
|
42
|
-
ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
|
43
|
-
ad_group_criterion_srv =
|
44
|
-
adwords.service(:AdGroupCriterionService, API_VERSION)
|
45
|
-
|
46
|
-
# Prepare for adding experiment.
|
47
|
-
operation = {
|
48
|
-
:operator => 'ADD',
|
49
|
-
:operand => {
|
50
|
-
:campaign_id => campaign_id,
|
51
|
-
:name => "Interplanetary Experiment #%d" % (Time.new.to_f * 1000).to_i,
|
52
|
-
:query_percentage => 10,
|
53
|
-
:start_date_time => Time.now.strftime('%Y%m%d %H%M%S'),
|
54
|
-
# Optional fields:
|
55
|
-
:status => 'ACTIVE',
|
56
|
-
:end_date_time =>
|
57
|
-
DateTime.parse((Date.today + 30).to_s).strftime('%Y%m%d %H%M%S')
|
58
|
-
}
|
59
|
-
}
|
60
|
-
|
61
|
-
# Add experiment.
|
62
|
-
response = experiment_srv.mutate([operation])
|
63
|
-
experiment = response[:value].first
|
64
|
-
puts "Experiment with name '%s' and ID %d was added." %
|
65
|
-
[experiment[:name], experiment[:id]]
|
66
|
-
|
67
|
-
experiment_id = experiment[:id]
|
68
|
-
|
69
|
-
# Setup ad group for the experiment.
|
70
|
-
ad_group = {
|
71
|
-
:id => ad_group_id,
|
72
|
-
# Set experiment data for the ad group.
|
73
|
-
:experiment_data => {
|
74
|
-
:experiment_id => experiment_id,
|
75
|
-
:experiment_delta_status => 'MODIFIED',
|
76
|
-
# Bid multiplier rule that will modify ad group bid for the experiment.
|
77
|
-
:experiment_bid_multipliers => {
|
78
|
-
:xsi_type => 'ManualCPCAdGroupExperimentBidMultipliers',
|
79
|
-
:max_cpc_multiplier => {
|
80
|
-
:multiplier => 1.5
|
81
|
-
}
|
82
|
-
}
|
83
|
-
}
|
84
|
-
}
|
85
|
-
|
86
|
-
# Prepare for updating ad group.
|
87
|
-
operation = {
|
88
|
-
:operator => 'SET',
|
89
|
-
:operand => ad_group
|
90
|
-
}
|
91
|
-
|
92
|
-
# Update ad group.
|
93
|
-
response = ad_group_srv.mutate([operation])
|
94
|
-
ad_group = response[:value].first
|
95
|
-
puts "Ad group ID %d was updated for the experiment." % ad_group[:id]
|
96
|
-
|
97
|
-
# Setup ad group criterion for the experiment.
|
98
|
-
ad_group_criterion = {
|
99
|
-
:xsi_type => 'BiddableAdGroupCriterion',
|
100
|
-
:ad_group_id => ad_group_id,
|
101
|
-
:criterion => {
|
102
|
-
:id => criterion_id
|
103
|
-
},
|
104
|
-
# Set experiment data for the criterion.
|
105
|
-
:experiment_data => {
|
106
|
-
:xsi_type => 'BiddableAdGroupCriterionExperimentData',
|
107
|
-
:experiment_id => experiment_id,
|
108
|
-
:experiment_delta_status => 'MODIFIED',
|
109
|
-
# Bid multiplier rule that will modify criterion bid for the experiment.
|
110
|
-
:experiment_bid_multiplier => {
|
111
|
-
:xsi_type => 'ManualCPCAdGroupCriterionExperimentBidMultiplier',
|
112
|
-
:max_cpc_multiplier => {
|
113
|
-
:multiplier => 1.5
|
114
|
-
}
|
115
|
-
}
|
116
|
-
}
|
117
|
-
}
|
118
|
-
|
119
|
-
# Prepare for updating ad group criterion.
|
120
|
-
operation = {
|
121
|
-
:operator => 'SET',
|
122
|
-
:operand => ad_group_criterion
|
123
|
-
}
|
124
|
-
|
125
|
-
# Update criterion.
|
126
|
-
response = ad_group_criterion_srv.mutate([operation])
|
127
|
-
criterion = response[:value].first
|
128
|
-
puts "Criterion ID %d was successfully updated for the experiment." %
|
129
|
-
[criterion[:criterion][:id]]
|
130
|
-
|
131
|
-
end
|
132
|
-
|
133
|
-
if __FILE__ == $0
|
134
|
-
API_VERSION = :v201206
|
135
|
-
|
136
|
-
begin
|
137
|
-
# IDs of the required objects.
|
138
|
-
campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
|
139
|
-
ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
|
140
|
-
criterion_id = 'INSERT_CRITERION_ID_HERE'.to_i
|
141
|
-
add_experiment(campaign_id, ad_group_id, criterion_id)
|
142
|
-
|
143
|
-
# HTTP errors.
|
144
|
-
rescue AdsCommon::Errors::HttpError => e
|
145
|
-
puts "HTTP Error: %s" % e
|
146
|
-
|
147
|
-
# API errors.
|
148
|
-
rescue AdwordsApi::Errors::ApiException => e
|
149
|
-
puts "Message: %s" % e.message
|
150
|
-
puts 'Errors:'
|
151
|
-
e.errors.each_with_index do |error, index|
|
152
|
-
puts "\tError [%d]:" % (index + 1)
|
153
|
-
error.each do |field, value|
|
154
|
-
puts "\t\t%s: %s" % [field, value]
|
155
|
-
end
|
156
|
-
end
|
157
|
-
end
|
158
|
-
end
|
@@ -1,150 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
# Encoding: utf-8
|
3
|
-
#
|
4
|
-
# Author:: api.dklimkin@gmail.com (Danial Klimkin)
|
5
|
-
#
|
6
|
-
# Copyright:: Copyright 2011, Google Inc. All Rights Reserved.
|
7
|
-
#
|
8
|
-
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
9
|
-
# you may not use this file except in compliance with the License.
|
10
|
-
# You may obtain a copy of the License at
|
11
|
-
#
|
12
|
-
# http://www.apache.org/licenses/LICENSE-2.0
|
13
|
-
#
|
14
|
-
# Unless required by applicable law or agreed to in writing, software
|
15
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
16
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
17
|
-
# implied.
|
18
|
-
# See the License for the specific language governing permissions and
|
19
|
-
# limitations under the License.
|
20
|
-
#
|
21
|
-
# This code sample illustrates how to add many keywords using asynchronous
|
22
|
-
# requests and MutateJobService.
|
23
|
-
#
|
24
|
-
# Tags: MutateJobService.mutate, MutateJobService.get
|
25
|
-
# Tags: MutateJobService.getResult
|
26
|
-
|
27
|
-
require 'adwords_api'
|
28
|
-
|
29
|
-
def add_keywords_in_bulk()
|
30
|
-
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
31
|
-
# when called without parameters.
|
32
|
-
adwords = AdwordsApi::Api.new
|
33
|
-
|
34
|
-
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
35
|
-
# the configuration file or provide your own logger:
|
36
|
-
# adwords.logger = Logger.new('adwords_xml.log')
|
37
|
-
|
38
|
-
mutate_job_srv = adwords.service(:MutateJobService, API_VERSION)
|
39
|
-
|
40
|
-
ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
|
41
|
-
|
42
|
-
# Create AdGroupCriterionOperations to add keywords.
|
43
|
-
operations = (1..KEYWORD_NUMBER).map do |index|
|
44
|
-
{:xsi_type => 'AdGroupCriterionOperation',
|
45
|
-
:operator => 'ADD',
|
46
|
-
:operand => {
|
47
|
-
:xsi_type => 'BiddableAdGroupCriterion',
|
48
|
-
:ad_group_id => ad_group_id,
|
49
|
-
:criterion => {
|
50
|
-
:xsi_type => 'Keyword',
|
51
|
-
:match_type => 'BROAD',
|
52
|
-
:text => "mars%d" % index}}}
|
53
|
-
end
|
54
|
-
|
55
|
-
# You can specify up to 3 job IDs that must successfully complete before
|
56
|
-
# this job can be processed.
|
57
|
-
policy = {:prerequisite_job_ids => []}
|
58
|
-
|
59
|
-
# Call mutate to create a new job.
|
60
|
-
response = mutate_job_srv.mutate(operations, policy)
|
61
|
-
|
62
|
-
raise StandardError, 'Failed to submit a job; aborting.' unless response
|
63
|
-
|
64
|
-
job_id = response[:id]
|
65
|
-
puts "Job ID %d was successfully created." % job_id
|
66
|
-
|
67
|
-
# Creating selector to retrive hob status and wait for it to complete.
|
68
|
-
selector = {
|
69
|
-
:xsi_type => 'BulkMutateJobSelector',
|
70
|
-
:job_ids => [job_id]
|
71
|
-
}
|
72
|
-
|
73
|
-
status = nil
|
74
|
-
|
75
|
-
# Poll for job status until it's finished.
|
76
|
-
puts 'Retrieving job status...'
|
77
|
-
RETRIES_COUNT.times do |retry_attempt|
|
78
|
-
job_status_response = mutate_job_srv.get(selector)
|
79
|
-
if job_status_response
|
80
|
-
status = job_status_response.first[:status]
|
81
|
-
case status
|
82
|
-
when 'FAILED'
|
83
|
-
raise StandardError, "Job failed with reason: '%s'" %
|
84
|
-
job_status_response.first[:failure_reason]
|
85
|
-
when 'COMPLETED'
|
86
|
-
puts "[%d] Job finished with status '%s'" % [retry_attempt, status]
|
87
|
-
break
|
88
|
-
else
|
89
|
-
puts "[%d] Current status is '%s', waiting %d seconds to retry..." %
|
90
|
-
[retry_attempt, status, RETRY_INTERVAL]
|
91
|
-
sleep(RETRY_INTERVAL)
|
92
|
-
end
|
93
|
-
else
|
94
|
-
raise StandardError, 'Error retrieving job status; aborting.'
|
95
|
-
end
|
96
|
-
end
|
97
|
-
|
98
|
-
if status == 'COMPLETED'
|
99
|
-
# Get the job result. Here we re-use the same selector.
|
100
|
-
result_response = mutate_job_srv.get_result(selector)
|
101
|
-
|
102
|
-
if result_response and result_response[:simple_mutate_result]
|
103
|
-
results = result_response[:simple_mutate_result][:results]
|
104
|
-
if results
|
105
|
-
results.each_with_index do |result, index|
|
106
|
-
result_message = result.include?(:place_holder) ?
|
107
|
-
'FAILED' : 'SUCCEEDED'
|
108
|
-
puts "Operation [%d] - %s" % [index, result_message]
|
109
|
-
end
|
110
|
-
end
|
111
|
-
errors = result_response[:simple_mutate_result][:errors]
|
112
|
-
if errors
|
113
|
-
errors.each do |error|
|
114
|
-
puts "Error, reason: '%s', trigger: '%s', field path: '%s'" %
|
115
|
-
[error[:reason], error[:trigger], error[:field_path]]
|
116
|
-
end
|
117
|
-
end
|
118
|
-
else
|
119
|
-
raise StandardError, 'Error retrieving job results; aborting.'
|
120
|
-
end
|
121
|
-
else
|
122
|
-
puts "Job failed to complete after %d retries." % RETRIES_COUNT
|
123
|
-
end
|
124
|
-
end
|
125
|
-
|
126
|
-
if __FILE__ == $0
|
127
|
-
API_VERSION = :v201206
|
128
|
-
RETRY_INTERVAL = 30
|
129
|
-
RETRIES_COUNT = 30
|
130
|
-
KEYWORD_NUMBER = 100
|
131
|
-
|
132
|
-
begin
|
133
|
-
add_keywords_in_bulk()
|
134
|
-
|
135
|
-
# HTTP errors.
|
136
|
-
rescue AdsCommon::Errors::HttpError => e
|
137
|
-
puts "HTTP Error: %s" % e
|
138
|
-
|
139
|
-
# API errors.
|
140
|
-
rescue AdwordsApi::Errors::ApiException => e
|
141
|
-
puts "Message: %s" % e.message
|
142
|
-
puts 'Errors:'
|
143
|
-
e.errors.each_with_index do |error, index|
|
144
|
-
puts "\tError [%d]:" % (index + 1)
|
145
|
-
error.each do |field, value|
|
146
|
-
puts "\t\t%s: %s" % [field, value]
|
147
|
-
end
|
148
|
-
end
|
149
|
-
end
|
150
|
-
end
|