google-adwords-api 0.13.2 → 0.14.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +8 -8
- data/ChangeLog +12 -0
- data/examples/v201406/advanced_operations/{add_places_location_extensions.rb → add_google_my_business_location_extensions.rb} +24 -15
- data/examples/v201409/advanced_operations/{add_places_location_extensions.rb → add_google_my_business_location_extensions.rb} +41 -16
- data/examples/v201409/advanced_operations/use_shared_bidding_strategy.rb +1 -13
- data/examples/v201409/basic_operations/add_campaigns.rb +0 -10
- data/examples/v201409/remarketing/add_audience.rb +0 -1
- data/examples/v201409/remarketing/add_rule_based_user_lists.rb +171 -0
- data/examples/v201409/shopping_campaigns/add_shopping_campaign.rb +0 -4
- data/lib/adwords_api/api_config.rb +0 -78
- data/lib/adwords_api/report_header_handler.rb +0 -4
- data/lib/adwords_api/report_utils.rb +0 -9
- data/lib/adwords_api/version.rb +1 -1
- data/test/adwords_api/test_choices.rb +138 -0
- data/test/adwords_api/test_report_utils.rb +0 -27
- data/test/templates/v201406/basic_operations_get_campaigns.def +1 -1
- data/test/templates/v201406/misc_use_oauth2_jwt.def +1 -1
- data/test/templates/v201409/basic_operations_get_campaigns.def +1 -1
- data/test/templates/v201409/misc_use_oauth2_jwt.def +1 -1
- metadata +8 -149
- data/examples/v201402/account_management/create_account.rb +0 -95
- data/examples/v201402/account_management/get_account_alerts.rb +0 -122
- data/examples/v201402/account_management/get_account_changes.rb +0 -145
- data/examples/v201402/account_management/get_account_hierarchy.rb +0 -103
- data/examples/v201402/advanced_operations/add_ad_group_bid_modifier.rb +0 -105
- data/examples/v201402/advanced_operations/add_click_to_download_ad.rb +0 -137
- data/examples/v201402/advanced_operations/add_places_location_extensions.rb +0 -159
- data/examples/v201402/advanced_operations/add_site_links.rb +0 -306
- data/examples/v201402/advanced_operations/get_ad_group_bid_modifiers.rb +0 -106
- data/examples/v201402/advanced_operations/update_site_links.rb +0 -194
- data/examples/v201402/advanced_operations/upload_offline_conversions.rb +0 -117
- data/examples/v201402/advanced_operations/use_shared_bidding_strategy.rb +0 -163
- data/examples/v201402/basic_operations/add_ad_groups.rb +0 -142
- data/examples/v201402/basic_operations/add_campaigns.rb +0 -153
- data/examples/v201402/basic_operations/add_keywords.rb +0 -116
- data/examples/v201402/basic_operations/add_text_ads.rb +0 -113
- data/examples/v201402/basic_operations/delete_ad.rb +0 -93
- data/examples/v201402/basic_operations/delete_ad_group.rb +0 -89
- data/examples/v201402/basic_operations/delete_campaign.rb +0 -90
- data/examples/v201402/basic_operations/delete_keyword.rb +0 -98
- data/examples/v201402/basic_operations/get_ad_groups.rb +0 -106
- data/examples/v201402/basic_operations/get_campaigns.rb +0 -101
- data/examples/v201402/basic_operations/get_campaigns_with_awql.rb +0 -93
- data/examples/v201402/basic_operations/get_keywords.rb +0 -112
- data/examples/v201402/basic_operations/get_text_ads.rb +0 -114
- data/examples/v201402/basic_operations/pause_ad.rb +0 -92
- data/examples/v201402/basic_operations/update_ad_group.rb +0 -89
- data/examples/v201402/basic_operations/update_campaign.rb +0 -90
- data/examples/v201402/basic_operations/update_keyword.rb +0 -110
- data/examples/v201402/campaign_management/add_experiment.rb +0 -166
- data/examples/v201402/campaign_management/add_keywords_in_bulk.rb +0 -158
- data/examples/v201402/campaign_management/add_location_extension.rb +0 -125
- data/examples/v201402/campaign_management/get_all_disapproved_ads.rb +0 -101
- data/examples/v201402/campaign_management/get_all_disapproved_ads_with_awql.rb +0 -93
- data/examples/v201402/campaign_management/promote_experiment.rb +0 -85
- data/examples/v201402/campaign_management/set_ad_parameters.rb +0 -122
- data/examples/v201402/campaign_management/set_criterion_bid_modifier.rb +0 -108
- data/examples/v201402/campaign_management/validate_text_ad.rb +0 -114
- data/examples/v201402/error_handling/handle_captcha_challenge.rb +0 -93
- data/examples/v201402/error_handling/handle_partial_failures.rb +0 -134
- data/examples/v201402/error_handling/handle_policy_violation_error.rb +0 -145
- data/examples/v201402/error_handling/handle_two_factor_authorization_error.rb +0 -88
- data/examples/v201402/misc/create_ad_words_session_without_properties_file.rb +0 -94
- data/examples/v201402/misc/get_all_images_and_videos.rb +0 -108
- data/examples/v201402/misc/setup_oauth2.rb +0 -88
- data/examples/v201402/misc/upload_image.rb +0 -97
- data/examples/v201402/misc/use_oauth2_jwt.rb +0 -97
- data/examples/v201402/optimization/estimate_keyword_traffic.rb +0 -137
- data/examples/v201402/optimization/get_keyword_bid_simulations.rb +0 -100
- data/examples/v201402/optimization/get_keyword_ideas.rb +0 -130
- data/examples/v201402/optimization/get_placement_ideas.rb +0 -112
- data/examples/v201402/remarketing/add_audience.rb +0 -123
- data/examples/v201402/remarketing/add_conversion_tracker.rb +0 -105
- data/examples/v201402/reporting/download_criteria_report.rb +0 -87
- data/examples/v201402/reporting/download_criteria_report_with_awql.rb +0 -86
- data/examples/v201402/reporting/get_report_fields.rb +0 -79
- data/examples/v201402/reporting/parallel_report_download.rb +0 -171
- data/examples/v201402/shopping_campaigns/add_product_partition_tree.rb +0 -269
- data/examples/v201402/shopping_campaigns/add_product_scope.rb +0 -133
- data/examples/v201402/shopping_campaigns/add_shopping_campaign.rb +0 -135
- data/examples/v201402/shopping_campaigns/get_product_category_taxonomy.rb +0 -117
- data/examples/v201402/shopping_campaigns/set_product_sales_channel.rb +0 -98
- data/examples/v201402/targeting/add_campaign_targeting_criteria.rb +0 -157
- data/examples/v201402/targeting/add_demographic_targeting_criteria.rb +0 -116
- data/examples/v201402/targeting/get_campaign_targeting_criteria.rb +0 -110
- data/examples/v201402/targeting/get_targetable_languages_and_carriers.rb +0 -94
- data/examples/v201402/targeting/lookup_location.rb +0 -112
- data/lib/adwords_api/v201402/ad_group_ad_service.rb +0 -42
- data/lib/adwords_api/v201402/ad_group_ad_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/ad_group_bid_modifier_service.rb +0 -42
- data/lib/adwords_api/v201402/ad_group_bid_modifier_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/ad_group_criterion_service.rb +0 -42
- data/lib/adwords_api/v201402/ad_group_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/ad_group_feed_service.rb +0 -42
- data/lib/adwords_api/v201402/ad_group_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/ad_group_service.rb +0 -42
- data/lib/adwords_api/v201402/ad_group_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/ad_param_service.rb +0 -38
- data/lib/adwords_api/v201402/ad_param_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/adwords_user_list_service.rb +0 -38
- data/lib/adwords_api/v201402/adwords_user_list_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/alert_service.rb +0 -34
- data/lib/adwords_api/v201402/alert_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/bidding_strategy_service.rb +0 -42
- data/lib/adwords_api/v201402/bidding_strategy_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/budget_order_service.rb +0 -42
- data/lib/adwords_api/v201402/budget_order_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/budget_service.rb +0 -42
- data/lib/adwords_api/v201402/budget_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/campaign_ad_extension_service.rb +0 -38
- data/lib/adwords_api/v201402/campaign_ad_extension_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/campaign_criterion_service.rb +0 -42
- data/lib/adwords_api/v201402/campaign_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/campaign_feed_service.rb +0 -42
- data/lib/adwords_api/v201402/campaign_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/campaign_service.rb +0 -42
- data/lib/adwords_api/v201402/campaign_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/campaign_shared_set_service.rb +0 -38
- data/lib/adwords_api/v201402/campaign_shared_set_service_registry.rb +0 -47
- data/lib/adwords_api/v201402/constant_data_service.rb +0 -66
- data/lib/adwords_api/v201402/constant_data_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/conversion_tracker_service.rb +0 -38
- data/lib/adwords_api/v201402/conversion_tracker_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/customer_feed_service.rb +0 -42
- data/lib/adwords_api/v201402/customer_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/customer_service.rb +0 -38
- data/lib/adwords_api/v201402/customer_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/customer_sync_service.rb +0 -34
- data/lib/adwords_api/v201402/customer_sync_service_registry.rb +0 -47
- data/lib/adwords_api/v201402/data_service.rb +0 -46
- data/lib/adwords_api/v201402/data_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/experiment_service.rb +0 -38
- data/lib/adwords_api/v201402/experiment_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/feed_item_service.rb +0 -42
- data/lib/adwords_api/v201402/feed_item_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/feed_mapping_service.rb +0 -42
- data/lib/adwords_api/v201402/feed_mapping_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/feed_service.rb +0 -42
- data/lib/adwords_api/v201402/feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/geo_location_service.rb +0 -34
- data/lib/adwords_api/v201402/geo_location_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/location_criterion_service.rb +0 -38
- data/lib/adwords_api/v201402/location_criterion_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/managed_customer_service.rb +0 -50
- data/lib/adwords_api/v201402/managed_customer_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/media_service.rb +0 -42
- data/lib/adwords_api/v201402/media_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/mutate_job_service.rb +0 -42
- data/lib/adwords_api/v201402/mutate_job_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/offline_conversion_feed_service.rb +0 -34
- data/lib/adwords_api/v201402/offline_conversion_feed_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/report_definition_service.rb +0 -34
- data/lib/adwords_api/v201402/report_definition_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/shared_criterion_service.rb +0 -38
- data/lib/adwords_api/v201402/shared_criterion_service_registry.rb +0 -47
- data/lib/adwords_api/v201402/shared_set_service.rb +0 -38
- data/lib/adwords_api/v201402/shared_set_service_registry.rb +0 -47
- data/lib/adwords_api/v201402/targeting_idea_service.rb +0 -38
- data/lib/adwords_api/v201402/targeting_idea_service_registry.rb +0 -46
- data/lib/adwords_api/v201402/traffic_estimator_service.rb +0 -34
- data/lib/adwords_api/v201402/traffic_estimator_service_registry.rb +0 -46
- data/test/templates/v201402/basic_operations_get_campaigns.def +0 -114
- data/test/templates/v201402/misc_use_oauth2_jwt.def +0 -131
@@ -1,269 +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 creates a ProductPartition tree.
|
22
|
-
|
23
|
-
require 'adwords_api'
|
24
|
-
|
25
|
-
class ProductPartitionHelper
|
26
|
-
attr_reader :operations
|
27
|
-
|
28
|
-
def initialize(ad_group_id)
|
29
|
-
# The next temporary criterion ID to be used.
|
30
|
-
#
|
31
|
-
# When creating our tree we need to specify the parent-child relationships
|
32
|
-
# between nodes. However, until a criterion has been created on the server
|
33
|
-
# we do not have a criterionId with which to refer to it.
|
34
|
-
#
|
35
|
-
# Instead we can specify temporary IDs that are specific to a single mutate
|
36
|
-
# request. Once the criteria have been created they are assigned an ID as
|
37
|
-
# normal and the temporary ID will no longer refer to it.
|
38
|
-
#
|
39
|
-
# A valid temporary ID is any negative integer.
|
40
|
-
@next_id = -1
|
41
|
-
|
42
|
-
# The set of mutate operations needed to create the current tree.
|
43
|
-
@operations = []
|
44
|
-
|
45
|
-
# The ID of the AdGroup that we wish to attach the partition tree to.
|
46
|
-
@ad_group_id = ad_group_id
|
47
|
-
end
|
48
|
-
|
49
|
-
def create_subdivision(parent = nil, value = nil)
|
50
|
-
division = {
|
51
|
-
:xsi_type => 'ProductPartition',
|
52
|
-
:partition_type => 'SUBDIVISION',
|
53
|
-
:id => @next_id
|
54
|
-
}
|
55
|
-
|
56
|
-
@next_id -= 1
|
57
|
-
|
58
|
-
unless parent.nil? || value.nil?
|
59
|
-
division[:parent_criterion_id] = parent[:id]
|
60
|
-
division[:case_value] = value
|
61
|
-
end
|
62
|
-
|
63
|
-
ad_group_criterion = {
|
64
|
-
:xsi_type => 'BiddableAdGroupCriterion',
|
65
|
-
:ad_group_id => @ad_group_id,
|
66
|
-
:criterion => division
|
67
|
-
}
|
68
|
-
|
69
|
-
create_add_operation(ad_group_criterion)
|
70
|
-
|
71
|
-
return division
|
72
|
-
end
|
73
|
-
|
74
|
-
def create_unit(parent = nil, value = nil, bid_amount = nil)
|
75
|
-
unit = {
|
76
|
-
:xsi_type => 'ProductPartition',
|
77
|
-
:partition_type => 'UNIT'
|
78
|
-
}
|
79
|
-
|
80
|
-
unless parent.nil? || value.nil?
|
81
|
-
unit[:parent_criterion_id] = parent[:id]
|
82
|
-
unit[:case_value] = value
|
83
|
-
end
|
84
|
-
|
85
|
-
ad_group_criterion = {}
|
86
|
-
if bid_amount && bid_amount > 0
|
87
|
-
bidding_strategy_configuration = {
|
88
|
-
:bids => [{
|
89
|
-
:xsi_type => 'CpcBid',
|
90
|
-
:bid => {
|
91
|
-
:xsi_type => 'Money',
|
92
|
-
:micro_amount => bid_amount
|
93
|
-
}
|
94
|
-
}]
|
95
|
-
}
|
96
|
-
ad_group_criterion[:xsi_type] = 'BiddableAdGroupCriterion'
|
97
|
-
ad_group_criterion[:bidding_strategy_configuration] =
|
98
|
-
bidding_strategy_configuration
|
99
|
-
else
|
100
|
-
ad_group_criterion[:xsi_type] = 'NegativeAdGroupCriterion'
|
101
|
-
end
|
102
|
-
ad_group_criterion[:ad_group_id] = @ad_group_id
|
103
|
-
ad_group_criterion[:criterion] = unit
|
104
|
-
|
105
|
-
create_add_operation(ad_group_criterion)
|
106
|
-
|
107
|
-
return unit
|
108
|
-
end
|
109
|
-
|
110
|
-
private
|
111
|
-
|
112
|
-
def create_add_operation(ad_group_criterion)
|
113
|
-
operation = {
|
114
|
-
:operator => 'ADD',
|
115
|
-
:operand => ad_group_criterion
|
116
|
-
}
|
117
|
-
|
118
|
-
@operations << operation
|
119
|
-
end
|
120
|
-
end
|
121
|
-
|
122
|
-
def display_tree(node, children, level = 0)
|
123
|
-
value = ''
|
124
|
-
type = ''
|
125
|
-
|
126
|
-
if node[:case_value]
|
127
|
-
type = node[:case_value][:product_dimension_type]
|
128
|
-
|
129
|
-
value = case type
|
130
|
-
when 'ProductCanonicalCondition'
|
131
|
-
node[:case_value][:condition]
|
132
|
-
when 'ProductBiddingCategory'
|
133
|
-
"%s(%s)" % [node[:case_value][:type], node[:case_value][:value]]
|
134
|
-
else
|
135
|
-
node[:case_value][:value]
|
136
|
-
end
|
137
|
-
end
|
138
|
-
|
139
|
-
puts "%sid: %s, type: %s, value: %s" %
|
140
|
-
[' ' * level, node[:id], type, value]
|
141
|
-
|
142
|
-
children[node[:id]].each do |child_node|
|
143
|
-
display_tree(child_node, children, level + 1)
|
144
|
-
end
|
145
|
-
end
|
146
|
-
|
147
|
-
def add_product_partition_tree(ad_group_id)
|
148
|
-
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
149
|
-
# when called without parameters.
|
150
|
-
adwords = AdwordsApi::Api.new
|
151
|
-
|
152
|
-
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
153
|
-
# the configuration file or provide your own logger:
|
154
|
-
# adwords.logger = Logger.new('adwords_xml.log')
|
155
|
-
|
156
|
-
ad_group_criterion_srv =
|
157
|
-
adwords.service(:AdGroupCriterionService, API_VERSION)
|
158
|
-
|
159
|
-
helper = ProductPartitionHelper.new(ad_group_id)
|
160
|
-
|
161
|
-
root = helper.create_subdivision()
|
162
|
-
|
163
|
-
new_product_canonical_condition = {
|
164
|
-
:xsi_type => 'ProductCanonicalCondition',
|
165
|
-
:condition => 'NEW'
|
166
|
-
}
|
167
|
-
|
168
|
-
used_product_canonical_condition = {
|
169
|
-
:xsi_type => 'ProductCanonicalCondition',
|
170
|
-
:condition => 'USED'
|
171
|
-
}
|
172
|
-
|
173
|
-
other_product_canonical_condition = {
|
174
|
-
:xsi_type => 'ProductCanonicalCondition'
|
175
|
-
}
|
176
|
-
|
177
|
-
helper.create_unit(root, new_product_canonical_condition, 200000)
|
178
|
-
helper.create_unit(root, used_product_canonical_condition, 100000)
|
179
|
-
other_condition =
|
180
|
-
helper.create_subdivision(root, other_product_canonical_condition)
|
181
|
-
|
182
|
-
cool_product_brand = {
|
183
|
-
:xsi_type => 'ProductBrand',
|
184
|
-
:value => 'CoolBrand'
|
185
|
-
}
|
186
|
-
|
187
|
-
cheap_product_brand = {
|
188
|
-
:xsi_type => 'ProductBrand',
|
189
|
-
:value => 'CheapBrand'
|
190
|
-
}
|
191
|
-
|
192
|
-
other_product_brand = {
|
193
|
-
:xsi_type => 'ProductBrand'
|
194
|
-
}
|
195
|
-
|
196
|
-
helper.create_unit(other_condition, cool_product_brand, 900000)
|
197
|
-
helper.create_unit(other_condition, cheap_product_brand, 10000)
|
198
|
-
other_brand = helper.create_subdivision(other_condition, other_product_brand)
|
199
|
-
|
200
|
-
# The value for the bidding category is a fixed ID for the 'Luggage & Bags'
|
201
|
-
# category. You can retrieve IDs for categories from the ConstantDataService.
|
202
|
-
# See the get_product_taxonomy example for more details.
|
203
|
-
luggage_category = {
|
204
|
-
:xsi_type => 'ProductBiddingCategory',
|
205
|
-
:type => 'BIDDING_CATEGORY_L1',
|
206
|
-
:value => '-5914235892932915235'
|
207
|
-
}
|
208
|
-
|
209
|
-
generic_category = {
|
210
|
-
:xsi_type => 'ProductBiddingCategory',
|
211
|
-
:type => 'BIDDING_CATEGORY_L1'
|
212
|
-
}
|
213
|
-
|
214
|
-
helper.create_unit(other_brand, luggage_category, 750000)
|
215
|
-
helper.create_unit(other_brand, generic_category, 110000)
|
216
|
-
|
217
|
-
# Make the mutate request.
|
218
|
-
result = ad_group_criterion_srv.mutate(helper.operations)
|
219
|
-
|
220
|
-
children = {}
|
221
|
-
root_node = nil
|
222
|
-
# For each criterion, make an array containing each of its children.
|
223
|
-
# We always create the parent before the child, so we can rely on that here.
|
224
|
-
result[:value].each do |criterion|
|
225
|
-
children[criterion[:criterion][:id]] = []
|
226
|
-
|
227
|
-
if criterion[:criterion][:parent_criterion_id]
|
228
|
-
children[criterion[:criterion][:parent_criterion_id]] <<
|
229
|
-
criterion[:criterion]
|
230
|
-
else
|
231
|
-
root_node = criterion[:criterion]
|
232
|
-
end
|
233
|
-
end
|
234
|
-
|
235
|
-
display_tree(root_node, children)
|
236
|
-
end
|
237
|
-
|
238
|
-
if __FILE__ == $0
|
239
|
-
API_VERSION = :v201402
|
240
|
-
|
241
|
-
begin
|
242
|
-
ad_group_id = 'INSERT_AD_GROUP_ID_HERE'.to_i
|
243
|
-
|
244
|
-
add_product_partition_tree(ad_group_id)
|
245
|
-
|
246
|
-
# Authorization error.
|
247
|
-
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
248
|
-
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
249
|
-
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
250
|
-
"to retrieve and store OAuth2 tokens."
|
251
|
-
puts "See this wiki page for more details:\n\n " +
|
252
|
-
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
253
|
-
|
254
|
-
# HTTP errors.
|
255
|
-
rescue AdsCommon::Errors::HttpError => e
|
256
|
-
puts "HTTP Error: %s" % e
|
257
|
-
|
258
|
-
# API errors.
|
259
|
-
rescue AdwordsApi::Errors::ApiException => e
|
260
|
-
puts "Message: %s" % e.message
|
261
|
-
puts 'Errors:'
|
262
|
-
e.errors.each_with_index do |error, index|
|
263
|
-
puts "\tError [%d]:" % (index + 1)
|
264
|
-
error.each do |field, value|
|
265
|
-
puts "\t\t%s: %s" % [field, value]
|
266
|
-
end
|
267
|
-
end
|
268
|
-
end
|
269
|
-
end
|
@@ -1,133 +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 restricts the products that will be included in the campaign by
|
22
|
-
# setting a ProductScope.
|
23
|
-
#
|
24
|
-
# Tags: CampaignCriterionService.mutate
|
25
|
-
|
26
|
-
require 'adwords_api'
|
27
|
-
|
28
|
-
def add_product_scope(campaign_id)
|
29
|
-
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
30
|
-
# when called without parameters.
|
31
|
-
adwords = AdwordsApi::Api.new
|
32
|
-
|
33
|
-
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
34
|
-
# the configuration file or provide your own logger:
|
35
|
-
# adwords.logger = Logger.new('adwords_xml.log')
|
36
|
-
|
37
|
-
campaign_criterion_srv = adwords.service(:CampaignCriterionService,
|
38
|
-
API_VERSION)
|
39
|
-
|
40
|
-
product_scope = {
|
41
|
-
# This set of dimensions is for demonstration purposes only. It is
|
42
|
-
# extremely unlikely that you want to include so many dimensions in your
|
43
|
-
# product scope.
|
44
|
-
:dimensions => [
|
45
|
-
{
|
46
|
-
:xsi_type => 'ProductBrand',
|
47
|
-
:value => 'Nexus'
|
48
|
-
},
|
49
|
-
{
|
50
|
-
:xsi_type => 'ProductCanonicalCondition',
|
51
|
-
:value => 'NEW'
|
52
|
-
},
|
53
|
-
{
|
54
|
-
:xsi_type => 'ProductCustomAttribute',
|
55
|
-
:type => 'CUSTOM_ATTRIBUTE_0',
|
56
|
-
:value => 'my attribute value'
|
57
|
-
},
|
58
|
-
{
|
59
|
-
:xsi_type => 'ProductOfferId',
|
60
|
-
:value => 'book1'
|
61
|
-
},
|
62
|
-
{
|
63
|
-
:xsi_type => 'ProductType',
|
64
|
-
:type => 'PRODUCT_TYPE_L1',
|
65
|
-
:value => 'Media'
|
66
|
-
},
|
67
|
-
{
|
68
|
-
:xsi_type => 'ProductType',
|
69
|
-
:type => 'PRODUCT_TYPE_L2',
|
70
|
-
:value => 'Books'
|
71
|
-
},
|
72
|
-
# The value for the bidding category is a fixed ID for the
|
73
|
-
# 'Luggage & Bags' category. You can retrieve IDs for categories from
|
74
|
-
# the ConstantDataService. See the 'get_product_category_taxonomy'
|
75
|
-
# example for more details.
|
76
|
-
{
|
77
|
-
:xsi_type => 'ProductBiddingCategory',
|
78
|
-
:type => 'BIDDING_CATEGORY_L1',
|
79
|
-
:value => '-5914235892932915235',
|
80
|
-
}
|
81
|
-
]
|
82
|
-
}
|
83
|
-
|
84
|
-
campaign_criterion = {
|
85
|
-
:campaign_id => campaign_id,
|
86
|
-
:product_scope => product_scope
|
87
|
-
}
|
88
|
-
|
89
|
-
campaign_criterion_operation = {
|
90
|
-
:operator => 'ADD',
|
91
|
-
:operand => campaign_criterion
|
92
|
-
}
|
93
|
-
|
94
|
-
# Make the mutate request.
|
95
|
-
result = campaign_criterion_srv.mutate([campaign_criterion_operation])
|
96
|
-
|
97
|
-
campaign_criterion = result[:value].first
|
98
|
-
puts "Created a ProductScope criterion with ID %d." %
|
99
|
-
[campaign_criterion[:criterion][:id]]
|
100
|
-
end
|
101
|
-
|
102
|
-
if __FILE__ == $0
|
103
|
-
API_VERSION = :v201402
|
104
|
-
|
105
|
-
begin
|
106
|
-
campaign_id = 'INSERT_CAMPAIGN_ID_HERE'.to_i
|
107
|
-
|
108
|
-
add_product_scope(campaign_id)
|
109
|
-
|
110
|
-
# Authorization error.
|
111
|
-
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
112
|
-
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
113
|
-
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
114
|
-
"to retrieve and store OAuth2 tokens."
|
115
|
-
puts "See this wiki page for more details:\n\n " +
|
116
|
-
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
117
|
-
|
118
|
-
# HTTP errors.
|
119
|
-
rescue AdsCommon::Errors::HttpError => e
|
120
|
-
puts "HTTP Error: %s" % e
|
121
|
-
|
122
|
-
# API errors.
|
123
|
-
rescue AdwordsApi::Errors::ApiException => e
|
124
|
-
puts "Message: %s" % e.message
|
125
|
-
puts 'Errors:'
|
126
|
-
e.errors.each_with_index do |error, index|
|
127
|
-
puts "\tError [%d]:" % (index + 1)
|
128
|
-
error.each do |field, value|
|
129
|
-
puts "\t\t%s: %s" % [field, value]
|
130
|
-
end
|
131
|
-
end
|
132
|
-
end
|
133
|
-
end
|
@@ -1,135 +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 Shopping campaign.
|
22
|
-
#
|
23
|
-
# Tags: CampaignService.mutate, AdGroupService.mutate, AdGroupAdService.mutate
|
24
|
-
|
25
|
-
require 'adwords_api'
|
26
|
-
require 'date'
|
27
|
-
|
28
|
-
def add_shopping_campaign(budget_id, merchant_id)
|
29
|
-
# AdwordsApi::Api will read a config file from ENV['HOME']/adwords_api.yml
|
30
|
-
# when called without parameters.
|
31
|
-
adwords = AdwordsApi::Api.new
|
32
|
-
|
33
|
-
# To enable logging of SOAP requests, set the log_level value to 'DEBUG' in
|
34
|
-
# the configuration file or provide your own logger:
|
35
|
-
# adwords.logger = Logger.new('adwords_xml.log')
|
36
|
-
|
37
|
-
campaign_srv = adwords.service(:CampaignService, API_VERSION)
|
38
|
-
ad_group_srv = adwords.service(:AdGroupService, API_VERSION)
|
39
|
-
ad_group_ad_srv = adwords.service(:AdGroupAdService, API_VERSION)
|
40
|
-
|
41
|
-
# Create campaign.
|
42
|
-
campaign = {
|
43
|
-
:name => "Shopping campaign #%d" % (Time.new.to_f * 1000).to_i,
|
44
|
-
# The advertising_channel_type is what makes this a Shopping campaign.
|
45
|
-
:advertising_channel_type => 'SHOPPING',
|
46
|
-
:budget => {:budget_id => budget_id},
|
47
|
-
:bidding_strategy_configuration => {
|
48
|
-
:bidding_strategy_type => 'MANUAL_CPC'
|
49
|
-
},
|
50
|
-
:settings => [
|
51
|
-
{
|
52
|
-
:xsi_type => 'KeywordMatchSetting',
|
53
|
-
:opt_in => false
|
54
|
-
},
|
55
|
-
{
|
56
|
-
:xsi_type => 'ShoppingSetting',
|
57
|
-
:sales_country => 'US',
|
58
|
-
:campaign_priority => 0,
|
59
|
-
:merchant_id => merchant_id
|
60
|
-
}
|
61
|
-
]
|
62
|
-
}
|
63
|
-
campaign_operation = {:operator => 'ADD', :operand => campaign}
|
64
|
-
|
65
|
-
# Make the mutate request.
|
66
|
-
result = campaign_srv.mutate([campaign_operation])
|
67
|
-
|
68
|
-
# Print the result.
|
69
|
-
campaign = result[:value].first
|
70
|
-
puts "Campaign with name '%s' and ID %d was added." %
|
71
|
-
[campaign[:name], campaign[:id]]
|
72
|
-
|
73
|
-
# Create ad group.
|
74
|
-
ad_group = {
|
75
|
-
:campaign_id => campaign[:id],
|
76
|
-
:name => 'Ad Group #%d' % (Time.new.to_f * 1000).to_i
|
77
|
-
}
|
78
|
-
ad_group_operation = {:operator => 'ADD', :operand => ad_group}
|
79
|
-
|
80
|
-
# Make the mutate request.
|
81
|
-
result = ad_group_srv.mutate([ad_group_operation])
|
82
|
-
|
83
|
-
# Print the result.
|
84
|
-
ad_group = result[:value].first
|
85
|
-
puts "Ad group with name '%s' and ID %d was added." %
|
86
|
-
[ad_group[:name], ad_group[:id]]
|
87
|
-
|
88
|
-
# Create product ad.
|
89
|
-
ad_group_ad = {
|
90
|
-
:ad_group_id => ad_group[:id],
|
91
|
-
:ad => {:xsi_type => 'ProductAd'}
|
92
|
-
}
|
93
|
-
ad_group_operation = {:operator => 'ADD', :operand => ad_group_ad}
|
94
|
-
|
95
|
-
# Make the mutate request.
|
96
|
-
result = ad_group_ad_srv.mutate([ad_group_operation])
|
97
|
-
|
98
|
-
# Print the result.
|
99
|
-
ad_group_ad = result[:value].first
|
100
|
-
puts "Product ad with ID %d was added." % [ad_group_ad[:id]]
|
101
|
-
end
|
102
|
-
|
103
|
-
if __FILE__ == $0
|
104
|
-
API_VERSION = :v201402
|
105
|
-
|
106
|
-
begin
|
107
|
-
budget_id = 'INSERT_BUDGET_ID_HERE'.to_i
|
108
|
-
merchant_id = 'INSERT_MERCHANT_ID_HERE'.to_i
|
109
|
-
|
110
|
-
add_shopping_campaign(budget_id, merchant_id)
|
111
|
-
|
112
|
-
# Authorization error.
|
113
|
-
rescue AdsCommon::Errors::OAuth2VerificationRequired => e
|
114
|
-
puts "Authorization credentials are not valid. Edit adwords_api.yml for " +
|
115
|
-
"OAuth2 client ID and secret and run misc/setup_oauth2.rb example " +
|
116
|
-
"to retrieve and store OAuth2 tokens."
|
117
|
-
puts "See this wiki page for more details:\n\n " +
|
118
|
-
'http://code.google.com/p/google-api-ads-ruby/wiki/OAuth2'
|
119
|
-
|
120
|
-
# HTTP errors.
|
121
|
-
rescue AdsCommon::Errors::HttpError => e
|
122
|
-
puts "HTTP Error: %s" % e
|
123
|
-
|
124
|
-
# API errors.
|
125
|
-
rescue AdwordsApi::Errors::ApiException => e
|
126
|
-
puts "Message: %s" % e.message
|
127
|
-
puts 'Errors:'
|
128
|
-
e.errors.each_with_index do |error, index|
|
129
|
-
puts "\tError [%d]:" % (index + 1)
|
130
|
-
error.each do |field, value|
|
131
|
-
puts "\t\t%s: %s" % [field, value]
|
132
|
-
end
|
133
|
-
end
|
134
|
-
end
|
135
|
-
end
|