-
Notifications
You must be signed in to change notification settings - Fork 95
/
AddCompleteCampaignsUsingBatchJob.cs
590 lines (533 loc) · 25.2 KB
/
AddCompleteCampaignsUsingBatchJob.cs
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
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
// 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
//
// http://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.
using Google.Ads.GoogleAds.Lib;
using Google.Ads.GoogleAds.V6.Common;
using Google.Ads.GoogleAds.V6.Errors;
using Google.Ads.GoogleAds.V6.Resources;
using Google.Ads.GoogleAds.V6.Services;
using Google.Api.Gax;
using Google.LongRunning;
using Google.Protobuf.WellKnownTypes;
using System;
using System.Collections.Generic;
using static Google.Ads.GoogleAds.V6.Enums.AdGroupAdStatusEnum.Types;
using static Google.Ads.GoogleAds.V6.Enums.AdGroupCriterionStatusEnum.Types;
using static Google.Ads.GoogleAds.V6.Enums.AdGroupTypeEnum.Types;
using static Google.Ads.GoogleAds.V6.Enums.AdvertisingChannelTypeEnum.Types;
using static Google.Ads.GoogleAds.V6.Enums.BudgetDeliveryMethodEnum.Types;
using static Google.Ads.GoogleAds.V6.Enums.CampaignStatusEnum.Types;
using static Google.Ads.GoogleAds.V6.Enums.KeywordMatchTypeEnum.Types;
using static Google.Ads.GoogleAds.V6.Resources.BatchJob.Types;
namespace Google.Ads.GoogleAds.Examples.V6
{
/// <summary>
/// This code example adds complete campaigns including campaign budgets, campaigns, ad groups
/// and keywords using BatchJobService.
/// </summary>
public class AddCompleteCampaignsUsingBatchJob : ExampleBase
{
/// <summary>
/// The number of campaigns to add.
/// </summary>
private const int NUMBER_OF_CAMPAIGNS_TO_ADD = 2;
/// <summary>
/// The number of ad groups per campaign to add.
/// </summary>
private const int NUMBER_OF_AD_GROUPS_TO_ADD = 2;
/// <summary>
/// The number of keywords per ad group to add.
/// </summary>
private const int NUMBER_OF_KEYWORDS_TO_ADD = 4;
/// <summary>
/// The maximum total poll interval in seconds.
/// </summary>
private const int MAX_TOTAL_POLL_INTERVAL_SECONDS = 60;
/// <summary>
/// The page size for retrieving results.
/// </summary>
private const int PAGE_SIZE = 1000;
/// <summary>
/// The negative temporary ID used in batch job operations.
/// </summary>
private static long temporaryId = -1;
/// <summary>
/// Main method, to run this code example as a standalone application.
/// </summary>
/// <param name="args">The command line arguments.</param>
public static void Main(string[] args)
{
AddCompleteCampaignsUsingBatchJob codeExample =
new AddCompleteCampaignsUsingBatchJob();
Console.WriteLine(codeExample.Description);
// The Google Ads customer ID for which the call is made.
long customerId = long.Parse("INSERT_CUSTOMER_ID_HERE");
codeExample.Run(new GoogleAdsClient(), customerId);
}
/// <summary>
/// Returns a description about the code example.
/// </summary>
public override string Description =>
"This code example adds complete campaigns including campaign budgets, campaigns, ad " +
"groups and keywords using BatchJobService.";
/// <summary>
/// Runs the code example.
/// </summary>
/// <param name="client">The Google Ads client.</param>
/// <param name="customerId">The Google Ads customer ID for which the call is made.</param>
public void Run(GoogleAdsClient client, long customerId)
{
// Gets the BatchJobService.
BatchJobServiceClient batchJobService =
client.GetService(Services.V6.BatchJobService);
try
{
string batchJobResourceName = CreateBatchJob(batchJobService, customerId);
AddAllBatchJobOperations(batchJobService, customerId, batchJobResourceName);
Operation<Empty, BatchJobMetadata> operationResponse =
RunBatchJob(batchJobService, batchJobResourceName);
PollBatchJob(operationResponse);
FetchAndPrintResults(batchJobService, batchJobResourceName);
}
catch (GoogleAdsException e)
{
Console.WriteLine("Failure:");
Console.WriteLine($"Message: {e.Message}");
Console.WriteLine($"Failure: {e.Failure}");
Console.WriteLine($"Request ID: {e.RequestId}");
throw;
}
}
/// <summary>
/// Creates the batch job.
/// </summary>
/// <param name="batchJobService">The batch job service.</param>
/// <param name="customerId">The Google Ads customer ID for which the call is made.</param>
/// <returns>The resource name of the created batch job.</returns>
// [START AddCompleteCampaignsUsingBatchJob]
private static string CreateBatchJob(BatchJobServiceClient batchJobService,
long customerId)
{
BatchJobOperation operation = new BatchJobOperation()
{
Create = new BatchJob()
{
}
};
string batchJobResourceName =
batchJobService.MutateBatchJob(customerId.ToString(), operation).Result.ResourceName;
Console.WriteLine($"Created a batch job with resource name: " +
$"'{batchJobResourceName}'.");
return batchJobResourceName;
}
// [END AddCompleteCampaignsUsingBatchJob]
/// <summary>
/// Adds all batch job operations to the batch job. As this is the first time for this
/// batch job, the sequence token is not set. The response will contain the next sequence
/// token that you can use to upload more operations in the future.
/// </summary>
/// <param name="batchJobService">The batch job service.</param>
/// <param name="customerId">The Google Ads customer ID for which the call is made.</param>
/// <param name="batchJobResourceName">The resource name of batch job to which the batch
/// job operations will be added.
/// </param>
// [START AddCompleteCampaignsUsingBatchJob_1]
private static void AddAllBatchJobOperations(BatchJobServiceClient batchJobService,
long customerId, string batchJobResourceName)
{
AddBatchJobOperationsResponse response =
batchJobService.AddBatchJobOperations(
new AddBatchJobOperationsRequest()
{
ResourceName = batchJobResourceName,
MutateOperations = { BuildAllOperations(customerId) }
});
Console.WriteLine($"{response.TotalOperations} mutate operations have been added" +
$" so far.");
// You can use this next sequence token for calling AddBatchJobOperations() next time.
Console.WriteLine($"Next sequence token for adding next operations is " +
$"'{response.NextSequenceToken}'.");
}
// [END AddCompleteCampaignsUsingBatchJob_1]
/// <summary>
/// Requests the API to run the batch job for executing all uploaded batch job
/// operations.
/// </summary>
/// <param name="batchJobService">The batch job service client.</param>
/// <param name="batchJobResourceName">The resource name of batch job to be run.</param>
/// <returns>The operation response from running batch job.</returns>
// [START AddCompleteCampaignsUsingBatchJob_2]
private Operation<Empty, BatchJobMetadata> RunBatchJob(
BatchJobServiceClient batchJobService, string batchJobResourceName)
{
Operation<Empty, BatchJobMetadata> operationResponse =
batchJobService.RunBatchJob(batchJobResourceName);
Console.WriteLine($"Batch job with resource name '{batchJobResourceName}' has been " +
$"executed.");
return operationResponse;
}
// [END AddCompleteCampaignsUsingBatchJob_2]
/// <summary>
/// Polls the server until the batch job execution finishes by setting the total
/// time to wait before time-out.
/// </summary>
/// <param name="operationResponse">The operation response used to poll the server.</param>
// [START AddCompleteCampaignsUsingBatchJob_3]
private static void PollBatchJob(Operation<Empty, BatchJobMetadata> operationResponse)
{
PollSettings pollSettings = new PollSettings(
Expiration.FromTimeout(TimeSpan.FromSeconds(MAX_TOTAL_POLL_INTERVAL_SECONDS)),
TimeSpan.FromSeconds(1));
operationResponse.PollUntilCompleted(pollSettings);
}
// [END AddCompleteCampaignsUsingBatchJob_3]
/// <summary>
/// Fetches and prints all the results from running the batch job.
/// </summary>
/// <param name="batchJobService">The batch job service.</param>
/// <param name="batchJobResourceName">The resource name of batch job to get its results.</param>
// [START AddCompleteCampaignsUsingBatchJob_4]
private static void FetchAndPrintResults(BatchJobServiceClient batchJobService,
string batchJobResourceName)
{
Console.WriteLine($"batch job with resource name '{batchJobResourceName}' has " +
$"finished. Now, printing its results...");
ListBatchJobResultsRequest request = new ListBatchJobResultsRequest()
{
ResourceName = batchJobResourceName,
PageSize = PAGE_SIZE,
};
ListBatchJobResultsResponse resp = new ListBatchJobResultsResponse();
// Gets all the results from running batch job and prints their information.
foreach (BatchJobResult batchJobResult in
batchJobService.ListBatchJobResults(request))
{
if (!batchJobResult.IsFailed)
{
Console.WriteLine($"batch job result #{batchJobResult.OperationIndex} is " +
$"successful and response is of type " +
$"'{batchJobResult.MutateOperationResponse.ResponseCase}'.");
}
else
{
Console.WriteLine($"batch job result #{batchJobResult.OperationIndex} " +
$"failed with error message {batchJobResult.Status.Message}.");
foreach (GoogleAdsError error in batchJobResult.Failure.Errors)
{
Console.WriteLine($"Error found: {error}.");
}
}
}
}
// [END AddCompleteCampaignsUsingBatchJob_4]
/// <summary>
/// Builds all operations for creating a complete campaign and return an array of
/// their corresponding mutate operations.
/// </summary>
/// <param name="customerId">The Google Ads customer ID for which the call is made.</param>
/// <returns>The mutate operations to be added to a batch job.</returns>
private static List<MutateOperation> BuildAllOperations(long customerId)
{
List<MutateOperation> mutateOperations = new List<MutateOperation>();
// Creates a new campaign budget operation and adds it to the array of mutate operations.
CampaignBudgetOperation campaignBudgetOperation = BuildCampaignBudgetOperation(customerId);
mutateOperations.Add(
new MutateOperation()
{
CampaignBudgetOperation = campaignBudgetOperation
}
);
// Creates new campaign operations and adds them to the array of mutate operations.
List<CampaignOperation> campaignOperations =
BuildCampaignOperations(customerId, campaignBudgetOperation.Create.ResourceName);
foreach (CampaignOperation campaignOperation in campaignOperations)
{
mutateOperations.Add(
new MutateOperation()
{
CampaignOperation = campaignOperation
}
);
}
// Creates new campaign criterion operations and adds them to the array of mutate operations.
List<CampaignCriterionOperation> campaignCriterionOperations =
BuildCampaignCriterionOperations(campaignOperations);
foreach (CampaignCriterionOperation campaignCriterionOperation in
campaignCriterionOperations)
{
mutateOperations.Add(
new MutateOperation()
{
CampaignCriterionOperation = campaignCriterionOperation
}
);
}
// Creates new ad group operations and adds them to the array of mutate operations.
List<AdGroupOperation> adGroupOperations = BuildAdGroupOperations(customerId,
campaignOperations);
foreach (AdGroupOperation adGroupOperation in adGroupOperations)
{
mutateOperations.Add(
new MutateOperation()
{
AdGroupOperation = adGroupOperation
}
);
}
// Creates new ad group criterion operations and adds them to the array of mutate operations.
List<AdGroupCriterionOperation> adGroupCriterionOperations =
BuildAdGroupCriterionOperations(adGroupOperations);
foreach (AdGroupCriterionOperation adGroupCriterionOperation in adGroupCriterionOperations)
{
mutateOperations.Add(
new MutateOperation()
{
AdGroupCriterionOperation = adGroupCriterionOperation
}
);
}
// Creates new ad group ad operations and adds them to the array of mutate operations.
List<AdGroupAdOperation> adGroupAdOperations = BuildAdGroupAdOperations(adGroupOperations);
foreach (AdGroupAdOperation adGroupAdOperation in adGroupAdOperations)
{
mutateOperations.Add(
new MutateOperation()
{
AdGroupAdOperation = adGroupAdOperation
}
);
}
return mutateOperations;
}
/// <summary>
/// Builds a new campaign budget operation for the specified customer ID.
/// </summary>
/// <param name="customerId">The Google Ads customer ID for which the call is made.</param>
/// <returns>The campaign budget operation.</returns>
private static CampaignBudgetOperation BuildCampaignBudgetOperation(long customerId)
{
// Creates a campaign budget.
CampaignBudget budget = new CampaignBudget()
{
ResourceName = ResourceNames.CampaignBudget(customerId, GetNextTemporaryId()),
Name = "batch job Budget #" + ExampleUtilities.GetRandomString(),
DeliveryMethod = BudgetDeliveryMethod.Standard,
AmountMicros = 5_000_000
};
// Creates a campaign budget operation.
return new CampaignBudgetOperation()
{
Create = budget
};
}
/// <summary>
/// Builds new campaign operations for the specified customer ID.
/// </summary>
/// <param name="customerId">The Google Ads customer ID for which the call is made.</param>
/// <param name="campaignBudgetResourceName">The resource name of campaign budget to be
/// used to create campaigns.</param>
/// <returns>The campaign operations.</returns>
private static List<CampaignOperation> BuildCampaignOperations(long customerId,
string campaignBudgetResourceName)
{
List<CampaignOperation> operations = new List<CampaignOperation>();
for (int i = 0; i < NUMBER_OF_CAMPAIGNS_TO_ADD; i++)
{
// Creates a campaign.
long campaignId = GetNextTemporaryId();
Campaign campaign = new Campaign()
{
ResourceName = ResourceNames.Campaign(customerId, campaignId),
Name = "batch job campaign #" + ExampleUtilities.GetRandomString(),
AdvertisingChannelType = AdvertisingChannelType.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.
Status = CampaignStatus.Paused,
// Sets the bidding strategy and budget.
ManualCpc = new ManualCpc(),
CampaignBudget = campaignBudgetResourceName
};
// Creates a campaign operation and adds it to the operations list.
CampaignOperation op = new CampaignOperation()
{
Create = campaign
};
operations.Add(op);
}
return operations;
}
/// <summary>
/// Builds new campaign criterion operations for creating negative campaign criteria
/// (as keywords).
/// </summary>
/// <param name="campaignOperations">The campaign operations to be used to create
/// campaign criteria.</param>
/// <returns>The campaign criterion operations.</returns>
private static List<CampaignCriterionOperation> BuildCampaignCriterionOperations(
List<CampaignOperation> campaignOperations)
{
List<CampaignCriterionOperation> operations =
new List<CampaignCriterionOperation>();
foreach (CampaignOperation campaignOperation in campaignOperations)
{
// Creates a campaign criterion.
CampaignCriterion campaignCriterion = new CampaignCriterion()
{
Keyword = new KeywordInfo()
{
Text = "venus",
MatchType = KeywordMatchType.Broad
},
// Sets the campaign criterion as a negative criterion.
Negative = true,
Campaign = campaignOperation.Create.ResourceName
};
// Creates a campaign criterion operation and adds it to the operations list.
CampaignCriterionOperation op = new CampaignCriterionOperation()
{
Create = campaignCriterion
};
operations.Add(op);
}
return operations;
}
/// <summary>
/// Builds new ad group operations for the specified customer ID.
/// </summary>
/// <param name="customerId">The Google Ads customer ID for which the call is made.</param>
/// <param name="campaignOperations">The campaign operations to be used to create ad
/// groups.</param>
/// <returns>The ad group operations.</returns>
private static List<AdGroupOperation> BuildAdGroupOperations(
long customerId, List<CampaignOperation> campaignOperations)
{
List<AdGroupOperation> operations = new List<AdGroupOperation>();
foreach (CampaignOperation campaignOperation in campaignOperations)
{
for (int i = 0; i < NUMBER_OF_AD_GROUPS_TO_ADD; i++)
{
// Creates an ad group.
long adGroupId = GetNextTemporaryId();
AdGroup adGroup = new AdGroup()
{
ResourceName = ResourceNames.AdGroup(customerId, adGroupId),
Name = "batch job ad group #" + ExampleUtilities.GetShortRandomString(),
Campaign = campaignOperation.Create.ResourceName,
Type = AdGroupType.SearchStandard,
CpcBidMicros = 10_000_000
};
// Creates an ad group operation and adds it to the operations list.
AdGroupOperation op = new AdGroupOperation()
{
Create = adGroup
};
operations.Add(op);
}
}
return operations;
}
/// <summary>
/// Builds new ad group criterion operations for creating keywords. 50% of keywords are
/// created some invalid characters to demonstrate how BatchJobService returns information
/// about such errors.
/// </summary>
/// <param name="adGroupOperations">The ad group operations to be used to create ad group
/// criteria.</param>
/// <returns>The ad group criterion operations.</returns>
private static List<AdGroupCriterionOperation> BuildAdGroupCriterionOperations(
List<AdGroupOperation> adGroupOperations)
{
List<AdGroupCriterionOperation> operations = new List<AdGroupCriterionOperation>();
foreach (AdGroupOperation adGroupOperation in adGroupOperations)
{
for (int i = 0; i < NUMBER_OF_KEYWORDS_TO_ADD; i++)
{
// Creates a keyword text by making 50% of keywords invalid to demonstrate
// error handling.
string keywordText = "mars" + i;
if (i % 2 == 0)
{
keywordText += "!!!";
}
// Creates an ad group criterion using the created keyword text.
AdGroupCriterion adGroupCriterion = new AdGroupCriterion()
{
Keyword = new KeywordInfo()
{
Text = keywordText,
MatchType = KeywordMatchType.Broad,
},
AdGroup = adGroupOperation.Create.ResourceName,
Status = AdGroupCriterionStatus.Paused
};
// Creates an ad group criterion operation and adds it to the operations list.
AdGroupCriterionOperation op = new AdGroupCriterionOperation()
{
Create = adGroupCriterion
};
operations.Add(op);
}
}
return operations;
}
/// <summary>
/// Builds the ad group ad operations.
/// </summary>
/// <param name="adGroupOperations">The ad group operations to be used to create ad
/// group ads.</param>
/// <returns>The ad group ad operations.</returns>
private static List<AdGroupAdOperation> BuildAdGroupAdOperations(
List<AdGroupOperation> adGroupOperations)
{
List<AdGroupAdOperation> operations = new List<AdGroupAdOperation>();
foreach (AdGroupOperation adGroupOperation in adGroupOperations)
{
// Creates an ad group ad.
AdGroupAd adGroupAd = new AdGroupAd()
{
Ad = new Ad
{
FinalUrls = { "http://www.example.com/" },
// Sets the expanded text ad info on an ad.
ExpandedTextAd = new ExpandedTextAdInfo
{
HeadlinePart1 = "Cruise #" + ExampleUtilities.GetShortRandomString() +
" to Mars",
HeadlinePart2 = "Best Space Cruise Line",
Description = "Buy your tickets now!",
},
},
AdGroup = adGroupOperation.Create.ResourceName,
// Optional: Set the status.
Status = AdGroupAdStatus.Paused,
};
// Creates an ad group ad operation and adds it to the operations list.
AdGroupAdOperation op = new AdGroupAdOperation()
{
Create = adGroupAd
};
operations.Add(op);
}
return operations;
}
/// <summary>
/// Returns the next temporary ID and decreases it by one.
/// </summary>
/// <returns>The next temporary ID.</returns>
private static long GetNextTemporaryId()
{
return temporaryId--;
}
}
}