google-adwords-api 0.17.0 → 0.18.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -13
- data/ChangeLog +5 -0
- data/README.md +3 -3
- data/adwords_api.yml +3 -0
- data/examples/v201509/{campaign_management → advanced_operations}/add_complete_campaigns_using_batch_job.rb +10 -16
- data/examples/v201509/advanced_operations/add_keywords_using_incremental_batch_job.rb +179 -0
- data/examples/v201509/reporting/stream_criteria_report_results.rb +97 -0
- data/lib/adwords_api/api_config.rb +0 -86
- data/lib/adwords_api/batch_job_utils.rb +124 -51
- data/lib/adwords_api/incremental_upload_helper.rb +71 -0
- data/lib/adwords_api/report_header_handler.rb +1 -1
- data/lib/adwords_api/report_stream.rb +64 -0
- data/lib/adwords_api/report_utils.rb +88 -8
- data/lib/adwords_api/version.rb +1 -1
- data/test/adwords_api/test_batch_job_utils.rb +15 -0
- metadata +18 -168
- data/examples/v201502/account_management/create_account.rb +0 -88
- data/examples/v201502/account_management/get_account_changes.rb +0 -139
- data/examples/v201502/account_management/get_account_hierarchy.rb +0 -94
- data/examples/v201502/advanced_operations/add_ad_customizers.rb +0 -184
- data/examples/v201502/advanced_operations/add_ad_group_bid_modifier.rb +0 -101
- data/examples/v201502/advanced_operations/add_click_to_download_ad.rb +0 -133
- data/examples/v201502/advanced_operations/add_text_ad_with_upgraded_urls.rb +0 -134
- data/examples/v201502/advanced_operations/create_and_attach_shared_keyword_set.rb +0 -133
- data/examples/v201502/advanced_operations/find_and_remove_criteria_from_shared_set.rb +0 -166
- data/examples/v201502/advanced_operations/get_ad_group_bid_modifiers.rb +0 -102
- data/examples/v201502/advanced_operations/upload_offline_conversions.rb +0 -113
- data/examples/v201502/advanced_operations/use_shared_bidding_strategy.rb +0 -147
- data/examples/v201502/basic_operations/add_ad_groups.rb +0 -140
- data/examples/v201502/basic_operations/add_campaigns.rb +0 -139
- data/examples/v201502/basic_operations/add_keywords.rb +0 -114
- data/examples/v201502/basic_operations/add_text_ads.rb +0 -109
- data/examples/v201502/basic_operations/get_ad_groups.rb +0 -102
- data/examples/v201502/basic_operations/get_campaigns.rb +0 -97
- data/examples/v201502/basic_operations/get_campaigns_with_awql.rb +0 -89
- data/examples/v201502/basic_operations/get_keywords.rb +0 -108
- data/examples/v201502/basic_operations/get_text_ads.rb +0 -110
- data/examples/v201502/basic_operations/pause_ad.rb +0 -88
- data/examples/v201502/basic_operations/remove_ad.rb +0 -89
- data/examples/v201502/basic_operations/remove_ad_group.rb +0 -85
- data/examples/v201502/basic_operations/remove_campaign.rb +0 -87
- data/examples/v201502/basic_operations/remove_keyword.rb +0 -94
- data/examples/v201502/basic_operations/update_ad_group.rb +0 -85
- data/examples/v201502/basic_operations/update_campaign.rb +0 -86
- data/examples/v201502/basic_operations/update_keyword.rb +0 -106
- data/examples/v201502/campaign_management/add_campaign_labels.rb +0 -82
- data/examples/v201502/campaign_management/add_experiment.rb +0 -162
- data/examples/v201502/campaign_management/add_keywords_in_bulk.rb +0 -153
- data/examples/v201502/campaign_management/get_all_disapproved_ads.rb +0 -97
- data/examples/v201502/campaign_management/get_all_disapproved_ads_with_awql.rb +0 -89
- data/examples/v201502/campaign_management/get_campaigns_by_label.rb +0 -108
- data/examples/v201502/campaign_management/promote_experiment.rb +0 -81
- data/examples/v201502/campaign_management/set_ad_parameters.rb +0 -118
- data/examples/v201502/campaign_management/set_criterion_bid_modifier.rb +0 -104
- data/examples/v201502/campaign_management/validate_text_ad.rb +0 -110
- data/examples/v201502/error_handling/handle_partial_failures.rb +0 -130
- data/examples/v201502/error_handling/handle_policy_violation_error.rb +0 -141
- data/examples/v201502/extensions/add_google_my_business_location_extensions.rb +0 -179
- data/examples/v201502/extensions/add_site_links.rb +0 -164
- data/examples/v201502/extensions/add_site_links_using_feeds.rb +0 -271
- data/examples/v201502/migration/migrate_to_extension_settings.rb +0 -386
- data/examples/v201502/migration/upgrade_ad_url.rb +0 -93
- data/examples/v201502/misc/create_ad_words_session_without_properties_file.rb +0 -92
- data/examples/v201502/misc/get_all_images_and_videos.rb +0 -104
- data/examples/v201502/misc/setup_oauth2.rb +0 -84
- data/examples/v201502/misc/upload_image.rb +0 -93
- data/examples/v201502/misc/use_oauth2_jwt.rb +0 -93
- data/examples/v201502/optimization/estimate_keyword_traffic.rb +0 -146
- data/examples/v201502/optimization/get_keyword_bid_simulations.rb +0 -95
- data/examples/v201502/optimization/get_keyword_ideas.rb +0 -126
- data/examples/v201502/remarketing/add_audience.rb +0 -118
- data/examples/v201502/remarketing/add_conversion_tracker.rb +0 -100
- data/examples/v201502/remarketing/add_rule_based_user_lists.rb +0 -167
- data/examples/v201502/reporting/download_criteria_report.rb +0 -85
- data/examples/v201502/reporting/download_criteria_report_with_awql.rb +0 -84
- data/examples/v201502/reporting/get_report_fields.rb +0 -75
- data/examples/v201502/reporting/parallel_report_download.rb +0 -166
- data/examples/v201502/shopping_campaigns/add_product_partition_tree.rb +0 -267
- data/examples/v201502/shopping_campaigns/add_product_scope.rb +0 -129
- data/examples/v201502/shopping_campaigns/add_shopping_campaign.rb +0 -129
- data/examples/v201502/shopping_campaigns/get_product_category_taxonomy.rb +0 -115
- data/examples/v201502/targeting/add_campaign_targeting_criteria.rb +0 -169
- data/examples/v201502/targeting/add_demographic_targeting_criteria.rb +0 -112
- data/examples/v201502/targeting/get_campaign_targeting_criteria.rb +0 -106
- data/examples/v201502/targeting/get_targetable_languages_and_carriers.rb +0 -89
- data/examples/v201502/targeting/lookup_location.rb +0 -108
- data/lib/adwords_api/v201502/account_label_service.rb +0 -46
- data/lib/adwords_api/v201502/account_label_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/ad_customizer_feed_service.rb +0 -46
- data/lib/adwords_api/v201502/ad_customizer_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/ad_group_ad_service.rb +0 -70
- data/lib/adwords_api/v201502/ad_group_ad_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/ad_group_bid_modifier_service.rb +0 -54
- data/lib/adwords_api/v201502/ad_group_bid_modifier_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/ad_group_criterion_service.rb +0 -62
- data/lib/adwords_api/v201502/ad_group_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/ad_group_extension_setting_service.rb +0 -54
- data/lib/adwords_api/v201502/ad_group_extension_setting_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/ad_group_feed_service.rb +0 -54
- data/lib/adwords_api/v201502/ad_group_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/ad_group_service.rb +0 -62
- data/lib/adwords_api/v201502/ad_group_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/ad_param_service.rb +0 -46
- data/lib/adwords_api/v201502/ad_param_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/adwords_user_list_service.rb +0 -46
- data/lib/adwords_api/v201502/adwords_user_list_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/bidding_strategy_service.rb +0 -54
- data/lib/adwords_api/v201502/bidding_strategy_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/budget_order_service.rb +0 -54
- data/lib/adwords_api/v201502/budget_order_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/budget_service.rb +0 -54
- data/lib/adwords_api/v201502/budget_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/campaign_criterion_service.rb +0 -54
- data/lib/adwords_api/v201502/campaign_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/campaign_extension_setting_service.rb +0 -54
- data/lib/adwords_api/v201502/campaign_extension_setting_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/campaign_feed_service.rb +0 -54
- data/lib/adwords_api/v201502/campaign_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/campaign_service.rb +0 -62
- data/lib/adwords_api/v201502/campaign_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/campaign_shared_set_service.rb +0 -46
- data/lib/adwords_api/v201502/campaign_shared_set_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/constant_data_service.rb +0 -102
- data/lib/adwords_api/v201502/constant_data_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/conversion_tracker_service.rb +0 -54
- data/lib/adwords_api/v201502/conversion_tracker_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/customer_extension_setting_service.rb +0 -54
- data/lib/adwords_api/v201502/customer_extension_setting_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/customer_feed_service.rb +0 -54
- data/lib/adwords_api/v201502/customer_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/customer_service.rb +0 -46
- data/lib/adwords_api/v201502/customer_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/customer_sync_service.rb +0 -38
- data/lib/adwords_api/v201502/customer_sync_service_registry.rb +0 -47
- data/lib/adwords_api/v201502/data_service.rb +0 -78
- data/lib/adwords_api/v201502/data_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/experiment_service.rb +0 -46
- data/lib/adwords_api/v201502/experiment_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/feed_item_service.rb +0 -54
- data/lib/adwords_api/v201502/feed_item_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/feed_mapping_service.rb +0 -54
- data/lib/adwords_api/v201502/feed_mapping_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/feed_service.rb +0 -54
- data/lib/adwords_api/v201502/feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/geo_location_service.rb +0 -38
- data/lib/adwords_api/v201502/geo_location_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/label_service.rb +0 -54
- data/lib/adwords_api/v201502/label_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/location_criterion_service.rb +0 -46
- data/lib/adwords_api/v201502/location_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/managed_customer_service.rb +0 -78
- data/lib/adwords_api/v201502/managed_customer_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/media_service.rb +0 -54
- data/lib/adwords_api/v201502/media_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/mutate_job_service.rb +0 -54
- data/lib/adwords_api/v201502/mutate_job_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/offline_conversion_feed_service.rb +0 -38
- data/lib/adwords_api/v201502/offline_conversion_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/report_definition_service.rb +0 -38
- data/lib/adwords_api/v201502/report_definition_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/shared_criterion_service.rb +0 -46
- data/lib/adwords_api/v201502/shared_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/shared_set_service.rb +0 -46
- data/lib/adwords_api/v201502/shared_set_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/targeting_idea_service.rb +0 -38
- data/lib/adwords_api/v201502/targeting_idea_service_registry.rb +0 -46
- data/lib/adwords_api/v201502/traffic_estimator_service.rb +0 -38
- data/lib/adwords_api/v201502/traffic_estimator_service_registry.rb +0 -46
- data/test/templates/v201502/basic_operations_get_campaigns.def +0 -116
- data/test/templates/v201502/misc_use_oauth2_service_account.def +0 -131
@@ -1,164 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
# Encoding: utf-8
|
3
|
-
#
|
4
|
-
# Copyright:: Copyright 2015, Google Inc. All Rights Reserved.
|
5
|
-
#
|
6
|
-
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
7
|
-
# you may not use this file except in compliance with the License.
|
8
|
-
# You may obtain a copy of the License at
|
9
|
-
#
|
10
|
-
# http://www.apache.org/licenses/LICENSE-2.0
|
11
|
-
#
|
12
|
-
# Unless required by applicable law or agreed to in writing, software
|
13
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
14
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
15
|
-
# implied.
|
16
|
-
# See the License for the specific language governing permissions and
|
17
|
-
# limitations under the License.
|
18
|
-
#
|
19
|
-
# This example adds a sitelinks feed and associates it with a campaign.
|
20
|
-
|
21
|
-
require 'adwords_api'
|
22
|
-
require 'date'
|
23
|
-
|
24
|
-
def add_site_links(campaign_id)
|
25
|
-
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
26
|
-
# when called without parameters.
|
27
|
-
adwords = AdwordsApi::Api.new
|
28
|
-
|
29
|
-
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
30
|
-
# the configuration file or provide your own logger:
|
31
|
-
# adwords.logger = Logger.new('adwords_xml.log')
|
32
|
-
|
33
|
-
customer_srv = adwords.service(:CustomerService, API_VERSION)
|
34
|
-
customer = customer_srv.get()
|
35
|
-
customer_time_zone = customer[:date_time_zone]
|
36
|
-
|
37
|
-
campaign_extension_setting_srv =
|
38
|
-
adwords.service(:CampaignExtensionSettingService, API_VERSION)
|
39
|
-
|
40
|
-
sitelink_1 = {
|
41
|
-
:xsi_type => "SitelinkFeedItem",
|
42
|
-
:sitelink_text => "Store Hours",
|
43
|
-
:sitelink_url => "http://www.example.com/storehours"
|
44
|
-
}
|
45
|
-
|
46
|
-
sitelink_2 = {
|
47
|
-
:xsi_type => "SitelinkFeedItem",
|
48
|
-
:sitelink_text => "Thanksgiving Specials",
|
49
|
-
:sitelink_url => "http://www.example.com/thanksgiving",
|
50
|
-
:start_time => DateTime.new(Date.today.year, 11, 20, 0, 0, 0).
|
51
|
-
strftime("%Y%m%d %H%M%S ") + customer_time_zone,
|
52
|
-
:end_time => DateTime.new(Date.today.year, 11, 27, 23, 59, 59).
|
53
|
-
strftime("%Y%m%d %H%M%S ") + customer_time_zone
|
54
|
-
}
|
55
|
-
|
56
|
-
sitelink_3 = {
|
57
|
-
:xsi_type => "SitelinkFeedItem",
|
58
|
-
:sitelink_text => "Wifi available",
|
59
|
-
:sitelink_url => "http://www.example.com/mobile/wifi",
|
60
|
-
:device_preference => {:device_preference => 30001}
|
61
|
-
}
|
62
|
-
|
63
|
-
sitelink_4 = {
|
64
|
-
:xsi_type => "SitelinkFeedItem",
|
65
|
-
:sitelink_text => "Happy hours",
|
66
|
-
:sitelink_url => "http://www.example.com/happyhours",
|
67
|
-
:scheduling => {
|
68
|
-
:feed_item_schedules => [
|
69
|
-
{
|
70
|
-
:day_of_week => 'MONDAY',
|
71
|
-
:start_hour => 18,
|
72
|
-
:start_minute => 'ZERO',
|
73
|
-
:end_hour => 21,
|
74
|
-
:end_minute => 'ZERO'
|
75
|
-
},
|
76
|
-
{
|
77
|
-
:day_of_week => 'TUESDAY',
|
78
|
-
:start_hour => 18,
|
79
|
-
:start_minute => 'ZERO',
|
80
|
-
:end_hour => 21,
|
81
|
-
:end_minute => 'ZERO'
|
82
|
-
},
|
83
|
-
{
|
84
|
-
:day_of_week => 'WEDNESDAY',
|
85
|
-
:start_hour => 18,
|
86
|
-
:start_minute => 'ZERO',
|
87
|
-
:end_hour => 21,
|
88
|
-
:end_minute => 'ZERO'
|
89
|
-
},
|
90
|
-
{
|
91
|
-
:day_of_week => 'THURSDAY',
|
92
|
-
:start_hour => 18,
|
93
|
-
:start_minute => 'ZERO',
|
94
|
-
:end_hour => 21,
|
95
|
-
:end_minute => 'ZERO'
|
96
|
-
},
|
97
|
-
{
|
98
|
-
:day_of_week => 'FRIDAY',
|
99
|
-
:start_hour => 18,
|
100
|
-
:start_minute => 'ZERO',
|
101
|
-
:end_hour => 21,
|
102
|
-
:end_minute => 'ZERO'
|
103
|
-
}
|
104
|
-
]
|
105
|
-
}
|
106
|
-
}
|
107
|
-
|
108
|
-
campaign_extension_setting = {
|
109
|
-
:campaign_id => campaign_id,
|
110
|
-
:extension_type => 'SITELINK',
|
111
|
-
:extension_setting => {
|
112
|
-
:extensions => [sitelink_1, sitelink_2, sitelink_3, sitelink_4]
|
113
|
-
}
|
114
|
-
}
|
115
|
-
|
116
|
-
operation = {
|
117
|
-
:operand => campaign_extension_setting,
|
118
|
-
:operator => 'ADD'
|
119
|
-
}
|
120
|
-
|
121
|
-
response = campaign_extension_setting_srv.mutate([operation])
|
122
|
-
if response and response[:value]
|
123
|
-
new_extension_setting = response[:value].first
|
124
|
-
puts "Extension setting wiht type = %s was added to campaign ID %d" % [
|
125
|
-
new_extension_setting[:extension_type],
|
126
|
-
new_extension_setting[:campaign_id]
|
127
|
-
]
|
128
|
-
elsif
|
129
|
-
puts "No extension settings were created."
|
130
|
-
end
|
131
|
-
end
|
132
|
-
|
133
|
-
if __FILE__ == $0
|
134
|
-
API_VERSION = :v201502
|
135
|
-
|
136
|
-
begin
|
137
|
-
# Campaign ID to add site link to.
|
138
|
-
campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
|
139
|
-
add_site_links(campaign_id)
|
140
|
-
|
141
|
-
# Authorization error.
|
142
|
-
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
143
|
-
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
144
|
-
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
145
|
-
"to retrieve and store OAuth2 tokens."
|
146
|
-
puts "See this wiki page for more details:\n\n " +
|
147
|
-
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
148
|
-
|
149
|
-
# HTTP errors.
|
150
|
-
rescue AdsCommon::Errors::HttpError => e
|
151
|
-
puts "HTTP Error: %s" % e
|
152
|
-
|
153
|
-
# API errors.
|
154
|
-
rescue AdwordsApi::Errors::ApiException => e
|
155
|
-
puts "Message: %s" % e.message
|
156
|
-
puts 'Errors:'
|
157
|
-
e.errors.each_with_index do |error, index|
|
158
|
-
puts "\tError [%d]:" % (index + 1)
|
159
|
-
error.each do |field, value|
|
160
|
-
puts "\t\t%s: %s" % [field, value]
|
161
|
-
end
|
162
|
-
end
|
163
|
-
end
|
164
|
-
end
|
@@ -1,271 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
# Encoding: utf-8
|
3
|
-
#
|
4
|
-
# Copyright:: Copyright 2013, Google Inc. All Rights Reserved.
|
5
|
-
#
|
6
|
-
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
7
|
-
# you may not use this file except in compliance with the License.
|
8
|
-
# You may obtain a copy of the License at
|
9
|
-
#
|
10
|
-
# http://www.apache.org/licenses/LICENSE-2.0
|
11
|
-
#
|
12
|
-
# Unless required by applicable law or agreed to in writing, software
|
13
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
14
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
15
|
-
# implied.
|
16
|
-
# See the License for the specific language governing permissions and
|
17
|
-
# limitations under the License.
|
18
|
-
#
|
19
|
-
# This example adds a sitelinks feed and associates it with a campaign.
|
20
|
-
|
21
|
-
require 'adwords_api'
|
22
|
-
|
23
|
-
def add_site_links(campaign_id)
|
24
|
-
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
25
|
-
# when called without parameters.
|
26
|
-
adwords = AdwordsApi::Api.new
|
27
|
-
|
28
|
-
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
29
|
-
# the configuration file or provide your own logger:
|
30
|
-
# adwords.logger = Logger.new('adwords_xml.log')
|
31
|
-
|
32
|
-
feed_srv = adwords.service(:FeedService, API_VERSION)
|
33
|
-
feed_item_srv = adwords.service(:FeedItemService, API_VERSION)
|
34
|
-
feed_mapping_srv = adwords.service(:FeedMappingService, API_VERSION)
|
35
|
-
campaign_feed_srv = adwords.service(:CampaignFeedService, API_VERSION)
|
36
|
-
|
37
|
-
sitelinks_data = {}
|
38
|
-
|
39
|
-
# Create site links feed first.
|
40
|
-
site_links_feed = {
|
41
|
-
:name => 'Feed For Site Links',
|
42
|
-
:attributes => [
|
43
|
-
{:type => 'STRING', :name => 'Link Text'},
|
44
|
-
{:type => 'URL_LIST', :name => 'Final URLs'},
|
45
|
-
{:type => 'STRING', :name => 'Line 1 Description'},
|
46
|
-
{:type => 'STRING', :name => 'Line 2 Description'}
|
47
|
-
]
|
48
|
-
}
|
49
|
-
|
50
|
-
response = feed_srv.mutate([
|
51
|
-
{:operator => 'ADD', :operand => site_links_feed}
|
52
|
-
])
|
53
|
-
if response and response[:value]
|
54
|
-
feed = response[:value].first
|
55
|
-
# Attribute of type STRING.
|
56
|
-
link_text_feed_attribute_id = feed[:attributes][0][:id]
|
57
|
-
# Attribute of type URL_LIST.
|
58
|
-
final_url_feed_attribute_id = feed[:attributes][1][:id]
|
59
|
-
# Attribute of type STRING.
|
60
|
-
line_1_feed_attribute_id = feed[:attributes][2][:id]
|
61
|
-
#Attribute of type STRING.
|
62
|
-
line_2_feed_attribute_id = feed[:attributes][3][:id]
|
63
|
-
puts "Feed with name '%s' and ID %d was added with" %
|
64
|
-
[feed[:name], feed[:id]]
|
65
|
-
puts "\tText attribute ID %d and Final URLs attribute ID %d " +
|
66
|
-
"and Line 1 attribute ID %d and Line 2 attribute ID %d." % [
|
67
|
-
link_text_feed_attribute_id,
|
68
|
-
final_url_feed_attribute_id,
|
69
|
-
line_1_feed_attribute_id,
|
70
|
-
line_2_feed_attribute_id
|
71
|
-
]
|
72
|
-
|
73
|
-
sitelinks_data[:feed_id] = feed[:id]
|
74
|
-
sitelinks_data[:link_text_feed_id] = link_text_feed_attribute_id
|
75
|
-
sitelinks_data[:final_url_feed_id] = final_url_feed_attribute_id
|
76
|
-
sitelinks_data[:line_1_feed_id] = line_1_feed_attribute_id
|
77
|
-
sitelinks_data[:line_2_feed_id] = line_2_feed_attribute_id
|
78
|
-
else
|
79
|
-
raise new StandardError, 'No feeds were added.'
|
80
|
-
end
|
81
|
-
|
82
|
-
# Create site links feed items.
|
83
|
-
items_data = [
|
84
|
-
{
|
85
|
-
:text => 'Home',
|
86
|
-
:final_urls => ['http://www.example.com'],
|
87
|
-
:line_1 => 'Home line 1',
|
88
|
-
:line_2 => 'Home line 2'
|
89
|
-
},
|
90
|
-
{
|
91
|
-
:text => 'Stores',
|
92
|
-
:final_urls => ['http://www.example.com/stores'],
|
93
|
-
:line_1 => 'Stores line 1',
|
94
|
-
:line_2 => 'Stores line 2'
|
95
|
-
},
|
96
|
-
{
|
97
|
-
:text => 'On Sale',
|
98
|
-
:final_urls => ['http://www.example.com/sale'],
|
99
|
-
:line_1 => 'On Sale line 1',
|
100
|
-
:line_2 => 'On Sale line 2'
|
101
|
-
},
|
102
|
-
{
|
103
|
-
:text => 'Support',
|
104
|
-
:final_urls => ['http://www.example.com/support'],
|
105
|
-
:line_1 => 'Support line 1',
|
106
|
-
:line_2 => 'Support line 2'
|
107
|
-
},
|
108
|
-
{
|
109
|
-
:text => 'Products',
|
110
|
-
:final_urls => ['http://www.example.com/products'],
|
111
|
-
:line_1 => 'Products line 1',
|
112
|
-
:line_2 => 'Products line 2'
|
113
|
-
},
|
114
|
-
{
|
115
|
-
:text => 'About',
|
116
|
-
:final_urls => ['http://www.example.com/about'],
|
117
|
-
:line_1 => 'About line 1',
|
118
|
-
:line_2 => 'About line 2'
|
119
|
-
}
|
120
|
-
]
|
121
|
-
|
122
|
-
feed_items = items_data.map do |item|
|
123
|
-
{
|
124
|
-
:feed_id => sitelinks_data[:feed_id],
|
125
|
-
:attribute_values => [
|
126
|
-
{
|
127
|
-
:feed_attribute_id => sitelinks_data[:link_text_feed_id],
|
128
|
-
:string_value => item[:text]
|
129
|
-
},
|
130
|
-
{
|
131
|
-
:feed_attribute_id => sitelinks_data[:final_url_feed_id],
|
132
|
-
:string_values => item[:final_urls]
|
133
|
-
},
|
134
|
-
{
|
135
|
-
:feed_attribute_id => sitelinks_data[:line_1_feed_id],
|
136
|
-
:string_value => item[:line_1]
|
137
|
-
},
|
138
|
-
{
|
139
|
-
:feed_attribute_id => sitelinks_data[:line_2_feed_id],
|
140
|
-
:string_value => item[:line_2]
|
141
|
-
}
|
142
|
-
]
|
143
|
-
}
|
144
|
-
end
|
145
|
-
|
146
|
-
feed_items_operations = feed_items.map do |item|
|
147
|
-
{:operator => 'ADD', :operand => item}
|
148
|
-
end
|
149
|
-
|
150
|
-
response = feed_item_srv.mutate(feed_items_operations)
|
151
|
-
if response and response[:value]
|
152
|
-
sitelinks_data[:feed_item_ids] = []
|
153
|
-
response[:value].each do |feed_item|
|
154
|
-
puts 'Feed item with ID %d was added.' % feed_item[:feed_item_id]
|
155
|
-
sitelinks_data[:feed_item_ids] << feed_item[:feed_item_id]
|
156
|
-
end
|
157
|
-
else
|
158
|
-
raise new StandardError, 'No feed items were added.'
|
159
|
-
end
|
160
|
-
|
161
|
-
# Create site links feed mapping.
|
162
|
-
feed_mapping = {
|
163
|
-
:placeholder_type => PLACEHOLDER_SITELINKS,
|
164
|
-
:feed_id => sitelinks_data[:feed_id],
|
165
|
-
:attribute_field_mappings => [
|
166
|
-
{
|
167
|
-
:feed_attribute_id => sitelinks_data[:link_text_feed_id],
|
168
|
-
:field_id => PLACEHOLDER_FIELD_SITELINK_LINK_TEXT
|
169
|
-
},
|
170
|
-
{
|
171
|
-
:feed_attribute_id => sitelinks_data[:final_url_feed_id],
|
172
|
-
:field_id => PLACEHOLDER_FIELD_SITELINK_FINAL_URLS
|
173
|
-
},
|
174
|
-
{
|
175
|
-
:feed_attribute_id => sitelinks_data[:line_1_feed_id],
|
176
|
-
:field_id => PLACEHOLDER_FIELD_SITELINK_LINE_1_TEXT
|
177
|
-
},
|
178
|
-
{
|
179
|
-
:feed_attribute_id => sitelinks_data[:line_2_feed_id],
|
180
|
-
:field_id => PLACEHOLDER_FIELD_SITELINK_LINE_2_TEXT
|
181
|
-
}
|
182
|
-
]
|
183
|
-
}
|
184
|
-
|
185
|
-
response = feed_mapping_srv.mutate([
|
186
|
-
{:operator => 'ADD', :operand => feed_mapping}
|
187
|
-
])
|
188
|
-
if response and response[:value]
|
189
|
-
feed_mapping = response[:value].first
|
190
|
-
puts ('Feed mapping with ID %d and placeholder type %d was saved for feed' +
|
191
|
-
' with ID %d.') % [
|
192
|
-
feed_mapping[:feed_mapping_id],
|
193
|
-
feed_mapping[:placeholder_type],
|
194
|
-
feed_mapping[:feed_id]
|
195
|
-
]
|
196
|
-
else
|
197
|
-
raise new StandardError, 'No feed mappings were added.'
|
198
|
-
end
|
199
|
-
|
200
|
-
# Construct a matching function that associates the sitelink feeditems to the
|
201
|
-
# campaign, and set the device preference to Mobile. See the matching function
|
202
|
-
# guide at:
|
203
|
-
# https://developers.google.com/adwords/api/docs/guides/feed-matching-functions
|
204
|
-
# for more details.
|
205
|
-
matching_function_string =
|
206
|
-
"AND(IN(FEED_ITEM_ID, {%s}), EQUALS(CONTEXT.DEVICE, 'Mobile'))" %
|
207
|
-
sitelinks_data[:feed_item_ids].join(',')
|
208
|
-
|
209
|
-
# Create site links campaign feed.
|
210
|
-
campaign_feed = {
|
211
|
-
:feed_id => sitelinks_data[:feed_id],
|
212
|
-
:campaign_id => campaign_id,
|
213
|
-
:matching_function => {:function_string => matching_function_string},
|
214
|
-
# Specifying placeholder types on the CampaignFeed allows the same feed
|
215
|
-
# to be used for different placeholders in different Campaigns.
|
216
|
-
:placeholder_types => [PLACEHOLDER_SITELINKS]
|
217
|
-
}
|
218
|
-
|
219
|
-
response = campaign_feed_srv.mutate([
|
220
|
-
{:operator => 'ADD', :operand => campaign_feed}
|
221
|
-
])
|
222
|
-
if response and response[:value]
|
223
|
-
campaign_feed = response[:value].first
|
224
|
-
puts 'Campaign with ID %d was associated with feed with ID %d.' %
|
225
|
-
[campaign_feed[:campaign_id], campaign_feed[:feed_id]]
|
226
|
-
else
|
227
|
-
raise new StandardError, 'No campaign feeds were added.'
|
228
|
-
end
|
229
|
-
end
|
230
|
-
|
231
|
-
if __FILE__ == $0
|
232
|
-
API_VERSION = :v201502
|
233
|
-
|
234
|
-
# See the Placeholder reference page for a list of all the placeholder types
|
235
|
-
# and fields, see:
|
236
|
-
# https://developers.google.com/adwords/api/docs/appendix/placeholders
|
237
|
-
PLACEHOLDER_SITELINKS = 1
|
238
|
-
PLACEHOLDER_FIELD_SITELINK_LINK_TEXT = 1
|
239
|
-
PLACEHOLDER_FIELD_SITELINK_FINAL_URLS = 5
|
240
|
-
PLACEHOLDER_FIELD_SITELINK_LINE_1_TEXT = 3
|
241
|
-
PLACEHOLDER_FIELD_SITELINK_LINE_2_TEXT = 4
|
242
|
-
|
243
|
-
begin
|
244
|
-
# Campaign ID to add site link to.
|
245
|
-
campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
|
246
|
-
add_site_links(campaign_id)
|
247
|
-
|
248
|
-
# Authorization error.
|
249
|
-
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
250
|
-
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
251
|
-
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
252
|
-
"to retrieve and store OAuth2 tokens."
|
253
|
-
puts "See this wiki page for more details:\n\n " +
|
254
|
-
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
255
|
-
|
256
|
-
# HTTP errors.
|
257
|
-
rescue AdsCommon::Errors::HttpError => e
|
258
|
-
puts "HTTP Error: %s" % e
|
259
|
-
|
260
|
-
# API errors.
|
261
|
-
rescue AdwordsApi::Errors::ApiException => e
|
262
|
-
puts "Message: %s" % e.message
|
263
|
-
puts 'Errors:'
|
264
|
-
e.errors.each_with_index do |error, index|
|
265
|
-
puts "\tError [%d]:" % (index + 1)
|
266
|
-
error.each do |field, value|
|
267
|
-
puts "\t\t%s: %s" % [field, value]
|
268
|
-
end
|
269
|
-
end
|
270
|
-
end
|
271
|
-
end
|
@@ -1,386 +0,0 @@
|
|
1
|
-
#!/usr/bin/env ruby
|
2
|
-
# Encoding: utf-8
|
3
|
-
#
|
4
|
-
# Copyright:: Copyright 2015, Google Inc. All Rights Reserved.
|
5
|
-
#
|
6
|
-
# License:: Licensed under the Apache License, Version 2.0 (the "License");
|
7
|
-
# you may not use this file except in compliance with the License.
|
8
|
-
# You may obtain a copy of the License at
|
9
|
-
#
|
10
|
-
# http://www.apache.org/licenses/LICENSE-2.0
|
11
|
-
#
|
12
|
-
# Unless required by applicable law or agreed to in writing, software
|
13
|
-
# distributed under the License is distributed on an "AS IS" BASIS,
|
14
|
-
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
15
|
-
# implied.
|
16
|
-
# See the License for the specific language governing permissions and
|
17
|
-
# limitations under the License.
|
18
|
-
#
|
19
|
-
# This example migrates your feed based sitelinks at campaign level to use
|
20
|
-
# extension settings. To learn more about extensionsettings, see
|
21
|
-
# https://developers.google.com/adwords/api/docs/guides/extension-settings.
|
22
|
-
# To learn more about migrating Feed based extensions to extension settings,
|
23
|
-
# see
|
24
|
-
# https://developers.google.com/adwords/api/docs/guides/migrate-to-extension-settings.
|
25
|
-
|
26
|
-
require 'adwords_api'
|
27
|
-
require 'set'
|
28
|
-
|
29
|
-
def migrate_to_extension_settings()
|
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
|
-
# Get all of the feeds for the current user.
|
39
|
-
feeds = get_feeds(adwords)
|
40
|
-
|
41
|
-
feeds.each do |feed|
|
42
|
-
# Retrieve all the sitelinks from the current feed.
|
43
|
-
feed_items = get_site_links_from_feed(adwords, feed)
|
44
|
-
|
45
|
-
# Get all the instances where a sitelink from this feed has been added
|
46
|
-
# to a campaign.
|
47
|
-
campaign_feeds = get_campaign_feeds(adwords, feed, PLACEHOLDER_SITELINKS)
|
48
|
-
|
49
|
-
all_feed_items_to_delete = campaign_feeds.map do |campaign_feed|
|
50
|
-
# Retrieve the sitelinks that have been associated with this campaign.
|
51
|
-
feed_item_ids = get_feed_item_ids_for_campaign(campaign_feed)
|
52
|
-
|
53
|
-
if feed_item_ids.empty?
|
54
|
-
puts(("Migration skipped for campaign feed with campaign ID %d " +
|
55
|
-
"and feed ID %d because no mapped feed item IDs were found in " +
|
56
|
-
"the campaign feed's matching function.") %
|
57
|
-
[campaign_feed[:campaign_id], campaign_feed[:feed_id]])
|
58
|
-
next
|
59
|
-
end
|
60
|
-
|
61
|
-
platform_restrictions = get_platform_restrictions(campaign_feed)
|
62
|
-
|
63
|
-
# Delete the campaign feed that associates the sitelinks from the
|
64
|
-
# feed to the campaign.
|
65
|
-
delete_campaign_feed(adwords, campaign_feed)
|
66
|
-
|
67
|
-
# Create extension settings instead of sitelinks.
|
68
|
-
create_extension_setting(adwords, feed_items, campaign_feed,
|
69
|
-
feed_item_ids, platform_restrictions)
|
70
|
-
|
71
|
-
# Mark the sitelinks from the feed for deletion.
|
72
|
-
feed_item_ids
|
73
|
-
end.flatten.to_set.reject {|id| id.nil?}
|
74
|
-
|
75
|
-
# Delete all the sitelinks from the feed.
|
76
|
-
delete_old_feed_items(adwords, all_feed_items_to_delete, feed)
|
77
|
-
end
|
78
|
-
end
|
79
|
-
|
80
|
-
def get_site_links_from_feed(adwords, feed)
|
81
|
-
# Retrieve the feed's attribute mapping.
|
82
|
-
feed_mappings = get_feed_mapping(adwords, feed, PLACEHOLDER_SITELINKS)
|
83
|
-
|
84
|
-
feed_items = {}
|
85
|
-
|
86
|
-
get_feed_items(adwords, feed).each do |feed_item|
|
87
|
-
site_link_from_feed = {}
|
88
|
-
|
89
|
-
feed_item[:attribute_values].each do |attribute_value|
|
90
|
-
# Skip this attribute if it hasn't been mapped to a field.
|
91
|
-
next unless feed_mappings.has_key?(
|
92
|
-
attribute_value[:feed_attribute_id])
|
93
|
-
|
94
|
-
feed_mappings[attribute_value[:feed_attribute_id]].each do |field_id|
|
95
|
-
case field_id
|
96
|
-
when PLACEHOLDER_FIELD_SITELINK_LINK_TEXT
|
97
|
-
site_link_from_feed[:text] = attribute_value[:string_value]
|
98
|
-
when PLACEHOLDER_FIELD_SITELINK_URL
|
99
|
-
site_link_from_feed[:url] = attribute_value[:string_value]
|
100
|
-
when PLACEHOLDER_FIELD_FINAL_URLS
|
101
|
-
site_link_from_feed[:final_urls] = attribute_value[:string_values]
|
102
|
-
when PLACEHOLDER_FIELD_FINAL_MOBILE_URLS
|
103
|
-
site_link_from_feed[:final_mobile_urls] =
|
104
|
-
attribute_value[:string_values]
|
105
|
-
when PLACEHOLDER_FIELD_TRACKING_URL_TEMPLATE
|
106
|
-
site_link_from_feed[:tracking_url_template] =
|
107
|
-
attribute_value[:string_value]
|
108
|
-
when PLACEHOLDER_FIELD_LINE_2_TEXT
|
109
|
-
site_link_from_feed[:line2] = attribute_value[:string_value]
|
110
|
-
when PLACEHOLDER_FIELD_LINE_3_TEXT
|
111
|
-
site_link_from_feed[:line3] = attribute_value[:string_value]
|
112
|
-
end
|
113
|
-
end
|
114
|
-
end
|
115
|
-
site_link_from_feed[:scheduling] = feed_item[:scheduling]
|
116
|
-
|
117
|
-
feed_items[feed_item[:feed_item_id]] = site_link_from_feed
|
118
|
-
end
|
119
|
-
return feed_items
|
120
|
-
end
|
121
|
-
|
122
|
-
def get_feed_mapping(adwords, feed, placeholder_type)
|
123
|
-
feed_mapping_srv = adwords.service(:FeedMappingService, API_VERSION)
|
124
|
-
query = ("SELECT FeedMappingId, AttributeFieldMappings " +
|
125
|
-
"WHERE FeedId = %d AND PlaceholderType = %d AND Status = 'ENABLED'") %
|
126
|
-
[feed[:id], placeholder_type]
|
127
|
-
|
128
|
-
attribute_mappings = {}
|
129
|
-
offset = 0
|
130
|
-
|
131
|
-
begin
|
132
|
-
page_query = (query + " LIMIT %d, %d") % [offset, PAGE_SIZE]
|
133
|
-
page = feed_mapping_srv.query(page_query)
|
134
|
-
|
135
|
-
unless page[:entries].nil?
|
136
|
-
# Normally, a feed attribute is mapped only to one field. However, you
|
137
|
-
# may map it to more than one field if needed.
|
138
|
-
page[:entries].each do |feed_mapping|
|
139
|
-
feed_mapping[:attribute_field_mappings].each do |attribute_mapping|
|
140
|
-
# Since attribute_mappings can have multiple values for each key,
|
141
|
-
# we set up an array to store the values.
|
142
|
-
if attribute_mappings.has_key?(attribute_mapping[:feed_attribute_id])
|
143
|
-
attribute_mappings[attribute_mapping[:feed_attribute_id]] <<
|
144
|
-
attribute_mapping[:field_id]
|
145
|
-
else
|
146
|
-
attribute_mappings[attribute_mapping[:feed_attribute_id]] =
|
147
|
-
[attribute_mapping[:field_id]]
|
148
|
-
end
|
149
|
-
end
|
150
|
-
end
|
151
|
-
end
|
152
|
-
offset += PAGE_SIZE
|
153
|
-
end while page[:total_num_entries] > offset
|
154
|
-
|
155
|
-
return attribute_mappings
|
156
|
-
end
|
157
|
-
|
158
|
-
def get_feeds(adwords)
|
159
|
-
feed_srv = adwords.service(:FeedService, API_VERSION)
|
160
|
-
query = "SELECT Id, Name, Attributes " +
|
161
|
-
"WHERE Origin = 'USER' AND FeedStatus = 'ENABLED'"
|
162
|
-
|
163
|
-
feeds = []
|
164
|
-
offset = 0
|
165
|
-
|
166
|
-
begin
|
167
|
-
page_query = (query + " LIMIT %d, %d") % [offset, PAGE_SIZE]
|
168
|
-
page = feed_srv.query(page_query)
|
169
|
-
|
170
|
-
unless page[:entries].nil?
|
171
|
-
feeds += page[:entries]
|
172
|
-
end
|
173
|
-
offset += PAGE_SIZE
|
174
|
-
end while page[:total_num_entries] > offset
|
175
|
-
|
176
|
-
return feeds
|
177
|
-
end
|
178
|
-
|
179
|
-
def get_feed_items(adwords, feed)
|
180
|
-
feed_item_srv = adwords.service(:FeedItemService, API_VERSION)
|
181
|
-
query = ("SELECT FeedItemId, AttributeValues, Scheduling " +
|
182
|
-
"WHERE Status = 'ENABLED' AND FeedId = %d") % feed[:id]
|
183
|
-
|
184
|
-
feed_items = []
|
185
|
-
offset = 0
|
186
|
-
|
187
|
-
begin
|
188
|
-
page_query = (query + " LIMIT %d, %d") % [offset, PAGE_SIZE]
|
189
|
-
page = feed_item_srv.query(page_query)
|
190
|
-
|
191
|
-
unless page[:entries].nil?
|
192
|
-
feed_items += page[:entries]
|
193
|
-
end
|
194
|
-
offset += PAGE_SIZE
|
195
|
-
end while page[:total_num_entries] > offset
|
196
|
-
|
197
|
-
return feed_items
|
198
|
-
end
|
199
|
-
|
200
|
-
def get_platform_restrictions(campaign_feed)
|
201
|
-
platform_restrictions = nil
|
202
|
-
|
203
|
-
if campaign_feed[:matching_function][:operator] == 'AND'
|
204
|
-
campaign_feed[:matching_function][:lhs_operand].each do |argument|
|
205
|
-
# Check if matchingFunction is EQUALS(CONTEXT.DEVICE, 'Mobile')
|
206
|
-
if argument[:value][:operator] == 'EQUALS'
|
207
|
-
request_context_operand = argument[:value][:lhs_operand].first()
|
208
|
-
if request_context_operand &&
|
209
|
-
request_context_operand == 'DEVICE_PLATFORM'
|
210
|
-
platform_restrictions =
|
211
|
-
argument[:value][:rhs_operand].first().upcase()
|
212
|
-
break
|
213
|
-
end
|
214
|
-
end
|
215
|
-
end
|
216
|
-
end
|
217
|
-
return platform_restrictions
|
218
|
-
end
|
219
|
-
|
220
|
-
def delete_old_feed_items(adwords, feed_item_ids, feed)
|
221
|
-
return if feed_item_ids.empty?
|
222
|
-
|
223
|
-
feed_item_srv = adwords.service(:FeedItemService, API_VERSION)
|
224
|
-
|
225
|
-
operations = feed_item_ids.map do |feed_item_id|
|
226
|
-
{
|
227
|
-
:operator => 'REMOVE',
|
228
|
-
:operand => {
|
229
|
-
:feed_id => feed[:id],
|
230
|
-
:feed_item_id => feed_item_id
|
231
|
-
}
|
232
|
-
}
|
233
|
-
end
|
234
|
-
|
235
|
-
feed_item_srv.mutate(operations)
|
236
|
-
end
|
237
|
-
|
238
|
-
def create_extension_setting(
|
239
|
-
adwords, feed_items, campaign_feed, feed_item_ids, platform_restrictions)
|
240
|
-
campaign_extension_setting_srv = adwords.service(
|
241
|
-
:CampaignExtensionSettingService, API_VERSION)
|
242
|
-
|
243
|
-
extension_feed_items = feed_item_ids.map do |feed_item_id|
|
244
|
-
site_link_from_feed = feed_items[:feed_item_id]
|
245
|
-
site_link_feed_item = {
|
246
|
-
:sitelink_text => site_link_from_feed[:text],
|
247
|
-
:sitelink_line2 => site_link_from_feed[:line2],
|
248
|
-
:sitelink_line3 => site_link_from_feed[:line3],
|
249
|
-
:scheduling => site_link_from_feed[:scheduling]
|
250
|
-
}
|
251
|
-
if !site_link_from_feed.final_urls.nil? &&
|
252
|
-
site_link_from_feed[:final_urls].length > 0
|
253
|
-
site_link_feed_item[:sitelink_final_urls] = {
|
254
|
-
:urls => site_link_from_feed[:final_urls]
|
255
|
-
}
|
256
|
-
unless site_link_from_feed[:final_mobile_urls].nil?
|
257
|
-
site_link_feed_item[:sitelink_final_mobile_urls] = {
|
258
|
-
:urls => site_link_from_feed[:final_mobile_urls]
|
259
|
-
}
|
260
|
-
end
|
261
|
-
site_link_feed_item[:sitelink_tracking_url_template] =
|
262
|
-
site_link_from_feed[:tracking_url_template]
|
263
|
-
else
|
264
|
-
site_link_feed_item[:sitelink_url] = site_link_from_feed[:url]
|
265
|
-
end
|
266
|
-
|
267
|
-
site_link_feed_item
|
268
|
-
end
|
269
|
-
|
270
|
-
extension_setting = {
|
271
|
-
:extensions => extension_feed_items
|
272
|
-
}
|
273
|
-
|
274
|
-
unless platform_restrictions.nil?
|
275
|
-
extension_setting[:platform_restrictions] = platform_restrictions
|
276
|
-
end
|
277
|
-
|
278
|
-
campaign_extension_setting = {
|
279
|
-
:campaign_id => campaign_feed[:campaign_id],
|
280
|
-
:extension_type => 'SITELINK',
|
281
|
-
:extension_setting => extension_setting
|
282
|
-
}
|
283
|
-
|
284
|
-
operation = {
|
285
|
-
:operand => campaign_extension_setting,
|
286
|
-
:operator => 'ADD'
|
287
|
-
}
|
288
|
-
|
289
|
-
campaign_extension_setting_srv.mutate([operation])
|
290
|
-
end
|
291
|
-
|
292
|
-
def delete_campaign_feed(adwords, campaign_feed)
|
293
|
-
campaign_feed_srv = adwords.service(:CampaignFeedService, API_VERSION)
|
294
|
-
|
295
|
-
operation = {
|
296
|
-
:operand => campaign_feed,
|
297
|
-
:operator => 'REMOVE'
|
298
|
-
}
|
299
|
-
|
300
|
-
campaign_feed_srv.mutate([operation])
|
301
|
-
end
|
302
|
-
|
303
|
-
def get_feed_item_ids_for_campaign(campaign_feed)
|
304
|
-
feed_item_ids = Set.new
|
305
|
-
if !campaign_feed[:matching_function][:lhs_operand].empty? &&
|
306
|
-
campaign_feed[:matching_function][:lhs_operand].first[:xsi_type] ==
|
307
|
-
'RequestContextOperand'
|
308
|
-
request_context_operand =
|
309
|
-
campaign_feed[:matching_function][:lhs_operand].first
|
310
|
-
if request_context_operand[:context_type] == 'FEED_ITEM_ID' &&
|
311
|
-
campaign_feed[:matching_function][:operator] == 'IN'
|
312
|
-
campaign_feed[:matching_function][:rhs_operand].each do |argument|
|
313
|
-
if argument[:xsi_type] == 'ConstantOperand'
|
314
|
-
feed_item_ids.add(argument[:long_value])
|
315
|
-
end
|
316
|
-
end
|
317
|
-
end
|
318
|
-
end
|
319
|
-
return feed_item_ids
|
320
|
-
end
|
321
|
-
|
322
|
-
def get_campaign_feeds(adwords, feed, placeholder_type)
|
323
|
-
campaign_feed_srv = adwords.service(:CampaignFeedService, API_VERSION)
|
324
|
-
query = ("SELECT CampaignId, MatchingFunction, PlaceholderTypes " +
|
325
|
-
"WHERE Status = 'ENABLED' AND FeedId = %d " +
|
326
|
-
"AND PlaceholderTypes CONTAINS_ANY [%d]") % [feed[:id], placeholder_type]
|
327
|
-
|
328
|
-
campaign_feeds = []
|
329
|
-
offset = 0
|
330
|
-
|
331
|
-
begin
|
332
|
-
page_query = (query + " LIMIT %d, %d") % [offset, PAGE_SIZE]
|
333
|
-
page = campaign_feed_srv.query(page_query)
|
334
|
-
|
335
|
-
unless page[:entries].nil?
|
336
|
-
campaign_feeds += page[:entries]
|
337
|
-
end
|
338
|
-
offset += PAGE_SIZE
|
339
|
-
end while page[:total_num_entries] > offset
|
340
|
-
|
341
|
-
return campaign_feeds
|
342
|
-
end
|
343
|
-
|
344
|
-
if __FILE__ == $0
|
345
|
-
API_VERSION = :v201502
|
346
|
-
PAGE_SIZE = 500
|
347
|
-
|
348
|
-
# See the Placeholder reference page for a liste of all placeholder types
|
349
|
-
# and fields.
|
350
|
-
# https://developers.google.com/adwords/api/docs/appendix/placeholders
|
351
|
-
PLACEHOLDER_SITELINKS = 1
|
352
|
-
PLACEHOLDER_FIELD_SITELINK_LINK_TEXT = 1
|
353
|
-
PLACEHOLDER_FIELD_SITELINK_URL = 2
|
354
|
-
PLACEHOLDER_FIELD_LINE_2_TEXT = 3
|
355
|
-
PLACEHOLDER_FIELD_LINE_3_TEXT = 4
|
356
|
-
PLACEHOLDER_FIELD_FINAL_URLS = 5
|
357
|
-
PLACEHOLDER_FIELD_FINAL_MOBILE_URLS = 6
|
358
|
-
PLACEHOLDER_FIELD_TRACKING_URL_TEMPLATE = 7
|
359
|
-
|
360
|
-
begin
|
361
|
-
migrate_to_extension_settings()
|
362
|
-
|
363
|
-
# Authorization error.
|
364
|
-
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
365
|
-
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
366
|
-
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
367
|
-
"to retrieve and store OAuth2 tokens."
|
368
|
-
puts "See this wiki page for more details:\n\n " +
|
369
|
-
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
370
|
-
|
371
|
-
# HTTP errors.
|
372
|
-
rescue AdsCommon::Errors::HttpError => e
|
373
|
-
puts "HTTP Error: %s" % e
|
374
|
-
|
375
|
-
# API errors.
|
376
|
-
rescue AdwordsApi::Errors::ApiException => e
|
377
|
-
puts "Message: %s" % e.message
|
378
|
-
puts 'Errors:'
|
379
|
-
e.errors.each_with_index do |error, index|
|
380
|
-
puts "\tError [%d]:" % (index + 1)
|
381
|
-
error.each do |field, value|
|
382
|
-
puts "\t\t%s: %s" % [field, value]
|
383
|
-
end
|
384
|
-
end
|
385
|
-
end
|
386
|
-
end
|