google-adwords-api 0.10.0 → 0.11.0
Sign up to get free protection for your applications and to get access to all the features.
- data/ChangeLog +3 -0
- data/examples/v201306/misc/setup_oauth2.rb +4 -4
- data/examples/v201306/optimization/get_keyword_ideas.rb +1 -1
- data/examples/v201309/advanced_operations/add_site_links.rb +71 -9
- data/examples/v201309/advanced_operations/update_site_links.rb +194 -0
- data/examples/v201309/misc/setup_oauth2.rb +4 -4
- data/examples/v201309/optimization/get_keyword_ideas.rb +1 -1
- data/lib/adwords_api/api_config.rb +0 -88
- data/lib/adwords_api/version.rb +1 -1
- data/test/templates/v201306/basic_operations_get_campaigns.def +1 -1
- data/test/templates/v201306/misc_use_oauth2_jwt.def +1 -1
- data/test/templates/v201309/basic_operations_get_campaigns.def +1 -1
- data/test/templates/v201309/misc_use_oauth2_jwt.def +1 -1
- metadata +266 -429
- data/examples/v201302/account_management/create_account.rb +0 -95
- data/examples/v201302/account_management/get_account_alerts.rb +0 -122
- data/examples/v201302/account_management/get_account_changes.rb +0 -145
- data/examples/v201302/account_management/get_account_hierarchy.rb +0 -103
- data/examples/v201302/advanced_operations/add_ad_group_bid_modifier.rb +0 -105
- data/examples/v201302/advanced_operations/add_click_to_download_ad.rb +0 -137
- data/examples/v201302/advanced_operations/add_site_links.rb +0 -221
- data/examples/v201302/advanced_operations/create_and_attach_shared_keyword_set.rb +0 -147
- data/examples/v201302/advanced_operations/find_and_remove_criteria_from_shared_set.rb +0 -181
- data/examples/v201302/advanced_operations/get_ad_group_bid_modifiers.rb +0 -106
- data/examples/v201302/adwords_for_video/add_video_call_to_action.rb +0 -94
- data/examples/v201302/adwords_for_video/add_video_campaign.rb +0 -103
- data/examples/v201302/adwords_for_video/find_videos.rb +0 -92
- data/examples/v201302/adwords_for_video/get_keyword_criteria.rb +0 -101
- data/examples/v201302/adwords_for_video/get_targeting_groups.rb +0 -93
- data/examples/v201302/adwords_for_video/get_video_campaign_criteria.rb +0 -99
- data/examples/v201302/adwords_for_video/get_video_campaign_stats.rb +0 -126
- data/examples/v201302/adwords_for_video/get_video_campaigns.rb +0 -94
- data/examples/v201302/basic_operations/add_ad_groups.rb +0 -143
- data/examples/v201302/basic_operations/add_campaigns.rb +0 -162
- data/examples/v201302/basic_operations/add_keywords.rb +0 -116
- data/examples/v201302/basic_operations/add_text_ads.rb +0 -113
- data/examples/v201302/basic_operations/delete_ad.rb +0 -93
- data/examples/v201302/basic_operations/delete_ad_group.rb +0 -110
- data/examples/v201302/basic_operations/delete_campaign.rb +0 -111
- data/examples/v201302/basic_operations/delete_keyword.rb +0 -98
- data/examples/v201302/basic_operations/get_ad_groups.rb +0 -106
- data/examples/v201302/basic_operations/get_campaigns.rb +0 -101
- data/examples/v201302/basic_operations/get_campaigns_with_awql.rb +0 -93
- data/examples/v201302/basic_operations/get_keywords.rb +0 -112
- data/examples/v201302/basic_operations/get_text_ads.rb +0 -114
- data/examples/v201302/basic_operations/pause_ad.rb +0 -92
- data/examples/v201302/basic_operations/update_ad_group.rb +0 -89
- data/examples/v201302/basic_operations/update_campaign.rb +0 -90
- data/examples/v201302/basic_operations/update_keyword.rb +0 -110
- data/examples/v201302/campaign_management/add_experiment.rb +0 -166
- data/examples/v201302/campaign_management/add_keywords_in_bulk.rb +0 -158
- data/examples/v201302/campaign_management/add_location_extension.rb +0 -125
- data/examples/v201302/campaign_management/add_location_extension_override.rb +0 -91
- data/examples/v201302/campaign_management/get_all_disapproved_ads.rb +0 -101
- data/examples/v201302/campaign_management/get_all_disapproved_ads_with_awql.rb +0 -92
- data/examples/v201302/campaign_management/promote_experiment.rb +0 -85
- data/examples/v201302/campaign_management/set_ad_parameters.rb +0 -122
- data/examples/v201302/campaign_management/set_criterion_bid_modifier.rb +0 -110
- data/examples/v201302/campaign_management/validate_text_ad.rb +0 -114
- data/examples/v201302/error_handling/handle_captcha_challenge.rb +0 -93
- data/examples/v201302/error_handling/handle_partial_failures.rb +0 -134
- data/examples/v201302/error_handling/handle_policy_violation_error.rb +0 -145
- data/examples/v201302/error_handling/handle_two_factor_authorization_error.rb +0 -88
- data/examples/v201302/migration/set_campaign_enhanced.rb +0 -91
- data/examples/v201302/migration/upgrade_legacy_sitelinks.rb +0 -313
- data/examples/v201302/misc/get_all_images_and_videos.rb +0 -108
- data/examples/v201302/misc/setup_oauth2.rb +0 -88
- data/examples/v201302/misc/upload_image.rb +0 -97
- data/examples/v201302/misc/use_oauth2_jwt.rb +0 -93
- data/examples/v201302/optimization/estimate_keyword_traffic.rb +0 -137
- data/examples/v201302/optimization/get_keyword_bid_simulations.rb +0 -100
- data/examples/v201302/optimization/get_keyword_ideas.rb +0 -130
- data/examples/v201302/optimization/get_placement_ideas.rb +0 -112
- data/examples/v201302/remarketing/add_audience.rb +0 -123
- data/examples/v201302/remarketing/add_conversion_tracker.rb +0 -104
- data/examples/v201302/reporting/download_criteria_report.rb +0 -87
- data/examples/v201302/reporting/download_criteria_report_with_awql.rb +0 -86
- data/examples/v201302/reporting/get_campaign_stats.rb +0 -113
- data/examples/v201302/reporting/get_report_fields.rb +0 -79
- data/examples/v201302/reporting/parallel_report_download.rb +0 -171
- data/examples/v201302/targeting/add_campaign_targeting_criteria.rb +0 -123
- data/examples/v201302/targeting/add_demographic_targeting_criteria.rb +0 -116
- data/examples/v201302/targeting/get_campaign_targeting_criteria.rb +0 -110
- data/examples/v201302/targeting/get_targetable_languages_and_carriers.rb +0 -94
- data/examples/v201302/targeting/lookup_location.rb +0 -112
- data/examples/v201309/campaign_management/add_location_extension_override.rb +0 -91
- data/examples/v201309/reporting/get_campaign_stats.rb +0 -113
- data/lib/adwords_api/v201302/ad_extension_override_service.rb +0 -38
- data/lib/adwords_api/v201302/ad_extension_override_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/ad_group_ad_service.rb +0 -42
- data/lib/adwords_api/v201302/ad_group_ad_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/ad_group_bid_modifier_service.rb +0 -38
- data/lib/adwords_api/v201302/ad_group_bid_modifier_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/ad_group_criterion_service.rb +0 -42
- data/lib/adwords_api/v201302/ad_group_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/ad_group_feed_service.rb +0 -38
- data/lib/adwords_api/v201302/ad_group_feed_service_registry.rb +0 -47
- data/lib/adwords_api/v201302/ad_group_service.rb +0 -42
- data/lib/adwords_api/v201302/ad_group_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/ad_param_service.rb +0 -38
- data/lib/adwords_api/v201302/ad_param_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/alert_service.rb +0 -34
- data/lib/adwords_api/v201302/alert_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/budget_order_service.rb +0 -42
- data/lib/adwords_api/v201302/budget_order_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/budget_service.rb +0 -38
- data/lib/adwords_api/v201302/budget_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/campaign_ad_extension_service.rb +0 -38
- data/lib/adwords_api/v201302/campaign_ad_extension_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/campaign_criterion_service.rb +0 -42
- data/lib/adwords_api/v201302/campaign_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/campaign_feed_service.rb +0 -38
- data/lib/adwords_api/v201302/campaign_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/campaign_service.rb +0 -42
- data/lib/adwords_api/v201302/campaign_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/campaign_shared_set_service.rb +0 -38
- data/lib/adwords_api/v201302/campaign_shared_set_service_registry.rb +0 -47
- data/lib/adwords_api/v201302/constant_data_service.rb +0 -62
- data/lib/adwords_api/v201302/constant_data_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/conversion_tracker_service.rb +0 -38
- data/lib/adwords_api/v201302/conversion_tracker_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/customer_service.rb +0 -34
- data/lib/adwords_api/v201302/customer_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/customer_sync_service.rb +0 -34
- data/lib/adwords_api/v201302/customer_sync_service_registry.rb +0 -47
- data/lib/adwords_api/v201302/data_service.rb +0 -38
- data/lib/adwords_api/v201302/data_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/experiment_service.rb +0 -38
- data/lib/adwords_api/v201302/experiment_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/feed_item_service.rb +0 -38
- data/lib/adwords_api/v201302/feed_item_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/feed_mapping_service.rb +0 -38
- data/lib/adwords_api/v201302/feed_mapping_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/feed_service.rb +0 -38
- data/lib/adwords_api/v201302/feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/geo_location_service.rb +0 -34
- data/lib/adwords_api/v201302/geo_location_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/location_criterion_service.rb +0 -34
- data/lib/adwords_api/v201302/location_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/managed_customer_service.rb +0 -50
- data/lib/adwords_api/v201302/managed_customer_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/media_service.rb +0 -38
- data/lib/adwords_api/v201302/media_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/mutate_job_service.rb +0 -42
- data/lib/adwords_api/v201302/mutate_job_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/report_definition_service.rb +0 -34
- data/lib/adwords_api/v201302/report_definition_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/shared_criterion_service.rb +0 -38
- data/lib/adwords_api/v201302/shared_criterion_service_registry.rb +0 -47
- data/lib/adwords_api/v201302/shared_set_service.rb +0 -38
- data/lib/adwords_api/v201302/shared_set_service_registry.rb +0 -47
- data/lib/adwords_api/v201302/targeting_idea_service.rb +0 -38
- data/lib/adwords_api/v201302/targeting_idea_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/traffic_estimator_service.rb +0 -34
- data/lib/adwords_api/v201302/traffic_estimator_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/user_list_service.rb +0 -38
- data/lib/adwords_api/v201302/user_list_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/video_ad_service.rb +0 -38
- data/lib/adwords_api/v201302/video_ad_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/video_campaign_criterion_service.rb +0 -38
- data/lib/adwords_api/v201302/video_campaign_criterion_service_registry.rb +0 -47
- data/lib/adwords_api/v201302/video_campaign_service.rb +0 -38
- data/lib/adwords_api/v201302/video_campaign_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/video_service.rb +0 -42
- data/lib/adwords_api/v201302/video_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/video_targeting_group_criterion_service.rb +0 -38
- data/lib/adwords_api/v201302/video_targeting_group_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201302/video_targeting_group_service.rb +0 -38
- data/lib/adwords_api/v201302/video_targeting_group_service_registry.rb +0 -46
- data/test/examples/v201302/test_account_management.rb +0 -50
- data/test/examples/v201302/test_advanced_operations.rb +0 -81
- data/test/examples/v201302/test_basic_operations.rb +0 -177
- data/test/examples/v201302/test_campaign_management.rb +0 -132
- data/test/examples/v201302/test_error_handling.rb +0 -63
- data/test/examples/v201302/test_migration.rb +0 -49
- data/test/examples/v201302/test_misc.rb +0 -39
- data/test/examples/v201302/test_optimization.rb +0 -63
- data/test/examples/v201302/test_remarketing.rb +0 -39
- data/test/examples/v201302/test_reporting.rb +0 -84
- data/test/examples/v201302/test_targeting.rb +0 -68
- data/test/examples/v201302/utils.rb +0 -267
- data/test/suite_exampletests_v201302.rb +0 -37
- data/test/templates/v201302/basic_operations_get_campaigns.def +0 -114
- data/test/templates/v201302/misc_use_oauth2_jwt.def +0 -131
@@ -1,105 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
# Encoding: utf-8
|
3
|
-
#
|
4
|
-
# Author:: api.dklimkin@gmail.com (Danial Klimkin)
|
5
|
-
#
|
6
|
-
# Copyright:: Copyright 2013, 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 add an ad group level mobile bid modifier
|
22
|
-
# override for a campaign.
|
23
|
-
#
|
24
|
-
# Tags: AdGroupBidModifierService.mutate
|
25
|
-
|
26
|
-
require 'adwords_api'
|
27
|
-
|
28
|
-
def add_ad_group_bid_modifier(ad_group_id, bid_modifier)
|
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
|
-
bid_modifier_srv = adwords.service(:AdGroupBidModifierService, API_VERSION)
|
38
|
-
|
39
|
-
# Mobile criterion ID.
|
40
|
-
criterion_id = 30001
|
41
|
-
|
42
|
-
# Prepare to add an ad group level override.
|
43
|
-
operation = {
|
44
|
-
# Use 'ADD' to add a new modifier and 'SET' to update an existing one. A
|
45
|
-
# modifier can be removed with the 'REMOVE' operator.
|
46
|
-
:operator => 'ADD',
|
47
|
-
:operand => {
|
48
|
-
:ad_group_id => adgroup_id,
|
49
|
-
:criterion => {
|
50
|
-
:xsi_type => 'Platform',
|
51
|
-
:id => criterion_id
|
52
|
-
},
|
53
|
-
:bid_modifier => bid_modifier
|
54
|
-
}
|
55
|
-
}
|
56
|
-
|
57
|
-
# Add ad group level mobile bid modifier.
|
58
|
-
response = bid_modifier_srv.mutate([operation])
|
59
|
-
if response and response[:value]
|
60
|
-
modifier = response[:value].first
|
61
|
-
value = modifier[:bid_modifier] || 'unset'
|
62
|
-
puts ('Campaign ID %d, AdGroup ID %d, Criterion ID %d was updated with ' +
|
63
|
-
'ad group level modifier: %s') %
|
64
|
-
[modifier[:campaign_id], modifier[:ad_group_id],
|
65
|
-
modifier[:criterion][:id], value]
|
66
|
-
else
|
67
|
-
puts 'No modifiers were added.'
|
68
|
-
end
|
69
|
-
end
|
70
|
-
|
71
|
-
if __FILE__ == $0
|
72
|
-
API_VERSION = :v201302
|
73
|
-
|
74
|
-
begin
|
75
|
-
# ID of an ad group to add an override for.
|
76
|
-
ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
|
77
|
-
# Bid modifier to override with.
|
78
|
-
bid_modifier = 1.5
|
79
|
-
|
80
|
-
add_ad_group_bid_modifier(ad_group_id, bid_modifier)
|
81
|
-
|
82
|
-
# Authorization error.
|
83
|
-
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
84
|
-
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
85
|
-
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
86
|
-
"to retrieve and store OAuth2 tokens."
|
87
|
-
puts "See this wiki page for more details:\n\n " +
|
88
|
-
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
89
|
-
|
90
|
-
# HTTP errors.
|
91
|
-
rescue AdsCommon::Errors::HttpError => e
|
92
|
-
puts "HTTP Error: %s" % e
|
93
|
-
|
94
|
-
# API errors.
|
95
|
-
rescue AdwordsApi::Errors::ApiException => e
|
96
|
-
puts "Message: %s" % e.message
|
97
|
-
puts 'Errors:'
|
98
|
-
e.errors.each_with_index do |error, index|
|
99
|
-
puts "\tError [%d]:" % (index + 1)
|
100
|
-
error.each do |field, value|
|
101
|
-
puts "\t\t%s: %s" % [field, value]
|
102
|
-
end
|
103
|
-
end
|
104
|
-
end
|
105
|
-
end
|
@@ -1,137 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
# Encoding: utf-8
|
3
|
-
#
|
4
|
-
# Author:: api.dklimkin@gmail.com (Danial Klimkin)
|
5
|
-
#
|
6
|
-
# Copyright:: Copyright 2013, 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 example creates a click-to-download ad, also known as an app
|
22
|
-
# promotion ad to a given ad group. To list ad groups, run get_ad_groups.rb.
|
23
|
-
#
|
24
|
-
# Tags: AdGroupAdService.mutate
|
25
|
-
|
26
|
-
require 'adwords_api'
|
27
|
-
|
28
|
-
def add_click_to_download_ad(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_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
|
38
|
-
|
39
|
-
# Create the template elements for the ad. You can refer to
|
40
|
-
# https://developers.google.com/adwords/api/docs/appendix/templateads
|
41
|
-
# for the list of available template fields.
|
42
|
-
ad_data = {
|
43
|
-
:unique_name => 'adData',
|
44
|
-
:fields => [
|
45
|
-
{
|
46
|
-
:name => 'headline',
|
47
|
-
:field_text => 'Enjoy your drive in Mars',
|
48
|
-
:type => 'TEXT'
|
49
|
-
},
|
50
|
-
{
|
51
|
-
:name => 'description1',
|
52
|
-
:field_text => 'Realistic physics simulation',
|
53
|
-
:type => 'TEXT'
|
54
|
-
},
|
55
|
-
{
|
56
|
-
:name => 'description2',
|
57
|
-
:field_text => 'Race against players online',
|
58
|
-
:type => 'TEXT'
|
59
|
-
},
|
60
|
-
{
|
61
|
-
:name => 'appId',
|
62
|
-
:field_text => 'com.example.demogame',
|
63
|
-
:type => 'TEXT'
|
64
|
-
},
|
65
|
-
{
|
66
|
-
:name => 'appStore',
|
67
|
-
:field_text => '2',
|
68
|
-
:type => 'ENUM'
|
69
|
-
}
|
70
|
-
]
|
71
|
-
}
|
72
|
-
|
73
|
-
# Create click to download ad.
|
74
|
-
click_to_download_app_ad = {
|
75
|
-
:xsi_type => 'TemplateAd',
|
76
|
-
:name => 'Ad for demo game',
|
77
|
-
:template_id => 353,
|
78
|
-
:url =>
|
79
|
-
'http://play.google.com/store/apps/details?id=com.example.demogame',
|
80
|
-
:display_url => 'play.google.com',
|
81
|
-
:template_elements => [ad_data]
|
82
|
-
}
|
83
|
-
|
84
|
-
# Create ad group ad.
|
85
|
-
ad_group_ad = {
|
86
|
-
:ad_group_id => ad_group_id,
|
87
|
-
:ad => click_to_download_app_ad,
|
88
|
-
# Optional.
|
89
|
-
:status => 'PAUSED'
|
90
|
-
}
|
91
|
-
|
92
|
-
# Add ad.
|
93
|
-
response = ad_group_ad_srv.mutate([
|
94
|
-
{:operator => 'ADD', :operand => ad_group_ad}
|
95
|
-
])
|
96
|
-
if response and response[:value]
|
97
|
-
response[:value].each do |ad|
|
98
|
-
puts "Added new click-to-download ad to ad group ID %d with url '%s'." %
|
99
|
-
[ad[:ad][:id], ad[:ad][:url]]
|
100
|
-
end
|
101
|
-
else
|
102
|
-
raise StandardError, 'No ads were added.'
|
103
|
-
end
|
104
|
-
end
|
105
|
-
|
106
|
-
if __FILE__ == $0
|
107
|
-
API_VERSION = :v201302
|
108
|
-
|
109
|
-
begin
|
110
|
-
# Ad group ID to add text ads to.
|
111
|
-
ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
|
112
|
-
add_click_to_download_ad(ad_group_id)
|
113
|
-
|
114
|
-
# Authorization error.
|
115
|
-
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
116
|
-
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
117
|
-
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
118
|
-
"to retrieve and store OAuth2 tokens."
|
119
|
-
puts "See this wiki page for more details:\n\n " +
|
120
|
-
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
121
|
-
|
122
|
-
# HTTP errors.
|
123
|
-
rescue AdsCommon::Errors::HttpError => e
|
124
|
-
puts "HTTP Error: %s" % e
|
125
|
-
|
126
|
-
# API errors.
|
127
|
-
rescue AdwordsApi::Errors::ApiException => e
|
128
|
-
puts "Message: %s" % e.message
|
129
|
-
puts 'Errors:'
|
130
|
-
e.errors.each_with_index do |error, index|
|
131
|
-
puts "\tError [%d]:" % (index + 1)
|
132
|
-
error.each do |field, value|
|
133
|
-
puts "\t\t%s: %s" % [field, value]
|
134
|
-
end
|
135
|
-
end
|
136
|
-
end
|
137
|
-
end
|
@@ -1,221 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
# Encoding: utf-8
|
3
|
-
#
|
4
|
-
# Author:: api.dklimkin@gmail.com (Danial Klimkin)
|
5
|
-
#
|
6
|
-
# Copyright:: Copyright 2013, 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 adds a sitelinks feed and associates it with a campaign.
|
22
|
-
#
|
23
|
-
# Tags: CampaignFeedService.mutate, FeedItemService.mutate
|
24
|
-
# Tags: FeedMappingService.mutate, FeedService.mutate
|
25
|
-
|
26
|
-
require 'adwords_api'
|
27
|
-
|
28
|
-
def add_site_links(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
|
-
feed_srv = adwords.service(:FeedService, API_VERSION)
|
38
|
-
feed_item_srv = adwords.service(:FeedItemService, API_VERSION)
|
39
|
-
feed_mapping_srv = adwords.service(:FeedMappingService, API_VERSION)
|
40
|
-
campaign_feed_srv = adwords.service(:CampaignFeedService, API_VERSION)
|
41
|
-
|
42
|
-
sitelinks_data = {}
|
43
|
-
|
44
|
-
# Create site links feed first.
|
45
|
-
site_links_feed = {
|
46
|
-
:name => 'Feed For Site Links',
|
47
|
-
:attributes => [
|
48
|
-
{:type => 'STRING', :name => 'Link Text'},
|
49
|
-
{:type => 'URL', :name => 'Link URL'}
|
50
|
-
]
|
51
|
-
}
|
52
|
-
|
53
|
-
response = feed_srv.mutate([
|
54
|
-
{:operator => 'ADD', :operand => site_links_feed}
|
55
|
-
])
|
56
|
-
if response and response[:value]
|
57
|
-
feed = response[:value].first
|
58
|
-
# Attribute of type STRING.
|
59
|
-
link_text_feed_attribute_id = feed[:attributes][0][:id]
|
60
|
-
# Attribute of type URL.
|
61
|
-
link_url_feed_attribute_id = feed[:attributes][1][:id]
|
62
|
-
puts "Feed with name '%s' and ID %d was added with" %
|
63
|
-
[feed[:name], feed[:id]]
|
64
|
-
puts "\tText attribute ID %d and URL attribute ID %d." %
|
65
|
-
[link_text_feed_attribute_id, link_url_feed_attribute_id]
|
66
|
-
sitelinks_data[:feed_id] = feed[:id]
|
67
|
-
sitelinks_data[:link_text_feed_id] = link_text_feed_attribute_id
|
68
|
-
sitelinks_data[:link_url_feed_id] = link_url_feed_attribute_id
|
69
|
-
else
|
70
|
-
raise new StandardError, 'No feeds were added.'
|
71
|
-
end
|
72
|
-
|
73
|
-
# Create site links feed items.
|
74
|
-
items_data = [
|
75
|
-
{:text => 'Home', :url => 'http://www.example.com'},
|
76
|
-
{:text => 'Stores', :url => 'http://www.example.com/stores'},
|
77
|
-
{:text => 'On Sale', :url => 'http://www.example.com/sale'},
|
78
|
-
{:text => 'Support', :url => 'http://www.example.com/support'},
|
79
|
-
{:text => 'Products', :url => 'http://www.example.com/products'},
|
80
|
-
{:text => 'About', :url => 'http://www.example.com/about'}
|
81
|
-
]
|
82
|
-
|
83
|
-
feed_items = items_data.map do |item|
|
84
|
-
{
|
85
|
-
:feed_id => sitelinks_data[:feed_id],
|
86
|
-
:attribute_values => [
|
87
|
-
{
|
88
|
-
:feed_attribute_id => sitelinks_data[:link_text_feed_id],
|
89
|
-
:string_value => item[:text]
|
90
|
-
},
|
91
|
-
{
|
92
|
-
:feed_attribute_id => sitelinks_data[:link_url_feed_id],
|
93
|
-
:string_value => item[:url]
|
94
|
-
}
|
95
|
-
]
|
96
|
-
}
|
97
|
-
end
|
98
|
-
|
99
|
-
feed_items_operations = feed_items.map do |item|
|
100
|
-
{:operator => 'ADD', :operand => item}
|
101
|
-
end
|
102
|
-
|
103
|
-
response = feed_item_srv.mutate(feed_items_operations)
|
104
|
-
if response and response[:value]
|
105
|
-
sitelinks_data[:feed_item_ids] = []
|
106
|
-
response[:value].each do |feed_item|
|
107
|
-
puts 'Feed item with ID %d was added.' % feed_item[:feed_item_id]
|
108
|
-
sitelinks_data[:feed_item_ids] << feed_item[:feed_item_id]
|
109
|
-
end
|
110
|
-
else
|
111
|
-
raise new StandardError, 'No feed items were added.'
|
112
|
-
end
|
113
|
-
|
114
|
-
# Create site links feed mapping.
|
115
|
-
feed_mapping = {
|
116
|
-
:placeholder_type => PLACEHOLDER_SITELINKS,
|
117
|
-
:feed_id => sitelinks_data[:feed_id],
|
118
|
-
:attribute_field_mappings => [
|
119
|
-
{
|
120
|
-
:feed_attribute_id => sitelinks_data[:link_text_feed_id],
|
121
|
-
:field_id => PLACEHOLDER_FIELD_SITELINK_LINK_TEXT
|
122
|
-
},
|
123
|
-
{
|
124
|
-
:feed_attribute_id => sitelinks_data[:link_url_feed_id],
|
125
|
-
:field_id => PLACEHOLDER_FIELD_SITELINK_LINK_URL
|
126
|
-
}
|
127
|
-
]
|
128
|
-
}
|
129
|
-
|
130
|
-
response = feed_mapping_srv.mutate([
|
131
|
-
{:operator => 'ADD', :operand => feed_mapping}
|
132
|
-
])
|
133
|
-
if response and response[:value]
|
134
|
-
feed_mapping = response[:value].first
|
135
|
-
puts ('Feed mapping with ID %d and placeholder type %d was saved for feed' +
|
136
|
-
' with ID %d.') % [
|
137
|
-
feed_mapping[:feed_mapping_id],
|
138
|
-
feed_mapping[:placeholder_type],
|
139
|
-
feed_mapping[:feed_id]
|
140
|
-
]
|
141
|
-
else
|
142
|
-
raise new StandardError, 'No feed mappings were added.'
|
143
|
-
end
|
144
|
-
|
145
|
-
# Create site links campaign feed.
|
146
|
-
operands = sitelinks_data[:feed_item_ids].map do |feed_item_id|
|
147
|
-
{
|
148
|
-
:xsi_type => 'ConstantOperand',
|
149
|
-
:type => 'LONG',
|
150
|
-
:long_value => feed_item_id
|
151
|
-
}
|
152
|
-
end
|
153
|
-
|
154
|
-
function = {
|
155
|
-
:operator => 'IN',
|
156
|
-
:lhs_operand => [
|
157
|
-
{:xsi_type => 'RequestContextOperand', :context_type => 'FEED_ITEM_ID'}
|
158
|
-
],
|
159
|
-
:rhs_operand => operands
|
160
|
-
}
|
161
|
-
|
162
|
-
campaign_feed = {
|
163
|
-
:feed_id => sitelinks_data[:feed_id],
|
164
|
-
:campaign_id => campaign_id,
|
165
|
-
:matching_function => function,
|
166
|
-
# Specifying placeholder types on the CampaignFeed allows the same feed
|
167
|
-
# to be used for different placeholders in different Campaigns.
|
168
|
-
:placeholder_types => [PLACEHOLDER_SITELINKS]
|
169
|
-
}
|
170
|
-
|
171
|
-
response = campaign_feed_srv.mutate([
|
172
|
-
{:operator => 'ADD', :operand => campaign_feed}
|
173
|
-
])
|
174
|
-
if response and response[:value]
|
175
|
-
campaign_feed = response[:value].first
|
176
|
-
puts 'Campaign with ID %d was associated with feed with ID %d.' %
|
177
|
-
[campaign_feed[:campaign_id], campaign_feed[:feed_id]]
|
178
|
-
else
|
179
|
-
raise new StandardError, 'No campaign feeds were added.'
|
180
|
-
end
|
181
|
-
end
|
182
|
-
|
183
|
-
if __FILE__ == $0
|
184
|
-
API_VERSION = :v201302
|
185
|
-
|
186
|
-
# See the Placeholder reference page for a list of all the placeholder types
|
187
|
-
# and fields, see:
|
188
|
-
# https://developers.google.com/adwords/api/docs/appendix/placeholders
|
189
|
-
PLACEHOLDER_SITELINKS = 1
|
190
|
-
PLACEHOLDER_FIELD_SITELINK_LINK_TEXT = 1
|
191
|
-
PLACEHOLDER_FIELD_SITELINK_LINK_URL = 2
|
192
|
-
|
193
|
-
begin
|
194
|
-
# Campaign ID to add site link to. Campaign must be enhanced.
|
195
|
-
campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
|
196
|
-
add_site_links(campaign_id)
|
197
|
-
|
198
|
-
# Authorization error.
|
199
|
-
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
200
|
-
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
201
|
-
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
202
|
-
"to retrieve and store OAuth2 tokens."
|
203
|
-
puts "See this wiki page for more details:\n\n " +
|
204
|
-
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
205
|
-
|
206
|
-
# HTTP errors.
|
207
|
-
rescue AdsCommon::Errors::HttpError => e
|
208
|
-
puts "HTTP Error: %s" % e
|
209
|
-
|
210
|
-
# API errors.
|
211
|
-
rescue AdwordsApi::Errors::ApiException => e
|
212
|
-
puts "Message: %s" % e.message
|
213
|
-
puts 'Errors:'
|
214
|
-
e.errors.each_with_index do |error, index|
|
215
|
-
puts "\tError [%d]:" % (index + 1)
|
216
|
-
error.each do |field, value|
|
217
|
-
puts "\t\t%s: %s" % [field, value]
|
218
|
-
end
|
219
|
-
end
|
220
|
-
end
|
221
|
-
end
|