google-adwords-api 0.11.0 → 0.11.1
Sign up to get free protection for your applications and to get access to all the features.
- data/ChangeLog +4 -0
- data/README +124 -107
- data/examples/v201306/misc/use_oauth2_jwt.rb +5 -1
- data/examples/v201309/misc/use_oauth2_jwt.rb +5 -1
- data/examples/v201402/account_management/create_account.rb +95 -0
- data/examples/v201402/account_management/get_account_alerts.rb +122 -0
- data/examples/v201402/account_management/get_account_changes.rb +145 -0
- data/examples/v201402/account_management/get_account_hierarchy.rb +103 -0
- data/examples/v201402/advanced_operations/add_ad_group_bid_modifier.rb +105 -0
- data/examples/v201402/advanced_operations/add_click_to_download_ad.rb +137 -0
- data/examples/v201402/advanced_operations/add_places_location_extensions.rb +159 -0
- data/examples/v201402/advanced_operations/add_places_location_extensions.rb~ +159 -0
- data/examples/v201402/advanced_operations/add_site_links.rb +306 -0
- data/examples/v201402/advanced_operations/get_ad_group_bid_modifiers.rb +106 -0
- data/examples/v201402/advanced_operations/update_site_links.rb +194 -0
- data/examples/v201402/advanced_operations/upload_offline_conversions.rb +117 -0
- data/examples/v201402/advanced_operations/use_shared_bidding_strategy.rb +163 -0
- data/examples/v201402/basic_operations/add_ad_groups.rb +142 -0
- data/examples/v201402/basic_operations/add_ad_groups.rb~ +147 -0
- data/examples/v201402/basic_operations/add_campaigns.rb +153 -0
- data/examples/v201402/basic_operations/add_keywords.rb +116 -0
- data/examples/v201402/basic_operations/add_text_ads.rb +113 -0
- data/examples/v201402/basic_operations/delete_ad.rb +93 -0
- data/examples/v201402/basic_operations/delete_ad_group.rb +110 -0
- data/examples/v201402/basic_operations/delete_campaign.rb +111 -0
- data/examples/v201402/basic_operations/delete_keyword.rb +98 -0
- data/examples/v201402/basic_operations/get_ad_groups.rb +106 -0
- data/examples/v201402/basic_operations/get_campaigns.rb +101 -0
- data/examples/v201402/basic_operations/get_campaigns_with_awql.rb +93 -0
- data/examples/v201402/basic_operations/get_keywords.rb +112 -0
- data/examples/v201402/basic_operations/get_text_ads.rb +114 -0
- data/examples/v201402/basic_operations/pause_ad.rb +92 -0
- data/examples/v201402/basic_operations/update_ad_group.rb +89 -0
- data/examples/v201402/basic_operations/update_campaign.rb +90 -0
- data/examples/v201402/basic_operations/update_keyword.rb +110 -0
- data/examples/v201402/campaign_management/add_experiment.rb +166 -0
- data/examples/v201402/campaign_management/add_keywords_in_bulk.rb +158 -0
- data/examples/v201402/campaign_management/add_location_extension.rb +125 -0
- data/examples/v201402/campaign_management/get_all_disapproved_ads.rb +101 -0
- data/examples/v201402/campaign_management/get_all_disapproved_ads_with_awql.rb +93 -0
- data/examples/v201402/campaign_management/promote_experiment.rb +85 -0
- data/examples/v201402/campaign_management/set_ad_parameters.rb +122 -0
- data/examples/v201402/campaign_management/set_criterion_bid_modifier.rb +108 -0
- data/examples/v201402/campaign_management/validate_text_ad.rb +114 -0
- data/examples/v201402/error_handling/handle_captcha_challenge.rb +93 -0
- data/examples/v201402/error_handling/handle_partial_failures.rb +134 -0
- data/examples/v201402/error_handling/handle_policy_violation_error.rb +145 -0
- data/examples/v201402/error_handling/handle_two_factor_authorization_error.rb +88 -0
- data/examples/v201402/misc/create_ad_words_session_without_properties_file.rb +94 -0
- data/examples/v201402/misc/create_ad_words_session_without_properties_file.rb~ +94 -0
- data/examples/v201402/misc/get_all_images_and_videos.rb +108 -0
- data/examples/v201402/misc/setup_oauth2.rb +88 -0
- data/examples/v201402/misc/upload_image.rb +97 -0
- data/examples/v201402/misc/use_oauth2_jwt.rb +97 -0
- data/examples/v201402/optimization/estimate_keyword_traffic.rb +137 -0
- data/examples/v201402/optimization/get_keyword_bid_simulations.rb +100 -0
- data/examples/v201402/optimization/get_keyword_ideas.rb +130 -0
- data/examples/v201402/optimization/get_placement_ideas.rb +112 -0
- data/examples/v201402/remarketing/add_audience.rb +123 -0
- data/examples/v201402/remarketing/add_conversion_tracker.rb +105 -0
- data/examples/v201402/remarketing/add_conversion_tracker.rb~ +109 -0
- data/examples/v201402/reporting/download_criteria_report.rb +87 -0
- data/examples/v201402/reporting/download_criteria_report_with_awql.rb +86 -0
- data/examples/v201402/reporting/get_report_fields.rb +79 -0
- data/examples/v201402/reporting/parallel_report_download.rb +171 -0
- data/examples/v201402/shopping_campaigns/add_product_partition_tree.rb +269 -0
- data/examples/v201402/shopping_campaigns/add_product_partition_tree.rb~ +269 -0
- data/examples/v201402/shopping_campaigns/add_product_scope.rb +133 -0
- data/examples/v201402/shopping_campaigns/add_shopping_campaign.rb +135 -0
- data/examples/v201402/shopping_campaigns/add_shopping_campaign.rb~ +136 -0
- data/examples/v201402/shopping_campaigns/get_product_category_taxonomy.rb +117 -0
- data/examples/v201402/shopping_campaigns/get_product_category_taxonomy.rb~ +128 -0
- data/examples/v201402/shopping_campaigns/set_product_sales_channel.rb +98 -0
- data/examples/v201402/shopping_campaigns/set_product_sales_channel.rb~ +98 -0
- data/examples/v201402/targeting/add_campaign_targeting_criteria.rb +157 -0
- data/examples/v201402/targeting/add_demographic_targeting_criteria.rb +116 -0
- data/examples/v201402/targeting/get_campaign_targeting_criteria.rb +110 -0
- data/examples/v201402/targeting/get_targetable_languages_and_carriers.rb +94 -0
- data/examples/v201402/targeting/lookup_location.rb +112 -0
- data/lib/adwords_api.rb +7 -0
- data/lib/adwords_api/api_config.rb +76 -4
- data/lib/adwords_api/report_header_handler.rb +1 -1
- data/lib/adwords_api/v201402/ad_group_ad_service.rb +42 -0
- data/lib/adwords_api/v201402/ad_group_ad_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/ad_group_bid_modifier_service.rb +42 -0
- data/lib/adwords_api/v201402/ad_group_bid_modifier_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/ad_group_criterion_service.rb +42 -0
- data/lib/adwords_api/v201402/ad_group_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/ad_group_feed_service.rb +42 -0
- data/lib/adwords_api/v201402/ad_group_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/ad_group_service.rb +42 -0
- data/lib/adwords_api/v201402/ad_group_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/ad_param_service.rb +38 -0
- data/lib/adwords_api/v201402/ad_param_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/adwords_user_list_service.rb +38 -0
- data/lib/adwords_api/v201402/adwords_user_list_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/alert_service.rb +34 -0
- data/lib/adwords_api/v201402/alert_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/bidding_strategy_service.rb +42 -0
- data/lib/adwords_api/v201402/bidding_strategy_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/budget_order_service.rb +42 -0
- data/lib/adwords_api/v201402/budget_order_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/budget_service.rb +42 -0
- data/lib/adwords_api/v201402/budget_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/campaign_ad_extension_service.rb +38 -0
- data/lib/adwords_api/v201402/campaign_ad_extension_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/campaign_criterion_service.rb +42 -0
- data/lib/adwords_api/v201402/campaign_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/campaign_feed_service.rb +42 -0
- data/lib/adwords_api/v201402/campaign_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/campaign_service.rb +42 -0
- data/lib/adwords_api/v201402/campaign_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/constant_data_service.rb +66 -0
- data/lib/adwords_api/v201402/constant_data_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/conversion_tracker_service.rb +38 -0
- data/lib/adwords_api/v201402/conversion_tracker_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/customer_feed_service.rb +42 -0
- data/lib/adwords_api/v201402/customer_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/customer_service.rb +38 -0
- data/lib/adwords_api/v201402/customer_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/customer_sync_service.rb +34 -0
- data/lib/adwords_api/v201402/customer_sync_service_registry.rb +47 -0
- data/lib/adwords_api/v201402/data_service.rb +46 -0
- data/lib/adwords_api/v201402/data_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/experiment_service.rb +38 -0
- data/lib/adwords_api/v201402/experiment_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/feed_item_service.rb +42 -0
- data/lib/adwords_api/v201402/feed_item_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/feed_mapping_service.rb +42 -0
- data/lib/adwords_api/v201402/feed_mapping_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/feed_service.rb +42 -0
- data/lib/adwords_api/v201402/feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/geo_location_service.rb +34 -0
- data/lib/adwords_api/v201402/geo_location_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/location_criterion_service.rb +38 -0
- data/lib/adwords_api/v201402/location_criterion_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/managed_customer_service.rb +50 -0
- data/lib/adwords_api/v201402/managed_customer_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/media_service.rb +42 -0
- data/lib/adwords_api/v201402/media_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/mutate_job_service.rb +42 -0
- data/lib/adwords_api/v201402/mutate_job_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/offline_conversion_feed_service.rb +34 -0
- data/lib/adwords_api/v201402/offline_conversion_feed_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/report_definition_service.rb +34 -0
- data/lib/adwords_api/v201402/report_definition_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/targeting_idea_service.rb +38 -0
- data/lib/adwords_api/v201402/targeting_idea_service_registry.rb +46 -0
- data/lib/adwords_api/v201402/traffic_estimator_service.rb +34 -0
- data/lib/adwords_api/v201402/traffic_estimator_service_registry.rb +46 -0
- data/lib/adwords_api/version.rb +1 -1
- data/test/adwords_api/test_adwords_api.rb +15 -2
- data/test/adwords_api/test_adwords_api.rb~ +127 -0
- 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 +146 -2
@@ -0,0 +1,306 @@
|
|
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
|
+
{: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.
|
63
|
+
link_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 URL attribute ID %d " +
|
71
|
+
"and Line 1 attribute ID %d and Line 2 attribute ID %d." % [
|
72
|
+
link_text_feed_attribute_id,
|
73
|
+
link_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[:link_url_feed_id] = link_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
|
+
:url => 'http://www.example.com',
|
92
|
+
:line_1 => 'Home line 1',
|
93
|
+
:line_2 => 'Home line 2'
|
94
|
+
},
|
95
|
+
{
|
96
|
+
:text => 'Stores',
|
97
|
+
:url => 'http://www.example.com/stores',
|
98
|
+
:line_1 => 'Stores line 1',
|
99
|
+
:line_2 => 'Stores line 2'
|
100
|
+
},
|
101
|
+
{
|
102
|
+
:text => 'On Sale',
|
103
|
+
:url => '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
|
+
:url => 'http://www.example.com/support',
|
110
|
+
:line_1 => 'Support line 1',
|
111
|
+
:line_2 => 'Support line 2'
|
112
|
+
},
|
113
|
+
{
|
114
|
+
:text => 'Products',
|
115
|
+
:url => 'http://www.example.com/products',
|
116
|
+
:line_1 => 'Products line 1',
|
117
|
+
:line_2 => 'Products line 2'
|
118
|
+
},
|
119
|
+
{
|
120
|
+
:text => 'About',
|
121
|
+
:url => '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[:link_url_feed_id],
|
137
|
+
:string_value => item[:url]
|
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[:link_url_feed_id],
|
177
|
+
:field_id => PLACEHOLDER_FIELD_SITELINK_LINK_URL
|
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 = :v201402
|
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_LINK_URL = 2
|
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
|
@@ -0,0 +1,106 @@
|
|
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 retrieve ad group level bid modifiers for a
|
22
|
+
# campaign.
|
23
|
+
#
|
24
|
+
# Tags: AdGroupBidModifierService.get
|
25
|
+
|
26
|
+
require 'adwords_api'
|
27
|
+
|
28
|
+
def get_ad_group_bid_modifiers(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
|
+
bid_modifier_srv = adwords.service(:AdGroupBidModifierService, API_VERSION)
|
38
|
+
|
39
|
+
# Get all ad group bid modifiers for the campaign.
|
40
|
+
selector = {
|
41
|
+
:fields => ['CampaignId', 'AdGroupId', 'Id', 'BidModifier'],
|
42
|
+
:predicates => [
|
43
|
+
{:field => 'CampaignId', :operator => 'EQUALS', :values => [campaign_id]}
|
44
|
+
],
|
45
|
+
:paging => {
|
46
|
+
:start_index => 0,
|
47
|
+
:number_results => PAGE_SIZE
|
48
|
+
}
|
49
|
+
}
|
50
|
+
|
51
|
+
# Set initial values.
|
52
|
+
offset, page = 0, {}
|
53
|
+
|
54
|
+
begin
|
55
|
+
page = bid_modifier_srv.get(selector)
|
56
|
+
if page[:entries]
|
57
|
+
page[:entries].each do |modifier|
|
58
|
+
value = modifier[:bid_modifier] || 'unset'
|
59
|
+
puts ('Campaign ID %d, AdGroup ID %d, Criterion ID %d has ad group ' +
|
60
|
+
'level modifier: %s') %
|
61
|
+
[modifier[:campaign_id], modifier[:ad_group_id],
|
62
|
+
modifier[:criterion][:id], value]
|
63
|
+
end
|
64
|
+
# Increment values to request the next page.
|
65
|
+
offset += PAGE_SIZE
|
66
|
+
selector[:paging][:start_index] = offset
|
67
|
+
else
|
68
|
+
puts 'No ad group level bid overrides returned.'
|
69
|
+
end
|
70
|
+
end while page[:total_num_entries] > offset
|
71
|
+
end
|
72
|
+
|
73
|
+
if __FILE__ == $0
|
74
|
+
API_VERSION = :v201402
|
75
|
+
PAGE_SIZE = 500
|
76
|
+
|
77
|
+
begin
|
78
|
+
# ID of a campaign to pull overrides for.
|
79
|
+
campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
|
80
|
+
|
81
|
+
get_ad_group_bid_modifiers(campaign_id)
|
82
|
+
|
83
|
+
# Authorization error.
|
84
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
85
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
86
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
87
|
+
"to retrieve and store OAuth2 tokens."
|
88
|
+
puts "See this wiki page for more details:\n\n " +
|
89
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
90
|
+
|
91
|
+
# HTTP errors.
|
92
|
+
rescue AdsCommon::Errors::HttpError => e
|
93
|
+
puts "HTTP Error: %s" % e
|
94
|
+
|
95
|
+
# API errors.
|
96
|
+
rescue AdwordsApi::Errors::ApiException => e
|
97
|
+
puts "Message: %s" % e.message
|
98
|
+
puts 'Errors:'
|
99
|
+
e.errors.each_with_index do |error, index|
|
100
|
+
puts "\tError [%d]:" % (index + 1)
|
101
|
+
error.each do |field, value|
|
102
|
+
puts "\t\t%s: %s" % [field, value]
|
103
|
+
end
|
104
|
+
end
|
105
|
+
end
|
106
|
+
end
|
@@ -0,0 +1,194 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
# Encoding: utf-8
|
3
|
+
#
|
4
|
+
# Author:: api.mcloonan@gmail.com (Michael Cloonan)
|
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 updates an existing sitelinks feed as follows:
|
22
|
+
# * Adds FeedItemAttributes for line 1 and line 2 descriptions to the Feed
|
23
|
+
# * Populates the new FeedItemAttributes on FeedItems in the Feed
|
24
|
+
# * Replaces the Feed's existing FeedMapping with one that contains the new
|
25
|
+
# set of FeedItemAttributes
|
26
|
+
#
|
27
|
+
# The end result of this is that any campaign or ad group whose CampaignFeed
|
28
|
+
# or AdGroupFeed points to the Feed's ID will now serve line 1 and line 2
|
29
|
+
# descriptions in its sitelinks.
|
30
|
+
#
|
31
|
+
# Tags: FeedItemService.mutate
|
32
|
+
# Tags: FeedMappingService.mutate, FeedService.mutate
|
33
|
+
|
34
|
+
require 'adwords_api'
|
35
|
+
|
36
|
+
def update_site_links(feed_id, feed_item_descriptions)
|
37
|
+
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
38
|
+
# when called without parameters.
|
39
|
+
adwords = AdwordsApi::Api.new
|
40
|
+
|
41
|
+
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
42
|
+
# the configuration file or provide your own logger:
|
43
|
+
# adwords.logger = Logger.new('adwords_xml.log')
|
44
|
+
|
45
|
+
feed_srv = adwords.service(:FeedService, API_VERSION)
|
46
|
+
feed_item_srv = adwords.service(:FeedItemService, API_VERSION)
|
47
|
+
feed_mapping_srv = adwords.service(:FeedMappingService, API_VERSION)
|
48
|
+
|
49
|
+
feed_selector = {
|
50
|
+
:fields => ['Id', 'Attributes'],
|
51
|
+
:predicates => [
|
52
|
+
{:field => 'Id', :operator => 'EQUALS', :values => [feed_id]}
|
53
|
+
]
|
54
|
+
}
|
55
|
+
|
56
|
+
feed = feed_srv.get(feed_selector)[:entries][0]
|
57
|
+
|
58
|
+
# Add new line1 and line2 feed attributes.
|
59
|
+
next_attribute_index = feed[:attributes].length()
|
60
|
+
|
61
|
+
feed[:attributes] = [
|
62
|
+
{:type => 'STRING', :name => 'Line 1 Description'},
|
63
|
+
{:type => 'STRING', :name => 'Line 2 Description'}
|
64
|
+
]
|
65
|
+
|
66
|
+
mutated_feed_result = feed_srv.mutate([
|
67
|
+
{:operator => 'SET', :operand => feed}
|
68
|
+
])
|
69
|
+
|
70
|
+
mutated_feed = mutated_feed_result[:value][0]
|
71
|
+
line_1_attribute = mutated_feed[:attributes][next_attribute_index]
|
72
|
+
line_2_attribute = mutated_feed[:attributes][next_attribute_index + 1]
|
73
|
+
|
74
|
+
# Update feed items.
|
75
|
+
feed_item_ids = feed_item_descriptions.keys
|
76
|
+
item_selector = {
|
77
|
+
:fields => ['FeedId', 'FeedItemId', 'AttributeValues'],
|
78
|
+
:predicates => [
|
79
|
+
{:field => 'FeedId', :operator => 'EQUALS', :values => [feed_id]},
|
80
|
+
{:field => 'FeedItemId', :operator => 'IN', :values => feed_item_ids}
|
81
|
+
]
|
82
|
+
}
|
83
|
+
|
84
|
+
feed_items = feed_item_srv.get(item_selector)[:entries]
|
85
|
+
|
86
|
+
item_operations = feed_items.map do |feed_item|
|
87
|
+
feed_item[:attribute_values] = [
|
88
|
+
{
|
89
|
+
:feed_attribute_id => line_1_attribute[:id],
|
90
|
+
:string_value => feed_item_descriptions[feed_item[:feed_item_id]][0]
|
91
|
+
},
|
92
|
+
{
|
93
|
+
:feed_attribute_id => line_2_attribute[:id],
|
94
|
+
:string_value => feed_item_descriptions[feed_item[:feed_item_id]][1]
|
95
|
+
}
|
96
|
+
]
|
97
|
+
|
98
|
+
{:operator => 'SET', :operand => feed_item}
|
99
|
+
end
|
100
|
+
items_update_result = feed_item_srv.mutate(item_operations)
|
101
|
+
puts 'Updated %d items' % items_update_result[:value].length
|
102
|
+
|
103
|
+
# Update feed mapping.
|
104
|
+
mapping_selector = {
|
105
|
+
:fields => [
|
106
|
+
'FeedId',
|
107
|
+
'FeedMappingId',
|
108
|
+
'PlaceholderType',
|
109
|
+
'AttributeFieldMappings'
|
110
|
+
],
|
111
|
+
:predicates => [
|
112
|
+
{:field => 'FeedId', :operator => 'EQUALS', :values => [feed_id]}
|
113
|
+
]
|
114
|
+
}
|
115
|
+
feed_mapping_results = feed_mapping_srv.get(mapping_selector)
|
116
|
+
feed_mapping = feed_mapping_results[:entries][0]
|
117
|
+
|
118
|
+
# Feed mappings are immutable, so we have to delete it and re-add
|
119
|
+
# it with modifications.
|
120
|
+
feed_mapping_srv.mutate([
|
121
|
+
{:operator => 'REMOVE', :operand => feed_mapping}
|
122
|
+
])[:value][0]
|
123
|
+
|
124
|
+
feed_mapping[:attribute_field_mappings].push(
|
125
|
+
{
|
126
|
+
:feed_attribute_id => line_1_attribute[:id],
|
127
|
+
:field_id => PLACEHOLDER_FIELD_LINE_1_TEXT
|
128
|
+
},
|
129
|
+
{
|
130
|
+
:feed_attribute_id => line_2_attribute[:id],
|
131
|
+
:field_id => PLACEHOLDER_FIELD_LINE_2_TEXT
|
132
|
+
}
|
133
|
+
)
|
134
|
+
mapping_update_result = feed_mapping_srv.mutate([
|
135
|
+
{:operator => 'ADD', :operand => feed_mapping}
|
136
|
+
])
|
137
|
+
|
138
|
+
mutated_mapping = mapping_update_result[:value][0]
|
139
|
+
puts 'Updated field mappings for feedId %d and feedMappingId %d to:' %
|
140
|
+
[mutated_mapping[:feed_id], mutated_mapping[:feed_mapping_id]]
|
141
|
+
mutated_mapping[:attribute_field_mappings].each do |field_mapping|
|
142
|
+
puts "\tfeedAttributeId %d --> fieldId %d" %
|
143
|
+
[field_mapping[:feed_attribute_id], field_mapping[:field_id]]
|
144
|
+
end
|
145
|
+
end
|
146
|
+
|
147
|
+
if __FILE__ == $0
|
148
|
+
API_VERSION = :v201402
|
149
|
+
|
150
|
+
# See the Placeholder reference page for a list of all the placeholder types
|
151
|
+
# and fields:
|
152
|
+
# https://developers.google.com/adwords/api/docs/appendix/placeholders
|
153
|
+
PLACEHOLDER_FIELD_LINE_1_TEXT = 3
|
154
|
+
PLACEHOLDER_FIELD_LINE_2_TEXT = 4
|
155
|
+
|
156
|
+
begin
|
157
|
+
feed_id = 'INSERT_FEED_ID_HERE'.to_i
|
158
|
+
feed_item_descriptions = {
|
159
|
+
'INSERT_FEED_ITEM_A_ID_HERE'.to_i => [
|
160
|
+
'INSERT_FEED_ITEM_A_LINE1_DESC_HERE',
|
161
|
+
'INSERT_FEED_ITEM_A_LINE2_DESC_HERE'
|
162
|
+
],
|
163
|
+
'INSERT_FEED_ITEM_B_ID_HERE'.to_i => [
|
164
|
+
'INSERT_FEED_ITEM_B_LINE1_DESC_HERE',
|
165
|
+
'INSERT_FEED_ITEM_B_LINE2_DESC_HERE'
|
166
|
+
]
|
167
|
+
}
|
168
|
+
|
169
|
+
update_site_links(feed_id, feed_item_descriptions)
|
170
|
+
|
171
|
+
# Authorization error.
|
172
|
+
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
173
|
+
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
174
|
+
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
175
|
+
"to retrieve and store OAuth2 tokens."
|
176
|
+
puts "See this wiki page for more details:\n\n " +
|
177
|
+
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
178
|
+
|
179
|
+
# HTTP errors.
|
180
|
+
rescue AdsCommon::Errors::HttpError => e
|
181
|
+
puts "HTTP Error: %s" % e
|
182
|
+
|
183
|
+
# API errors.
|
184
|
+
rescue AdwordsApi::Errors::ApiException => e
|
185
|
+
puts "Message: %s" % e.message
|
186
|
+
puts 'Errors:'
|
187
|
+
e.errors.each_with_index do |error, index|
|
188
|
+
puts "\tError [%d]:" % (index + 1)
|
189
|
+
error.each do |field, value|
|
190
|
+
puts "\t\t%s: %s" % [field, value]
|
191
|
+
end
|
192
|
+
end
|
193
|
+
end
|
194
|
+
end
|