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
|
<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_2.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_2.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="#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(maxResults=None, pageToken=None, statusFilter=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="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="get">get(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 should not be set.
"accountId": 42, # Account id.
"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.
"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": [ # All attributes for the ads that may be shown from this snippet.
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.
{
"details": [ # Additional details about the correction.
"A String",
],
"reason": "A String", # The type of correction that was applied to the creative.
},
],
"disapprovalReasons": [ # The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
{
"details": [ # Additional details about the reason for disapproval.
"A String",
],
"reason": "A String", # The categorized reason for disapproval.
},
],
"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. Please refer to the creative-status-codes.txt file for different statuses.
},
],
},
"height": 42, # Ad height.
"impressionTrackingUrl": [ # The set of urls to be called to record an impression.
"A String",
],
"kind": "adexchangebuyer#creative", # Resource type.
"productCategories": [ # Detected product categories, if any. 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.
42,
],
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
42,
],
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
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 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 should not be set.
"accountId": 42, # Account id.
"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.
"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": [ # All attributes for the ads that may be shown from this snippet.
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.
{
"details": [ # Additional details about the correction.
"A String",
],
"reason": "A String", # The type of correction that was applied to the creative.
},
],
"disapprovalReasons": [ # The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
{
"details": [ # Additional details about the reason for disapproval.
"A String",
],
"reason": "A String", # The categorized reason for disapproval.
},
],
"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. Please refer to the creative-status-codes.txt file for different statuses.
},
],
},
"height": 42, # Ad height.
"impressionTrackingUrl": [ # The set of urls to be called to record an impression.
"A String",
],
"kind": "adexchangebuyer#creative", # Resource type.
"productCategories": [ # Detected product categories, if any. 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.
42,
],
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
42,
],
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
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 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 should not be set.
"accountId": 42, # Account id.
"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.
"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": [ # All attributes for the ads that may be shown from this snippet.
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.
{
"details": [ # Additional details about the correction.
"A String",
],
"reason": "A String", # The type of correction that was applied to the creative.
},
],
"disapprovalReasons": [ # The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
{
"details": [ # Additional details about the reason for disapproval.
"A String",
],
"reason": "A String", # The categorized reason for disapproval.
},
],
"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. Please refer to the creative-status-codes.txt file for different statuses.
},
],
},
"height": 42, # Ad height.
"impressionTrackingUrl": [ # The set of urls to be called to record an impression.
"A String",
],
"kind": "adexchangebuyer#creative", # Resource type.
"productCategories": [ # Detected product categories, if any. 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.
42,
],
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
42,
],
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
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 should not be set.
"width": 42, # Ad width.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(maxResults=None, pageToken=None, statusFilter=None)</code>
<pre>Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.
Args:
maxResults: integer, Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
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.
statusFilter: string, When specified, only creatives having the given status are returned.
Allowed values
approved - Creatives which have been approved.
disapproved - Creatives which have been disapproved.
not_checked - Creatives whose status is not yet checked.
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 should not be set.
"accountId": 42, # Account id.
"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.
"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": [ # All attributes for the ads that may be shown from this snippet.
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.
{
"details": [ # Additional details about the correction.
"A String",
],
"reason": "A String", # The type of correction that was applied to the creative.
},
],
"disapprovalReasons": [ # The reasons for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
{
"details": [ # Additional details about the reason for disapproval.
"A String",
],
"reason": "A String", # The categorized reason for disapproval.
},
],
"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. Please refer to the creative-status-codes.txt file for different statuses.
},
],
},
"height": 42, # Ad height.
"impressionTrackingUrl": [ # The set of urls to be called to record an impression.
"A String",
],
"kind": "adexchangebuyer#creative", # Resource type.
"productCategories": [ # Detected product categories, if any. 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.
42,
],
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
42,
],
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
"vendorType": [ # All vendor types for the ads that may be shown from this snippet.
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 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="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>
</body></html>
|
