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
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
|
<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="adexchangebuyer_v1_4.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_4.creatives.html">creatives</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#addDeal">addDeal(accountId, buyerCreativeId, dealId)</a></code></p>
<p class="firstline">Add a deal id association for the creative.</p>
<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(accountId, buyerCreativeId)</a></code></p>
<p class="firstline">Gets the status for a single creative. A creative will be available 30-40 minutes after submission.</p>
<p class="toc_element">
<code><a href="#insert">insert(body=None)</a></code></p>
<p class="firstline">Submit a new creative.</p>
<p class="toc_element">
<code><a href="#list">list(accountId=None, buyerCreativeId=None, dealsStatusFilter=None, maxResults=None, openAuctionStatusFilter=None, pageToken=None)</a></code></p>
<p class="firstline">Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.</p>
<p class="toc_element">
<code><a href="#listDeals">listDeals(accountId, buyerCreativeId)</a></code></p>
<p class="firstline">Lists the external deal ids associated with the creative.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#removeDeal">removeDeal(accountId, buyerCreativeId, dealId)</a></code></p>
<p class="firstline">Remove a deal id associated with the creative.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="addDeal">addDeal(accountId, buyerCreativeId, dealId)</code>
<pre>Add a deal id association for the creative.
Args:
accountId: integer, The id for the account that will serve this creative. (required)
buyerCreativeId: string, The buyer-specific id for this creative. (required)
dealId: string, The id of the deal id to associate with this creative. (required)
</pre>
</div>
<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(accountId, buyerCreativeId)</code>
<pre>Gets the status for a single creative. A creative will be available 30-40 minutes after submission.
Args:
accountId: integer, The id for the account that will serve this creative. (required)
buyerCreativeId: string, The buyer-specific id for this creative. (required)
Returns:
An object of the form:
{ # A creative and its classification data.
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL, videoVastXML, and nativeAd should not be set.
"accountId": 42, # Account id.
"adChoicesDestinationUrl": "A String", # The link to the Ad Preferences page. This is only supported for native ads.
"adTechnologyProviders": {
"detectedProviderIds": [ # The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If this creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the Authorized Buyers Real-Time Bidding protocol or the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the OpenRTB protocol, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the "Third-party Ad Technology Vendors" section of Authorized Buyers Program Guidelines.
"A String",
],
"hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. If true, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the "Third-party Ad Technology Vendors" section of Authorized Buyers Program Guidelines.
},
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
"A String",
],
"advertiserName": "A String", # The name of the company being advertised in the creative. A list of advertisers is provided in the advertisers.txt file.
"agencyId": "A String", # The agency id for this creative.
"apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
"attribute": [ # List of buyer selectable attributes for the ads that may be shown from this snippet. Each attribute is represented by an integer as defined in buyer-declarable-creative-attributes.txt.
42,
],
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
"clickThroughUrl": [ # The set of destination urls for the snippet.
"A String",
],
"corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
{
"contexts": [ # All known serving contexts containing serving status information.
{
"auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to.
"A String",
],
"contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
"geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this correction applies to.
42,
],
"platform": [ # Only set when contextType=PLATFORM. Represents the platforms this correction applies to.
"A String",
],
},
],
"details": [ # Additional details about the correction.
"A String",
],
"reason": "A String", # The type of correction that was applied to the creative.
},
],
"creativeStatusIdentityType": "A String", # Creative status identity type that the creative item applies to. Ad Exchange real-time bidding is migrating to the sizeless creative verification. Originally, Ad Exchange assigned creative verification status to a unique combination of a buyer creative ID and creative dimensions. Post-migration, a single verification status will be assigned at the buyer creative ID level. This field allows to distinguish whether a given creative status applies to a unique combination of a buyer creative ID and creative dimensions, or to a buyer creative ID as a whole.
"dealsStatus": "A String", # Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly.
"detectedDomains": [ # Detected domains for this creative. Read-only. This field should not be set in requests.
"A String",
],
"filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
"date": "A String", # The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.
"reasons": [ # The filtering reasons.
{
"filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
"filteringStatus": 42, # The filtering status code as defined in creative-status-codes.txt.
},
],
},
"height": 42, # Ad height.
"impressionTrackingUrl": [ # The set of urls to be called to record an impression.
"A String",
],
"kind": "adexchangebuyer#creative", # Resource type.
"languages": [ # Detected languages for this creative. Read-only. This field should not be set in requests.
"A String",
],
"nativeAd": { # If nativeAd is set, HTMLSnippet, videoVastXML, and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)
"advertiser": "A String",
"appIcon": { # The app icon, for app download ads.
"height": 42,
"url": "A String",
"width": 42,
},
"body": "A String", # A long description of the ad.
"callToAction": "A String", # A label for the button that the user is supposed to click.
"clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
"clickTrackingUrl": "A String", # The URL to use for click tracking.
"headline": "A String", # A short title for the ad.
"image": { # A large image.
"height": 42,
"url": "A String",
"width": 42,
},
"impressionTrackingUrl": [ # The URLs are called when the impression is rendered.
"A String",
],
"logo": { # A smaller image, for the advertiser logo.
"height": 42,
"url": "A String",
"width": 42,
},
"price": "A String", # The price of the promoted app including the currency info.
"starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
"videoURL": "A String", # The URL of the XML VAST for a native ad. Note this is a separate field from resource.video_url.
},
"openAuctionStatus": "A String", # Top-level open auction status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from ServingRestrictions directly.
"productCategories": [ # Detected product categories, if any. Each category is represented by an integer as defined in ad-product-categories.txt. Read-only. This field should not be set in requests.
42,
],
"restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet. Each category is represented by an integer as defined in the ad-restricted-categories.txt.
42,
],
"sensitiveCategories": [ # Detected sensitive categories, if any. Each category is represented by an integer as defined in ad-sensitive-categories.txt. Read-only. This field should not be set in requests.
42,
],
"servingRestrictions": [ # The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). Read-only. This field should not be set in requests. See the examples in the Creatives guide for more details.
{
"contexts": [ # All known contexts/restrictions.
{
"auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to.
"A String",
],
"contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
"geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to. Impressions are considered to match a context if either the user location or publisher location matches a given geoCriteriaId.
42,
],
"platform": [ # Only set when contextType=PLATFORM. Represents the platforms this restriction applies to.
"A String",
],
},
],
"disapprovalReasons": [ # The reasons for disapproval within this restriction, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED or CONDITIONALLY_APPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue.
{
"details": [ # Additional details about the reason for disapproval.
"A String",
],
"reason": "A String", # The categorized reason for disapproval.
},
],
"reason": "A String", # Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review).
},
],
"vendorType": [ # List of vendor types for the ads that may be shown from this snippet. Each vendor type is represented by an integer as defined in vendors.txt.
42,
],
"version": 42, # The version for this creative. Read-only. This field should not be set in requests.
"videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet, videoVastXML, and nativeAd should not be set. Note, this is different from resource.native_ad.video_url above.
"videoVastXML": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard. If set, HTMLSnippet, videoURL, and nativeAd and should not be set.
"width": 42, # Ad width.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(body=None)</code>
<pre>Submit a new creative.
Args:
body: object, The request body.
The object takes the form of:
{ # A creative and its classification data.
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL, videoVastXML, and nativeAd should not be set.
"accountId": 42, # Account id.
"adChoicesDestinationUrl": "A String", # The link to the Ad Preferences page. This is only supported for native ads.
"adTechnologyProviders": {
"detectedProviderIds": [ # The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If this creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the Authorized Buyers Real-Time Bidding protocol or the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the OpenRTB protocol, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the "Third-party Ad Technology Vendors" section of Authorized Buyers Program Guidelines.
"A String",
],
"hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. If true, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the "Third-party Ad Technology Vendors" section of Authorized Buyers Program Guidelines.
},
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
"A String",
],
"advertiserName": "A String", # The name of the company being advertised in the creative. A list of advertisers is provided in the advertisers.txt file.
"agencyId": "A String", # The agency id for this creative.
"apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
"attribute": [ # List of buyer selectable attributes for the ads that may be shown from this snippet. Each attribute is represented by an integer as defined in buyer-declarable-creative-attributes.txt.
42,
],
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
"clickThroughUrl": [ # The set of destination urls for the snippet.
"A String",
],
"corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
{
"contexts": [ # All known serving contexts containing serving status information.
{
"auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to.
"A String",
],
"contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
"geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this correction applies to.
42,
],
"platform": [ # Only set when contextType=PLATFORM. Represents the platforms this correction applies to.
"A String",
],
},
],
"details": [ # Additional details about the correction.
"A String",
],
"reason": "A String", # The type of correction that was applied to the creative.
},
],
"creativeStatusIdentityType": "A String", # Creative status identity type that the creative item applies to. Ad Exchange real-time bidding is migrating to the sizeless creative verification. Originally, Ad Exchange assigned creative verification status to a unique combination of a buyer creative ID and creative dimensions. Post-migration, a single verification status will be assigned at the buyer creative ID level. This field allows to distinguish whether a given creative status applies to a unique combination of a buyer creative ID and creative dimensions, or to a buyer creative ID as a whole.
"dealsStatus": "A String", # Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly.
"detectedDomains": [ # Detected domains for this creative. Read-only. This field should not be set in requests.
"A String",
],
"filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
"date": "A String", # The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.
"reasons": [ # The filtering reasons.
{
"filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
"filteringStatus": 42, # The filtering status code as defined in creative-status-codes.txt.
},
],
},
"height": 42, # Ad height.
"impressionTrackingUrl": [ # The set of urls to be called to record an impression.
"A String",
],
"kind": "adexchangebuyer#creative", # Resource type.
"languages": [ # Detected languages for this creative. Read-only. This field should not be set in requests.
"A String",
],
"nativeAd": { # If nativeAd is set, HTMLSnippet, videoVastXML, and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)
"advertiser": "A String",
"appIcon": { # The app icon, for app download ads.
"height": 42,
"url": "A String",
"width": 42,
},
"body": "A String", # A long description of the ad.
"callToAction": "A String", # A label for the button that the user is supposed to click.
"clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
"clickTrackingUrl": "A String", # The URL to use for click tracking.
"headline": "A String", # A short title for the ad.
"image": { # A large image.
"height": 42,
"url": "A String",
"width": 42,
},
"impressionTrackingUrl": [ # The URLs are called when the impression is rendered.
"A String",
],
"logo": { # A smaller image, for the advertiser logo.
"height": 42,
"url": "A String",
"width": 42,
},
"price": "A String", # The price of the promoted app including the currency info.
"starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
"videoURL": "A String", # The URL of the XML VAST for a native ad. Note this is a separate field from resource.video_url.
},
"openAuctionStatus": "A String", # Top-level open auction status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from ServingRestrictions directly.
"productCategories": [ # Detected product categories, if any. Each category is represented by an integer as defined in ad-product-categories.txt. Read-only. This field should not be set in requests.
42,
],
"restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet. Each category is represented by an integer as defined in the ad-restricted-categories.txt.
42,
],
"sensitiveCategories": [ # Detected sensitive categories, if any. Each category is represented by an integer as defined in ad-sensitive-categories.txt. Read-only. This field should not be set in requests.
42,
],
"servingRestrictions": [ # The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). Read-only. This field should not be set in requests. See the examples in the Creatives guide for more details.
{
"contexts": [ # All known contexts/restrictions.
{
"auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to.
"A String",
],
"contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
"geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to. Impressions are considered to match a context if either the user location or publisher location matches a given geoCriteriaId.
42,
],
"platform": [ # Only set when contextType=PLATFORM. Represents the platforms this restriction applies to.
"A String",
],
},
],
"disapprovalReasons": [ # The reasons for disapproval within this restriction, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED or CONDITIONALLY_APPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue.
{
"details": [ # Additional details about the reason for disapproval.
"A String",
],
"reason": "A String", # The categorized reason for disapproval.
},
],
"reason": "A String", # Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review).
},
],
"vendorType": [ # List of vendor types for the ads that may be shown from this snippet. Each vendor type is represented by an integer as defined in vendors.txt.
42,
],
"version": 42, # The version for this creative. Read-only. This field should not be set in requests.
"videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet, videoVastXML, and nativeAd should not be set. Note, this is different from resource.native_ad.video_url above.
"videoVastXML": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard. If set, HTMLSnippet, videoURL, and nativeAd and should not be set.
"width": 42, # Ad width.
}
Returns:
An object of the form:
{ # A creative and its classification data.
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL, videoVastXML, and nativeAd should not be set.
"accountId": 42, # Account id.
"adChoicesDestinationUrl": "A String", # The link to the Ad Preferences page. This is only supported for native ads.
"adTechnologyProviders": {
"detectedProviderIds": [ # The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If this creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the Authorized Buyers Real-Time Bidding protocol or the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the OpenRTB protocol, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the "Third-party Ad Technology Vendors" section of Authorized Buyers Program Guidelines.
"A String",
],
"hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. If true, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the "Third-party Ad Technology Vendors" section of Authorized Buyers Program Guidelines.
},
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
"A String",
],
"advertiserName": "A String", # The name of the company being advertised in the creative. A list of advertisers is provided in the advertisers.txt file.
"agencyId": "A String", # The agency id for this creative.
"apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
"attribute": [ # List of buyer selectable attributes for the ads that may be shown from this snippet. Each attribute is represented by an integer as defined in buyer-declarable-creative-attributes.txt.
42,
],
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
"clickThroughUrl": [ # The set of destination urls for the snippet.
"A String",
],
"corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
{
"contexts": [ # All known serving contexts containing serving status information.
{
"auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to.
"A String",
],
"contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
"geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this correction applies to.
42,
],
"platform": [ # Only set when contextType=PLATFORM. Represents the platforms this correction applies to.
"A String",
],
},
],
"details": [ # Additional details about the correction.
"A String",
],
"reason": "A String", # The type of correction that was applied to the creative.
},
],
"creativeStatusIdentityType": "A String", # Creative status identity type that the creative item applies to. Ad Exchange real-time bidding is migrating to the sizeless creative verification. Originally, Ad Exchange assigned creative verification status to a unique combination of a buyer creative ID and creative dimensions. Post-migration, a single verification status will be assigned at the buyer creative ID level. This field allows to distinguish whether a given creative status applies to a unique combination of a buyer creative ID and creative dimensions, or to a buyer creative ID as a whole.
"dealsStatus": "A String", # Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly.
"detectedDomains": [ # Detected domains for this creative. Read-only. This field should not be set in requests.
"A String",
],
"filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
"date": "A String", # The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.
"reasons": [ # The filtering reasons.
{
"filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
"filteringStatus": 42, # The filtering status code as defined in creative-status-codes.txt.
},
],
},
"height": 42, # Ad height.
"impressionTrackingUrl": [ # The set of urls to be called to record an impression.
"A String",
],
"kind": "adexchangebuyer#creative", # Resource type.
"languages": [ # Detected languages for this creative. Read-only. This field should not be set in requests.
"A String",
],
"nativeAd": { # If nativeAd is set, HTMLSnippet, videoVastXML, and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)
"advertiser": "A String",
"appIcon": { # The app icon, for app download ads.
"height": 42,
"url": "A String",
"width": 42,
},
"body": "A String", # A long description of the ad.
"callToAction": "A String", # A label for the button that the user is supposed to click.
"clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
"clickTrackingUrl": "A String", # The URL to use for click tracking.
"headline": "A String", # A short title for the ad.
"image": { # A large image.
"height": 42,
"url": "A String",
"width": 42,
},
"impressionTrackingUrl": [ # The URLs are called when the impression is rendered.
"A String",
],
"logo": { # A smaller image, for the advertiser logo.
"height": 42,
"url": "A String",
"width": 42,
},
"price": "A String", # The price of the promoted app including the currency info.
"starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
"videoURL": "A String", # The URL of the XML VAST for a native ad. Note this is a separate field from resource.video_url.
},
"openAuctionStatus": "A String", # Top-level open auction status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from ServingRestrictions directly.
"productCategories": [ # Detected product categories, if any. Each category is represented by an integer as defined in ad-product-categories.txt. Read-only. This field should not be set in requests.
42,
],
"restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet. Each category is represented by an integer as defined in the ad-restricted-categories.txt.
42,
],
"sensitiveCategories": [ # Detected sensitive categories, if any. Each category is represented by an integer as defined in ad-sensitive-categories.txt. Read-only. This field should not be set in requests.
42,
],
"servingRestrictions": [ # The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). Read-only. This field should not be set in requests. See the examples in the Creatives guide for more details.
{
"contexts": [ # All known contexts/restrictions.
{
"auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to.
"A String",
],
"contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
"geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to. Impressions are considered to match a context if either the user location or publisher location matches a given geoCriteriaId.
42,
],
"platform": [ # Only set when contextType=PLATFORM. Represents the platforms this restriction applies to.
"A String",
],
},
],
"disapprovalReasons": [ # The reasons for disapproval within this restriction, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED or CONDITIONALLY_APPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue.
{
"details": [ # Additional details about the reason for disapproval.
"A String",
],
"reason": "A String", # The categorized reason for disapproval.
},
],
"reason": "A String", # Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review).
},
],
"vendorType": [ # List of vendor types for the ads that may be shown from this snippet. Each vendor type is represented by an integer as defined in vendors.txt.
42,
],
"version": 42, # The version for this creative. Read-only. This field should not be set in requests.
"videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet, videoVastXML, and nativeAd should not be set. Note, this is different from resource.native_ad.video_url above.
"videoVastXML": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard. If set, HTMLSnippet, videoURL, and nativeAd and should not be set.
"width": 42, # Ad width.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(accountId=None, buyerCreativeId=None, dealsStatusFilter=None, maxResults=None, openAuctionStatusFilter=None, pageToken=None)</code>
<pre>Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.
Args:
accountId: integer, When specified, only creatives for the given account ids are returned. (repeated)
buyerCreativeId: string, When specified, only creatives for the given buyer creative ids are returned. (repeated)
dealsStatusFilter: string, When specified, only creatives having the given deals status are returned.
Allowed values
approved - Creatives which have been approved for serving on deals.
conditionally_approved - Creatives which have been conditionally approved for serving on deals.
disapproved - Creatives which have been disapproved for serving on deals.
not_checked - Creatives whose deals status is not yet checked.
maxResults: integer, Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
openAuctionStatusFilter: string, When specified, only creatives having the given open auction status are returned.
Allowed values
approved - Creatives which have been approved for serving on the open auction.
conditionally_approved - Creatives which have been conditionally approved for serving on the open auction.
disapproved - Creatives which have been disapproved for serving on the open auction.
not_checked - Creatives whose open auction status is not yet checked.
pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.
Returns:
An object of the form:
{ # The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.
"items": [ # A list of creatives.
{ # A creative and its classification data.
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL, videoVastXML, and nativeAd should not be set.
"accountId": 42, # Account id.
"adChoicesDestinationUrl": "A String", # The link to the Ad Preferences page. This is only supported for native ads.
"adTechnologyProviders": {
"detectedProviderIds": [ # The detected ad technology provider IDs for this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for mapping of provider ID to provided name, a privacy policy URL, and a list of domains which can be attributed to the provider. If this creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the Authorized Buyers Real-Time Bidding protocol or the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the OpenRTB protocol, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the "Third-party Ad Technology Vendors" section of Authorized Buyers Program Guidelines.
"A String",
],
"hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. If true, a bid submitted for a European Economic Area (EEA) user with this creative is not compliant with the GDPR policies as mentioned in the "Third-party Ad Technology Vendors" section of Authorized Buyers Program Guidelines.
},
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
"A String",
],
"advertiserName": "A String", # The name of the company being advertised in the creative. A list of advertisers is provided in the advertisers.txt file.
"agencyId": "A String", # The agency id for this creative.
"apiUploadTimestamp": "A String", # The last upload timestamp of this creative if it was uploaded via API. Read-only. The value of this field is generated, and will be ignored for uploads. (formatted RFC 3339 timestamp).
"attribute": [ # List of buyer selectable attributes for the ads that may be shown from this snippet. Each attribute is represented by an integer as defined in buyer-declarable-creative-attributes.txt.
42,
],
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
"clickThroughUrl": [ # The set of destination urls for the snippet.
"A String",
],
"corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests.
{
"contexts": [ # All known serving contexts containing serving status information.
{
"auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to.
"A String",
],
"contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
"geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this correction applies to.
42,
],
"platform": [ # Only set when contextType=PLATFORM. Represents the platforms this correction applies to.
"A String",
],
},
],
"details": [ # Additional details about the correction.
"A String",
],
"reason": "A String", # The type of correction that was applied to the creative.
},
],
"creativeStatusIdentityType": "A String", # Creative status identity type that the creative item applies to. Ad Exchange real-time bidding is migrating to the sizeless creative verification. Originally, Ad Exchange assigned creative verification status to a unique combination of a buyer creative ID and creative dimensions. Post-migration, a single verification status will be assigned at the buyer creative ID level. This field allows to distinguish whether a given creative status applies to a unique combination of a buyer creative ID and creative dimensions, or to a buyer creative ID as a whole.
"dealsStatus": "A String", # Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly.
"detectedDomains": [ # Detected domains for this creative. Read-only. This field should not be set in requests.
"A String",
],
"filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests.
"date": "A String", # The date in ISO 8601 format for the data. The data is collected from 00:00:00 to 23:59:59 in PST.
"reasons": [ # The filtering reasons.
{
"filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange.
"filteringStatus": 42, # The filtering status code as defined in creative-status-codes.txt.
},
],
},
"height": 42, # Ad height.
"impressionTrackingUrl": [ # The set of urls to be called to record an impression.
"A String",
],
"kind": "adexchangebuyer#creative", # Resource type.
"languages": [ # Detected languages for this creative. Read-only. This field should not be set in requests.
"A String",
],
"nativeAd": { # If nativeAd is set, HTMLSnippet, videoVastXML, and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.)
"advertiser": "A String",
"appIcon": { # The app icon, for app download ads.
"height": 42,
"url": "A String",
"width": 42,
},
"body": "A String", # A long description of the ad.
"callToAction": "A String", # A label for the button that the user is supposed to click.
"clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
"clickTrackingUrl": "A String", # The URL to use for click tracking.
"headline": "A String", # A short title for the ad.
"image": { # A large image.
"height": 42,
"url": "A String",
"width": 42,
},
"impressionTrackingUrl": [ # The URLs are called when the impression is rendered.
"A String",
],
"logo": { # A smaller image, for the advertiser logo.
"height": 42,
"url": "A String",
"width": 42,
},
"price": "A String", # The price of the promoted app including the currency info.
"starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
"videoURL": "A String", # The URL of the XML VAST for a native ad. Note this is a separate field from resource.video_url.
},
"openAuctionStatus": "A String", # Top-level open auction status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from ServingRestrictions directly.
"productCategories": [ # Detected product categories, if any. Each category is represented by an integer as defined in ad-product-categories.txt. Read-only. This field should not be set in requests.
42,
],
"restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet. Each category is represented by an integer as defined in the ad-restricted-categories.txt.
42,
],
"sensitiveCategories": [ # Detected sensitive categories, if any. Each category is represented by an integer as defined in ad-sensitive-categories.txt. Read-only. This field should not be set in requests.
42,
],
"servingRestrictions": [ # The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). Read-only. This field should not be set in requests. See the examples in the Creatives guide for more details.
{
"contexts": [ # All known contexts/restrictions.
{
"auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to.
"A String",
],
"contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness).
"geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to. Impressions are considered to match a context if either the user location or publisher location matches a given geoCriteriaId.
42,
],
"platform": [ # Only set when contextType=PLATFORM. Represents the platforms this restriction applies to.
"A String",
],
},
],
"disapprovalReasons": [ # The reasons for disapproval within this restriction, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED or CONDITIONALLY_APPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue.
{
"details": [ # Additional details about the reason for disapproval.
"A String",
],
"reason": "A String", # The categorized reason for disapproval.
},
],
"reason": "A String", # Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review).
},
],
"vendorType": [ # List of vendor types for the ads that may be shown from this snippet. Each vendor type is represented by an integer as defined in vendors.txt.
42,
],
"version": 42, # The version for this creative. Read-only. This field should not be set in requests.
"videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet, videoVastXML, and nativeAd should not be set. Note, this is different from resource.native_ad.video_url above.
"videoVastXML": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard. If set, HTMLSnippet, videoURL, and nativeAd and should not be set.
"width": 42, # Ad width.
},
],
"kind": "adexchangebuyer#creativesList", # Resource type.
"nextPageToken": "A String", # Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this.
}</pre>
</div>
<div class="method">
<code class="details" id="listDeals">listDeals(accountId, buyerCreativeId)</code>
<pre>Lists the external deal ids associated with the creative.
Args:
accountId: integer, The id for the account that will serve this creative. (required)
buyerCreativeId: string, The buyer-specific id for this creative. (required)
Returns:
An object of the form:
{ # The external deal ids associated with a creative.
"dealStatuses": [ # A list of external deal ids and ARC approval status.
{
"arcStatus": "A String", # ARC approval status.
"dealId": "A String", # External deal ID.
"webPropertyId": 42, # Publisher ID.
},
],
"kind": "adexchangebuyer#creativeDealIds", # Resource type.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</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>
<div class="method">
<code class="details" id="removeDeal">removeDeal(accountId, buyerCreativeId, dealId)</code>
<pre>Remove a deal id associated with the creative.
Args:
accountId: integer, The id for the account that will serve this creative. (required)
buyerCreativeId: string, The buyer-specific id for this creative. (required)
dealId: string, The id of the deal id to disassociate with this creative. (required)
</pre>
</div>
</body></html>
|
