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
|
<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="realtimebidding_v1.html">Real-time Bidding API</a> . <a href="realtimebidding_v1.bidders.html">bidders</a> . <a href="realtimebidding_v1.bidders.creatives.html">creatives</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="#list">list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists creatives as they are at the time of the initial request. This call may take multiple hours to complete. For large, paginated requests, this method returns a snapshot of creatives at the time of request for the first page. `lastStatusUpdate` and `creativeServingDecision` may be outdated for creatives on sequential pages. We recommend [Google Cloud Pub/Sub](//cloud.google.com/pubsub/docs/overview) to view the latest status.</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>
<p class="toc_element">
<code><a href="#watch">watch(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Watches all creatives pertaining to a bidder. It is sufficient to invoke this endpoint once per bidder. A Pub/Sub topic will be created and notifications will be pushed to the topic when any of the bidder's creatives change status. All of the bidder's service accounts will have access to read from the topic. Subsequent invocations of this method will return the existing Pub/Sub configuration.</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="list">list(parent, filter=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
<pre>Lists creatives as they are at the time of the initial request. This call may take multiple hours to complete. For large, paginated requests, this method returns a snapshot of creatives at the time of request for the first page. `lastStatusUpdate` and `creativeServingDecision` may be outdated for creatives on sequential pages. We recommend [Google Cloud Pub/Sub](//cloud.google.com/pubsub/docs/overview) to view the latest status.
Args:
parent: string, Required. Name of the parent buyer that owns the creatives. The pattern for this resource is either `buyers/{buyerAccountId}` or `bidders/{bidderAccountId}`. For `buyers/{buyerAccountId}`, the `buyerAccountId` can be one of the following: 1. The ID of the buyer that is accessing their own creatives. 2. The ID of the child seat buyer under a bidder account. So for listing creatives pertaining to the child seat buyer (`456`) under bidder account (`123`), you would use the pattern: `buyers/456`. 3. The ID of the bidder itself. So for listing creatives pertaining to bidder (`123`), you would use `buyers/123`. If you want to access all creatives pertaining to both the bidder and all of its child seat accounts, you would use `bidders/{bidderAccountId}`, for example, for all creatives pertaining to bidder (`123`), use `bidders/123`. (required)
filter: string, Query string to filter creatives. If no filter is specified, all active creatives will be returned. Example: 'accountId=12345 AND (dealsStatus:DISAPPROVED AND disapprovalReason:UNACCEPTABLE_CONTENT) OR declaredAttributes:IS_COOKIE_TARGETED'
pageSize: integer, Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available through another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive.
pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.nextPageToken returned from the previous call to the 'ListCreatives' method. Page tokens for continued pages are valid for up to five hours, counting from the call to 'ListCreatives' for the first page.
view: string, Controls the amount of information included in the response. By default only creativeServingDecision is included. To retrieve the entire creative resource (including the declared fields and the creative content) specify the view as "FULL".
Allowed values
CREATIVE_VIEW_UNSPECIFIED - Not specified, equivalent to SERVING_DECISION_ONLY.
SERVING_DECISION_ONLY - Only creativeServingDecision is included in the response.
FULL - The entire creative resource (including the declared fields and the creative content) is included in the response.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A response for listing creatives.
"creatives": [ # The list of creatives.
{ # A creative and its classification data.
"accountId": "A String", # Output only. ID of the buyer account that this creative is owned by. Can be used to filter the response of the creatives.list method with equality and inequality check.
"adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. This is only supported for native ads.
"advertiserName": "A String", # The name of the company being advertised in the creative. Can be used to filter the response of the creatives.list method.
"agencyId": "A String", # The agency ID for this creative.
"apiUpdateTime": "A String", # Output only. The last update timestamp of the creative through the API.
"creativeFormat": "A String", # Output only. The format of this creative. Can be used to filter the response of the creatives.list method.
"creativeId": "A String", # Buyer-specific creative ID that references this creative in bid responses. This field is Ignored in update operations. Can be used to filter the response of the creatives.list method. The maximum length of the creative ID is 128 bytes.
"creativeServingDecision": { # Top level status and detected attributes of a creative. # Output only. Top level status and detected attributes of a creative (for example domain, language, advertiser, product category, etc.) that affect whether (status) and where (context) a creative will be allowed to serve.
"adTechnologyProviders": { # The list of detected Ad Technology Providers for this creative. Bids placed for inventory that will serve to EEA or UK users are expected to comply with GDPR requirements. You must ensure that the creatives used in such bids should contain only user consented ad technology providers as indicated in the bid request. Google reserves the right to filter non-compliant bids. User consented ad technology providers can be found in the [Google Protocol](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) with the `BidRequest.adslot.consented_providers_settings` field, and can be found as an [OpenRTB extension](https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto) with the `BidRequest.user.ext.consented_providers_settings` and `BidRequest.user.ext.consent` fields. See https://support.google.com/authorizedbuyers/answer/9789378 for additional information about the Google TCF v2 integration. # The detected ad technology providers.
"detectedGvlIds": [ # The detected IAB Global Vendor List (GVL) IDs for this creative. See the IAB Global Vendor List at https://vendor-list.consensu.org/v2/vendor-list.json for details about the vendors.
"A String",
],
"detectedProviderIds": [ # The detected [Google Ad Tech Providers (ATP)](https://support.google.com/admanager/answer/9012903) 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.
"A String",
],
"unidentifiedProviderDomains": [ # Domains of detected unidentified ad technology providers (if any). You must ensure that the creatives used in bids placed for inventory that will serve to EEA or UK users does not contain unidentified ad technology providers. Google reserves the right to filter non-compliant bids.
"A String",
],
},
"chinaPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # The policy compliance of this creative in China. When approved or disapproved, this applies to both deals and open auction in China. When pending review, this creative is allowed to serve for deals but not for open auction.
"status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method.
"topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED.
{ # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation.
"evidences": [ # Pieces of evidence associated with this policy topic entry.
{ # Evidence associated with a policy topic entry.
"destinationNotCrawlable": { # Evidence that the creative's destination URL was not crawlable by Google. # The creative's destination URL was not crawlable by Google.
"crawlTime": "A String", # Approximate time of the crawl.
"crawledUrl": "A String", # Destination URL that was attempted to be crawled.
"reason": "A String", # Reason of destination not crawlable.
},
"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up.
"dnsError": "A String", # DNS lookup errors.
"expandedUrl": "A String", # The full non-working URL.
"httpError": 42, # HTTP error code (for example, 404 or 5xx)
"invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page.
"lastCheckTime": "A String", # Approximate time when the ad destination was last checked.
"platform": "A String", # Platform of the non-working URL.
"redirectionError": "A String", # HTTP redirect chain error.
"urlRejected": "A String", # Rejected because of malformed URLs or invalid requests.
},
"destinationUrl": { # The full landing page URL of the destination. # URL of the actual landing page.
"destinationUrl": "A String", # The full landing page URL of the destination.
},
"domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain.
"topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative.
{ # The number of HTTP calls made to the given domain.
"domain": "A String", # The domain name.
"httpCallCount": 42, # Number of HTTP calls made to the domain.
},
],
"totalHttpCallCount": 42, # The total number of HTTP calls made by the creative, including but not limited to the number of calls in the top_http_call_domains.
},
"downloadSize": { # Total download size and URL-level download size breakdown for resources in a creative. # Total download size and URL-level download size breakdown for resources in a creative.
"topUrlDownloadSizeBreakdowns": [ # Download size broken down by URLs with the top download size.
{ # The URL-level breakdown for the download size.
"downloadSizeKb": 42, # Download size of the URL in kilobytes.
"normalizedUrl": "A String", # The normalized URL with query parameters and fragment removed.
},
],
"totalDownloadSizeKb": 42, # Total download size (in kilobytes) for all the resources in the creative.
},
"httpCall": { # HTTP calls made by a creative that resulted in policy violations. # HTTP calls made by the creative that resulted in policy violations.
"urls": [ # URLs of HTTP calls made by the creative.
"A String",
],
},
"httpCookie": { # Evidence for HTTP cookie-related policy violations. # Evidence for HTTP cookie-related policy violations.
"cookieNames": [ # Names of cookies that violate Google policies. For TOO_MANY_COOKIES policy, this will be the cookie names of top domains with the largest number of cookies. For other policies, this will be all the cookie names that violate the policy.
"A String",
],
"maxCookieCount": 42, # The largest number of cookies set by a creative. If this field is set, cookie_names above will be set to the cookie names of top domains with the largest number of cookies. This field will only be set for TOO_MANY_COOKIES policy.
},
},
],
"helpCenterUrl": "A String", # URL of the help center article describing this policy topic.
"missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776
"policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method
},
],
},
"dealsPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding on Programmatic Guaranteed and Preferred Deals (outside of Russia and China).
"status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method.
"topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED.
{ # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation.
"evidences": [ # Pieces of evidence associated with this policy topic entry.
{ # Evidence associated with a policy topic entry.
"destinationNotCrawlable": { # Evidence that the creative's destination URL was not crawlable by Google. # The creative's destination URL was not crawlable by Google.
"crawlTime": "A String", # Approximate time of the crawl.
"crawledUrl": "A String", # Destination URL that was attempted to be crawled.
"reason": "A String", # Reason of destination not crawlable.
},
"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up.
"dnsError": "A String", # DNS lookup errors.
"expandedUrl": "A String", # The full non-working URL.
"httpError": 42, # HTTP error code (for example, 404 or 5xx)
"invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page.
"lastCheckTime": "A String", # Approximate time when the ad destination was last checked.
"platform": "A String", # Platform of the non-working URL.
"redirectionError": "A String", # HTTP redirect chain error.
"urlRejected": "A String", # Rejected because of malformed URLs or invalid requests.
},
"destinationUrl": { # The full landing page URL of the destination. # URL of the actual landing page.
"destinationUrl": "A String", # The full landing page URL of the destination.
},
"domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain.
"topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative.
{ # The number of HTTP calls made to the given domain.
"domain": "A String", # The domain name.
"httpCallCount": 42, # Number of HTTP calls made to the domain.
},
],
"totalHttpCallCount": 42, # The total number of HTTP calls made by the creative, including but not limited to the number of calls in the top_http_call_domains.
},
"downloadSize": { # Total download size and URL-level download size breakdown for resources in a creative. # Total download size and URL-level download size breakdown for resources in a creative.
"topUrlDownloadSizeBreakdowns": [ # Download size broken down by URLs with the top download size.
{ # The URL-level breakdown for the download size.
"downloadSizeKb": 42, # Download size of the URL in kilobytes.
"normalizedUrl": "A String", # The normalized URL with query parameters and fragment removed.
},
],
"totalDownloadSizeKb": 42, # Total download size (in kilobytes) for all the resources in the creative.
},
"httpCall": { # HTTP calls made by a creative that resulted in policy violations. # HTTP calls made by the creative that resulted in policy violations.
"urls": [ # URLs of HTTP calls made by the creative.
"A String",
],
},
"httpCookie": { # Evidence for HTTP cookie-related policy violations. # Evidence for HTTP cookie-related policy violations.
"cookieNames": [ # Names of cookies that violate Google policies. For TOO_MANY_COOKIES policy, this will be the cookie names of top domains with the largest number of cookies. For other policies, this will be all the cookie names that violate the policy.
"A String",
],
"maxCookieCount": 42, # The largest number of cookies set by a creative. If this field is set, cookie_names above will be set to the cookie names of top domains with the largest number of cookies. This field will only be set for TOO_MANY_COOKIES policy.
},
},
],
"helpCenterUrl": "A String", # URL of the help center article describing this policy topic.
"missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776
"policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method
},
],
},
"detectedAdvertisers": [ # Detected advertisers and brands.
{ # Detected advertiser and brand information.
"advertiserId": "A String", # See https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt for the list of possible values. Can be used to filter the response of the creatives.list method.
"advertiserName": "A String", # Advertiser name. Can be used to filter the response of the creatives.list method.
"brandId": "A String", # Detected brand ID or zero if no brand has been detected. See https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt for the list of possible values. Can be used to filter the response of the creatives.list method.
"brandName": "A String", # Brand name. Can be used to filter the response of the creatives.list method.
},
],
"detectedAttributes": [ # Publisher-excludable attributes that were detected for this creative. Can be used to filter the response of the creatives.list method. If the `excluded_attribute` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction.
"A String",
],
"detectedCategories": [ # Output only. IDs of the detected categories. The taxonomy in which the categories are expressed is specified by the detected_categories_taxonomy field. Use this in conjunction with BidRequest.bcat to avoid bidding on impressions where a given ad category is blocked, or to troubleshoot filtered bids. Can be used to filter the response of the creatives.list method.
"A String",
],
"detectedCategoriesTaxonomy": "A String", # Output only. The taxonomy in which the detected_categories field is expressed.
"detectedClickThroughUrls": [ # The set of detected destination URLs for the creative. Can be used to filter the response of the creatives.list method.
"A String",
],
"detectedDomains": [ # The detected domains for this creative.
"A String",
],
"detectedLanguages": [ # The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes. Can be used to filter the response of the creatives.list method.
"A String",
],
"detectedProductCategories": [ # Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs. Can be used to filter the response of the creatives.list method.
42,
],
"detectedSensitiveCategories": [ # Detected sensitive categories, if any. Can be used to filter the response of the creatives.list method. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids.
42,
],
"detectedVendorIds": [ # IDs of the ad technology vendors that were detected to be used by this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. Can be used to filter the response of the creatives.list method. If the `allowed_vendor_type` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto) does not contain one of the vendor type IDs that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction.
42,
],
"lastStatusUpdate": "A String", # The last time the creative status was updated. Can be used to filter the response of the creatives.list method.
"networkPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding in open auction, private auction, or auction packages (outside of Russia and China).
"status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method.
"topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED.
{ # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation.
"evidences": [ # Pieces of evidence associated with this policy topic entry.
{ # Evidence associated with a policy topic entry.
"destinationNotCrawlable": { # Evidence that the creative's destination URL was not crawlable by Google. # The creative's destination URL was not crawlable by Google.
"crawlTime": "A String", # Approximate time of the crawl.
"crawledUrl": "A String", # Destination URL that was attempted to be crawled.
"reason": "A String", # Reason of destination not crawlable.
},
"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up.
"dnsError": "A String", # DNS lookup errors.
"expandedUrl": "A String", # The full non-working URL.
"httpError": 42, # HTTP error code (for example, 404 or 5xx)
"invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page.
"lastCheckTime": "A String", # Approximate time when the ad destination was last checked.
"platform": "A String", # Platform of the non-working URL.
"redirectionError": "A String", # HTTP redirect chain error.
"urlRejected": "A String", # Rejected because of malformed URLs or invalid requests.
},
"destinationUrl": { # The full landing page URL of the destination. # URL of the actual landing page.
"destinationUrl": "A String", # The full landing page URL of the destination.
},
"domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain.
"topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative.
{ # The number of HTTP calls made to the given domain.
"domain": "A String", # The domain name.
"httpCallCount": 42, # Number of HTTP calls made to the domain.
},
],
"totalHttpCallCount": 42, # The total number of HTTP calls made by the creative, including but not limited to the number of calls in the top_http_call_domains.
},
"downloadSize": { # Total download size and URL-level download size breakdown for resources in a creative. # Total download size and URL-level download size breakdown for resources in a creative.
"topUrlDownloadSizeBreakdowns": [ # Download size broken down by URLs with the top download size.
{ # The URL-level breakdown for the download size.
"downloadSizeKb": 42, # Download size of the URL in kilobytes.
"normalizedUrl": "A String", # The normalized URL with query parameters and fragment removed.
},
],
"totalDownloadSizeKb": 42, # Total download size (in kilobytes) for all the resources in the creative.
},
"httpCall": { # HTTP calls made by a creative that resulted in policy violations. # HTTP calls made by the creative that resulted in policy violations.
"urls": [ # URLs of HTTP calls made by the creative.
"A String",
],
},
"httpCookie": { # Evidence for HTTP cookie-related policy violations. # Evidence for HTTP cookie-related policy violations.
"cookieNames": [ # Names of cookies that violate Google policies. For TOO_MANY_COOKIES policy, this will be the cookie names of top domains with the largest number of cookies. For other policies, this will be all the cookie names that violate the policy.
"A String",
],
"maxCookieCount": 42, # The largest number of cookies set by a creative. If this field is set, cookie_names above will be set to the cookie names of top domains with the largest number of cookies. This field will only be set for TOO_MANY_COOKIES policy.
},
},
],
"helpCenterUrl": "A String", # URL of the help center article describing this policy topic.
"missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776
"policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method
},
],
},
"platformPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # Policy compliance of this creative when bidding in Open Bidding (outside of Russia and China). For the list of platform policies, see: https://support.google.com/platformspolicy/answer/3013851.
"status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method.
"topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED.
{ # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation.
"evidences": [ # Pieces of evidence associated with this policy topic entry.
{ # Evidence associated with a policy topic entry.
"destinationNotCrawlable": { # Evidence that the creative's destination URL was not crawlable by Google. # The creative's destination URL was not crawlable by Google.
"crawlTime": "A String", # Approximate time of the crawl.
"crawledUrl": "A String", # Destination URL that was attempted to be crawled.
"reason": "A String", # Reason of destination not crawlable.
},
"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up.
"dnsError": "A String", # DNS lookup errors.
"expandedUrl": "A String", # The full non-working URL.
"httpError": 42, # HTTP error code (for example, 404 or 5xx)
"invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page.
"lastCheckTime": "A String", # Approximate time when the ad destination was last checked.
"platform": "A String", # Platform of the non-working URL.
"redirectionError": "A String", # HTTP redirect chain error.
"urlRejected": "A String", # Rejected because of malformed URLs or invalid requests.
},
"destinationUrl": { # The full landing page URL of the destination. # URL of the actual landing page.
"destinationUrl": "A String", # The full landing page URL of the destination.
},
"domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain.
"topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative.
{ # The number of HTTP calls made to the given domain.
"domain": "A String", # The domain name.
"httpCallCount": 42, # Number of HTTP calls made to the domain.
},
],
"totalHttpCallCount": 42, # The total number of HTTP calls made by the creative, including but not limited to the number of calls in the top_http_call_domains.
},
"downloadSize": { # Total download size and URL-level download size breakdown for resources in a creative. # Total download size and URL-level download size breakdown for resources in a creative.
"topUrlDownloadSizeBreakdowns": [ # Download size broken down by URLs with the top download size.
{ # The URL-level breakdown for the download size.
"downloadSizeKb": 42, # Download size of the URL in kilobytes.
"normalizedUrl": "A String", # The normalized URL with query parameters and fragment removed.
},
],
"totalDownloadSizeKb": 42, # Total download size (in kilobytes) for all the resources in the creative.
},
"httpCall": { # HTTP calls made by a creative that resulted in policy violations. # HTTP calls made by the creative that resulted in policy violations.
"urls": [ # URLs of HTTP calls made by the creative.
"A String",
],
},
"httpCookie": { # Evidence for HTTP cookie-related policy violations. # Evidence for HTTP cookie-related policy violations.
"cookieNames": [ # Names of cookies that violate Google policies. For TOO_MANY_COOKIES policy, this will be the cookie names of top domains with the largest number of cookies. For other policies, this will be all the cookie names that violate the policy.
"A String",
],
"maxCookieCount": 42, # The largest number of cookies set by a creative. If this field is set, cookie_names above will be set to the cookie names of top domains with the largest number of cookies. This field will only be set for TOO_MANY_COOKIES policy.
},
},
],
"helpCenterUrl": "A String", # URL of the help center article describing this policy topic.
"missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776
"policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method
},
],
},
"russiaPolicyCompliance": { # Policy compliance of the creative for a transaction type or a region. # The policy compliance of this creative in Russia. When approved or disapproved, this applies to both deals and open auction in Russia. When pending review, this creative is allowed to serve for deals but not for open auction.
"status": "A String", # Serving status for the given transaction type (for example, open auction, deals) or region (for example, China, Russia). Can be used to filter the response of the creatives.list method.
"topics": [ # Topics related to the policy compliance for this transaction type (for example, open auction, deals) or region (for example, China, Russia). Topics may be present only if status is DISAPPROVED.
{ # Each policy topic entry will represent a violation of a policy topic for a creative, with the policy topic information and optional evidence for the policy violation.
"evidences": [ # Pieces of evidence associated with this policy topic entry.
{ # Evidence associated with a policy topic entry.
"destinationNotCrawlable": { # Evidence that the creative's destination URL was not crawlable by Google. # The creative's destination URL was not crawlable by Google.
"crawlTime": "A String", # Approximate time of the crawl.
"crawledUrl": "A String", # Destination URL that was attempted to be crawled.
"reason": "A String", # Reason of destination not crawlable.
},
"destinationNotWorking": { # Evidence of the creative's destination URL not functioning properly or having been incorrectly set up. # The creative's destination URL did not function properly or was incorrectly set up.
"dnsError": "A String", # DNS lookup errors.
"expandedUrl": "A String", # The full non-working URL.
"httpError": 42, # HTTP error code (for example, 404 or 5xx)
"invalidPage": "A String", # Page was crawled successfully, but was detected as either a page with no content or an error page.
"lastCheckTime": "A String", # Approximate time when the ad destination was last checked.
"platform": "A String", # Platform of the non-working URL.
"redirectionError": "A String", # HTTP redirect chain error.
"urlRejected": "A String", # Rejected because of malformed URLs or invalid requests.
},
"destinationUrl": { # The full landing page URL of the destination. # URL of the actual landing page.
"destinationUrl": "A String", # The full landing page URL of the destination.
},
"domainCall": { # Number of HTTP calls made by a creative, broken down by domain. # Number of HTTP calls made by the creative, broken down by domain.
"topHttpCallDomains": [ # Breakdown of the most frequent domains called through HTTP by the creative.
{ # The number of HTTP calls made to the given domain.
"domain": "A String", # The domain name.
"httpCallCount": 42, # Number of HTTP calls made to the domain.
},
],
"totalHttpCallCount": 42, # The total number of HTTP calls made by the creative, including but not limited to the number of calls in the top_http_call_domains.
},
"downloadSize": { # Total download size and URL-level download size breakdown for resources in a creative. # Total download size and URL-level download size breakdown for resources in a creative.
"topUrlDownloadSizeBreakdowns": [ # Download size broken down by URLs with the top download size.
{ # The URL-level breakdown for the download size.
"downloadSizeKb": 42, # Download size of the URL in kilobytes.
"normalizedUrl": "A String", # The normalized URL with query parameters and fragment removed.
},
],
"totalDownloadSizeKb": 42, # Total download size (in kilobytes) for all the resources in the creative.
},
"httpCall": { # HTTP calls made by a creative that resulted in policy violations. # HTTP calls made by the creative that resulted in policy violations.
"urls": [ # URLs of HTTP calls made by the creative.
"A String",
],
},
"httpCookie": { # Evidence for HTTP cookie-related policy violations. # Evidence for HTTP cookie-related policy violations.
"cookieNames": [ # Names of cookies that violate Google policies. For TOO_MANY_COOKIES policy, this will be the cookie names of top domains with the largest number of cookies. For other policies, this will be all the cookie names that violate the policy.
"A String",
],
"maxCookieCount": 42, # The largest number of cookies set by a creative. If this field is set, cookie_names above will be set to the cookie names of top domains with the largest number of cookies. This field will only be set for TOO_MANY_COOKIES policy.
},
},
],
"helpCenterUrl": "A String", # URL of the help center article describing this policy topic.
"missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776
"policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method
},
],
},
},
"dealIds": [ # Output only. IDs of all of the deals with which this creative has been used in bidding. Can be used to filter the response of the creatives.list method.
"A String",
],
"declaredAttributes": [ # All declared attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. If the `excluded_attribute` field of a [bid request](https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto") contains one of the attributes that were declared or detected for a given creative, and a bid is submitted with that creative, the bid will be filtered before the auction.
"A String",
],
"declaredClickThroughUrls": [ # The set of declared destination URLs for the creative. Can be used to filter the response of the creatives.list method.
"A String",
],
"declaredRestrictedCategories": [ # All declared restricted categories for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method.
"A String",
],
"declaredVendorIds": [ # IDs for the declared ad technology vendors that may be used by this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. Can be used to filter the response of the creatives.list method.
42,
],
"html": { # HTML content for a creative. # An HTML creative.
"height": 42, # The height of the HTML snippet in pixels. Can be used to filter the response of the creatives.list method.
"snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
"width": 42, # The width of the HTML snippet in pixels. Can be used to filter the response of the creatives.list method.
},
"impressionTrackingUrls": [ # The set of URLs to be called to record an impression.
"A String",
],
"name": "A String", # Output only. Name of the creative. Follows the pattern `buyers/{buyer}/creatives/{creative}`, where `{buyer}` represents the account ID of the buyer who owns the creative, and `{creative}` is the buyer-specific creative ID that references this creative in the bid response.
"native": { # Native content for a creative. # A native creative.
"advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative.
"appIcon": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # The app icon, for app download ads.
"height": 42, # Image height in pixels.
"url": "A String", # The URL of the image.
"width": 42, # Image width in pixels.
},
"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": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A large image.
"height": 42, # Image height in pixels.
"url": "A String", # The URL of the image.
"width": 42, # Image width in pixels.
},
"logo": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A smaller image, for the advertiser's logo.
"height": 42, # Image height in pixels.
"url": "A String", # The URL of the image.
"width": 42, # Image width in pixels.
},
"priceDisplayText": "A String", # The price of the promoted app including currency info.
"starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
"videoUrl": "A String", # The URL to fetch a native video ad.
"videoVastXml": "A String", # The contents of a VAST document for a native video ad.
},
"renderUrl": "A String", # Experimental field that can be used during the [FLEDGE Origin Trial](/authorized-buyers/rtb/fledge-origin-trial). The URL to fetch an interest group ad used in [TURTLEDOVE on-device auction](https://github.com/WICG/turtledove/blob/main/FLEDGE.md#1-browsers-record-interest-groups"). This should be unique among all creatives for a given `accountId`. This URL should be the same as the URL returned by [generateBid()](https://github.com/WICG/turtledove/blob/main/FLEDGE.md#32-on-device-bidding).
"restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
"A String",
],
"version": 42, # Output only. The version of the creative. Version for a new creative is 1 and it increments during subsequent creative updates.
"video": { # Video content for a creative. # A video creative.
"videoMetadata": { # Video metadata for a creative. # Output only. Video metadata.
"duration": "A String", # The duration of the ad. Can be used to filter the response of the creatives.list method.
"isValidVast": True or False, # Is this a valid VAST ad? Can be used to filter the response of the creatives.list method.
"isVpaid": True or False, # Is this a VPAID ad? Can be used to filter the response of the creatives.list method.
"mediaFiles": [ # The list of all media files declared in the VAST. If there are multiple VASTs in a wrapper chain, this includes the media files from the deepest one in the chain.
{ # Information about each media file in the VAST.
"bitrate": "A String", # Bitrate of the video file, in Kbps. Can be used to filter the response of the creatives.list method.
"mimeType": "A String", # The MIME type of this media file. Can be used to filter the response of the creatives.list method.
},
],
"skipOffset": "A String", # The minimum duration that the user has to watch before being able to skip this ad. If the field is not set, the ad is not skippable. If the field is set, the ad is skippable. Can be used to filter the response of the creatives.list method.
"vastVersion": "A String", # The maximum VAST version across all wrapped VAST documents. Can be used to filter the response of the creatives.list method.
},
"videoUrl": "A String", # The URL to fetch a video ad. The URL should return an XML response that conforms to the VAST 2.0, 3.0 or 4.x standard.
"videoVastXml": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0, 3.0, or 4.x standard.
},
},
],
"nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListCreativesRequest.pageToken field in the subsequent call to the `ListCreatives` 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>
<div class="method">
<code class="details" id="watch">watch(parent, body=None, x__xgafv=None)</code>
<pre>Watches all creatives pertaining to a bidder. It is sufficient to invoke this endpoint once per bidder. A Pub/Sub topic will be created and notifications will be pushed to the topic when any of the bidder's creatives change status. All of the bidder's service accounts will have access to read from the topic. Subsequent invocations of this method will return the existing Pub/Sub configuration.
Args:
parent: string, Required. To watch all creatives pertaining to the bidder and all its child seat accounts, the bidder must follow the pattern `bidders/{bidderAccountId}`. (required)
body: object, The request body.
The object takes the form of:
{ # A request to receive push notifications when any of the creatives belonging to the bidder changes status.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A response for the request to receive push notification when a bidder's creatives change status.
"subscription": "A String", # The Pub/Sub subscription that can be used to pull creative status notifications. This would be of the format `projects/{project_id}/subscriptions/{subscription_id}`. Subscription is created with pull delivery. All service accounts belonging to the bidder will have read access to this subscription. Subscriptions that are inactive for more than 90 days will be disabled. Use watchCreatives to re-enable the subscription.
"topic": "A String", # The Pub/Sub topic that will be used to publish creative serving status notifications. This would be of the format `projects/{project_id}/topics/{topic_id}`.
}</pre>
</div>
</body></html>
|
