| 1 |
<html><body> |
| 2 |
<style> |
| 3 |
|
| 4 |
body, h1, h2, h3, div, span, p, pre, a { |
| 5 |
margin: 0; |
| 6 |
padding: 0; |
| 7 |
border: 0; |
| 8 |
font-weight: inherit; |
| 9 |
font-style: inherit; |
| 10 |
font-size: 100%; |
| 11 |
font-family: inherit; |
| 12 |
vertical-align: baseline; |
| 13 |
} |
| 14 |
|
| 15 |
body { |
| 16 |
font-size: 13px; |
| 17 |
padding: 1em; |
| 18 |
} |
| 19 |
|
| 20 |
h1 { |
| 21 |
font-size: 26px; |
| 22 |
margin-bottom: 1em; |
| 23 |
} |
| 24 |
|
| 25 |
h2 { |
| 26 |
font-size: 24px; |
| 27 |
margin-bottom: 1em; |
| 28 |
} |
| 29 |
|
| 30 |
h3 { |
| 31 |
font-size: 20px; |
| 32 |
margin-bottom: 1em; |
| 33 |
margin-top: 1em; |
| 34 |
} |
| 35 |
|
| 36 |
pre, code { |
| 37 |
line-height: 1.5; |
| 38 |
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 |
} |
| 40 |
|
| 41 |
pre { |
| 42 |
margin-top: 0.5em; |
| 43 |
} |
| 44 |
|
| 45 |
h1, h2, h3, p { |
| 46 |
font-family: Arial, sans serif; |
| 47 |
} |
| 48 |
|
| 49 |
h1, h2, h3 { |
| 50 |
border-bottom: solid #CCC 1px; |
| 51 |
} |
| 52 |
|
| 53 |
.toc_element { |
| 54 |
margin-top: 0.5em; |
| 55 |
} |
| 56 |
|
| 57 |
.firstline { |
| 58 |
margin-left: 2 em; |
| 59 |
} |
| 60 |
|
| 61 |
.method { |
| 62 |
margin-top: 1em; |
| 63 |
border: solid 1px #CCC; |
| 64 |
padding: 1em; |
| 65 |
background: #EEE; |
| 66 |
} |
| 67 |
|
| 68 |
.details { |
| 69 |
font-weight: bold; |
| 70 |
font-size: 14px; |
| 71 |
} |
| 72 |
|
| 73 |
</style> |
| 74 |
|
| 75 |
<h1><a href="adexchangebuyer_v1_3.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_3.creatives.html">creatives</a></h1> |
| 76 |
<h2>Instance Methods</h2> |
| 77 |
<p class="toc_element"> |
| 78 |
<code><a href="#close">close()</a></code></p> |
| 79 |
<p class="firstline">Close httplib2 connections.</p> |
| 80 |
<p class="toc_element"> |
| 81 |
<code><a href="#get">get(accountId, buyerCreativeId)</a></code></p> |
| 82 |
<p class="firstline">Gets the status for a single creative. A creative will be available 30-40 minutes after submission.</p> |
| 83 |
<p class="toc_element"> |
| 84 |
<code><a href="#insert">insert(body=None)</a></code></p> |
| 85 |
<p class="firstline">Submit a new creative.</p> |
| 86 |
<p class="toc_element"> |
| 87 |
<code><a href="#list">list(accountId=None, buyerCreativeId=None, maxResults=None, pageToken=None, statusFilter=None)</a></code></p> |
| 88 |
<p class="firstline">Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.</p> |
| 89 |
<p class="toc_element"> |
| 90 |
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 91 |
<p class="firstline">Retrieves the next page of results.</p> |
| 92 |
<h3>Method Details</h3> |
| 93 |
<div class="method"> |
| 94 |
<code class="details" id="close">close()</code> |
| 95 |
<pre>Close httplib2 connections.</pre> |
| 96 |
</div> |
| 97 |
|
| 98 |
<div class="method"> |
| 99 |
<code class="details" id="get">get(accountId, buyerCreativeId)</code> |
| 100 |
<pre>Gets the status for a single creative. A creative will be available 30-40 minutes after submission. |
| 101 |
|
| 102 |
Args: |
| 103 |
accountId: integer, The id for the account that will serve this creative. (required) |
| 104 |
buyerCreativeId: string, The buyer-specific id for this creative. (required) |
| 105 |
|
| 106 |
Returns: |
| 107 |
An object of the form: |
| 108 |
|
| 109 |
{ # A creative and its classification data. |
| 110 |
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set. |
| 111 |
"accountId": 42, # Account id. |
| 112 |
"adTechnologyProviders": { |
| 113 |
"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. |
| 114 |
"A String", |
| 115 |
], |
| 116 |
"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. |
| 117 |
}, |
| 118 |
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests. |
| 119 |
"A String", |
| 120 |
], |
| 121 |
"advertiserName": "A String", # The name of the company being advertised in the creative. |
| 122 |
"agencyId": "A String", # The agency id for this creative. |
| 123 |
"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). |
| 124 |
"attribute": [ # All attributes for the ads that may be shown from this snippet. |
| 125 |
42, |
| 126 |
], |
| 127 |
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad. |
| 128 |
"clickThroughUrl": [ # The set of destination urls for the snippet. |
| 129 |
"A String", |
| 130 |
], |
| 131 |
"corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests. |
| 132 |
{ |
| 133 |
"details": [ # Additional details about the correction. |
| 134 |
"A String", |
| 135 |
], |
| 136 |
"reason": "A String", # The type of correction that was applied to the creative. |
| 137 |
}, |
| 138 |
], |
| 139 |
"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. |
| 140 |
{ |
| 141 |
"details": [ # Additional details about the reason for disapproval. |
| 142 |
"A String", |
| 143 |
], |
| 144 |
"reason": "A String", # The categorized reason for disapproval. |
| 145 |
}, |
| 146 |
], |
| 147 |
"filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests. |
| 148 |
"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. |
| 149 |
"reasons": [ # The filtering reasons. |
| 150 |
{ |
| 151 |
"filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange. |
| 152 |
"filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses. |
| 153 |
}, |
| 154 |
], |
| 155 |
}, |
| 156 |
"height": 42, # Ad height. |
| 157 |
"impressionTrackingUrl": [ # The set of urls to be called to record an impression. |
| 158 |
"A String", |
| 159 |
], |
| 160 |
"kind": "adexchangebuyer#creative", # Resource type. |
| 161 |
"nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set. |
| 162 |
"advertiser": "A String", |
| 163 |
"appIcon": { # The app icon, for app download ads. |
| 164 |
"height": 42, |
| 165 |
"url": "A String", |
| 166 |
"width": 42, |
| 167 |
}, |
| 168 |
"body": "A String", # A long description of the ad. |
| 169 |
"callToAction": "A String", # A label for the button that the user is supposed to click. |
| 170 |
"clickTrackingUrl": "A String", # The URL to use for click tracking. |
| 171 |
"headline": "A String", # A short title for the ad. |
| 172 |
"image": { # A large image. |
| 173 |
"height": 42, |
| 174 |
"url": "A String", |
| 175 |
"width": 42, |
| 176 |
}, |
| 177 |
"impressionTrackingUrl": [ # The URLs are called when the impression is rendered. |
| 178 |
"A String", |
| 179 |
], |
| 180 |
"logo": { # A smaller image, for the advertiser logo. |
| 181 |
"height": 42, |
| 182 |
"url": "A String", |
| 183 |
"width": 42, |
| 184 |
}, |
| 185 |
"price": "A String", # The price of the promoted app including the currency info. |
| 186 |
"starRating": 3.14, # The app rating in the app store. Must be in the range [0-5]. |
| 187 |
}, |
| 188 |
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests. |
| 189 |
42, |
| 190 |
], |
| 191 |
"restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet. |
| 192 |
42, |
| 193 |
], |
| 194 |
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests. |
| 195 |
42, |
| 196 |
], |
| 197 |
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests. |
| 198 |
"vendorType": [ # All vendor types for the ads that may be shown from this snippet. |
| 199 |
42, |
| 200 |
], |
| 201 |
"version": 42, # The version for this creative. Read-only. This field should not be set in requests. |
| 202 |
"videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set. |
| 203 |
"width": 42, # Ad width. |
| 204 |
}</pre> |
| 205 |
</div> |
| 206 |
|
| 207 |
<div class="method"> |
| 208 |
<code class="details" id="insert">insert(body=None)</code> |
| 209 |
<pre>Submit a new creative. |
| 210 |
|
| 211 |
Args: |
| 212 |
body: object, The request body. |
| 213 |
The object takes the form of: |
| 214 |
|
| 215 |
{ # A creative and its classification data. |
| 216 |
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set. |
| 217 |
"accountId": 42, # Account id. |
| 218 |
"adTechnologyProviders": { |
| 219 |
"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. |
| 220 |
"A String", |
| 221 |
], |
| 222 |
"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. |
| 223 |
}, |
| 224 |
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests. |
| 225 |
"A String", |
| 226 |
], |
| 227 |
"advertiserName": "A String", # The name of the company being advertised in the creative. |
| 228 |
"agencyId": "A String", # The agency id for this creative. |
| 229 |
"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). |
| 230 |
"attribute": [ # All attributes for the ads that may be shown from this snippet. |
| 231 |
42, |
| 232 |
], |
| 233 |
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad. |
| 234 |
"clickThroughUrl": [ # The set of destination urls for the snippet. |
| 235 |
"A String", |
| 236 |
], |
| 237 |
"corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests. |
| 238 |
{ |
| 239 |
"details": [ # Additional details about the correction. |
| 240 |
"A String", |
| 241 |
], |
| 242 |
"reason": "A String", # The type of correction that was applied to the creative. |
| 243 |
}, |
| 244 |
], |
| 245 |
"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. |
| 246 |
{ |
| 247 |
"details": [ # Additional details about the reason for disapproval. |
| 248 |
"A String", |
| 249 |
], |
| 250 |
"reason": "A String", # The categorized reason for disapproval. |
| 251 |
}, |
| 252 |
], |
| 253 |
"filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests. |
| 254 |
"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. |
| 255 |
"reasons": [ # The filtering reasons. |
| 256 |
{ |
| 257 |
"filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange. |
| 258 |
"filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses. |
| 259 |
}, |
| 260 |
], |
| 261 |
}, |
| 262 |
"height": 42, # Ad height. |
| 263 |
"impressionTrackingUrl": [ # The set of urls to be called to record an impression. |
| 264 |
"A String", |
| 265 |
], |
| 266 |
"kind": "adexchangebuyer#creative", # Resource type. |
| 267 |
"nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set. |
| 268 |
"advertiser": "A String", |
| 269 |
"appIcon": { # The app icon, for app download ads. |
| 270 |
"height": 42, |
| 271 |
"url": "A String", |
| 272 |
"width": 42, |
| 273 |
}, |
| 274 |
"body": "A String", # A long description of the ad. |
| 275 |
"callToAction": "A String", # A label for the button that the user is supposed to click. |
| 276 |
"clickTrackingUrl": "A String", # The URL to use for click tracking. |
| 277 |
"headline": "A String", # A short title for the ad. |
| 278 |
"image": { # A large image. |
| 279 |
"height": 42, |
| 280 |
"url": "A String", |
| 281 |
"width": 42, |
| 282 |
}, |
| 283 |
"impressionTrackingUrl": [ # The URLs are called when the impression is rendered. |
| 284 |
"A String", |
| 285 |
], |
| 286 |
"logo": { # A smaller image, for the advertiser logo. |
| 287 |
"height": 42, |
| 288 |
"url": "A String", |
| 289 |
"width": 42, |
| 290 |
}, |
| 291 |
"price": "A String", # The price of the promoted app including the currency info. |
| 292 |
"starRating": 3.14, # The app rating in the app store. Must be in the range [0-5]. |
| 293 |
}, |
| 294 |
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests. |
| 295 |
42, |
| 296 |
], |
| 297 |
"restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet. |
| 298 |
42, |
| 299 |
], |
| 300 |
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests. |
| 301 |
42, |
| 302 |
], |
| 303 |
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests. |
| 304 |
"vendorType": [ # All vendor types for the ads that may be shown from this snippet. |
| 305 |
42, |
| 306 |
], |
| 307 |
"version": 42, # The version for this creative. Read-only. This field should not be set in requests. |
| 308 |
"videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set. |
| 309 |
"width": 42, # Ad width. |
| 310 |
} |
| 311 |
|
| 312 |
|
| 313 |
Returns: |
| 314 |
An object of the form: |
| 315 |
|
| 316 |
{ # A creative and its classification data. |
| 317 |
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set. |
| 318 |
"accountId": 42, # Account id. |
| 319 |
"adTechnologyProviders": { |
| 320 |
"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. |
| 321 |
"A String", |
| 322 |
], |
| 323 |
"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. |
| 324 |
}, |
| 325 |
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests. |
| 326 |
"A String", |
| 327 |
], |
| 328 |
"advertiserName": "A String", # The name of the company being advertised in the creative. |
| 329 |
"agencyId": "A String", # The agency id for this creative. |
| 330 |
"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). |
| 331 |
"attribute": [ # All attributes for the ads that may be shown from this snippet. |
| 332 |
42, |
| 333 |
], |
| 334 |
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad. |
| 335 |
"clickThroughUrl": [ # The set of destination urls for the snippet. |
| 336 |
"A String", |
| 337 |
], |
| 338 |
"corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests. |
| 339 |
{ |
| 340 |
"details": [ # Additional details about the correction. |
| 341 |
"A String", |
| 342 |
], |
| 343 |
"reason": "A String", # The type of correction that was applied to the creative. |
| 344 |
}, |
| 345 |
], |
| 346 |
"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. |
| 347 |
{ |
| 348 |
"details": [ # Additional details about the reason for disapproval. |
| 349 |
"A String", |
| 350 |
], |
| 351 |
"reason": "A String", # The categorized reason for disapproval. |
| 352 |
}, |
| 353 |
], |
| 354 |
"filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests. |
| 355 |
"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. |
| 356 |
"reasons": [ # The filtering reasons. |
| 357 |
{ |
| 358 |
"filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange. |
| 359 |
"filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses. |
| 360 |
}, |
| 361 |
], |
| 362 |
}, |
| 363 |
"height": 42, # Ad height. |
| 364 |
"impressionTrackingUrl": [ # The set of urls to be called to record an impression. |
| 365 |
"A String", |
| 366 |
], |
| 367 |
"kind": "adexchangebuyer#creative", # Resource type. |
| 368 |
"nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set. |
| 369 |
"advertiser": "A String", |
| 370 |
"appIcon": { # The app icon, for app download ads. |
| 371 |
"height": 42, |
| 372 |
"url": "A String", |
| 373 |
"width": 42, |
| 374 |
}, |
| 375 |
"body": "A String", # A long description of the ad. |
| 376 |
"callToAction": "A String", # A label for the button that the user is supposed to click. |
| 377 |
"clickTrackingUrl": "A String", # The URL to use for click tracking. |
| 378 |
"headline": "A String", # A short title for the ad. |
| 379 |
"image": { # A large image. |
| 380 |
"height": 42, |
| 381 |
"url": "A String", |
| 382 |
"width": 42, |
| 383 |
}, |
| 384 |
"impressionTrackingUrl": [ # The URLs are called when the impression is rendered. |
| 385 |
"A String", |
| 386 |
], |
| 387 |
"logo": { # A smaller image, for the advertiser logo. |
| 388 |
"height": 42, |
| 389 |
"url": "A String", |
| 390 |
"width": 42, |
| 391 |
}, |
| 392 |
"price": "A String", # The price of the promoted app including the currency info. |
| 393 |
"starRating": 3.14, # The app rating in the app store. Must be in the range [0-5]. |
| 394 |
}, |
| 395 |
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests. |
| 396 |
42, |
| 397 |
], |
| 398 |
"restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet. |
| 399 |
42, |
| 400 |
], |
| 401 |
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests. |
| 402 |
42, |
| 403 |
], |
| 404 |
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests. |
| 405 |
"vendorType": [ # All vendor types for the ads that may be shown from this snippet. |
| 406 |
42, |
| 407 |
], |
| 408 |
"version": 42, # The version for this creative. Read-only. This field should not be set in requests. |
| 409 |
"videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set. |
| 410 |
"width": 42, # Ad width. |
| 411 |
}</pre> |
| 412 |
</div> |
| 413 |
|
| 414 |
<div class="method"> |
| 415 |
<code class="details" id="list">list(accountId=None, buyerCreativeId=None, maxResults=None, pageToken=None, statusFilter=None)</code> |
| 416 |
<pre>Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission. |
| 417 |
|
| 418 |
Args: |
| 419 |
accountId: integer, When specified, only creatives for the given account ids are returned. (repeated) |
| 420 |
buyerCreativeId: string, When specified, only creatives for the given buyer creative ids are returned. (repeated) |
| 421 |
maxResults: integer, Maximum number of entries returned on one result page. If not set, the default is 100. Optional. |
| 422 |
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. |
| 423 |
statusFilter: string, When specified, only creatives having the given status are returned. |
| 424 |
Allowed values |
| 425 |
approved - Creatives which have been approved. |
| 426 |
disapproved - Creatives which have been disapproved. |
| 427 |
not_checked - Creatives whose status is not yet checked. |
| 428 |
|
| 429 |
Returns: |
| 430 |
An object of the form: |
| 431 |
|
| 432 |
{ # 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. |
| 433 |
"items": [ # A list of creatives. |
| 434 |
{ # A creative and its classification data. |
| 435 |
"HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set. |
| 436 |
"accountId": 42, # Account id. |
| 437 |
"adTechnologyProviders": { |
| 438 |
"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. |
| 439 |
"A String", |
| 440 |
], |
| 441 |
"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. |
| 442 |
}, |
| 443 |
"advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests. |
| 444 |
"A String", |
| 445 |
], |
| 446 |
"advertiserName": "A String", # The name of the company being advertised in the creative. |
| 447 |
"agencyId": "A String", # The agency id for this creative. |
| 448 |
"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). |
| 449 |
"attribute": [ # All attributes for the ads that may be shown from this snippet. |
| 450 |
42, |
| 451 |
], |
| 452 |
"buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad. |
| 453 |
"clickThroughUrl": [ # The set of destination urls for the snippet. |
| 454 |
"A String", |
| 455 |
], |
| 456 |
"corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests. |
| 457 |
{ |
| 458 |
"details": [ # Additional details about the correction. |
| 459 |
"A String", |
| 460 |
], |
| 461 |
"reason": "A String", # The type of correction that was applied to the creative. |
| 462 |
}, |
| 463 |
], |
| 464 |
"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. |
| 465 |
{ |
| 466 |
"details": [ # Additional details about the reason for disapproval. |
| 467 |
"A String", |
| 468 |
], |
| 469 |
"reason": "A String", # The categorized reason for disapproval. |
| 470 |
}, |
| 471 |
], |
| 472 |
"filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests. |
| 473 |
"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. |
| 474 |
"reasons": [ # The filtering reasons. |
| 475 |
{ |
| 476 |
"filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange. |
| 477 |
"filteringStatus": 42, # The filtering status code. Please refer to the creative-status-codes.txt file for different statuses. |
| 478 |
}, |
| 479 |
], |
| 480 |
}, |
| 481 |
"height": 42, # Ad height. |
| 482 |
"impressionTrackingUrl": [ # The set of urls to be called to record an impression. |
| 483 |
"A String", |
| 484 |
], |
| 485 |
"kind": "adexchangebuyer#creative", # Resource type. |
| 486 |
"nativeAd": { # If nativeAd is set, HTMLSnippet and videoURL should not be set. |
| 487 |
"advertiser": "A String", |
| 488 |
"appIcon": { # The app icon, for app download ads. |
| 489 |
"height": 42, |
| 490 |
"url": "A String", |
| 491 |
"width": 42, |
| 492 |
}, |
| 493 |
"body": "A String", # A long description of the ad. |
| 494 |
"callToAction": "A String", # A label for the button that the user is supposed to click. |
| 495 |
"clickTrackingUrl": "A String", # The URL to use for click tracking. |
| 496 |
"headline": "A String", # A short title for the ad. |
| 497 |
"image": { # A large image. |
| 498 |
"height": 42, |
| 499 |
"url": "A String", |
| 500 |
"width": 42, |
| 501 |
}, |
| 502 |
"impressionTrackingUrl": [ # The URLs are called when the impression is rendered. |
| 503 |
"A String", |
| 504 |
], |
| 505 |
"logo": { # A smaller image, for the advertiser logo. |
| 506 |
"height": 42, |
| 507 |
"url": "A String", |
| 508 |
"width": 42, |
| 509 |
}, |
| 510 |
"price": "A String", # The price of the promoted app including the currency info. |
| 511 |
"starRating": 3.14, # The app rating in the app store. Must be in the range [0-5]. |
| 512 |
}, |
| 513 |
"productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests. |
| 514 |
42, |
| 515 |
], |
| 516 |
"restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet. |
| 517 |
42, |
| 518 |
], |
| 519 |
"sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests. |
| 520 |
42, |
| 521 |
], |
| 522 |
"status": "A String", # Creative serving status. Read-only. This field should not be set in requests. |
| 523 |
"vendorType": [ # All vendor types for the ads that may be shown from this snippet. |
| 524 |
42, |
| 525 |
], |
| 526 |
"version": 42, # The version for this creative. Read-only. This field should not be set in requests. |
| 527 |
"videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet and the nativeAd should not be set. |
| 528 |
"width": 42, # Ad width. |
| 529 |
}, |
| 530 |
], |
| 531 |
"kind": "adexchangebuyer#creativesList", # Resource type. |
| 532 |
"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. |
| 533 |
}</pre> |
| 534 |
</div> |
| 535 |
|
| 536 |
<div class="method"> |
| 537 |
<code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 538 |
<pre>Retrieves the next page of results. |
| 539 |
|
| 540 |
Args: |
| 541 |
previous_request: The request for the previous page. (required) |
| 542 |
previous_response: The response from the request for the previous page. (required) |
| 543 |
|
| 544 |
Returns: |
| 545 |
A request object that you can call 'execute()' on to request the next |
| 546 |
page. Returns None if there are no more items in the collection. |
| 547 |
</pre> |
| 548 |
</div> |
| 549 |
|
| 550 |
</body></html> |