1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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_4.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1_4.creatives.html">creatives</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#addDeal">addDeal(accountId, buyerCreativeId, dealId)</a></code></p> 79<p class="firstline">Add a deal id association for the creative.</p> 80<p class="toc_element"> 81 <code><a href="#close">close()</a></code></p> 82<p class="firstline">Close httplib2 connections.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(accountId, buyerCreativeId)</a></code></p> 85<p class="firstline">Gets the status for a single creative. A creative will be available 30-40 minutes after submission.</p> 86<p class="toc_element"> 87 <code><a href="#insert">insert(body=None)</a></code></p> 88<p class="firstline">Submit a new creative.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(accountId=None, buyerCreativeId=None, dealsStatusFilter=None, maxResults=None, openAuctionStatusFilter=None, pageToken=None)</a></code></p> 91<p class="firstline">Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission.</p> 92<p class="toc_element"> 93 <code><a href="#listDeals">listDeals(accountId, buyerCreativeId)</a></code></p> 94<p class="firstline">Lists the external deal ids associated with the creative.</p> 95<p class="toc_element"> 96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 97<p class="firstline">Retrieves the next page of results.</p> 98<p class="toc_element"> 99 <code><a href="#removeDeal">removeDeal(accountId, buyerCreativeId, dealId)</a></code></p> 100<p class="firstline">Remove a deal id associated with the creative.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="addDeal">addDeal(accountId, buyerCreativeId, dealId)</code> 104 <pre>Add a deal id association for the creative. 105 106Args: 107 accountId: integer, The id for the account that will serve this creative. (required) 108 buyerCreativeId: string, The buyer-specific id for this creative. (required) 109 dealId: string, The id of the deal id to associate with this creative. (required) 110</pre> 111</div> 112 113<div class="method"> 114 <code class="details" id="close">close()</code> 115 <pre>Close httplib2 connections.</pre> 116</div> 117 118<div class="method"> 119 <code class="details" id="get">get(accountId, buyerCreativeId)</code> 120 <pre>Gets the status for a single creative. A creative will be available 30-40 minutes after submission. 121 122Args: 123 accountId: integer, The id for the account that will serve this creative. (required) 124 buyerCreativeId: string, The buyer-specific id for this creative. (required) 125 126Returns: 127 An object of the form: 128 129 { # A creative and its classification data. 130 "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL, videoVastXML, and nativeAd should not be set. 131 "accountId": 42, # Account id. 132 "adChoicesDestinationUrl": "A String", # The link to the Ad Preferences page. This is only supported for native ads. 133 "adTechnologyProviders": { 134 "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. 135 "A String", 136 ], 137 "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. 138 }, 139 "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests. 140 "A String", 141 ], 142 "advertiserName": "A String", # The name of the company being advertised in the creative. A list of advertisers is provided in the advertisers.txt file. 143 "agencyId": "A String", # The agency id for this creative. 144 "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). 145 "attribute": [ # List of buyer selectable attributes for the ads that may be shown from this snippet. Each attribute is represented by an integer as defined in buyer-declarable-creative-attributes.txt. 146 42, 147 ], 148 "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad. 149 "clickThroughUrl": [ # The set of destination urls for the snippet. 150 "A String", 151 ], 152 "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests. 153 { 154 "contexts": [ # All known serving contexts containing serving status information. 155 { 156 "auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to. 157 "A String", 158 ], 159 "contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness). 160 "geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this correction applies to. 161 42, 162 ], 163 "platform": [ # Only set when contextType=PLATFORM. Represents the platforms this correction applies to. 164 "A String", 165 ], 166 }, 167 ], 168 "details": [ # Additional details about the correction. 169 "A String", 170 ], 171 "reason": "A String", # The type of correction that was applied to the creative. 172 }, 173 ], 174 "creativeStatusIdentityType": "A String", # Creative status identity type that the creative item applies to. Ad Exchange real-time bidding is migrating to the sizeless creative verification. Originally, Ad Exchange assigned creative verification status to a unique combination of a buyer creative ID and creative dimensions. Post-migration, a single verification status will be assigned at the buyer creative ID level. This field allows to distinguish whether a given creative status applies to a unique combination of a buyer creative ID and creative dimensions, or to a buyer creative ID as a whole. 175 "dealsStatus": "A String", # Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly. 176 "detectedDomains": [ # Detected domains for this creative. Read-only. This field should not be set in requests. 177 "A String", 178 ], 179 "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests. 180 "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. 181 "reasons": [ # The filtering reasons. 182 { 183 "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange. 184 "filteringStatus": 42, # The filtering status code as defined in creative-status-codes.txt. 185 }, 186 ], 187 }, 188 "height": 42, # Ad height. 189 "impressionTrackingUrl": [ # The set of urls to be called to record an impression. 190 "A String", 191 ], 192 "kind": "adexchangebuyer#creative", # Resource type. 193 "languages": [ # Detected languages for this creative. Read-only. This field should not be set in requests. 194 "A String", 195 ], 196 "nativeAd": { # If nativeAd is set, HTMLSnippet, videoVastXML, and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.) 197 "advertiser": "A String", 198 "appIcon": { # The app icon, for app download ads. 199 "height": 42, 200 "url": "A String", 201 "width": 42, 202 }, 203 "body": "A String", # A long description of the ad. 204 "callToAction": "A String", # A label for the button that the user is supposed to click. 205 "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad. 206 "clickTrackingUrl": "A String", # The URL to use for click tracking. 207 "headline": "A String", # A short title for the ad. 208 "image": { # A large image. 209 "height": 42, 210 "url": "A String", 211 "width": 42, 212 }, 213 "impressionTrackingUrl": [ # The URLs are called when the impression is rendered. 214 "A String", 215 ], 216 "logo": { # A smaller image, for the advertiser logo. 217 "height": 42, 218 "url": "A String", 219 "width": 42, 220 }, 221 "price": "A String", # The price of the promoted app including the currency info. 222 "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5]. 223 "videoURL": "A String", # The URL of the XML VAST for a native ad. Note this is a separate field from resource.video_url. 224 }, 225 "openAuctionStatus": "A String", # Top-level open auction status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from ServingRestrictions directly. 226 "productCategories": [ # Detected product categories, if any. Each category is represented by an integer as defined in ad-product-categories.txt. Read-only. This field should not be set in requests. 227 42, 228 ], 229 "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet. Each category is represented by an integer as defined in the ad-restricted-categories.txt. 230 42, 231 ], 232 "sensitiveCategories": [ # Detected sensitive categories, if any. Each category is represented by an integer as defined in ad-sensitive-categories.txt. Read-only. This field should not be set in requests. 233 42, 234 ], 235 "servingRestrictions": [ # The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). Read-only. This field should not be set in requests. See the examples in the Creatives guide for more details. 236 { 237 "contexts": [ # All known contexts/restrictions. 238 { 239 "auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to. 240 "A String", 241 ], 242 "contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness). 243 "geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to. Impressions are considered to match a context if either the user location or publisher location matches a given geoCriteriaId. 244 42, 245 ], 246 "platform": [ # Only set when contextType=PLATFORM. Represents the platforms this restriction applies to. 247 "A String", 248 ], 249 }, 250 ], 251 "disapprovalReasons": [ # The reasons for disapproval within this restriction, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED or CONDITIONALLY_APPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. 252 { 253 "details": [ # Additional details about the reason for disapproval. 254 "A String", 255 ], 256 "reason": "A String", # The categorized reason for disapproval. 257 }, 258 ], 259 "reason": "A String", # Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review). 260 }, 261 ], 262 "vendorType": [ # List of vendor types for the ads that may be shown from this snippet. Each vendor type is represented by an integer as defined in vendors.txt. 263 42, 264 ], 265 "version": 42, # The version for this creative. Read-only. This field should not be set in requests. 266 "videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet, videoVastXML, and nativeAd should not be set. Note, this is different from resource.native_ad.video_url above. 267 "videoVastXML": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard. If set, HTMLSnippet, videoURL, and nativeAd and should not be set. 268 "width": 42, # Ad width. 269}</pre> 270</div> 271 272<div class="method"> 273 <code class="details" id="insert">insert(body=None)</code> 274 <pre>Submit a new creative. 275 276Args: 277 body: object, The request body. 278 The object takes the form of: 279 280{ # A creative and its classification data. 281 "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL, videoVastXML, and nativeAd should not be set. 282 "accountId": 42, # Account id. 283 "adChoicesDestinationUrl": "A String", # The link to the Ad Preferences page. This is only supported for native ads. 284 "adTechnologyProviders": { 285 "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. 286 "A String", 287 ], 288 "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. 289 }, 290 "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests. 291 "A String", 292 ], 293 "advertiserName": "A String", # The name of the company being advertised in the creative. A list of advertisers is provided in the advertisers.txt file. 294 "agencyId": "A String", # The agency id for this creative. 295 "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). 296 "attribute": [ # List of buyer selectable attributes for the ads that may be shown from this snippet. Each attribute is represented by an integer as defined in buyer-declarable-creative-attributes.txt. 297 42, 298 ], 299 "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad. 300 "clickThroughUrl": [ # The set of destination urls for the snippet. 301 "A String", 302 ], 303 "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests. 304 { 305 "contexts": [ # All known serving contexts containing serving status information. 306 { 307 "auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to. 308 "A String", 309 ], 310 "contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness). 311 "geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this correction applies to. 312 42, 313 ], 314 "platform": [ # Only set when contextType=PLATFORM. Represents the platforms this correction applies to. 315 "A String", 316 ], 317 }, 318 ], 319 "details": [ # Additional details about the correction. 320 "A String", 321 ], 322 "reason": "A String", # The type of correction that was applied to the creative. 323 }, 324 ], 325 "creativeStatusIdentityType": "A String", # Creative status identity type that the creative item applies to. Ad Exchange real-time bidding is migrating to the sizeless creative verification. Originally, Ad Exchange assigned creative verification status to a unique combination of a buyer creative ID and creative dimensions. Post-migration, a single verification status will be assigned at the buyer creative ID level. This field allows to distinguish whether a given creative status applies to a unique combination of a buyer creative ID and creative dimensions, or to a buyer creative ID as a whole. 326 "dealsStatus": "A String", # Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly. 327 "detectedDomains": [ # Detected domains for this creative. Read-only. This field should not be set in requests. 328 "A String", 329 ], 330 "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests. 331 "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. 332 "reasons": [ # The filtering reasons. 333 { 334 "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange. 335 "filteringStatus": 42, # The filtering status code as defined in creative-status-codes.txt. 336 }, 337 ], 338 }, 339 "height": 42, # Ad height. 340 "impressionTrackingUrl": [ # The set of urls to be called to record an impression. 341 "A String", 342 ], 343 "kind": "adexchangebuyer#creative", # Resource type. 344 "languages": [ # Detected languages for this creative. Read-only. This field should not be set in requests. 345 "A String", 346 ], 347 "nativeAd": { # If nativeAd is set, HTMLSnippet, videoVastXML, and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.) 348 "advertiser": "A String", 349 "appIcon": { # The app icon, for app download ads. 350 "height": 42, 351 "url": "A String", 352 "width": 42, 353 }, 354 "body": "A String", # A long description of the ad. 355 "callToAction": "A String", # A label for the button that the user is supposed to click. 356 "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad. 357 "clickTrackingUrl": "A String", # The URL to use for click tracking. 358 "headline": "A String", # A short title for the ad. 359 "image": { # A large image. 360 "height": 42, 361 "url": "A String", 362 "width": 42, 363 }, 364 "impressionTrackingUrl": [ # The URLs are called when the impression is rendered. 365 "A String", 366 ], 367 "logo": { # A smaller image, for the advertiser logo. 368 "height": 42, 369 "url": "A String", 370 "width": 42, 371 }, 372 "price": "A String", # The price of the promoted app including the currency info. 373 "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5]. 374 "videoURL": "A String", # The URL of the XML VAST for a native ad. Note this is a separate field from resource.video_url. 375 }, 376 "openAuctionStatus": "A String", # Top-level open auction status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from ServingRestrictions directly. 377 "productCategories": [ # Detected product categories, if any. Each category is represented by an integer as defined in ad-product-categories.txt. Read-only. This field should not be set in requests. 378 42, 379 ], 380 "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet. Each category is represented by an integer as defined in the ad-restricted-categories.txt. 381 42, 382 ], 383 "sensitiveCategories": [ # Detected sensitive categories, if any. Each category is represented by an integer as defined in ad-sensitive-categories.txt. Read-only. This field should not be set in requests. 384 42, 385 ], 386 "servingRestrictions": [ # The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). Read-only. This field should not be set in requests. See the examples in the Creatives guide for more details. 387 { 388 "contexts": [ # All known contexts/restrictions. 389 { 390 "auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to. 391 "A String", 392 ], 393 "contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness). 394 "geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to. Impressions are considered to match a context if either the user location or publisher location matches a given geoCriteriaId. 395 42, 396 ], 397 "platform": [ # Only set when contextType=PLATFORM. Represents the platforms this restriction applies to. 398 "A String", 399 ], 400 }, 401 ], 402 "disapprovalReasons": [ # The reasons for disapproval within this restriction, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED or CONDITIONALLY_APPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. 403 { 404 "details": [ # Additional details about the reason for disapproval. 405 "A String", 406 ], 407 "reason": "A String", # The categorized reason for disapproval. 408 }, 409 ], 410 "reason": "A String", # Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review). 411 }, 412 ], 413 "vendorType": [ # List of vendor types for the ads that may be shown from this snippet. Each vendor type is represented by an integer as defined in vendors.txt. 414 42, 415 ], 416 "version": 42, # The version for this creative. Read-only. This field should not be set in requests. 417 "videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet, videoVastXML, and nativeAd should not be set. Note, this is different from resource.native_ad.video_url above. 418 "videoVastXML": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard. If set, HTMLSnippet, videoURL, and nativeAd and should not be set. 419 "width": 42, # Ad width. 420} 421 422 423Returns: 424 An object of the form: 425 426 { # A creative and its classification data. 427 "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL, videoVastXML, and nativeAd should not be set. 428 "accountId": 42, # Account id. 429 "adChoicesDestinationUrl": "A String", # The link to the Ad Preferences page. This is only supported for native ads. 430 "adTechnologyProviders": { 431 "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. 432 "A String", 433 ], 434 "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. 435 }, 436 "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests. 437 "A String", 438 ], 439 "advertiserName": "A String", # The name of the company being advertised in the creative. A list of advertisers is provided in the advertisers.txt file. 440 "agencyId": "A String", # The agency id for this creative. 441 "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). 442 "attribute": [ # List of buyer selectable attributes for the ads that may be shown from this snippet. Each attribute is represented by an integer as defined in buyer-declarable-creative-attributes.txt. 443 42, 444 ], 445 "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad. 446 "clickThroughUrl": [ # The set of destination urls for the snippet. 447 "A String", 448 ], 449 "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests. 450 { 451 "contexts": [ # All known serving contexts containing serving status information. 452 { 453 "auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to. 454 "A String", 455 ], 456 "contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness). 457 "geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this correction applies to. 458 42, 459 ], 460 "platform": [ # Only set when contextType=PLATFORM. Represents the platforms this correction applies to. 461 "A String", 462 ], 463 }, 464 ], 465 "details": [ # Additional details about the correction. 466 "A String", 467 ], 468 "reason": "A String", # The type of correction that was applied to the creative. 469 }, 470 ], 471 "creativeStatusIdentityType": "A String", # Creative status identity type that the creative item applies to. Ad Exchange real-time bidding is migrating to the sizeless creative verification. Originally, Ad Exchange assigned creative verification status to a unique combination of a buyer creative ID and creative dimensions. Post-migration, a single verification status will be assigned at the buyer creative ID level. This field allows to distinguish whether a given creative status applies to a unique combination of a buyer creative ID and creative dimensions, or to a buyer creative ID as a whole. 472 "dealsStatus": "A String", # Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly. 473 "detectedDomains": [ # Detected domains for this creative. Read-only. This field should not be set in requests. 474 "A String", 475 ], 476 "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests. 477 "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. 478 "reasons": [ # The filtering reasons. 479 { 480 "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange. 481 "filteringStatus": 42, # The filtering status code as defined in creative-status-codes.txt. 482 }, 483 ], 484 }, 485 "height": 42, # Ad height. 486 "impressionTrackingUrl": [ # The set of urls to be called to record an impression. 487 "A String", 488 ], 489 "kind": "adexchangebuyer#creative", # Resource type. 490 "languages": [ # Detected languages for this creative. Read-only. This field should not be set in requests. 491 "A String", 492 ], 493 "nativeAd": { # If nativeAd is set, HTMLSnippet, videoVastXML, and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.) 494 "advertiser": "A String", 495 "appIcon": { # The app icon, for app download ads. 496 "height": 42, 497 "url": "A String", 498 "width": 42, 499 }, 500 "body": "A String", # A long description of the ad. 501 "callToAction": "A String", # A label for the button that the user is supposed to click. 502 "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad. 503 "clickTrackingUrl": "A String", # The URL to use for click tracking. 504 "headline": "A String", # A short title for the ad. 505 "image": { # A large image. 506 "height": 42, 507 "url": "A String", 508 "width": 42, 509 }, 510 "impressionTrackingUrl": [ # The URLs are called when the impression is rendered. 511 "A String", 512 ], 513 "logo": { # A smaller image, for the advertiser logo. 514 "height": 42, 515 "url": "A String", 516 "width": 42, 517 }, 518 "price": "A String", # The price of the promoted app including the currency info. 519 "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5]. 520 "videoURL": "A String", # The URL of the XML VAST for a native ad. Note this is a separate field from resource.video_url. 521 }, 522 "openAuctionStatus": "A String", # Top-level open auction status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from ServingRestrictions directly. 523 "productCategories": [ # Detected product categories, if any. Each category is represented by an integer as defined in ad-product-categories.txt. Read-only. This field should not be set in requests. 524 42, 525 ], 526 "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet. Each category is represented by an integer as defined in the ad-restricted-categories.txt. 527 42, 528 ], 529 "sensitiveCategories": [ # Detected sensitive categories, if any. Each category is represented by an integer as defined in ad-sensitive-categories.txt. Read-only. This field should not be set in requests. 530 42, 531 ], 532 "servingRestrictions": [ # The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). Read-only. This field should not be set in requests. See the examples in the Creatives guide for more details. 533 { 534 "contexts": [ # All known contexts/restrictions. 535 { 536 "auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to. 537 "A String", 538 ], 539 "contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness). 540 "geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to. Impressions are considered to match a context if either the user location or publisher location matches a given geoCriteriaId. 541 42, 542 ], 543 "platform": [ # Only set when contextType=PLATFORM. Represents the platforms this restriction applies to. 544 "A String", 545 ], 546 }, 547 ], 548 "disapprovalReasons": [ # The reasons for disapproval within this restriction, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED or CONDITIONALLY_APPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. 549 { 550 "details": [ # Additional details about the reason for disapproval. 551 "A String", 552 ], 553 "reason": "A String", # The categorized reason for disapproval. 554 }, 555 ], 556 "reason": "A String", # Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review). 557 }, 558 ], 559 "vendorType": [ # List of vendor types for the ads that may be shown from this snippet. Each vendor type is represented by an integer as defined in vendors.txt. 560 42, 561 ], 562 "version": 42, # The version for this creative. Read-only. This field should not be set in requests. 563 "videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet, videoVastXML, and nativeAd should not be set. Note, this is different from resource.native_ad.video_url above. 564 "videoVastXML": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard. If set, HTMLSnippet, videoURL, and nativeAd and should not be set. 565 "width": 42, # Ad width. 566}</pre> 567</div> 568 569<div class="method"> 570 <code class="details" id="list">list(accountId=None, buyerCreativeId=None, dealsStatusFilter=None, maxResults=None, openAuctionStatusFilter=None, pageToken=None)</code> 571 <pre>Retrieves a list of the authenticated user's active creatives. A creative will be available 30-40 minutes after submission. 572 573Args: 574 accountId: integer, When specified, only creatives for the given account ids are returned. (repeated) 575 buyerCreativeId: string, When specified, only creatives for the given buyer creative ids are returned. (repeated) 576 dealsStatusFilter: string, When specified, only creatives having the given deals status are returned. 577 Allowed values 578 approved - Creatives which have been approved for serving on deals. 579 conditionally_approved - Creatives which have been conditionally approved for serving on deals. 580 disapproved - Creatives which have been disapproved for serving on deals. 581 not_checked - Creatives whose deals status is not yet checked. 582 maxResults: integer, Maximum number of entries returned on one result page. If not set, the default is 100. Optional. 583 openAuctionStatusFilter: string, When specified, only creatives having the given open auction status are returned. 584 Allowed values 585 approved - Creatives which have been approved for serving on the open auction. 586 conditionally_approved - Creatives which have been conditionally approved for serving on the open auction. 587 disapproved - Creatives which have been disapproved for serving on the open auction. 588 not_checked - Creatives whose open auction status is not yet checked. 589 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. 590 591Returns: 592 An object of the form: 593 594 { # 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. 595 "items": [ # A list of creatives. 596 { # A creative and its classification data. 597 "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL, videoVastXML, and nativeAd should not be set. 598 "accountId": 42, # Account id. 599 "adChoicesDestinationUrl": "A String", # The link to the Ad Preferences page. This is only supported for native ads. 600 "adTechnologyProviders": { 601 "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. 602 "A String", 603 ], 604 "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. 605 }, 606 "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests. 607 "A String", 608 ], 609 "advertiserName": "A String", # The name of the company being advertised in the creative. A list of advertisers is provided in the advertisers.txt file. 610 "agencyId": "A String", # The agency id for this creative. 611 "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). 612 "attribute": [ # List of buyer selectable attributes for the ads that may be shown from this snippet. Each attribute is represented by an integer as defined in buyer-declarable-creative-attributes.txt. 613 42, 614 ], 615 "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad. 616 "clickThroughUrl": [ # The set of destination urls for the snippet. 617 "A String", 618 ], 619 "corrections": [ # Shows any corrections that were applied to this creative. Read-only. This field should not be set in requests. 620 { 621 "contexts": [ # All known serving contexts containing serving status information. 622 { 623 "auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this correction applies to. 624 "A String", 625 ], 626 "contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness). 627 "geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this correction applies to. 628 42, 629 ], 630 "platform": [ # Only set when contextType=PLATFORM. Represents the platforms this correction applies to. 631 "A String", 632 ], 633 }, 634 ], 635 "details": [ # Additional details about the correction. 636 "A String", 637 ], 638 "reason": "A String", # The type of correction that was applied to the creative. 639 }, 640 ], 641 "creativeStatusIdentityType": "A String", # Creative status identity type that the creative item applies to. Ad Exchange real-time bidding is migrating to the sizeless creative verification. Originally, Ad Exchange assigned creative verification status to a unique combination of a buyer creative ID and creative dimensions. Post-migration, a single verification status will be assigned at the buyer creative ID level. This field allows to distinguish whether a given creative status applies to a unique combination of a buyer creative ID and creative dimensions, or to a buyer creative ID as a whole. 642 "dealsStatus": "A String", # Top-level deals status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=DIRECT_DEALS (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from servingRestrictions directly. 643 "detectedDomains": [ # Detected domains for this creative. Read-only. This field should not be set in requests. 644 "A String", 645 ], 646 "filteringReasons": { # The filtering reasons for the creative. Read-only. This field should not be set in requests. 647 "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. 648 "reasons": [ # The filtering reasons. 649 { 650 "filteringCount": "A String", # The number of times the creative was filtered for the status. The count is aggregated across all publishers on the exchange. 651 "filteringStatus": 42, # The filtering status code as defined in creative-status-codes.txt. 652 }, 653 ], 654 }, 655 "height": 42, # Ad height. 656 "impressionTrackingUrl": [ # The set of urls to be called to record an impression. 657 "A String", 658 ], 659 "kind": "adexchangebuyer#creative", # Resource type. 660 "languages": [ # Detected languages for this creative. Read-only. This field should not be set in requests. 661 "A String", 662 ], 663 "nativeAd": { # If nativeAd is set, HTMLSnippet, videoVastXML, and the videoURL outside of nativeAd should not be set. (The videoURL inside nativeAd can be set.) 664 "advertiser": "A String", 665 "appIcon": { # The app icon, for app download ads. 666 "height": 42, 667 "url": "A String", 668 "width": 42, 669 }, 670 "body": "A String", # A long description of the ad. 671 "callToAction": "A String", # A label for the button that the user is supposed to click. 672 "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad. 673 "clickTrackingUrl": "A String", # The URL to use for click tracking. 674 "headline": "A String", # A short title for the ad. 675 "image": { # A large image. 676 "height": 42, 677 "url": "A String", 678 "width": 42, 679 }, 680 "impressionTrackingUrl": [ # The URLs are called when the impression is rendered. 681 "A String", 682 ], 683 "logo": { # A smaller image, for the advertiser logo. 684 "height": 42, 685 "url": "A String", 686 "width": 42, 687 }, 688 "price": "A String", # The price of the promoted app including the currency info. 689 "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5]. 690 "videoURL": "A String", # The URL of the XML VAST for a native ad. Note this is a separate field from resource.video_url. 691 }, 692 "openAuctionStatus": "A String", # Top-level open auction status. Read-only. This field should not be set in requests. If disapproved, an entry for auctionType=OPEN_AUCTION (or ALL) in servingRestrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case it may be preferable to read from ServingRestrictions directly. 693 "productCategories": [ # Detected product categories, if any. Each category is represented by an integer as defined in ad-product-categories.txt. Read-only. This field should not be set in requests. 694 42, 695 ], 696 "restrictedCategories": [ # All restricted categories for the ads that may be shown from this snippet. Each category is represented by an integer as defined in the ad-restricted-categories.txt. 697 42, 698 ], 699 "sensitiveCategories": [ # Detected sensitive categories, if any. Each category is represented by an integer as defined in ad-sensitive-categories.txt. Read-only. This field should not be set in requests. 700 42, 701 ], 702 "servingRestrictions": [ # The granular status of this ad in specific contexts. A context here relates to where something ultimately serves (for example, a physical location, a platform, an HTTPS vs HTTP request, or the type of auction). Read-only. This field should not be set in requests. See the examples in the Creatives guide for more details. 703 { 704 "contexts": [ # All known contexts/restrictions. 705 { 706 "auctionType": [ # Only set when contextType=AUCTION_TYPE. Represents the auction types this restriction applies to. 707 "A String", 708 ], 709 "contextType": "A String", # The type of context (e.g., location, platform, auction type, SSL-ness). 710 "geoCriteriaId": [ # Only set when contextType=LOCATION. Represents the geo criterias this restriction applies to. Impressions are considered to match a context if either the user location or publisher location matches a given geoCriteriaId. 711 42, 712 ], 713 "platform": [ # Only set when contextType=PLATFORM. Represents the platforms this restriction applies to. 714 "A String", 715 ], 716 }, 717 ], 718 "disapprovalReasons": [ # The reasons for disapproval within this restriction, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED or CONDITIONALLY_APPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. 719 { 720 "details": [ # Additional details about the reason for disapproval. 721 "A String", 722 ], 723 "reason": "A String", # The categorized reason for disapproval. 724 }, 725 ], 726 "reason": "A String", # Why the creative is ineligible to serve in this context (e.g., it has been explicitly disapproved or is pending review). 727 }, 728 ], 729 "vendorType": [ # List of vendor types for the ads that may be shown from this snippet. Each vendor type is represented by an integer as defined in vendors.txt. 730 42, 731 ], 732 "version": 42, # The version for this creative. Read-only. This field should not be set in requests. 733 "videoURL": "A String", # The URL to fetch a video ad. If set, HTMLSnippet, videoVastXML, and nativeAd should not be set. Note, this is different from resource.native_ad.video_url above. 734 "videoVastXML": "A String", # The contents of a VAST document for a video ad. This document should conform to the VAST 2.0 or 3.0 standard. If set, HTMLSnippet, videoURL, and nativeAd and should not be set. 735 "width": 42, # Ad width. 736 }, 737 ], 738 "kind": "adexchangebuyer#creativesList", # Resource type. 739 "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. 740}</pre> 741</div> 742 743<div class="method"> 744 <code class="details" id="listDeals">listDeals(accountId, buyerCreativeId)</code> 745 <pre>Lists the external deal ids associated with the creative. 746 747Args: 748 accountId: integer, The id for the account that will serve this creative. (required) 749 buyerCreativeId: string, The buyer-specific id for this creative. (required) 750 751Returns: 752 An object of the form: 753 754 { # The external deal ids associated with a creative. 755 "dealStatuses": [ # A list of external deal ids and ARC approval status. 756 { 757 "arcStatus": "A String", # ARC approval status. 758 "dealId": "A String", # External deal ID. 759 "webPropertyId": 42, # Publisher ID. 760 }, 761 ], 762 "kind": "adexchangebuyer#creativeDealIds", # Resource type. 763}</pre> 764</div> 765 766<div class="method"> 767 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 768 <pre>Retrieves the next page of results. 769 770Args: 771 previous_request: The request for the previous page. (required) 772 previous_response: The response from the request for the previous page. (required) 773 774Returns: 775 A request object that you can call 'execute()' on to request the next 776 page. Returns None if there are no more items in the collection. 777 </pre> 778</div> 779 780<div class="method"> 781 <code class="details" id="removeDeal">removeDeal(accountId, buyerCreativeId, dealId)</code> 782 <pre>Remove a deal id associated with the creative. 783 784Args: 785 accountId: integer, The id for the account that will serve this creative. (required) 786 buyerCreativeId: string, The buyer-specific id for this creative. (required) 787 dealId: string, The id of the deal id to disassociate with this creative. (required) 788</pre> 789</div> 790 791</body></html>