-
Notifications
You must be signed in to change notification settings - Fork 66
/
add_complete_campaigns_using_batch_job.rb
379 lines (331 loc) · 12.6 KB
/
add_complete_campaigns_using_batch_job.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
#!/usr/bin/env ruby
# Encoding: utf-8
#
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# This example adds complete campaigns including campaign budgets, campaigns,
# ad groups and keywords using BatchJobService.
require 'optparse'
require 'google/ads/google_ads'
def add_complete_campaigns_using_batch_job(customer_id)
# GoogleAdsClient will read a config file from
# ENV['HOME']/google_ads_config.rb when called without parameters
client = Google::Ads::GoogleAds::GoogleAdsClient.new
batch_job_service = client.service.batch_job
batch_job_resource_name = create_batch_job(
client,
batch_job_service,
customer_id,
)
add_all_batch_job_operations(
client,
batch_job_service,
customer_id,
batch_job_resource_name,
)
operation_response = run_batch_job(
batch_job_service,
batch_job_resource_name,
)
poll_batch_job(operation_response)
fetch_and_print_results(batch_job_service, batch_job_resource_name)
end
# Creates a new batch job for the specified customer ID.
# [START add_complete_campaigns_using_batch_job]
def create_batch_job(client, batch_job_service, customer_id)
# Creates a batch job operation to create a new batch job.
operation = client.operation.create_resource.batch_job
# Issues a request to the API and get the batch job's resource name.
response = batch_job_service.mutate_batch_job(
customer_id: customer_id,
operation: operation
)
batch_job_resource_name = response.result.resource_name
puts "Created a batch job with resource name: '#{batch_job_resource_name}'"
batch_job_resource_name
end
# [END add_complete_campaigns_using_batch_job]
# Adds all batch job operations to the batch job. As this is the first time
# for this batch job, pass null as a sequence token. The response will contain
# the next sequence token that you can use to upload more operations in the
# future.
# [START add_complete_campaigns_using_batch_job_1]
def add_all_batch_job_operations(
client,
batch_job_service,
customer_id,
batch_job_resource_name)
response = batch_job_service.add_batch_job_operations(
resource_name: batch_job_resource_name,
mutate_operations: build_all_operations(client, customer_id),
)
puts "#{response.total_operations} mutate operations have been added so far."
# You can use this next sequence token for calling
# add_all_batch_job_operations() next time
puts "Next sequence token for adding next operations is " \
"'#{response.next_sequence_token}'"
end
# [END add_complete_campaigns_using_batch_job_1]
# Requests the API to run the batch job for executing all uploaded batch job
# operations.
# [START add_complete_campaigns_using_batch_job_2]
def run_batch_job(batch_job_service, batch_job_resource_name)
operation_response = batch_job_service.run_batch_job(
resource_name: batch_job_resource_name,
)
puts "Batch job with resource name '#{batch_job_resource_name}' " \
"has been executed."
operation_response
end
# [END add_complete_campaigns_using_batch_job_2]
# Polls the server until the batch job execution finishes by setting the initial
# poll delay time and the total time to wait before time-out.
# [START add_complete_campaigns_using_batch_job_3]
def poll_batch_job(operation_response)
operation_response.wait_until_done!
end
# [END add_complete_campaigns_using_batch_job_3]
# Prints all the results from running the batch job.
# [START add_complete_campaigns_using_batch_job_4]
def fetch_and_print_results(batch_job_service, batch_job_resource_name)
puts "Batch job with resource name '#{batch_job_resource_name}' has " \
"finished. Now, printing its results..." \
# Gets all the results from running batch job and print their information.
batch_job_results = batch_job_service.list_batch_job_results(
resource_name: batch_job_resource_name,
page_size: PAGE_SIZE,
)
batch_job_results.each do |result|
puts "Batch job ##{result.operation_index} has a status " \
"#{result.status ? result.status.message : 'N/A'} and response of type " \
"#{result.mutate_operation_response ? result.mutate_operation_response.response : 'N/A'}"
end
end
# [END add_complete_campaigns_using_batch_job_4]
# Builds all operations for creating a complete campaign and return an array of
# their corresponding mutate operations.
def build_all_operations(client, customer_id)
mutate_operations = []
# Creates a new campaign budget operation and add it to the array of mutate
# operations.
campaign_budget_operation = build_campaign_budget_operation(client, customer_id)
mutate_operations << client.operation.mutate do |mutate_op|
mutate_op.campaign_budget_operation = campaign_budget_operation
end
# Creates new campaign operations and adds them to the array of mutate
# operations.
campaign_operations = build_campaign_operations(
client, customer_id, campaign_budget_operation.create.resource_name)
campaign_operations.each do |op|
mutate_operations << client.operation.mutate do |mutate_op|
mutate_op.campaign_operation = op
end
end
# Creates new campaign criterion operations and adds them to the array of
# mutate operations.
campaign_criterion_operations = build_campaign_criterion_operations(
client, campaign_operations)
campaign_criterion_operations.each do |op|
mutate_operations << client.operation.mutate do |mutate_op|
mutate_op.campaign_criterion_operation = op
end
end
# Creates new ad group operations and adds them to the array of mutate
# operations.
ad_group_operations = build_ad_group_operations(
client, customer_id, campaign_operations)
ad_group_operations.each do |op|
mutate_operations << client.operation.mutate do |mutate_op|
mutate_op.ad_group_operation = op
end
end
# Creates new ad group criterion operations and adds them to the array of
# mutate operations.
ad_group_criterion_operations = build_ad_group_criterion_operations(
client, ad_group_operations)
ad_group_criterion_operations.each do |op|
mutate_operations << client.operation.mutate do |mutate_op|
mutate_op.ad_group_criterion_operation = op
end
end
# Creates new ad group ad operations and adds them to the array of mutate
# operations.
ad_group_ad_operations = build_ad_group_ad_operations(
client, ad_group_operations)
ad_group_ad_operations.each do |op|
mutate_operations << client.operation.mutate do |mutate_op|
mutate_op.ad_group_ad_operation = op
end
end
mutate_operations
end
# Builds a new campaign budget operation for the specified customer ID.
def build_campaign_budget_operation(client, customer_id)
# Creates a campaign budget operation.
operation = client.operation.create_resource.campaign_budget do |b|
# Creates a resource name using the temporary ID.
b.resource_name = client.path.campaign_budget(
customer_id, get_next_temporary_id)
b.name = "Interplanetary Cruise Budget ##{(Time.new.to_f * 1000).to_i}"
b.delivery_method = :STANDARD
b.amount_micros = 5_000_000
end
operation
end
# Builds new campaign operations for the specified customer ID.
def build_campaign_operations(client, customer_id, campaign_budget_resource_name)
operations = []
for i in 0..NUMBER_OF_CAMPAIGNS_TO_ADD-1
# Creates a campaign.
campaign_id = get_next_temporary_id
operations << client.operation.create_resource.campaign do |c|
c.resource_name = client.path.campaign(customer_id, campaign_id)
c.name = "Mutate job campaign ##{(Time.new.to_f * 1000).to_i}.#{campaign_id}"
c.advertising_channel_type = :SEARCH
# Recommendation: Set the campaign to PAUSED when creating it to prevent
# the ads from immediately serving. Set to ENABLED once you've added
# targeting and the ads are ready to serve.
c.status = :PAUSED
# Sets the bidding strategy and budget.
c.manual_cpc = client.resource.manual_cpc
c.campaign_budget = campaign_budget_resource_name
end
end
operations
end
# Builds new campaign criterion operations for creating negative campaign
# criteria (as keywords).
def build_campaign_criterion_operations(client, campaign_operations)
operations = []
campaign_operations.each do |op|
operations << client.operation.create_resource.campaign_criterion do |cc|
cc.keyword = client.resource.keyword_info do |k|
k.text = "venus"
k.match_type = :BROAD
end
cc.negative = true
cc.campaign = op.create.resource_name
end
end
operations
end
# Builds new ad group operations for the specified customer ID.
def build_ad_group_operations(client, customer_id, campaign_operations)
operations = []
campaign_operations.each do |op|
for i in 0..NUMBER_OF_AD_GROUPS_TO_ADD-1
# Creates an ad group.
ad_group_id = get_next_temporary_id
operations << client.operation.create_resource.ad_group do |ag|
# Creates a resource name using the temporary ID.
ag.resource_name = client.path.ad_group(customer_id, ad_group_id)
ag.name = "Mutate job ad group ##{(Time.new.to_f * 1000).to_i}.#{ad_group_id}"
ag.campaign = op.create.resource_name
ag.type = :SEARCH_STANDARD
ag.cpc_bid_micros = 10_000_000
end
end
end
operations
end
# Builds new ad group criterion operations for creating keywords. 50% of
# keywords are created with some invalid characters to demonstrate how
# BatchJobService returns information about such errors.
def build_ad_group_criterion_operations(client, ad_group_operations)
operations = []
ad_group_operations.each do |op|
for i in 0..NUMBER_OF_KEYWORDS_TO_ADD-1
# Create a keyword text by making 50% of keywords invalid to demonstrate
# error handling.
keyword_text = "mars#{i}"
if i % 2 == 0
keyword_text += "!!!"
end
# Creates an ad group criterion using the created keyword text.
operations << client.operation.create_resource.ad_group_criterion do |agc|
agc.keyword = client.resource.keyword_info do |k|
k.text = keyword_text
k.match_type = :BROAD
end
agc.ad_group = op.create.resource_name
agc.status = :ENABLED
end
end
end
operations
end
# Builds new ad group ad operations.
def build_ad_group_ad_operations(client, ad_group_operations)
operations = []
ad_group_operations.each do |op|
operations << client.operation.create_resource.ad_group_ad do |aga|
aga.ad = client.resource.ad do |ad|
ad.expanded_text_ad = client.resource.expanded_text_ad_info do |eta|
eta.headline_part1 = "Cruise to Mars ##{(Time.new.to_f * 1000).to_i}"
eta.headline_part2 = "Best Space Cruise Line"
eta.description = "Buy your tickets now!"
end
ad.final_urls << "http://www.example.com"
end
aga.ad_group = op.create.resource_name
aga.status = :PAUSED
end
end
operations
end
# Returns the next temporary ID and decrease it by one.
def get_next_temporary_id
@temporary_id ||= 0
@temporary_id -= 1
end
if __FILE__ == $0
NUMBER_OF_CAMPAIGNS_TO_ADD = 2;
NUMBER_OF_AD_GROUPS_TO_ADD = 2;
NUMBER_OF_KEYWORDS_TO_ADD = 4;
PAGE_SIZE = 1000
options = {}
OptionParser.new do |opts|
opts.banner = sprintf('Usage: %s [options]', File.basename(__FILE__))
opts.separator ''
opts.separator 'Options:'
opts.on('-C', '--customer-id CUSTOMER-ID', String, 'Customer ID') do |v|
options[:customer_id] = v
end
opts.separator ''
opts.separator 'Help:'
opts.on_tail('-h', '--help', 'Show this message') do
puts opts
exit
end
end.parse!
begin
add_complete_campaigns_using_batch_job(
options.fetch(:customer_id).tr("-", ""))
rescue Google::Ads::GoogleAds::Errors::GoogleAdsError => e
e.failure.errors.each do |error|
STDERR.printf("Error with message: %s\n", error.message)
if error.location
error.location.field_path_elements.each do |field_path_element|
STDERR.printf("\tOn field: %s\n", field_path_element.field_name)
end
end
error.error_code.to_h.each do |k, v|
next if v == :UNSPECIFIED
STDERR.printf("\tType: %s\n\tCode: %s\n", k, v)
end
end
raise
end
end