google-adwords-api 0.15.2 → 0.16.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +8 -8
- data/ChangeLog +7 -0
- data/adwords_api.yml +3 -2
- data/examples/v201506/basic_operations/get_keywords.rb +4 -3
- data/examples/v201506/misc/{create_ad_words_session_without_properties_file.rb → use_runtime_config.rb} +2 -2
- data/lib/adwords_api.rb +1 -1
- data/lib/adwords_api/api_config.rb +0 -86
- data/lib/adwords_api/report_header_handler.rb +4 -4
- data/lib/adwords_api/version.rb +1 -1
- data/test/templates/v201502/basic_operations_get_campaigns.def +1 -1
- data/test/templates/v201502/{misc_use_oauth2_jwt.def → misc_use_oauth2_service_account.def} +2 -2
- data/test/templates/v201506/basic_operations_get_campaigns.def +1 -1
- data/test/templates/v201506/{misc_use_oauth2_jwt.def → misc_use_oauth2_service_account.def} +2 -2
- metadata +7 -160
- data/examples/v201409/account_management/create_account.rb +0 -92
- data/examples/v201409/account_management/get_account_changes.rb +0 -145
- data/examples/v201409/account_management/get_account_hierarchy.rb +0 -102
- data/examples/v201409/advanced_operations/add_ad_customizers.rb +0 -277
- data/examples/v201409/advanced_operations/add_ad_group_bid_modifier.rb +0 -105
- data/examples/v201409/advanced_operations/add_click_to_download_ad.rb +0 -137
- data/examples/v201409/advanced_operations/add_text_ad_with_upgraded_urls.rb +0 -137
- data/examples/v201409/advanced_operations/get_ad_group_bid_modifiers.rb +0 -106
- data/examples/v201409/advanced_operations/upload_offline_conversions.rb +0 -117
- data/examples/v201409/advanced_operations/use_shared_bidding_strategy.rb +0 -152
- data/examples/v201409/basic_operations/add_ad_groups.rb +0 -144
- data/examples/v201409/basic_operations/add_campaigns.rb +0 -143
- data/examples/v201409/basic_operations/add_keywords.rb +0 -118
- data/examples/v201409/basic_operations/add_text_ads.rb +0 -113
- data/examples/v201409/basic_operations/get_ad_groups.rb +0 -106
- data/examples/v201409/basic_operations/get_campaigns.rb +0 -101
- data/examples/v201409/basic_operations/get_campaigns_with_awql.rb +0 -93
- data/examples/v201409/basic_operations/get_keywords.rb +0 -112
- data/examples/v201409/basic_operations/get_text_ads.rb +0 -114
- data/examples/v201409/basic_operations/pause_ad.rb +0 -92
- data/examples/v201409/basic_operations/remove_ad.rb +0 -93
- data/examples/v201409/basic_operations/remove_ad_group.rb +0 -89
- data/examples/v201409/basic_operations/remove_campaign.rb +0 -91
- data/examples/v201409/basic_operations/remove_keyword.rb +0 -98
- data/examples/v201409/basic_operations/update_ad_group.rb +0 -89
- data/examples/v201409/basic_operations/update_campaign.rb +0 -90
- data/examples/v201409/basic_operations/update_keyword.rb +0 -110
- data/examples/v201409/campaign_management/add_campaign_labels.rb +0 -86
- data/examples/v201409/campaign_management/add_experiment.rb +0 -166
- data/examples/v201409/campaign_management/add_keywords_in_bulk.rb +0 -158
- data/examples/v201409/campaign_management/add_location_extension.rb +0 -125
- data/examples/v201409/campaign_management/get_all_disapproved_ads.rb +0 -101
- data/examples/v201409/campaign_management/get_all_disapproved_ads_with_awql.rb +0 -93
- data/examples/v201409/campaign_management/get_campaigns_by_label.rb +0 -112
- data/examples/v201409/campaign_management/promote_experiment.rb +0 -85
- data/examples/v201409/campaign_management/set_ad_parameters.rb +0 -122
- data/examples/v201409/campaign_management/set_criterion_bid_modifier.rb +0 -108
- data/examples/v201409/campaign_management/validate_text_ad.rb +0 -114
- data/examples/v201409/error_handling/handle_partial_failures.rb +0 -134
- data/examples/v201409/error_handling/handle_policy_violation_error.rb +0 -145
- data/examples/v201409/extensions/add_google_my_business_location_extensions.rb +0 -183
- data/examples/v201409/extensions/add_site_links.rb +0 -167
- data/examples/v201409/extensions/add_site_links_using_feeds.rb +0 -306
- data/examples/v201409/migration/migrate_to_extension_settings.rb +0 -392
- data/examples/v201409/migration/upgrade_ad_url.rb +0 -97
- data/examples/v201409/misc/create_ad_words_session_without_properties_file.rb +0 -94
- data/examples/v201409/misc/get_all_images_and_videos.rb +0 -108
- data/examples/v201409/misc/setup_oauth2.rb +0 -88
- data/examples/v201409/misc/upload_image.rb +0 -97
- data/examples/v201409/misc/use_oauth2_jwt.rb +0 -97
- data/examples/v201409/optimization/estimate_keyword_traffic.rb +0 -155
- data/examples/v201409/optimization/get_keyword_bid_simulations.rb +0 -100
- data/examples/v201409/optimization/get_keyword_ideas.rb +0 -130
- data/examples/v201409/remarketing/add_audience.rb +0 -122
- data/examples/v201409/remarketing/add_conversion_tracker.rb +0 -105
- data/examples/v201409/remarketing/add_rule_based_user_lists.rb +0 -171
- data/examples/v201409/reporting/download_criteria_report.rb +0 -87
- data/examples/v201409/reporting/download_criteria_report_with_awql.rb +0 -86
- data/examples/v201409/reporting/get_report_fields.rb +0 -79
- data/examples/v201409/reporting/parallel_report_download.rb +0 -171
- data/examples/v201409/shopping_campaigns/add_product_partition_tree.rb +0 -269
- data/examples/v201409/shopping_campaigns/add_product_scope.rb +0 -133
- data/examples/v201409/shopping_campaigns/add_shopping_campaign.rb +0 -131
- data/examples/v201409/shopping_campaigns/get_product_category_taxonomy.rb +0 -117
- data/examples/v201409/targeting/add_campaign_targeting_criteria.rb +0 -173
- data/examples/v201409/targeting/add_demographic_targeting_criteria.rb +0 -116
- data/examples/v201409/targeting/get_campaign_targeting_criteria.rb +0 -110
- data/examples/v201409/targeting/get_targetable_languages_and_carriers.rb +0 -94
- data/examples/v201409/targeting/lookup_location.rb +0 -112
- data/lib/adwords_api/v201409/ad_customizer_feed_service.rb +0 -38
- data/lib/adwords_api/v201409/ad_customizer_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/ad_group_ad_service.rb +0 -50
- data/lib/adwords_api/v201409/ad_group_ad_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/ad_group_bid_modifier_service.rb +0 -42
- data/lib/adwords_api/v201409/ad_group_bid_modifier_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/ad_group_criterion_service.rb +0 -46
- data/lib/adwords_api/v201409/ad_group_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/ad_group_extension_setting_service.rb +0 -42
- data/lib/adwords_api/v201409/ad_group_extension_setting_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/ad_group_feed_service.rb +0 -42
- data/lib/adwords_api/v201409/ad_group_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/ad_group_service.rb +0 -46
- data/lib/adwords_api/v201409/ad_group_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/ad_param_service.rb +0 -38
- data/lib/adwords_api/v201409/ad_param_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/adwords_user_list_service.rb +0 -38
- data/lib/adwords_api/v201409/adwords_user_list_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/bidding_strategy_service.rb +0 -42
- data/lib/adwords_api/v201409/bidding_strategy_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/budget_order_service.rb +0 -42
- data/lib/adwords_api/v201409/budget_order_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/budget_service.rb +0 -42
- data/lib/adwords_api/v201409/budget_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/campaign_ad_extension_service.rb +0 -38
- data/lib/adwords_api/v201409/campaign_ad_extension_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/campaign_criterion_service.rb +0 -42
- data/lib/adwords_api/v201409/campaign_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/campaign_extension_setting_service.rb +0 -42
- data/lib/adwords_api/v201409/campaign_extension_setting_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/campaign_feed_service.rb +0 -42
- data/lib/adwords_api/v201409/campaign_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/campaign_service.rb +0 -46
- data/lib/adwords_api/v201409/campaign_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/campaign_shared_set_service.rb +0 -38
- data/lib/adwords_api/v201409/campaign_shared_set_service_registry.rb +0 -47
- data/lib/adwords_api/v201409/constant_data_service.rb +0 -66
- data/lib/adwords_api/v201409/constant_data_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/conversion_tracker_service.rb +0 -38
- data/lib/adwords_api/v201409/conversion_tracker_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/customer_extension_setting_service.rb +0 -42
- data/lib/adwords_api/v201409/customer_extension_setting_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/customer_feed_service.rb +0 -42
- data/lib/adwords_api/v201409/customer_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/customer_service.rb +0 -38
- data/lib/adwords_api/v201409/customer_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/customer_sync_service.rb +0 -34
- data/lib/adwords_api/v201409/customer_sync_service_registry.rb +0 -47
- data/lib/adwords_api/v201409/data_service.rb +0 -54
- data/lib/adwords_api/v201409/data_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/experiment_service.rb +0 -38
- data/lib/adwords_api/v201409/experiment_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/feed_item_service.rb +0 -42
- data/lib/adwords_api/v201409/feed_item_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/feed_mapping_service.rb +0 -42
- data/lib/adwords_api/v201409/feed_mapping_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/feed_service.rb +0 -42
- data/lib/adwords_api/v201409/feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/geo_location_service.rb +0 -34
- data/lib/adwords_api/v201409/geo_location_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/label_service.rb +0 -42
- data/lib/adwords_api/v201409/label_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/location_criterion_service.rb +0 -38
- data/lib/adwords_api/v201409/location_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/managed_customer_service.rb +0 -50
- data/lib/adwords_api/v201409/managed_customer_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/media_service.rb +0 -42
- data/lib/adwords_api/v201409/media_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/mutate_job_service.rb +0 -42
- data/lib/adwords_api/v201409/mutate_job_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/offline_conversion_feed_service.rb +0 -34
- data/lib/adwords_api/v201409/offline_conversion_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/report_definition_service.rb +0 -34
- data/lib/adwords_api/v201409/report_definition_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/shared_criterion_service.rb +0 -38
- data/lib/adwords_api/v201409/shared_criterion_service_registry.rb +0 -47
- data/lib/adwords_api/v201409/shared_set_service.rb +0 -38
- data/lib/adwords_api/v201409/shared_set_service_registry.rb +0 -47
- data/lib/adwords_api/v201409/targeting_idea_service.rb +0 -34
- data/lib/adwords_api/v201409/targeting_idea_service_registry.rb +0 -46
- data/lib/adwords_api/v201409/traffic_estimator_service.rb +0 -34
- data/lib/adwords_api/v201409/traffic_estimator_service_registry.rb +0 -46
- data/test/templates/v201409/basic_operations_get_campaigns.def +0 -116
- data/test/templates/v201409/misc_use_oauth2_jwt.def +0 -131
@@ -1,183 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
# Encoding: utf-8
|
3
|
-
#
|
4
|
-
# Author:: api.mcloonan@gmail.com (Michael Cloonan)
|
5
|
-
#
|
6
|
-
# Copyright:: Copyright 2014, 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 feed that syncs feed items from a Google My Business (GMB)
|
22
|
-
# account and associates the feed with a customer.
|
23
|
-
#
|
24
|
-
# Tags: CustomerFeedService.mutate, FeedService.mutate
|
25
|
-
|
26
|
-
require 'adwords_api'
|
27
|
-
require 'date'
|
28
|
-
|
29
|
-
def add_gmb_location_extensions(gmb_email_address, gmb_access_token,
|
30
|
-
business_account_identifier)
|
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
|
-
|
35
|
-
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
36
|
-
# the configuration file or provide your own logger:
|
37
|
-
# adwords.logger = Logger.new('adwords_xml.log')
|
38
|
-
|
39
|
-
feed_srv = adwords.service(:FeedService, API_VERSION)
|
40
|
-
customer_feed_srv = adwords.service(:CustomerFeedService, API_VERSION)
|
41
|
-
|
42
|
-
# Create a feed that will sync to the Google My Business account specified
|
43
|
-
# by gmb_email_address. Do not add FeedAttributes to this object, as AdWords
|
44
|
-
# will add them automatically because this will be a system generated feed.
|
45
|
-
gmb_feed = {
|
46
|
-
:name => "GMB feed #%d" % (Time.new.to_f * 1000).to_i,
|
47
|
-
:system_feed_generation_data => {
|
48
|
-
:xsi_type => 'PlacesLocationFeedData',
|
49
|
-
:o_auth_info => {
|
50
|
-
:http_method => 'GET',
|
51
|
-
:http_request_url => 'https://www.googleapis.com/auth/adwords',
|
52
|
-
:http_authorization_header => "Bearer %s" % gmb_access_token
|
53
|
-
},
|
54
|
-
:email_address => gmb_email_address
|
55
|
-
},
|
56
|
-
# Since this feed's feed items will be managed by AdWords, you must set
|
57
|
-
# its origin to ADWORDS.
|
58
|
-
:origin => 'ADWORDS'
|
59
|
-
}
|
60
|
-
# Only include the business_account_identifier if it's specified.
|
61
|
-
# A nil value will cause an invalid request.
|
62
|
-
unless business_account_identifier.nil?
|
63
|
-
gmb_feed[:system_feed_generation_data][:business_account_identifier] =
|
64
|
-
business_account_identifier
|
65
|
-
end
|
66
|
-
|
67
|
-
gmb_operation = {
|
68
|
-
:operator => 'ADD',
|
69
|
-
:operand => gmb_feed
|
70
|
-
}
|
71
|
-
|
72
|
-
result = feed_srv.mutate([gmb_operation])
|
73
|
-
added_feed = result[:value].first
|
74
|
-
puts "Added GMB feed with ID %d" % added_feed[:id]
|
75
|
-
|
76
|
-
# Add a CustomerFeed that associates the feed with this customer for the
|
77
|
-
# LOCATION placeholder type.
|
78
|
-
customer_feed = {
|
79
|
-
:feed_id => added_feed[:id],
|
80
|
-
:placeholder_types => PLACEHOLDER_TYPE_LOCATION,
|
81
|
-
:matching_function => {
|
82
|
-
:operator => 'IDENTITY',
|
83
|
-
:lhsOperand => {
|
84
|
-
:xsi_type => 'ConstantOperand',
|
85
|
-
:type => 'BOOLEAN',
|
86
|
-
:boolean_value => true
|
87
|
-
}
|
88
|
-
}
|
89
|
-
}
|
90
|
-
|
91
|
-
customer_feed_operation = {
|
92
|
-
:xsi_type => 'CustomerFeedOperation',
|
93
|
-
:operator => 'ADD',
|
94
|
-
:operand => customer_feed
|
95
|
-
}
|
96
|
-
|
97
|
-
added_customer_feed = nil
|
98
|
-
number_of_attempts = 0
|
99
|
-
while i < MAX_CUSTOMER_FEED_ADD_ATTEMPTS && !added_customer_feed
|
100
|
-
number_of_attempts += 1
|
101
|
-
begin
|
102
|
-
result = customer_feed_srv.mutate([customer_feed_operation])
|
103
|
-
added_customer_feed = result[:value].first
|
104
|
-
puts "Attempt #%d to add the CustomerFeed was successful" %
|
105
|
-
number_of_attempts
|
106
|
-
rescue
|
107
|
-
sleep_seconds = 5 * (2 ** number_of_attempts)
|
108
|
-
puts ("Attempt #%d to add the CustomerFeed was not succeessful. " +
|
109
|
-
"Waiting %d seconds before trying again.") %
|
110
|
-
[number_of_attempts, sleep_seconds]
|
111
|
-
sleep(sleep_seconds)
|
112
|
-
end
|
113
|
-
end
|
114
|
-
|
115
|
-
unless added_customer_feed
|
116
|
-
raise StandardError, ("Could not create the CustomerFeed after %d " +
|
117
|
-
"attempts. Please retry the CustomerFeed ADD operation later.") %
|
118
|
-
MAX_CUSTOMER_FEED_ADD_ATTEMPTS
|
119
|
-
end
|
120
|
-
|
121
|
-
puts "Added CustomerFeed for feed ID %d and placeholder type %d" %
|
122
|
-
[added_customer_feed[:id], added_customer_feed[:placeholder_types].first]
|
123
|
-
|
124
|
-
# OPTIONAL: Create a CampaignFeed to specify which FeedItems to use at the
|
125
|
-
# Campaign level. This will be similar to the CampaignFeed in the
|
126
|
-
# add_site_links example, except you can filter based on the business name
|
127
|
-
# and category of each FeedItem by using a FeedAttributeOperand in your
|
128
|
-
# matching function.
|
129
|
-
|
130
|
-
# OPTIONAL: Create an AdGroupFeed for even more fine grained control over
|
131
|
-
# which feed items are used at the AdGroup level.
|
132
|
-
end
|
133
|
-
|
134
|
-
if __FILE__ == $0
|
135
|
-
API_VERSION = :v201409
|
136
|
-
PLACEHOLDER_TYPE_LOCATION = 7
|
137
|
-
MAX_CUSTOMER_FEED_ADD_ATTEMPTS = 10
|
138
|
-
|
139
|
-
begin
|
140
|
-
# The email address of either an owner or a manager of the GMB account.
|
141
|
-
gmb_email_address = 'INSERT_GMB_EMAIL_ADDRESS_HERE'
|
142
|
-
|
143
|
-
# To obtain an access token for your GMB account, generate a refresh token
|
144
|
-
# as you did for AdWords, but make sure you are logged in as the same user
|
145
|
-
# as gmb_email_address above when you follow the link, then capture
|
146
|
-
# the generated access token
|
147
|
-
gmb_access_token = 'INSERT_GMB_OAUTH_ACCESS_TOKEN_HERE'
|
148
|
-
|
149
|
-
# If the gmb_email_address above is for a GMB manager instead of
|
150
|
-
# the GMB account owner, then set business_account_identifier to the
|
151
|
-
# +Page ID of a location for which the manager has access. See the
|
152
|
-
# location extensions guide at
|
153
|
-
# https://developers.google.com/adwords/api/docs/guides/feed-services-locations
|
154
|
-
# for details.
|
155
|
-
business_account_identifier = nil
|
156
|
-
|
157
|
-
add_gmb_location_extensions(gmb_email_address, gmb_access_token,
|
158
|
-
business_account_identifier)
|
159
|
-
|
160
|
-
# Authorization error.
|
161
|
-
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
162
|
-
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
163
|
-
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
164
|
-
"to retrieve and store OAuth2 tokens."
|
165
|
-
puts "See this wiki page for more details:\n\n " +
|
166
|
-
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
167
|
-
|
168
|
-
# HTTP errors.
|
169
|
-
rescue AdsCommon::Errors::HttpError => e
|
170
|
-
puts "HTTP Error: %s" % e
|
171
|
-
|
172
|
-
# API errors.
|
173
|
-
rescue AdwordsApi::Errors::ApiException => e
|
174
|
-
puts "Message: %s" % e.message
|
175
|
-
puts 'Errors:'
|
176
|
-
e.errors.each_with_index do |error, index|
|
177
|
-
puts "\tError [%d]:" % (index + 1)
|
178
|
-
error.each do |field, value|
|
179
|
-
puts "\t\t%s: %s" % [field, value]
|
180
|
-
end
|
181
|
-
end
|
182
|
-
end
|
183
|
-
end
|
@@ -1,167 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
# Encoding: utf-8
|
3
|
-
#
|
4
|
-
# Author:: api.mcloonan@gmail.com (Michael Cloonan)
|
5
|
-
#
|
6
|
-
# Copyright:: Copyright 2015, 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: CampaignExtensionSettingService.mutate
|
24
|
-
|
25
|
-
require 'adwords_api'
|
26
|
-
require 'date'
|
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
|
-
customer_srv = adwords.service(:CustomerService, API_VERSION)
|
38
|
-
customer = customer_srv.get()
|
39
|
-
customer_time_zone = customer[:date_time_zone]
|
40
|
-
|
41
|
-
campaign_extension_setting_srv =
|
42
|
-
adwords.service(:CampaignExtensionSettingService, API_VERSION)
|
43
|
-
|
44
|
-
sitelink_1 = {
|
45
|
-
:xsi_type => "SitelinkFeedItem",
|
46
|
-
:sitelink_text => "Store Hours",
|
47
|
-
:sitelink_url => "http://www.example.com/storehours"
|
48
|
-
}
|
49
|
-
|
50
|
-
sitelink_2 = {
|
51
|
-
:xsi_type => "SitelinkFeedItem",
|
52
|
-
:sitelink_text => "Thanksgiving Specials",
|
53
|
-
:sitelink_url => "http://www.example.com/thanksgiving",
|
54
|
-
:start_time => DateTime.new(Date.today.year, 11, 20, 0, 0, 0).
|
55
|
-
strftime("%Y%m%d %H%M%S ") + customer_time_zone,
|
56
|
-
:end_time => DateTime.new(Date.today.year, 11, 27, 23, 59, 59).
|
57
|
-
strftime("%Y%m%d %H%M%S ") + customer_time_zone
|
58
|
-
}
|
59
|
-
|
60
|
-
sitelink_3 = {
|
61
|
-
:xsi_type => "SitelinkFeedItem",
|
62
|
-
:sitelink_text => "Wifi available",
|
63
|
-
:sitelink_url => "http://www.example.com/mobile/wifi",
|
64
|
-
:device_preference => {:device_preference => 30001}
|
65
|
-
}
|
66
|
-
|
67
|
-
sitelink_4 = {
|
68
|
-
:xsi_type => "SitelinkFeedItem",
|
69
|
-
:sitelink_text => "Happy hours",
|
70
|
-
:sitelink_url => "http://www.example.com/happyhours",
|
71
|
-
:scheduling => {
|
72
|
-
:feed_item_schedules => [
|
73
|
-
{
|
74
|
-
:day_of_week => 'MONDAY',
|
75
|
-
:start_hour => 18,
|
76
|
-
:start_minute => 'ZERO',
|
77
|
-
:end_hour => 21,
|
78
|
-
:end_minute => 'ZERO'
|
79
|
-
},
|
80
|
-
{
|
81
|
-
:day_of_week => 'TUESDAY',
|
82
|
-
:start_hour => 18,
|
83
|
-
:start_minute => 'ZERO',
|
84
|
-
:end_hour => 21,
|
85
|
-
:end_minute => 'ZERO'
|
86
|
-
},
|
87
|
-
{
|
88
|
-
:day_of_week => 'WEDNESDAY',
|
89
|
-
:start_hour => 18,
|
90
|
-
:start_minute => 'ZERO',
|
91
|
-
:end_hour => 21,
|
92
|
-
:end_minute => 'ZERO'
|
93
|
-
},
|
94
|
-
{
|
95
|
-
:day_of_week => 'THURSDAY',
|
96
|
-
:start_hour => 18,
|
97
|
-
:start_minute => 'ZERO',
|
98
|
-
:end_hour => 21,
|
99
|
-
:end_minute => 'ZERO'
|
100
|
-
},
|
101
|
-
{
|
102
|
-
:day_of_week => 'FRIDAY',
|
103
|
-
:start_hour => 18,
|
104
|
-
:start_minute => 'ZERO',
|
105
|
-
:end_hour => 21,
|
106
|
-
:end_minute => 'ZERO'
|
107
|
-
}
|
108
|
-
]
|
109
|
-
}
|
110
|
-
}
|
111
|
-
|
112
|
-
campaign_extension_setting = {
|
113
|
-
:campaign_id => campaign_id,
|
114
|
-
:extension_type => 'SITELINK',
|
115
|
-
:extension_setting => {
|
116
|
-
:extensions => [sitelink_1, sitelink_2, sitelink_3, sitelink_4]
|
117
|
-
}
|
118
|
-
}
|
119
|
-
|
120
|
-
operation = {
|
121
|
-
:operand => campaign_extension_setting,
|
122
|
-
:operator => 'ADD'
|
123
|
-
}
|
124
|
-
|
125
|
-
response = campaign_extension_setting_srv.mutate([operation])
|
126
|
-
if response and response[:value]
|
127
|
-
new_extension_setting = response[:value].first
|
128
|
-
puts "Extension setting wiht type = %s was added to campaign ID %d" %
|
129
|
-
[new_extension_setting[:extension_type][:value],
|
130
|
-
new_extension_setting[:campaign_id]]
|
131
|
-
elsif
|
132
|
-
puts "No extension settings were created."
|
133
|
-
end
|
134
|
-
end
|
135
|
-
|
136
|
-
if __FILE__ == $0
|
137
|
-
API_VERSION = :v201409
|
138
|
-
|
139
|
-
begin
|
140
|
-
# Campaign ID to add site link to.
|
141
|
-
campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
|
142
|
-
add_site_links(campaign_id)
|
143
|
-
|
144
|
-
# Authorization error.
|
145
|
-
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
146
|
-
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
147
|
-
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
148
|
-
"to retrieve and store OAuth2 tokens."
|
149
|
-
puts "See this wiki page for more details:\n\n " +
|
150
|
-
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
151
|
-
|
152
|
-
# HTTP errors.
|
153
|
-
rescue AdsCommon::Errors::HttpError => e
|
154
|
-
puts "HTTP Error: %s" % e
|
155
|
-
|
156
|
-
# API errors.
|
157
|
-
rescue AdwordsApi::Errors::ApiException => e
|
158
|
-
puts "Message: %s" % e.message
|
159
|
-
puts 'Errors:'
|
160
|
-
e.errors.each_with_index do |error, index|
|
161
|
-
puts "\tError [%d]:" % (index + 1)
|
162
|
-
error.each do |field, value|
|
163
|
-
puts "\t\t%s: %s" % [field, value]
|
164
|
-
end
|
165
|
-
end
|
166
|
-
end
|
167
|
-
end
|
@@ -1,306 +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_LIST', :name => 'Final URLs'},
|
50
|
-
{:type => 'STRING', :name => 'Line 1 Description'},
|
51
|
-
{:type => 'STRING', :name => 'Line 2 Description'}
|
52
|
-
]
|
53
|
-
}
|
54
|
-
|
55
|
-
response = feed_srv.mutate([
|
56
|
-
{:operator => 'ADD', :operand => site_links_feed}
|
57
|
-
])
|
58
|
-
if response and response[:value]
|
59
|
-
feed = response[:value].first
|
60
|
-
# Attribute of type STRING.
|
61
|
-
link_text_feed_attribute_id = feed[:attributes][0][:id]
|
62
|
-
# Attribute of type URL_LIST.
|
63
|
-
final_url_feed_attribute_id = feed[:attributes][1][:id]
|
64
|
-
# Attribute of type STRING.
|
65
|
-
line_1_feed_attribute_id = feed[:attributes][2][:id]
|
66
|
-
#Attribute of type STRING.
|
67
|
-
line_2_feed_attribute_id = feed[:attributes][3][:id]
|
68
|
-
puts "Feed with name '%s' and ID %d was added with" %
|
69
|
-
[feed[:name], feed[:id]]
|
70
|
-
puts "\tText attribute ID %d and Final URLs attribute ID %d " +
|
71
|
-
"and Line 1 attribute ID %d and Line 2 attribute ID %d." % [
|
72
|
-
link_text_feed_attribute_id,
|
73
|
-
final_url_feed_attribute_id,
|
74
|
-
line_1_feed_attribute_id,
|
75
|
-
line_2_feed_attribute_id
|
76
|
-
]
|
77
|
-
|
78
|
-
sitelinks_data[:feed_id] = feed[:id]
|
79
|
-
sitelinks_data[:link_text_feed_id] = link_text_feed_attribute_id
|
80
|
-
sitelinks_data[:final_url_feed_id] = final_url_feed_attribute_id
|
81
|
-
sitelinks_data[:line_1_feed_id] = line_1_feed_attribute_id
|
82
|
-
sitelinks_data[:line_2_feed_id] = line_2_feed_attribute_id
|
83
|
-
else
|
84
|
-
raise new StandardError, 'No feeds were added.'
|
85
|
-
end
|
86
|
-
|
87
|
-
# Create site links feed items.
|
88
|
-
items_data = [
|
89
|
-
{
|
90
|
-
:text => 'Home',
|
91
|
-
:final_urls => ['http://www.example.com'],
|
92
|
-
:line_1 => 'Home line 1',
|
93
|
-
:line_2 => 'Home line 2'
|
94
|
-
},
|
95
|
-
{
|
96
|
-
:text => 'Stores',
|
97
|
-
:final_urls => ['http://www.example.com/stores'],
|
98
|
-
:line_1 => 'Stores line 1',
|
99
|
-
:line_2 => 'Stores line 2'
|
100
|
-
},
|
101
|
-
{
|
102
|
-
:text => 'On Sale',
|
103
|
-
:final_urls => ['http://www.example.com/sale'],
|
104
|
-
:line_1 => 'On Sale line 1',
|
105
|
-
:line_2 => 'On Sale line 2'
|
106
|
-
},
|
107
|
-
{
|
108
|
-
:text => 'Support',
|
109
|
-
:final_urls => ['http://www.example.com/support'],
|
110
|
-
:line_1 => 'Support line 1',
|
111
|
-
:line_2 => 'Support line 2'
|
112
|
-
},
|
113
|
-
{
|
114
|
-
:text => 'Products',
|
115
|
-
:final_urls => ['http://www.example.com/products'],
|
116
|
-
:line_1 => 'Products line 1',
|
117
|
-
:line_2 => 'Products line 2'
|
118
|
-
},
|
119
|
-
{
|
120
|
-
:text => 'About',
|
121
|
-
:final_urls => ['http://www.example.com/about'],
|
122
|
-
:line_1 => 'About line 1',
|
123
|
-
:line_2 => 'About line 2'
|
124
|
-
}
|
125
|
-
]
|
126
|
-
|
127
|
-
feed_items = items_data.map do |item|
|
128
|
-
{
|
129
|
-
:feed_id => sitelinks_data[:feed_id],
|
130
|
-
:attribute_values => [
|
131
|
-
{
|
132
|
-
:feed_attribute_id => sitelinks_data[:link_text_feed_id],
|
133
|
-
:string_value => item[:text]
|
134
|
-
},
|
135
|
-
{
|
136
|
-
:feed_attribute_id => sitelinks_data[:final_url_feed_id],
|
137
|
-
:string_values => item[:final_urls]
|
138
|
-
},
|
139
|
-
{
|
140
|
-
:feed_attribute_id => sitelinks_data[:line_1_feed_id],
|
141
|
-
:string_value => item[:line_1]
|
142
|
-
},
|
143
|
-
{
|
144
|
-
:feed_attribute_id => sitelinks_data[:line_2_feed_id],
|
145
|
-
:string_value => item[:line_2]
|
146
|
-
}
|
147
|
-
]
|
148
|
-
}
|
149
|
-
end
|
150
|
-
|
151
|
-
feed_items_operations = feed_items.map do |item|
|
152
|
-
{:operator => 'ADD', :operand => item}
|
153
|
-
end
|
154
|
-
|
155
|
-
response = feed_item_srv.mutate(feed_items_operations)
|
156
|
-
if response and response[:value]
|
157
|
-
sitelinks_data[:feed_item_ids] = []
|
158
|
-
response[:value].each do |feed_item|
|
159
|
-
puts 'Feed item with ID %d was added.' % feed_item[:feed_item_id]
|
160
|
-
sitelinks_data[:feed_item_ids] << feed_item[:feed_item_id]
|
161
|
-
end
|
162
|
-
else
|
163
|
-
raise new StandardError, 'No feed items were added.'
|
164
|
-
end
|
165
|
-
|
166
|
-
# Create site links feed mapping.
|
167
|
-
feed_mapping = {
|
168
|
-
:placeholder_type => PLACEHOLDER_SITELINKS,
|
169
|
-
:feed_id => sitelinks_data[:feed_id],
|
170
|
-
:attribute_field_mappings => [
|
171
|
-
{
|
172
|
-
:feed_attribute_id => sitelinks_data[:link_text_feed_id],
|
173
|
-
:field_id => PLACEHOLDER_FIELD_SITELINK_LINK_TEXT
|
174
|
-
},
|
175
|
-
{
|
176
|
-
:feed_attribute_id => sitelinks_data[:final_url_feed_id],
|
177
|
-
:field_id => PLACEHOLDER_FIELD_SITELINK_FINAL_URLS
|
178
|
-
},
|
179
|
-
{
|
180
|
-
:feed_attribute_id => sitelinks_data[:line_1_feed_id],
|
181
|
-
:field_id => PLACEHOLDER_FIELD_SITELINK_LINE_1_TEXT
|
182
|
-
},
|
183
|
-
{
|
184
|
-
:feed_attribute_id => sitelinks_data[:line_2_feed_id],
|
185
|
-
:field_id => PLACEHOLDER_FIELD_SITELINK_LINE_2_TEXT
|
186
|
-
}
|
187
|
-
]
|
188
|
-
}
|
189
|
-
|
190
|
-
response = feed_mapping_srv.mutate([
|
191
|
-
{:operator => 'ADD', :operand => feed_mapping}
|
192
|
-
])
|
193
|
-
if response and response[:value]
|
194
|
-
feed_mapping = response[:value].first
|
195
|
-
puts ('Feed mapping with ID %d and placeholder type %d was saved for feed' +
|
196
|
-
' with ID %d.') % [
|
197
|
-
feed_mapping[:feed_mapping_id],
|
198
|
-
feed_mapping[:placeholder_type],
|
199
|
-
feed_mapping[:feed_id]
|
200
|
-
]
|
201
|
-
else
|
202
|
-
raise new StandardError, 'No feed mappings were added.'
|
203
|
-
end
|
204
|
-
|
205
|
-
# Create site links campaign feed.
|
206
|
-
operands = sitelinks_data[:feed_item_ids].map do |feed_item_id|
|
207
|
-
{
|
208
|
-
:xsi_type => 'ConstantOperand',
|
209
|
-
:type => 'LONG',
|
210
|
-
:long_value => feed_item_id
|
211
|
-
}
|
212
|
-
end
|
213
|
-
|
214
|
-
feed_item_function = {
|
215
|
-
:operator => 'IN',
|
216
|
-
:lhs_operand => [
|
217
|
-
{:xsi_type => 'RequestContextOperand', :context_type => 'FEED_ITEM_ID'}
|
218
|
-
],
|
219
|
-
:rhs_operand => operands
|
220
|
-
}
|
221
|
-
|
222
|
-
# Optional: to target to a platform, define a function and 'AND' it with the
|
223
|
-
# feed item ID link:
|
224
|
-
platform_function = {
|
225
|
-
:operator => 'EQUALS',
|
226
|
-
:lhs_operand => [
|
227
|
-
{:xsi_type => 'RequestContextOperand', :context_type => 'DEVICE_PLATFORM'}
|
228
|
-
],
|
229
|
-
:rhs_operand => [
|
230
|
-
{
|
231
|
-
:xsi_type => 'ConstantOperand',
|
232
|
-
:type => 'STRING',
|
233
|
-
:string_value => 'Mobile'
|
234
|
-
}
|
235
|
-
]
|
236
|
-
}
|
237
|
-
combined_function = {
|
238
|
-
:operator => 'AND',
|
239
|
-
:lhs_operand => [
|
240
|
-
{:xsi_type => 'FunctionOperand', :value => feed_item_function},
|
241
|
-
{:xsi_type => 'FunctionOperand', :value => platform_function}
|
242
|
-
]
|
243
|
-
}
|
244
|
-
|
245
|
-
campaign_feed = {
|
246
|
-
:feed_id => sitelinks_data[:feed_id],
|
247
|
-
:campaign_id => campaign_id,
|
248
|
-
:matching_function => combined_function,
|
249
|
-
# Specifying placeholder types on the CampaignFeed allows the same feed
|
250
|
-
# to be used for different placeholders in different Campaigns.
|
251
|
-
:placeholder_types => [PLACEHOLDER_SITELINKS]
|
252
|
-
}
|
253
|
-
|
254
|
-
response = campaign_feed_srv.mutate([
|
255
|
-
{:operator => 'ADD', :operand => campaign_feed}
|
256
|
-
])
|
257
|
-
if response and response[:value]
|
258
|
-
campaign_feed = response[:value].first
|
259
|
-
puts 'Campaign with ID %d was associated with feed with ID %d.' %
|
260
|
-
[campaign_feed[:campaign_id], campaign_feed[:feed_id]]
|
261
|
-
else
|
262
|
-
raise new StandardError, 'No campaign feeds were added.'
|
263
|
-
end
|
264
|
-
end
|
265
|
-
|
266
|
-
if __FILE__ == $0
|
267
|
-
API_VERSION = :v201409
|
268
|
-
|
269
|
-
# See the Placeholder reference page for a list of all the placeholder types
|
270
|
-
# and fields, see:
|
271
|
-
# https://developers.google.com/adwords/api/docs/appendix/placeholders
|
272
|
-
PLACEHOLDER_SITELINKS = 1
|
273
|
-
PLACEHOLDER_FIELD_SITELINK_LINK_TEXT = 1
|
274
|
-
PLACEHOLDER_FIELD_SITELINK_FINAL_URLS = 5
|
275
|
-
PLACEHOLDER_FIELD_SITELINK_LINE_1_TEXT = 3
|
276
|
-
PLACEHOLDER_FIELD_SITELINK_LINE_2_TEXT = 4
|
277
|
-
|
278
|
-
begin
|
279
|
-
# Campaign ID to add site link to.
|
280
|
-
campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
|
281
|
-
add_site_links(campaign_id)
|
282
|
-
|
283
|
-
# Authorization error.
|
284
|
-
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
285
|
-
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
286
|
-
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
287
|
-
"to retrieve and store OAuth2 tokens."
|
288
|
-
puts "See this wiki page for more details:\n\n " +
|
289
|
-
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
290
|
-
|
291
|
-
# HTTP errors.
|
292
|
-
rescue AdsCommon::Errors::HttpError => e
|
293
|
-
puts "HTTP Error: %s" % e
|
294
|
-
|
295
|
-
# API errors.
|
296
|
-
rescue AdwordsApi::Errors::ApiException => e
|
297
|
-
puts "Message: %s" % e.message
|
298
|
-
puts 'Errors:'
|
299
|
-
e.errors.each_with_index do |error, index|
|
300
|
-
puts "\tError [%d]:" % (index + 1)
|
301
|
-
error.each do |field, value|
|
302
|
-
puts "\t\t%s: %s" % [field, value]
|
303
|
-
end
|
304
|
-
end
|
305
|
-
end
|
306
|
-
end
|