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="adexchangebuyer2_v2beta1.html">Ad Exchange Buyer API II</a> . <a href="adexchangebuyer2_v2beta1.accounts.html">accounts</a> . <a href="adexchangebuyer2_v2beta1.accounts.creatives.html">creatives</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="adexchangebuyer2_v2beta1.accounts.creatives.dealAssociations.html">dealAssociations()</a></code> 79</p> 80<p class="firstline">Returns the dealAssociations Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#create">create(accountId, body=None, duplicateIdMode=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Creates a creative.</p> 88<p class="toc_element"> 89 <code><a href="#get">get(accountId, creativeId, x__xgafv=None)</a></code></p> 90<p class="firstline">Gets a creative.</p> 91<p class="toc_element"> 92 <code><a href="#list">list(accountId, pageSize=None, pageToken=None, query=None, x__xgafv=None)</a></code></p> 93<p class="firstline">Lists creatives.</p> 94<p class="toc_element"> 95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 96<p class="firstline">Retrieves the next page of results.</p> 97<p class="toc_element"> 98 <code><a href="#stopWatching">stopWatching(accountId, creativeId, body=None, x__xgafv=None)</a></code></p> 99<p class="firstline">Stops watching a creative. Will stop push notifications being sent to the topics when the creative changes status.</p> 100<p class="toc_element"> 101 <code><a href="#update">update(accountId, creativeId, body=None, x__xgafv=None)</a></code></p> 102<p class="firstline">Updates a creative.</p> 103<p class="toc_element"> 104 <code><a href="#watch">watch(accountId, creativeId, body=None, x__xgafv=None)</a></code></p> 105<p class="firstline">Watches a creative. Will result in push notifications being sent to the topic when the creative changes status.</p> 106<h3>Method Details</h3> 107<div class="method"> 108 <code class="details" id="close">close()</code> 109 <pre>Close httplib2 connections.</pre> 110</div> 111 112<div class="method"> 113 <code class="details" id="create">create(accountId, body=None, duplicateIdMode=None, x__xgafv=None)</code> 114 <pre>Creates a creative. 115 116Args: 117 accountId: string, The account that this creative belongs to. Can be used to filter the response of the creatives.list method. (required) 118 body: object, The request body. 119 The object takes the form of: 120 121{ # A creative and its classification data. 122 "accountId": "A String", # The account that this creative belongs to. Can be used to filter the response of the creatives.list method. 123 "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. 124 "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers. 125 "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 the creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will serve to an EEA user, the bid will be filtered before the auction. 126 "A String", 127 ], 128 "hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA user will be filtered before the auction. 129 }, 130 "advertiserName": "A String", # The name of the company being advertised in the creative. 131 "agencyId": "A String", # The agency ID for this creative. 132 "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. 133 "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. 134 "A String", 135 ], 136 "clickThroughUrls": [ # The set of destination URLs for the creative. 137 "A String", 138 ], 139 "corrections": [ # Output only. Shows any corrections that were applied to this creative. 140 { # Output only. Shows any corrections that were applied to this creative. 141 "contexts": [ # The contexts for the correction. 142 { # The serving context for this restriction. 143 "all": "A String", # Matches all contexts. 144 "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. 145 "appTypes": [ # The app types this restriction applies to. 146 "A String", 147 ], 148 }, 149 "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. 150 "auctionTypes": [ # The auction types this restriction applies to. 151 "A String", 152 ], 153 }, 154 "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. 155 "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 156 42, 157 ], 158 }, 159 "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. 160 "platforms": [ # The platforms this restriction applies to. 161 "A String", 162 ], 163 }, 164 "securityType": { # Output only. A security context. # Matches impressions for a particular security type. 165 "securities": [ # The security types in this context. 166 "A String", 167 ], 168 }, 169 }, 170 ], 171 "details": [ # Additional details about what was corrected. 172 "A String", 173 ], 174 "type": "A String", # The type of correction that was applied to the creative. 175 }, 176 ], 177 "creativeId": "A String", # The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method. 178 "dealsStatus": "A String", # Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method. 179 "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative. 180 "A String", 181 ], 182 "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any. 183 "A String", 184 ], 185 "detectedDomains": [ # Output only. The detected domains for this creative. 186 "A String", 187 ], 188 "detectedLanguages": [ # Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes. 189 "A String", 190 ], 191 "detectedProductCategories": [ # Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs. 192 42, 193 ], 194 "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids. 195 42, 196 ], 197 "html": { # HTML content for a creative. # An HTML creative. 198 "height": 42, # The height of the HTML snippet in pixels. 199 "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. 200 "width": 42, # The width of the HTML snippet in pixels. 201 }, 202 "impressionTrackingUrls": [ # The set of URLs to be called to record an impression. 203 "A String", 204 ], 205 "native": { # Native content for a creative. # A native creative. 206 "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative. 207 "appIcon": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # The app icon, for app download ads. 208 "height": 42, # Image height in pixels. 209 "url": "A String", # The URL of the image. 210 "width": 42, # Image width in pixels. 211 }, 212 "body": "A String", # A long description of the ad. 213 "callToAction": "A String", # A label for the button that the user is supposed to click. 214 "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad. 215 "clickTrackingUrl": "A String", # The URL to use for click tracking. 216 "headline": "A String", # A short title for the ad. 217 "image": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A large image. 218 "height": 42, # Image height in pixels. 219 "url": "A String", # The URL of the image. 220 "width": 42, # Image width in pixels. 221 }, 222 "logo": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A smaller image, for the advertiser's logo. 223 "height": 42, # Image height in pixels. 224 "url": "A String", # The URL of the image. 225 "width": 42, # Image width in pixels. 226 }, 227 "priceDisplayText": "A String", # The price of the promoted app including currency info. 228 "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5]. 229 "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app. 230 "videoUrl": "A String", # The URL to fetch a native video ad. 231 }, 232 "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method. 233 "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative. 234 "A String", 235 ], 236 "servingRestrictions": [ # Output only. 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). 237 { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction). 238 "contexts": [ # The contexts for the restriction. 239 { # The serving context for this restriction. 240 "all": "A String", # Matches all contexts. 241 "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. 242 "appTypes": [ # The app types this restriction applies to. 243 "A String", 244 ], 245 }, 246 "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. 247 "auctionTypes": [ # The auction types this restriction applies to. 248 "A String", 249 ], 250 }, 251 "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. 252 "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 253 42, 254 ], 255 }, 256 "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. 257 "platforms": [ # The platforms this restriction applies to. 258 "A String", 259 ], 260 }, 261 "securityType": { # Output only. A security context. # Matches impressions for a particular security type. 262 "securities": [ # The security types in this context. 263 "A String", 264 ], 265 }, 266 }, 267 ], 268 "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. 269 "details": [ # Additional details about the reason for disapproval. 270 "A String", 271 ], 272 "reason": "A String", # The categorized reason for disapproval. 273 }, 274 "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead. 275 { # Output only. The reason and details for a disapproval. 276 "details": [ # Additional details about the reason for disapproval. 277 "A String", 278 ], 279 "reason": "A String", # The categorized reason for disapproval. 280 }, 281 ], 282 "status": "A String", # The status of the creative in this context (for example, it has been explicitly disapproved or is pending review). 283 }, 284 ], 285 "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. 286 42, 287 ], 288 "version": 42, # Output only. The version of this creative. 289 "video": { # Video content for a creative. # A video creative. 290 "videoUrl": "A String", # The URL to fetch a video ad. 291 "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. 292 }, 293} 294 295 duplicateIdMode: string, Indicates if multiple creatives can share an ID or not. Default is NO_DUPLICATES (one ID per creative). 296 Allowed values 297 NO_DUPLICATES - Recommended. This means that an ID will be unique to a single creative. Multiple creatives will not share an ID. 298 FORCE_ENABLE_DUPLICATE_IDS - Not recommended. Using this option will allow multiple creatives to share the same ID. Get and Update requests will not be possible for any ID that has more than one creative associated. (List will still function.) This is only intended for backwards compatibility in cases where a single ID is already shared by multiple creatives from previous APIs. 299 x__xgafv: string, V1 error format. 300 Allowed values 301 1 - v1 error format 302 2 - v2 error format 303 304Returns: 305 An object of the form: 306 307 { # A creative and its classification data. 308 "accountId": "A String", # The account that this creative belongs to. Can be used to filter the response of the creatives.list method. 309 "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. 310 "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers. 311 "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 the creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will serve to an EEA user, the bid will be filtered before the auction. 312 "A String", 313 ], 314 "hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA user will be filtered before the auction. 315 }, 316 "advertiserName": "A String", # The name of the company being advertised in the creative. 317 "agencyId": "A String", # The agency ID for this creative. 318 "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. 319 "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. 320 "A String", 321 ], 322 "clickThroughUrls": [ # The set of destination URLs for the creative. 323 "A String", 324 ], 325 "corrections": [ # Output only. Shows any corrections that were applied to this creative. 326 { # Output only. Shows any corrections that were applied to this creative. 327 "contexts": [ # The contexts for the correction. 328 { # The serving context for this restriction. 329 "all": "A String", # Matches all contexts. 330 "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. 331 "appTypes": [ # The app types this restriction applies to. 332 "A String", 333 ], 334 }, 335 "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. 336 "auctionTypes": [ # The auction types this restriction applies to. 337 "A String", 338 ], 339 }, 340 "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. 341 "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 342 42, 343 ], 344 }, 345 "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. 346 "platforms": [ # The platforms this restriction applies to. 347 "A String", 348 ], 349 }, 350 "securityType": { # Output only. A security context. # Matches impressions for a particular security type. 351 "securities": [ # The security types in this context. 352 "A String", 353 ], 354 }, 355 }, 356 ], 357 "details": [ # Additional details about what was corrected. 358 "A String", 359 ], 360 "type": "A String", # The type of correction that was applied to the creative. 361 }, 362 ], 363 "creativeId": "A String", # The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method. 364 "dealsStatus": "A String", # Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method. 365 "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative. 366 "A String", 367 ], 368 "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any. 369 "A String", 370 ], 371 "detectedDomains": [ # Output only. The detected domains for this creative. 372 "A String", 373 ], 374 "detectedLanguages": [ # Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes. 375 "A String", 376 ], 377 "detectedProductCategories": [ # Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs. 378 42, 379 ], 380 "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids. 381 42, 382 ], 383 "html": { # HTML content for a creative. # An HTML creative. 384 "height": 42, # The height of the HTML snippet in pixels. 385 "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. 386 "width": 42, # The width of the HTML snippet in pixels. 387 }, 388 "impressionTrackingUrls": [ # The set of URLs to be called to record an impression. 389 "A String", 390 ], 391 "native": { # Native content for a creative. # A native creative. 392 "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative. 393 "appIcon": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # The app icon, for app download ads. 394 "height": 42, # Image height in pixels. 395 "url": "A String", # The URL of the image. 396 "width": 42, # Image width in pixels. 397 }, 398 "body": "A String", # A long description of the ad. 399 "callToAction": "A String", # A label for the button that the user is supposed to click. 400 "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad. 401 "clickTrackingUrl": "A String", # The URL to use for click tracking. 402 "headline": "A String", # A short title for the ad. 403 "image": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A large image. 404 "height": 42, # Image height in pixels. 405 "url": "A String", # The URL of the image. 406 "width": 42, # Image width in pixels. 407 }, 408 "logo": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A smaller image, for the advertiser's logo. 409 "height": 42, # Image height in pixels. 410 "url": "A String", # The URL of the image. 411 "width": 42, # Image width in pixels. 412 }, 413 "priceDisplayText": "A String", # The price of the promoted app including currency info. 414 "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5]. 415 "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app. 416 "videoUrl": "A String", # The URL to fetch a native video ad. 417 }, 418 "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method. 419 "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative. 420 "A String", 421 ], 422 "servingRestrictions": [ # Output only. 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). 423 { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction). 424 "contexts": [ # The contexts for the restriction. 425 { # The serving context for this restriction. 426 "all": "A String", # Matches all contexts. 427 "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. 428 "appTypes": [ # The app types this restriction applies to. 429 "A String", 430 ], 431 }, 432 "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. 433 "auctionTypes": [ # The auction types this restriction applies to. 434 "A String", 435 ], 436 }, 437 "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. 438 "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 439 42, 440 ], 441 }, 442 "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. 443 "platforms": [ # The platforms this restriction applies to. 444 "A String", 445 ], 446 }, 447 "securityType": { # Output only. A security context. # Matches impressions for a particular security type. 448 "securities": [ # The security types in this context. 449 "A String", 450 ], 451 }, 452 }, 453 ], 454 "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. 455 "details": [ # Additional details about the reason for disapproval. 456 "A String", 457 ], 458 "reason": "A String", # The categorized reason for disapproval. 459 }, 460 "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead. 461 { # Output only. The reason and details for a disapproval. 462 "details": [ # Additional details about the reason for disapproval. 463 "A String", 464 ], 465 "reason": "A String", # The categorized reason for disapproval. 466 }, 467 ], 468 "status": "A String", # The status of the creative in this context (for example, it has been explicitly disapproved or is pending review). 469 }, 470 ], 471 "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. 472 42, 473 ], 474 "version": 42, # Output only. The version of this creative. 475 "video": { # Video content for a creative. # A video creative. 476 "videoUrl": "A String", # The URL to fetch a video ad. 477 "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. 478 }, 479}</pre> 480</div> 481 482<div class="method"> 483 <code class="details" id="get">get(accountId, creativeId, x__xgafv=None)</code> 484 <pre>Gets a creative. 485 486Args: 487 accountId: string, The account the creative belongs to. (required) 488 creativeId: string, The ID of the creative to retrieve. (required) 489 x__xgafv: string, V1 error format. 490 Allowed values 491 1 - v1 error format 492 2 - v2 error format 493 494Returns: 495 An object of the form: 496 497 { # A creative and its classification data. 498 "accountId": "A String", # The account that this creative belongs to. Can be used to filter the response of the creatives.list method. 499 "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. 500 "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers. 501 "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 the creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will serve to an EEA user, the bid will be filtered before the auction. 502 "A String", 503 ], 504 "hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA user will be filtered before the auction. 505 }, 506 "advertiserName": "A String", # The name of the company being advertised in the creative. 507 "agencyId": "A String", # The agency ID for this creative. 508 "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. 509 "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. 510 "A String", 511 ], 512 "clickThroughUrls": [ # The set of destination URLs for the creative. 513 "A String", 514 ], 515 "corrections": [ # Output only. Shows any corrections that were applied to this creative. 516 { # Output only. Shows any corrections that were applied to this creative. 517 "contexts": [ # The contexts for the correction. 518 { # The serving context for this restriction. 519 "all": "A String", # Matches all contexts. 520 "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. 521 "appTypes": [ # The app types this restriction applies to. 522 "A String", 523 ], 524 }, 525 "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. 526 "auctionTypes": [ # The auction types this restriction applies to. 527 "A String", 528 ], 529 }, 530 "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. 531 "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 532 42, 533 ], 534 }, 535 "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. 536 "platforms": [ # The platforms this restriction applies to. 537 "A String", 538 ], 539 }, 540 "securityType": { # Output only. A security context. # Matches impressions for a particular security type. 541 "securities": [ # The security types in this context. 542 "A String", 543 ], 544 }, 545 }, 546 ], 547 "details": [ # Additional details about what was corrected. 548 "A String", 549 ], 550 "type": "A String", # The type of correction that was applied to the creative. 551 }, 552 ], 553 "creativeId": "A String", # The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method. 554 "dealsStatus": "A String", # Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method. 555 "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative. 556 "A String", 557 ], 558 "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any. 559 "A String", 560 ], 561 "detectedDomains": [ # Output only. The detected domains for this creative. 562 "A String", 563 ], 564 "detectedLanguages": [ # Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes. 565 "A String", 566 ], 567 "detectedProductCategories": [ # Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs. 568 42, 569 ], 570 "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids. 571 42, 572 ], 573 "html": { # HTML content for a creative. # An HTML creative. 574 "height": 42, # The height of the HTML snippet in pixels. 575 "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. 576 "width": 42, # The width of the HTML snippet in pixels. 577 }, 578 "impressionTrackingUrls": [ # The set of URLs to be called to record an impression. 579 "A String", 580 ], 581 "native": { # Native content for a creative. # A native creative. 582 "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative. 583 "appIcon": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # The app icon, for app download ads. 584 "height": 42, # Image height in pixels. 585 "url": "A String", # The URL of the image. 586 "width": 42, # Image width in pixels. 587 }, 588 "body": "A String", # A long description of the ad. 589 "callToAction": "A String", # A label for the button that the user is supposed to click. 590 "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad. 591 "clickTrackingUrl": "A String", # The URL to use for click tracking. 592 "headline": "A String", # A short title for the ad. 593 "image": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A large image. 594 "height": 42, # Image height in pixels. 595 "url": "A String", # The URL of the image. 596 "width": 42, # Image width in pixels. 597 }, 598 "logo": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A smaller image, for the advertiser's logo. 599 "height": 42, # Image height in pixels. 600 "url": "A String", # The URL of the image. 601 "width": 42, # Image width in pixels. 602 }, 603 "priceDisplayText": "A String", # The price of the promoted app including currency info. 604 "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5]. 605 "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app. 606 "videoUrl": "A String", # The URL to fetch a native video ad. 607 }, 608 "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method. 609 "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative. 610 "A String", 611 ], 612 "servingRestrictions": [ # Output only. 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). 613 { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction). 614 "contexts": [ # The contexts for the restriction. 615 { # The serving context for this restriction. 616 "all": "A String", # Matches all contexts. 617 "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. 618 "appTypes": [ # The app types this restriction applies to. 619 "A String", 620 ], 621 }, 622 "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. 623 "auctionTypes": [ # The auction types this restriction applies to. 624 "A String", 625 ], 626 }, 627 "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. 628 "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 629 42, 630 ], 631 }, 632 "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. 633 "platforms": [ # The platforms this restriction applies to. 634 "A String", 635 ], 636 }, 637 "securityType": { # Output only. A security context. # Matches impressions for a particular security type. 638 "securities": [ # The security types in this context. 639 "A String", 640 ], 641 }, 642 }, 643 ], 644 "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. 645 "details": [ # Additional details about the reason for disapproval. 646 "A String", 647 ], 648 "reason": "A String", # The categorized reason for disapproval. 649 }, 650 "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead. 651 { # Output only. The reason and details for a disapproval. 652 "details": [ # Additional details about the reason for disapproval. 653 "A String", 654 ], 655 "reason": "A String", # The categorized reason for disapproval. 656 }, 657 ], 658 "status": "A String", # The status of the creative in this context (for example, it has been explicitly disapproved or is pending review). 659 }, 660 ], 661 "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. 662 42, 663 ], 664 "version": 42, # Output only. The version of this creative. 665 "video": { # Video content for a creative. # A video creative. 666 "videoUrl": "A String", # The URL to fetch a video ad. 667 "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. 668 }, 669}</pre> 670</div> 671 672<div class="method"> 673 <code class="details" id="list">list(accountId, pageSize=None, pageToken=None, query=None, x__xgafv=None)</code> 674 <pre>Lists creatives. 675 676Args: 677 accountId: string, The account to list the creatives from. Specify "-" to list all creatives the current user has access to. (required) 678 pageSize: integer, Requested page size. The server may return fewer creatives than requested (due to timeout constraint) even if more are available via another call. If unspecified, server will pick an appropriate default. Acceptable values are 1 to 1000, inclusive. 679 pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListCreativesResponse.next_page_token returned from the previous call to 'ListCreatives' method. 680 query: string, An optional query string to filter creatives. If no filter is specified, all active creatives will be returned. Supported queries are: - accountId=*account_id_string* - creativeId=*creative_id_string* - dealsStatus: {approved, conditionally_approved, disapproved, not_checked} - openAuctionStatus: {approved, conditionally_approved, disapproved, not_checked} - attribute: {a numeric attribute from the list of attributes} - disapprovalReason: {a reason from DisapprovalReason} Example: 'accountId=12345 AND (dealsStatus:disapproved AND disapprovalReason:unacceptable_content) OR attribute:47' 681 x__xgafv: string, V1 error format. 682 Allowed values 683 1 - v1 error format 684 2 - v2 error format 685 686Returns: 687 An object of the form: 688 689 { # A response for listing creatives. 690 "creatives": [ # The list of creatives. 691 { # A creative and its classification data. 692 "accountId": "A String", # The account that this creative belongs to. Can be used to filter the response of the creatives.list method. 693 "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. 694 "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers. 695 "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 the creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will serve to an EEA user, the bid will be filtered before the auction. 696 "A String", 697 ], 698 "hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA user will be filtered before the auction. 699 }, 700 "advertiserName": "A String", # The name of the company being advertised in the creative. 701 "agencyId": "A String", # The agency ID for this creative. 702 "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. 703 "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. 704 "A String", 705 ], 706 "clickThroughUrls": [ # The set of destination URLs for the creative. 707 "A String", 708 ], 709 "corrections": [ # Output only. Shows any corrections that were applied to this creative. 710 { # Output only. Shows any corrections that were applied to this creative. 711 "contexts": [ # The contexts for the correction. 712 { # The serving context for this restriction. 713 "all": "A String", # Matches all contexts. 714 "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. 715 "appTypes": [ # The app types this restriction applies to. 716 "A String", 717 ], 718 }, 719 "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. 720 "auctionTypes": [ # The auction types this restriction applies to. 721 "A String", 722 ], 723 }, 724 "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. 725 "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 726 42, 727 ], 728 }, 729 "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. 730 "platforms": [ # The platforms this restriction applies to. 731 "A String", 732 ], 733 }, 734 "securityType": { # Output only. A security context. # Matches impressions for a particular security type. 735 "securities": [ # The security types in this context. 736 "A String", 737 ], 738 }, 739 }, 740 ], 741 "details": [ # Additional details about what was corrected. 742 "A String", 743 ], 744 "type": "A String", # The type of correction that was applied to the creative. 745 }, 746 ], 747 "creativeId": "A String", # The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method. 748 "dealsStatus": "A String", # Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method. 749 "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative. 750 "A String", 751 ], 752 "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any. 753 "A String", 754 ], 755 "detectedDomains": [ # Output only. The detected domains for this creative. 756 "A String", 757 ], 758 "detectedLanguages": [ # Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes. 759 "A String", 760 ], 761 "detectedProductCategories": [ # Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs. 762 42, 763 ], 764 "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids. 765 42, 766 ], 767 "html": { # HTML content for a creative. # An HTML creative. 768 "height": 42, # The height of the HTML snippet in pixels. 769 "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. 770 "width": 42, # The width of the HTML snippet in pixels. 771 }, 772 "impressionTrackingUrls": [ # The set of URLs to be called to record an impression. 773 "A String", 774 ], 775 "native": { # Native content for a creative. # A native creative. 776 "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative. 777 "appIcon": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # The app icon, for app download ads. 778 "height": 42, # Image height in pixels. 779 "url": "A String", # The URL of the image. 780 "width": 42, # Image width in pixels. 781 }, 782 "body": "A String", # A long description of the ad. 783 "callToAction": "A String", # A label for the button that the user is supposed to click. 784 "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad. 785 "clickTrackingUrl": "A String", # The URL to use for click tracking. 786 "headline": "A String", # A short title for the ad. 787 "image": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A large image. 788 "height": 42, # Image height in pixels. 789 "url": "A String", # The URL of the image. 790 "width": 42, # Image width in pixels. 791 }, 792 "logo": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A smaller image, for the advertiser's logo. 793 "height": 42, # Image height in pixels. 794 "url": "A String", # The URL of the image. 795 "width": 42, # Image width in pixels. 796 }, 797 "priceDisplayText": "A String", # The price of the promoted app including currency info. 798 "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5]. 799 "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app. 800 "videoUrl": "A String", # The URL to fetch a native video ad. 801 }, 802 "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method. 803 "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative. 804 "A String", 805 ], 806 "servingRestrictions": [ # Output only. 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). 807 { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction). 808 "contexts": [ # The contexts for the restriction. 809 { # The serving context for this restriction. 810 "all": "A String", # Matches all contexts. 811 "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. 812 "appTypes": [ # The app types this restriction applies to. 813 "A String", 814 ], 815 }, 816 "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. 817 "auctionTypes": [ # The auction types this restriction applies to. 818 "A String", 819 ], 820 }, 821 "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. 822 "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 823 42, 824 ], 825 }, 826 "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. 827 "platforms": [ # The platforms this restriction applies to. 828 "A String", 829 ], 830 }, 831 "securityType": { # Output only. A security context. # Matches impressions for a particular security type. 832 "securities": [ # The security types in this context. 833 "A String", 834 ], 835 }, 836 }, 837 ], 838 "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. 839 "details": [ # Additional details about the reason for disapproval. 840 "A String", 841 ], 842 "reason": "A String", # The categorized reason for disapproval. 843 }, 844 "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead. 845 { # Output only. The reason and details for a disapproval. 846 "details": [ # Additional details about the reason for disapproval. 847 "A String", 848 ], 849 "reason": "A String", # The categorized reason for disapproval. 850 }, 851 ], 852 "status": "A String", # The status of the creative in this context (for example, it has been explicitly disapproved or is pending review). 853 }, 854 ], 855 "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. 856 42, 857 ], 858 "version": 42, # Output only. The version of this creative. 859 "video": { # Video content for a creative. # A video creative. 860 "videoUrl": "A String", # The URL to fetch a video ad. 861 "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. 862 }, 863 }, 864 ], 865 "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListCreativesRequest.page_token field in the subsequent call to `ListCreatives` method to retrieve the next page of results. 866}</pre> 867</div> 868 869<div class="method"> 870 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 871 <pre>Retrieves the next page of results. 872 873Args: 874 previous_request: The request for the previous page. (required) 875 previous_response: The response from the request for the previous page. (required) 876 877Returns: 878 A request object that you can call 'execute()' on to request the next 879 page. Returns None if there are no more items in the collection. 880 </pre> 881</div> 882 883<div class="method"> 884 <code class="details" id="stopWatching">stopWatching(accountId, creativeId, body=None, x__xgafv=None)</code> 885 <pre>Stops watching a creative. Will stop push notifications being sent to the topics when the creative changes status. 886 887Args: 888 accountId: string, The account of the creative to stop notifications for. (required) 889 creativeId: string, The creative ID of the creative to stop notifications for. Specify "-" to specify stopping account level notifications. (required) 890 body: object, The request body. 891 The object takes the form of: 892 893{ # A request for stopping notifications for changes to creative Status. 894} 895 896 x__xgafv: string, V1 error format. 897 Allowed values 898 1 - v1 error format 899 2 - v2 error format 900 901Returns: 902 An object of the form: 903 904 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 905}</pre> 906</div> 907 908<div class="method"> 909 <code class="details" id="update">update(accountId, creativeId, body=None, x__xgafv=None)</code> 910 <pre>Updates a creative. 911 912Args: 913 accountId: string, The account that this creative belongs to. Can be used to filter the response of the creatives.list method. (required) 914 creativeId: string, The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method. (required) 915 body: object, The request body. 916 The object takes the form of: 917 918{ # A creative and its classification data. 919 "accountId": "A String", # The account that this creative belongs to. Can be used to filter the response of the creatives.list method. 920 "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. 921 "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers. 922 "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 the creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will serve to an EEA user, the bid will be filtered before the auction. 923 "A String", 924 ], 925 "hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA user will be filtered before the auction. 926 }, 927 "advertiserName": "A String", # The name of the company being advertised in the creative. 928 "agencyId": "A String", # The agency ID for this creative. 929 "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. 930 "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. 931 "A String", 932 ], 933 "clickThroughUrls": [ # The set of destination URLs for the creative. 934 "A String", 935 ], 936 "corrections": [ # Output only. Shows any corrections that were applied to this creative. 937 { # Output only. Shows any corrections that were applied to this creative. 938 "contexts": [ # The contexts for the correction. 939 { # The serving context for this restriction. 940 "all": "A String", # Matches all contexts. 941 "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. 942 "appTypes": [ # The app types this restriction applies to. 943 "A String", 944 ], 945 }, 946 "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. 947 "auctionTypes": [ # The auction types this restriction applies to. 948 "A String", 949 ], 950 }, 951 "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. 952 "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 953 42, 954 ], 955 }, 956 "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. 957 "platforms": [ # The platforms this restriction applies to. 958 "A String", 959 ], 960 }, 961 "securityType": { # Output only. A security context. # Matches impressions for a particular security type. 962 "securities": [ # The security types in this context. 963 "A String", 964 ], 965 }, 966 }, 967 ], 968 "details": [ # Additional details about what was corrected. 969 "A String", 970 ], 971 "type": "A String", # The type of correction that was applied to the creative. 972 }, 973 ], 974 "creativeId": "A String", # The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method. 975 "dealsStatus": "A String", # Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method. 976 "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative. 977 "A String", 978 ], 979 "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any. 980 "A String", 981 ], 982 "detectedDomains": [ # Output only. The detected domains for this creative. 983 "A String", 984 ], 985 "detectedLanguages": [ # Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes. 986 "A String", 987 ], 988 "detectedProductCategories": [ # Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs. 989 42, 990 ], 991 "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids. 992 42, 993 ], 994 "html": { # HTML content for a creative. # An HTML creative. 995 "height": 42, # The height of the HTML snippet in pixels. 996 "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. 997 "width": 42, # The width of the HTML snippet in pixels. 998 }, 999 "impressionTrackingUrls": [ # The set of URLs to be called to record an impression. 1000 "A String", 1001 ], 1002 "native": { # Native content for a creative. # A native creative. 1003 "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative. 1004 "appIcon": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # The app icon, for app download ads. 1005 "height": 42, # Image height in pixels. 1006 "url": "A String", # The URL of the image. 1007 "width": 42, # Image width in pixels. 1008 }, 1009 "body": "A String", # A long description of the ad. 1010 "callToAction": "A String", # A label for the button that the user is supposed to click. 1011 "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad. 1012 "clickTrackingUrl": "A String", # The URL to use for click tracking. 1013 "headline": "A String", # A short title for the ad. 1014 "image": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A large image. 1015 "height": 42, # Image height in pixels. 1016 "url": "A String", # The URL of the image. 1017 "width": 42, # Image width in pixels. 1018 }, 1019 "logo": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A smaller image, for the advertiser's logo. 1020 "height": 42, # Image height in pixels. 1021 "url": "A String", # The URL of the image. 1022 "width": 42, # Image width in pixels. 1023 }, 1024 "priceDisplayText": "A String", # The price of the promoted app including currency info. 1025 "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5]. 1026 "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app. 1027 "videoUrl": "A String", # The URL to fetch a native video ad. 1028 }, 1029 "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method. 1030 "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative. 1031 "A String", 1032 ], 1033 "servingRestrictions": [ # Output only. 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). 1034 { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction). 1035 "contexts": [ # The contexts for the restriction. 1036 { # The serving context for this restriction. 1037 "all": "A String", # Matches all contexts. 1038 "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. 1039 "appTypes": [ # The app types this restriction applies to. 1040 "A String", 1041 ], 1042 }, 1043 "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. 1044 "auctionTypes": [ # The auction types this restriction applies to. 1045 "A String", 1046 ], 1047 }, 1048 "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. 1049 "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 1050 42, 1051 ], 1052 }, 1053 "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. 1054 "platforms": [ # The platforms this restriction applies to. 1055 "A String", 1056 ], 1057 }, 1058 "securityType": { # Output only. A security context. # Matches impressions for a particular security type. 1059 "securities": [ # The security types in this context. 1060 "A String", 1061 ], 1062 }, 1063 }, 1064 ], 1065 "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. 1066 "details": [ # Additional details about the reason for disapproval. 1067 "A String", 1068 ], 1069 "reason": "A String", # The categorized reason for disapproval. 1070 }, 1071 "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead. 1072 { # Output only. The reason and details for a disapproval. 1073 "details": [ # Additional details about the reason for disapproval. 1074 "A String", 1075 ], 1076 "reason": "A String", # The categorized reason for disapproval. 1077 }, 1078 ], 1079 "status": "A String", # The status of the creative in this context (for example, it has been explicitly disapproved or is pending review). 1080 }, 1081 ], 1082 "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. 1083 42, 1084 ], 1085 "version": 42, # Output only. The version of this creative. 1086 "video": { # Video content for a creative. # A video creative. 1087 "videoUrl": "A String", # The URL to fetch a video ad. 1088 "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. 1089 }, 1090} 1091 1092 x__xgafv: string, V1 error format. 1093 Allowed values 1094 1 - v1 error format 1095 2 - v2 error format 1096 1097Returns: 1098 An object of the form: 1099 1100 { # A creative and its classification data. 1101 "accountId": "A String", # The account that this creative belongs to. Can be used to filter the response of the creatives.list method. 1102 "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. 1103 "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers. 1104 "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 the creative contains provider IDs that are outside of those listed in the `BidRequest.adslot.consented_providers_settings.consented_providers` field on the (Google bid protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] and the `BidRequest.user.ext.consented_providers_settings.consented_providers` field on the (OpenRTB protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], and a bid is submitted with that creative for an impression that will serve to an EEA user, the bid will be filtered before the auction. 1105 "A String", 1106 ], 1107 "hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. If true for a given creative, any bid submitted with that creative for an impression that will serve to an EEA user will be filtered before the auction. 1108 }, 1109 "advertiserName": "A String", # The name of the company being advertised in the creative. 1110 "agencyId": "A String", # The agency ID for this creative. 1111 "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. 1112 "attributes": [ # All attributes for the ads that may be shown from this creative. Can be used to filter the response of the creatives.list method. 1113 "A String", 1114 ], 1115 "clickThroughUrls": [ # The set of destination URLs for the creative. 1116 "A String", 1117 ], 1118 "corrections": [ # Output only. Shows any corrections that were applied to this creative. 1119 { # Output only. Shows any corrections that were applied to this creative. 1120 "contexts": [ # The contexts for the correction. 1121 { # The serving context for this restriction. 1122 "all": "A String", # Matches all contexts. 1123 "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. 1124 "appTypes": [ # The app types this restriction applies to. 1125 "A String", 1126 ], 1127 }, 1128 "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. 1129 "auctionTypes": [ # The auction types this restriction applies to. 1130 "A String", 1131 ], 1132 }, 1133 "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. 1134 "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 1135 42, 1136 ], 1137 }, 1138 "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. 1139 "platforms": [ # The platforms this restriction applies to. 1140 "A String", 1141 ], 1142 }, 1143 "securityType": { # Output only. A security context. # Matches impressions for a particular security type. 1144 "securities": [ # The security types in this context. 1145 "A String", 1146 ], 1147 }, 1148 }, 1149 ], 1150 "details": [ # Additional details about what was corrected. 1151 "A String", 1152 ], 1153 "type": "A String", # The type of correction that was applied to the creative. 1154 }, 1155 ], 1156 "creativeId": "A String", # The buyer-defined creative ID of this creative. Can be used to filter the response of the creatives.list method. 1157 "dealsStatus": "A String", # Output only. The top-level deals status of this creative. If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method. 1158 "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative. 1159 "A String", 1160 ], 1161 "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any. 1162 "A String", 1163 ], 1164 "detectedDomains": [ # Output only. The detected domains for this creative. 1165 "A String", 1166 ], 1167 "detectedLanguages": [ # Output only. The detected languages for this creative. The order is arbitrary. The codes are 2 or 5 characters and are documented at https://developers.google.com/adwords/api/docs/appendix/languagecodes. 1168 "A String", 1169 ], 1170 "detectedProductCategories": [ # Output only. Detected product categories, if any. See the ad-product-categories.txt file in the technical documentation for a list of IDs. 1171 42, 1172 ], 1173 "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. See the ad-sensitive-categories.txt file in the technical documentation for a list of IDs. You should use these IDs along with the excluded-sensitive-category field in the bid request to filter your bids. 1174 42, 1175 ], 1176 "html": { # HTML content for a creative. # An HTML creative. 1177 "height": 42, # The height of the HTML snippet in pixels. 1178 "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. 1179 "width": 42, # The width of the HTML snippet in pixels. 1180 }, 1181 "impressionTrackingUrls": [ # The set of URLs to be called to record an impression. 1182 "A String", 1183 ], 1184 "native": { # Native content for a creative. # A native creative. 1185 "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative. 1186 "appIcon": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # The app icon, for app download ads. 1187 "height": 42, # Image height in pixels. 1188 "url": "A String", # The URL of the image. 1189 "width": 42, # Image width in pixels. 1190 }, 1191 "body": "A String", # A long description of the ad. 1192 "callToAction": "A String", # A label for the button that the user is supposed to click. 1193 "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad. 1194 "clickTrackingUrl": "A String", # The URL to use for click tracking. 1195 "headline": "A String", # A short title for the ad. 1196 "image": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A large image. 1197 "height": 42, # Image height in pixels. 1198 "url": "A String", # The URL of the image. 1199 "width": 42, # Image width in pixels. 1200 }, 1201 "logo": { # An image resource. You may provide a larger image than was requested, so long as the aspect ratio is preserved. # A smaller image, for the advertiser's logo. 1202 "height": 42, # Image height in pixels. 1203 "url": "A String", # The URL of the image. 1204 "width": 42, # Image width in pixels. 1205 }, 1206 "priceDisplayText": "A String", # The price of the promoted app including currency info. 1207 "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5]. 1208 "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app. 1209 "videoUrl": "A String", # The URL to fetch a native video ad. 1210 }, 1211 "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in serving_restrictions will also exist. Note that this may be nuanced with other contextual restrictions, in which case, it may be preferable to read from serving_restrictions directly. Can be used to filter the response of the creatives.list method. 1212 "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative. 1213 "A String", 1214 ], 1215 "servingRestrictions": [ # Output only. 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). 1216 { # Output only. A representation of the status of an ad in a specific context. A context here relates to where something ultimately serves (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, or the type of auction). 1217 "contexts": [ # The contexts for the restriction. 1218 { # The serving context for this restriction. 1219 "all": "A String", # Matches all contexts. 1220 "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. 1221 "appTypes": [ # The app types this restriction applies to. 1222 "A String", 1223 ], 1224 }, 1225 "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. 1226 "auctionTypes": [ # The auction types this restriction applies to. 1227 "A String", 1228 ], 1229 }, 1230 "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific location. 1231 "geoCriteriaIds": [ # IDs representing the geo location for this context. Please refer to the [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) file for different geo criteria IDs. 1232 42, 1233 ], 1234 }, 1235 "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. 1236 "platforms": [ # The platforms this restriction applies to. 1237 "A String", 1238 ], 1239 }, 1240 "securityType": { # Output only. A security context. # Matches impressions for a particular security type. 1241 "securities": [ # The security types in this context. 1242 "A String", 1243 ], 1244 }, 1245 }, 1246 ], 1247 "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. 1248 "details": [ # Additional details about the reason for disapproval. 1249 "A String", 1250 ], 1251 "reason": "A String", # The categorized reason for disapproval. 1252 }, 1253 "disapprovalReasons": [ # Any disapprovals bound to this restriction. Only present if status=DISAPPROVED. Can be used to filter the response of the creatives.list method. Deprecated; please use disapproval field instead. 1254 { # Output only. The reason and details for a disapproval. 1255 "details": [ # Additional details about the reason for disapproval. 1256 "A String", 1257 ], 1258 "reason": "A String", # The categorized reason for disapproval. 1259 }, 1260 ], 1261 "status": "A String", # The status of the creative in this context (for example, it has been explicitly disapproved or is pending review). 1262 }, 1263 ], 1264 "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt for possible values. 1265 42, 1266 ], 1267 "version": 42, # Output only. The version of this creative. 1268 "video": { # Video content for a creative. # A video creative. 1269 "videoUrl": "A String", # The URL to fetch a video ad. 1270 "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. 1271 }, 1272}</pre> 1273</div> 1274 1275<div class="method"> 1276 <code class="details" id="watch">watch(accountId, creativeId, body=None, x__xgafv=None)</code> 1277 <pre>Watches a creative. Will result in push notifications being sent to the topic when the creative changes status. 1278 1279Args: 1280 accountId: string, The account of the creative to watch. (required) 1281 creativeId: string, The creative ID to watch for status changes. Specify "-" to watch all creatives under the above account. If both creative-level and account-level notifications are sent, only a single notification will be sent to the creative-level notification topic. (required) 1282 body: object, The request body. 1283 The object takes the form of: 1284 1285{ # A request for watching changes to creative Status. 1286 "topic": "A String", # The Pub/Sub topic to publish notifications to. This topic must already exist and must give permission to [email protected] to write to the topic. This should be the full resource name in "projects/{project_id}/topics/{topic_id}" format. 1287} 1288 1289 x__xgafv: string, V1 error format. 1290 Allowed values 1291 1 - v1 error format 1292 2 - v2 error format 1293 1294Returns: 1295 An object of the form: 1296 1297 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 1298}</pre> 1299</div> 1300 1301</body></html>