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
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="displayvideo_v4.html">Display & Video 360 API</a> . <a href="displayvideo_v4.advertisers.html">advertisers</a> . <a href="displayvideo_v4.advertisers.adGroupAds.html">adGroupAds</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#get">get(advertiserId, adGroupAdId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an ad group ad.</p>
<p class="toc_element">
<code><a href="#list">list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists ad group ads.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(advertiserId, adGroupAdId, x__xgafv=None)</code>
<pre>Gets an ad group ad.
Args:
advertiserId: string, Required. The ID of the advertiser this ad group ad belongs to. (required)
adGroupAdId: string, Required. The ID of the ad group ad to fetch. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A single ad associated with an ad group.
"adGroupAdId": "A String", # The unique ID of the ad. Assigned by the system.
"adGroupId": "A String", # The unique ID of the ad group that the ad belongs to. *Caution*: Parent ad groups for Demand Gen ads are not currently retrieveable using `advertisers.adGroups.list` or `advertisers.adGroups.get`. Demand Gen ads can be identified by the absence of the `ad_details` union field.
"adPolicy": { # A single ad policy associated with an ad group ad. # The policy approval status of the ad.
"adPolicyApprovalStatus": "A String", # The policy approval status of an ad, indicating the approval decision.
"adPolicyReviewStatus": "A String", # The policy review status of an ad, indicating where in the review process the ad is currently.
"adPolicyTopicEntry": [ # The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues.
{ # An entry describing how an ad has been identified as relating to an ad policy.
"appealInfo": { # Information on how to appeal a policy decision. # Information on how to appeal the policy decision.
"appealFormLink": "A String", # Only available when appeal_type is `APPEAL_FORM`.
"appealType": "A String", # Whether the decision can be appealed through a self-service appeal or an appeal form.
},
"helpCenterLink": "A String", # Ad policy help center link for the policy topic.
"policyDecisionType": "A String", # The source of the policy decision.
"policyEnforcementMeans": "A String", # The policy enforcement means used in the policy review.
"policyLabel": "A String", # Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc.
"policyTopic": "A String", # The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc.
"policyTopicConstraints": [ # The serving constraints relevant to the policy decision.
{ # Details on ad serving constraints.
"certificateDomainMismatchCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the resource's domain is not covered by the certificates associated with it.
"countries": [ # Countries where the ad cannot serve.
{ # Represents a country restriction.
"countryCriterionId": "A String", # The country criterion id.
"countryLabel": "A String", # Localized name for the country. May be empty.
},
],
},
"certificateMissingCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where a certificate is required for serving.
"countries": [ # Countries where the ad cannot serve.
{ # Represents a country restriction.
"countryCriterionId": "A String", # The country criterion id.
"countryLabel": "A String", # Localized name for the country. May be empty.
},
],
},
"countryConstraint": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the ad cannot serve.
"countries": [ # Countries where the ad cannot serve.
{ # Represents a country restriction.
"countryCriterionId": "A String", # The country criterion id.
"countryLabel": "A String", # Localized name for the country. May be empty.
},
],
},
"globalCertificateDomainMismatch": { # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain.
},
"globalCertificateMissing": { # Certificate is required to serve in any country. # Certificate is required to serve in any country.
},
"requestCertificateFormLink": "A String", # Link to the form to request a certificate for the constraint.
"resellerConstraint": { # Policy topic was constrained due to disapproval of the website for reseller purposes. # Reseller constraint.
},
},
],
"policyTopicDescription": "A String", # A short summary description of the policy topic.
"policyTopicEvidences": [ # The evidence used in the policy decision.
{ # Evidence information used in the policy decision.
"counterfeit": { # Details on the counterfeit enforcement that caused a policy violation. # Counterfeit enforcement that caused a policy violation.
"owners": [ # The content or product owners that made a complaint.
"A String",
],
},
"destinationMismatch": { # Details on a mismatch between destination URL types. # A mismatch between the ad destination URLs.
"uriTypes": [ # The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch.
"A String",
],
},
"destinationNotWorking": { # Details for on HTTP or DNS errors related to the ad destination. # Information on HTTP or DNS errors related to the ad destination.
"device": "A String", # The device where visiting the URL resulted in the error.
"dnsErrorType": "A String", # The type of DNS error.
"expandedUri": "A String", # The full URL that didn't work.
"httpErrorCode": "A String", # The HTTP error code.
"lastCheckedTime": "A String", # The last time the error was seen when navigating to URL.
},
"destinationTextList": { # A list of destination text that violated the policy. # The text in the destination of the ad that is causing a policy violation.
"destinationTexts": [ # Destination text that caused the policy finding.
"A String",
],
},
"httpCode": 42, # HTTP code returned when the final URL was crawled.
"languageCode": "A String", # The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US".
"legalRemoval": { # Legal related regulation enforcement, either from DMCA or local legal regulation. # Legal related regulation enforcement that caused a policy violation.
"complaintType": "A String", # The type of complaint causing the legal removal.
"countryRestrictions": [ # The countries restricted due to the legal removal.
{ # Represents a country restriction.
"countryCriterionId": "A String", # The country criterion id.
"countryLabel": "A String", # Localized name for the country. May be empty.
},
],
"dmca": { # DMCA complaint details. # Details on the DMCA regulation legal removal.
"complainant": "A String", # The entity who made the legal complaint.
},
"localLegal": { # Local legal regulation details. # Details on the local legal regulation legal removal.
"lawType": "A String", # Type of law for the legal notice.
},
"restrictedUris": [ # The urls restricted due to the legal removal.
"A String",
],
},
"regionalRequirements": { # Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement. # T&S proactive enforcement that caused a policy violation.
"regionalRequirementsEntries": [ # List of regional requirements.
{ # Policy level regional legal violation details.
"countryRestrictions": [ # The countries restricted due to the legal policy.
{ # Represents a country restriction.
"countryCriterionId": "A String", # The country criterion id.
"countryLabel": "A String", # Localized name for the country. May be empty.
},
],
"legalPolicy": "A String", # The legal policy that is being violated.
},
],
},
"textList": { # A list of fragments of text that violated the policy. # List of evidence found in the text of the ad.
"texts": [ # The fragments of text from the resource that caused the policy finding.
"A String",
],
},
"trademark": { # Trademark terms that caused a policy violation. # Trademark terms that caused a policy violation.
"countryRestrictions": [ # Countries where the policy violation is relevant.
{ # Represents a country restriction.
"countryCriterionId": "A String", # The country criterion id.
"countryLabel": "A String", # Localized name for the country. May be empty.
},
],
"owner": "A String", # The trademark content owner.
"term": "A String", # The trademark term.
},
"websiteList": { # A list of websites that violated the policy. # List of websites linked with the ad.
"websites": [ # Websites that caused the policy finding.
"A String",
],
},
},
],
"policyTopicType": "A String", # How ad serving will be affected due to the relation to the ad policy topic.
},
],
},
"adUrls": [ # List of URLs used by the ad.
{ # Additional URLs related to the ad, including beacons.
"type": "A String", # The type of the Ad URL.
"url": "A String", # The URL string value.
},
],
"advertiserId": "A String", # The unique ID of the advertiser the ad belongs to.
"audioAd": { # Details for an audio ad. # Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
"bumperAd": { # Details for a bumper ad. # Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
"commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
"fileSize": "A String", # File size of the image asset in bytes.
"fullSize": { # Dimensions. # Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
"mimeType": "A String", # MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
},
"displayName": "A String", # The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
"displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Details of an ad sourced from a Display & Video 360 creative.
"creativeId": "A String", # The ID of the source creative.
},
"entityStatus": "A String", # The entity status of the ad.
"inStreamAd": { # Details for an in-stream ad. # Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
"commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
"fileSize": "A String", # File size of the image asset in bytes.
"fullSize": { # Dimensions. # Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
"mimeType": "A String", # MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
"a_key": "A String",
},
},
"mastheadAd": { # Details for a Masthead Ad. # Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).
"autoplayVideoDuration": "A String", # The duration of time the video will autoplay.
"autoplayVideoStartMillisecond": "A String", # The amount of time in milliseconds after which the video will start to play.
"callToActionButtonLabel": "A String", # The text on the call-to-action button.
"callToActionFinalUrl": "A String", # The destination URL for the call-to-action button.
"callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button.
"companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
{ # Details of a YouTube video.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
],
"description": "A String", # The description of the ad.
"headline": "A String", # The headline of the ad.
"showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
"video": { # Details of a YouTube video. # The YouTube video used by the ad.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
"videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead.
},
"name": "A String", # The resource name of the ad.
"nonSkippableAd": { # Details for a non-skippable ad. # Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
"commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
"fileSize": "A String", # File size of the image asset in bytes.
"fullSize": { # Dimensions. # Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
"mimeType": "A String", # MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
"a_key": "A String",
},
},
"videoDiscoverAd": { # Details for a video discovery ad. # Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
"description1": "A String", # First text line for the ad.
"description2": "A String", # Second text line for the ad.
"headline": "A String", # The headline of ad.
"thumbnail": "A String", # Thumbnail image used in the ad.
"video": { # Details of a YouTube video. # The YouTube video the ad promotes.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
"videoPerformanceAd": { # Details for a video performance ad. # Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
"actionButtonLabels": [ # The list of text assets shown on the call-to-action button.
"A String",
],
"companionBanners": [ # The list of companion banners used by this ad.
{ # Meta data of an image asset.
"fileSize": "A String", # File size of the image asset in bytes.
"fullSize": { # Dimensions. # Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
"mimeType": "A String", # MIME type of the image asset.
},
],
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
"a_key": "A String",
},
"descriptions": [ # The list of descriptions shown on the call-to-action banner.
"A String",
],
"displayUrlBreadcrumb1": "A String", # The first piece after the domain in the display URL.
"displayUrlBreadcrumb2": "A String", # The second piece after the domain in the display URL.
"domain": "A String", # The domain of the display URL.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"headlines": [ # The list of headlines shown on the call-to-action banner.
"A String",
],
"longHeadlines": [ # The list of lone headlines shown on the call-to-action banner.
"A String",
],
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"videos": [ # The list of YouTube video assets used by this ad.
{ # Details of a YouTube video.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists ad group ads.
Args:
advertiserId: string, Required. The ID of the advertiser the ad groups belongs to. (required)
filter: string, Optional. Allows filtering by custom ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId="1234"` * All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
orderBy: string, Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`.
pageSize: integer, Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
pageToken: string, Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAds` method. If not specified, the first page of results will be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"adGroupAds": [ # The list of ad group ads. This list will be absent if empty.
{ # A single ad associated with an ad group.
"adGroupAdId": "A String", # The unique ID of the ad. Assigned by the system.
"adGroupId": "A String", # The unique ID of the ad group that the ad belongs to. *Caution*: Parent ad groups for Demand Gen ads are not currently retrieveable using `advertisers.adGroups.list` or `advertisers.adGroups.get`. Demand Gen ads can be identified by the absence of the `ad_details` union field.
"adPolicy": { # A single ad policy associated with an ad group ad. # The policy approval status of the ad.
"adPolicyApprovalStatus": "A String", # The policy approval status of an ad, indicating the approval decision.
"adPolicyReviewStatus": "A String", # The policy review status of an ad, indicating where in the review process the ad is currently.
"adPolicyTopicEntry": [ # The entries for each policy topic identified as relating to the ad. Each entry includes the topic, restriction level, and guidance on how to fix policy issues.
{ # An entry describing how an ad has been identified as relating to an ad policy.
"appealInfo": { # Information on how to appeal a policy decision. # Information on how to appeal the policy decision.
"appealFormLink": "A String", # Only available when appeal_type is `APPEAL_FORM`.
"appealType": "A String", # Whether the decision can be appealed through a self-service appeal or an appeal form.
},
"helpCenterLink": "A String", # Ad policy help center link for the policy topic.
"policyDecisionType": "A String", # The source of the policy decision.
"policyEnforcementMeans": "A String", # The policy enforcement means used in the policy review.
"policyLabel": "A String", # Localized label text for policy. Examples include "Trademarks in text", "Contains Alcohol", etc.
"policyTopic": "A String", # The policy topic. Examples include "TRADEMARKS", "ALCOHOL", etc.
"policyTopicConstraints": [ # The serving constraints relevant to the policy decision.
{ # Details on ad serving constraints.
"certificateDomainMismatchCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the resource's domain is not covered by the certificates associated with it.
"countries": [ # Countries where the ad cannot serve.
{ # Represents a country restriction.
"countryCriterionId": "A String", # The country criterion id.
"countryLabel": "A String", # Localized name for the country. May be empty.
},
],
},
"certificateMissingCountryList": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where a certificate is required for serving.
"countries": [ # Countries where the ad cannot serve.
{ # Represents a country restriction.
"countryCriterionId": "A String", # The country criterion id.
"countryLabel": "A String", # Localized name for the country. May be empty.
},
],
},
"countryConstraint": { # A list of countries where the ad cannot serve due to policy constraints. # Countries where the ad cannot serve.
"countries": [ # Countries where the ad cannot serve.
{ # Represents a country restriction.
"countryCriterionId": "A String", # The country criterion id.
"countryLabel": "A String", # Localized name for the country. May be empty.
},
],
},
"globalCertificateDomainMismatch": { # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain. # Certificate is required to serve in any country and the existing certificate does not cover the ad's domain.
},
"globalCertificateMissing": { # Certificate is required to serve in any country. # Certificate is required to serve in any country.
},
"requestCertificateFormLink": "A String", # Link to the form to request a certificate for the constraint.
"resellerConstraint": { # Policy topic was constrained due to disapproval of the website for reseller purposes. # Reseller constraint.
},
},
],
"policyTopicDescription": "A String", # A short summary description of the policy topic.
"policyTopicEvidences": [ # The evidence used in the policy decision.
{ # Evidence information used in the policy decision.
"counterfeit": { # Details on the counterfeit enforcement that caused a policy violation. # Counterfeit enforcement that caused a policy violation.
"owners": [ # The content or product owners that made a complaint.
"A String",
],
},
"destinationMismatch": { # Details on a mismatch between destination URL types. # A mismatch between the ad destination URLs.
"uriTypes": [ # The set of URLs that do not match. The list can include single or multiple uri types. Example 1: [`DISPLAY_URL`, `FINAL_URL`] means ad display URL does not match with the ad final URL. Example 2: [`FINAL_URL`] means ad final URL did not match the crawled url, which is also considered as destination mismatch.
"A String",
],
},
"destinationNotWorking": { # Details for on HTTP or DNS errors related to the ad destination. # Information on HTTP or DNS errors related to the ad destination.
"device": "A String", # The device where visiting the URL resulted in the error.
"dnsErrorType": "A String", # The type of DNS error.
"expandedUri": "A String", # The full URL that didn't work.
"httpErrorCode": "A String", # The HTTP error code.
"lastCheckedTime": "A String", # The last time the error was seen when navigating to URL.
},
"destinationTextList": { # A list of destination text that violated the policy. # The text in the destination of the ad that is causing a policy violation.
"destinationTexts": [ # Destination text that caused the policy finding.
"A String",
],
},
"httpCode": 42, # HTTP code returned when the final URL was crawled.
"languageCode": "A String", # The language the ad was detected to be written in. This field uses IETF language tags, such as "en-US".
"legalRemoval": { # Legal related regulation enforcement, either from DMCA or local legal regulation. # Legal related regulation enforcement that caused a policy violation.
"complaintType": "A String", # The type of complaint causing the legal removal.
"countryRestrictions": [ # The countries restricted due to the legal removal.
{ # Represents a country restriction.
"countryCriterionId": "A String", # The country criterion id.
"countryLabel": "A String", # Localized name for the country. May be empty.
},
],
"dmca": { # DMCA complaint details. # Details on the DMCA regulation legal removal.
"complainant": "A String", # The entity who made the legal complaint.
},
"localLegal": { # Local legal regulation details. # Details on the local legal regulation legal removal.
"lawType": "A String", # Type of law for the legal notice.
},
"restrictedUris": [ # The urls restricted due to the legal removal.
"A String",
],
},
"regionalRequirements": { # Trust & Safety (T&S) proactive enforcement for policies meant to address regional requirements. This is considered a Google-owned investigation instead of a regulation notice since it's proactive T&S enforcement. # T&S proactive enforcement that caused a policy violation.
"regionalRequirementsEntries": [ # List of regional requirements.
{ # Policy level regional legal violation details.
"countryRestrictions": [ # The countries restricted due to the legal policy.
{ # Represents a country restriction.
"countryCriterionId": "A String", # The country criterion id.
"countryLabel": "A String", # Localized name for the country. May be empty.
},
],
"legalPolicy": "A String", # The legal policy that is being violated.
},
],
},
"textList": { # A list of fragments of text that violated the policy. # List of evidence found in the text of the ad.
"texts": [ # The fragments of text from the resource that caused the policy finding.
"A String",
],
},
"trademark": { # Trademark terms that caused a policy violation. # Trademark terms that caused a policy violation.
"countryRestrictions": [ # Countries where the policy violation is relevant.
{ # Represents a country restriction.
"countryCriterionId": "A String", # The country criterion id.
"countryLabel": "A String", # Localized name for the country. May be empty.
},
],
"owner": "A String", # The trademark content owner.
"term": "A String", # The trademark term.
},
"websiteList": { # A list of websites that violated the policy. # List of websites linked with the ad.
"websites": [ # Websites that caused the policy finding.
"A String",
],
},
},
],
"policyTopicType": "A String", # How ad serving will be affected due to the relation to the ad policy topic.
},
],
},
"adUrls": [ # List of URLs used by the ad.
{ # Additional URLs related to the ad, including beacons.
"type": "A String", # The type of the Ad URL.
"url": "A String", # The URL string value.
},
],
"advertiserId": "A String", # The unique ID of the advertiser the ad belongs to.
"audioAd": { # Details for an audio ad. # Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives.
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
"bumperAd": { # Details for a bumper ad. # Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach.
"commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
"fileSize": "A String", # File size of the image asset in bytes.
"fullSize": { # Dimensions. # Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
"mimeType": "A String", # MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
},
"displayName": "A String", # The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.
"displayVideoSourceAd": { # The ad sourced from a DV360 creative. # Details of an ad sourced from a Display & Video 360 creative.
"creativeId": "A String", # The ID of the source creative.
},
"entityStatus": "A String", # The entity status of the ad.
"inStreamAd": { # Details for an in-stream ad. # Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives.
"commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
"fileSize": "A String", # File size of the image asset in bytes.
"fullSize": { # Dimensions. # Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
"mimeType": "A String", # MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
"a_key": "A String",
},
},
"mastheadAd": { # Details for a Masthead Ad. # Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826).
"autoplayVideoDuration": "A String", # The duration of time the video will autoplay.
"autoplayVideoStartMillisecond": "A String", # The amount of time in milliseconds after which the video will start to play.
"callToActionButtonLabel": "A String", # The text on the call-to-action button.
"callToActionFinalUrl": "A String", # The destination URL for the call-to-action button.
"callToActionTrackingUrl": "A String", # The tracking URL for the call-to-action button.
"companionYoutubeVideos": [ # The videos that appear next to the Masthead Ad on desktop. Can be no more than two.
{ # Details of a YouTube video.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
],
"description": "A String", # The description of the ad.
"headline": "A String", # The headline of the ad.
"showChannelArt": True or False, # Whether to show a background or banner that appears at the top of a YouTube page.
"video": { # Details of a YouTube video. # The YouTube video used by the ad.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
"videoAspectRatio": "A String", # The aspect ratio of the autoplaying YouTube video on the Masthead.
},
"name": "A String", # The resource name of the ad.
"nonSkippableAd": { # Details for a non-skippable ad. # Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives.
"commonInStreamAttribute": { # Common attributes for in-stream, non-skippable and bumper ads. # Common ad attributes.
"actionButtonLabel": "A String", # The text on the call-to-action button.
"actionHeadline": "A String", # The headline of the call-to-action banner.
"companionBanner": { # Meta data of an image asset. # The image which shows next to the video ad.
"fileSize": "A String", # File size of the image asset in bytes.
"fullSize": { # Dimensions. # Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
"mimeType": "A String", # MIME type of the image asset.
},
"displayUrl": "A String", # The webpage address that appears with the ad.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"video": { # Details of a YouTube video. # The YouTube video of the ad.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
"a_key": "A String",
},
},
"videoDiscoverAd": { # Details for a video discovery ad. # Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery.
"description1": "A String", # First text line for the ad.
"description2": "A String", # Second text line for the ad.
"headline": "A String", # The headline of ad.
"thumbnail": "A String", # Thumbnail image used in the ad.
"video": { # Details of a YouTube video. # The YouTube video the ad promotes.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
},
"videoPerformanceAd": { # Details for a video performance ad. # Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product.
"actionButtonLabels": [ # The list of text assets shown on the call-to-action button.
"A String",
],
"companionBanners": [ # The list of companion banners used by this ad.
{ # Meta data of an image asset.
"fileSize": "A String", # File size of the image asset in bytes.
"fullSize": { # Dimensions. # Metadata for this image at its original size.
"heightPixels": 42, # The height in pixels.
"widthPixels": 42, # The width in pixels.
},
"mimeType": "A String", # MIME type of the image asset.
},
],
"customParameters": { # The custom parameters to pass custom values to tracking URL template.
"a_key": "A String",
},
"descriptions": [ # The list of descriptions shown on the call-to-action banner.
"A String",
],
"displayUrlBreadcrumb1": "A String", # The first piece after the domain in the display URL.
"displayUrlBreadcrumb2": "A String", # The second piece after the domain in the display URL.
"domain": "A String", # The domain of the display URL.
"finalUrl": "A String", # The URL address of the webpage that people reach after they click the ad.
"headlines": [ # The list of headlines shown on the call-to-action banner.
"A String",
],
"longHeadlines": [ # The list of lone headlines shown on the call-to-action banner.
"A String",
],
"trackingUrl": "A String", # The URL address loaded in the background for tracking purposes.
"videos": [ # The list of YouTube video assets used by this ad.
{ # Details of a YouTube video.
"id": "A String", # The YouTube video ID which can be searched on YouTube webpage.
"unavailableReason": "A String", # The reason why the video data is not available.
},
],
},
},
],
"nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdGroupAds` method to retrieve the next page of results.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>
|
