| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="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"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 83 | <code><a href="#create">create(accountId, body=None, duplicateIdMode=None, x__xgafv=None)</a></code></p> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 84 | <p class="firstline">Creates a creative.</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#get">get(accountId, creativeId, x__xgafv=None)</a></code></p> |
| 87 | <p class="firstline">Gets a creative.</p> |
| 88 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 89 | <code><a href="#list">list(accountId, pageToken=None, pageSize=None, query=None, x__xgafv=None)</a></code></p> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 90 | <p class="firstline">Lists creatives.</p> |
| 91 | <p class="toc_element"> |
| 92 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 93 | <p class="firstline">Retrieves the next page of results.</p> |
| 94 | <p class="toc_element"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 95 | <code><a href="#stopWatching">stopWatching(accountId, creativeId, body=None, x__xgafv=None)</a></code></p> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 96 | <p class="firstline">Stops watching a creative. Will stop push notifications being sent to the</p> |
| 97 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 98 | <code><a href="#update">update(accountId, creativeId, body=None, x__xgafv=None)</a></code></p> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 99 | <p class="firstline">Updates a creative.</p> |
| 100 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 101 | <code><a href="#watch">watch(accountId, creativeId, body=None, x__xgafv=None)</a></code></p> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 102 | <p class="firstline">Watches a creative. Will result in push notifications being sent to the</p> |
| 103 | <h3>Method Details</h3> |
| 104 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 105 | <code class="details" id="create">create(accountId, body=None, duplicateIdMode=None, x__xgafv=None)</code> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 106 | <pre>Creates a creative. |
| 107 | |
| 108 | Args: |
| 109 | accountId: string, The account that this creative belongs to. |
| 110 | Can be used to filter the response of the |
| 111 | creatives.list |
| 112 | method. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 113 | body: object, The request body. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 114 | The object takes the form of: |
| 115 | |
| 116 | { # A creative and its classification data. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 117 | "impressionTrackingUrls": [ # The set of URLs to be called to record an impression. |
| 118 | "A String", |
| 119 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 120 | "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 121 | "detectedProviderIds": [ # The detected ad technology provider IDs for this creative. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 122 | # See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for |
| 123 | # mapping of provider ID to provided name, a privacy policy URL, and a list |
| 124 | # of domains which can be attributed to the provider. |
| 125 | # |
| 126 | # If the creative contains provider IDs that are outside of those listed in |
| 127 | # the `BidRequest.adslot.consented_providers_settings.consented_providers` |
| 128 | # field on the (Google bid |
| 129 | # protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] |
| 130 | # and the |
| 131 | # `BidRequest.user.ext.consented_providers_settings.consented_providers` |
| 132 | # field on the (OpenRTB |
| 133 | # protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], |
| 134 | # and a bid is submitted with that creative for an impression that will |
| 135 | # serve to an EEA user, the bid will be filtered before the auction. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 136 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 137 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 138 | "hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. |
| 139 | # |
| 140 | # If true for a given creative, any bid submitted with that creative for an |
| 141 | # impression that will serve to an EEA user will be filtered before the |
| 142 | # auction. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 143 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 144 | "detectedLanguages": [ # Output only. The detected languages for this creative. The order is |
| 145 | # arbitrary. The codes are 2 or 5 characters and are documented at |
| 146 | # https://developers.google.com/adwords/api/docs/appendix/languagecodes. |
| 147 | "A String", |
| 148 | ], |
| 149 | "agencyId": "A String", # The agency ID for this creative. |
| 150 | "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative. |
| 151 | "A String", |
| 152 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 153 | "creativeId": "A String", # The buyer-defined creative ID of this creative. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 154 | # Can be used to filter the response of the |
| 155 | # creatives.list |
| 156 | # method. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 157 | "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative. |
| 158 | "A String", |
| 159 | ], |
| 160 | "accountId": "A String", # The account that this creative belongs to. |
| 161 | # Can be used to filter the response of the |
| 162 | # creatives.list |
| 163 | # method. |
| 164 | "advertiserName": "A String", # The name of the company being advertised in the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 165 | "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. |
| 166 | # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 167 | # serving_restrictions will also exist. Note |
| 168 | # that this may be nuanced with other contextual restrictions, in which case, |
| 169 | # it may be preferable to read from serving_restrictions directly. |
| 170 | # Can be used to filter the response of the |
| 171 | # creatives.list |
| 172 | # method. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 173 | "attributes": [ # All attributes for the ads that may be shown from this creative. |
| 174 | # Can be used to filter the response of the |
| 175 | # creatives.list |
| 176 | # method. |
| 177 | "A String", |
| 178 | ], |
| 179 | "version": 42, # Output only. The version of this creative. |
| 180 | "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. |
| 181 | # See the ad-sensitive-categories.txt file in the technical documentation for |
| 182 | # a list of IDs. You should use these IDs along with the |
| 183 | # excluded-sensitive-category field in the bid request to filter your bids. |
| 184 | 42, |
| 185 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 186 | "native": { # Native content for a creative. # A native creative. |
| 187 | "body": "A String", # A long description of the ad. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 188 | "image": { # An image resource. You may provide a larger image than was requested, # A large image. |
| 189 | # so long as the aspect ratio is preserved. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 190 | "width": 42, # Image width in pixels. |
| 191 | "height": 42, # Image height in pixels. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 192 | "url": "A String", # The URL of the image. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 193 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 194 | "priceDisplayText": "A String", # The price of the promoted app including currency info. |
| 195 | "logo": { # An image resource. You may provide a larger image than was requested, # A smaller image, for the advertiser's logo. |
| 196 | # so long as the aspect ratio is preserved. |
| 197 | "width": 42, # Image width in pixels. |
| 198 | "height": 42, # Image height in pixels. |
| 199 | "url": "A String", # The URL of the image. |
| 200 | }, |
| 201 | "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads. |
| 202 | # so long as the aspect ratio is preserved. |
| 203 | "width": 42, # Image width in pixels. |
| 204 | "height": 42, # Image height in pixels. |
| 205 | "url": "A String", # The URL of the image. |
| 206 | }, |
| 207 | "clickTrackingUrl": "A String", # The URL to use for click tracking. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 208 | "videoUrl": "A String", # The URL to fetch a native video ad. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 209 | "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5]. |
| 210 | "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app. |
| 211 | "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative. |
| 212 | "headline": "A String", # A short title for the ad. |
| 213 | "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad. |
| 214 | "callToAction": "A String", # A label for the button that the user is supposed to click. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 215 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 216 | "clickThroughUrls": [ # The set of destination URLs for the creative. |
| 217 | "A String", |
| 218 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 219 | "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any. |
| 220 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 221 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 222 | "dealsStatus": "A String", # Output only. The top-level deals status of this creative. |
| 223 | # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in |
| 224 | # serving_restrictions will also exist. Note |
| 225 | # that this may be nuanced with other contextual restrictions, in which case, |
| 226 | # it may be preferable to read from serving_restrictions directly. |
| 227 | # Can be used to filter the response of the |
| 228 | # creatives.list |
| 229 | # method. |
| 230 | "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. |
| 231 | # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt |
| 232 | # for possible values. |
| 233 | 42, |
| 234 | ], |
| 235 | "detectedProductCategories": [ # Output only. Detected product categories, if any. |
| 236 | # See the ad-product-categories.txt file in the technical documentation |
| 237 | # for a list of IDs. |
| 238 | 42, |
| 239 | ], |
| 240 | "video": { # Video content for a creative. # A video creative. |
| 241 | "videoVastXml": "A String", # The contents of a VAST document for a video ad. |
| 242 | # This document should conform to the VAST 2.0 or 3.0 standard. |
| 243 | "videoUrl": "A String", # The URL to fetch a video ad. |
| 244 | }, |
| 245 | "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. |
| 246 | # A context here relates to where something ultimately serves (for example, |
| 247 | # a physical location, a platform, an HTTPS vs HTTP request, or the type |
| 248 | # of auction). |
| 249 | { # Output only. A representation of the status of an ad in a |
| 250 | # specific context. A context here relates to where something ultimately serves |
| 251 | # (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, |
| 252 | # or the type of auction). |
| 253 | "disapprovalReasons": [ # Any disapprovals bound to this restriction. |
| 254 | # Only present if status=DISAPPROVED. |
| 255 | # Can be used to filter the response of the |
| 256 | # creatives.list |
| 257 | # method. |
| 258 | # Deprecated; please use |
| 259 | # disapproval |
| 260 | # field instead. |
| 261 | { # Output only. The reason and details for a disapproval. |
| 262 | "details": [ # Additional details about the reason for disapproval. |
| 263 | "A String", |
| 264 | ], |
| 265 | "reason": "A String", # The categorized reason for disapproval. |
| 266 | }, |
| 267 | ], |
| 268 | "status": "A String", # The status of the creative in this context (for example, it has been |
| 269 | # explicitly disapproved or is pending review). |
| 270 | "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. |
| 271 | # Only present if status=DISAPPROVED. |
| 272 | # Can be used to filter the response of the |
| 273 | # creatives.list |
| 274 | # method. |
| 275 | "details": [ # Additional details about the reason for disapproval. |
| 276 | "A String", |
| 277 | ], |
| 278 | "reason": "A String", # The categorized reason for disapproval. |
| 279 | }, |
| 280 | "contexts": [ # The contexts for the restriction. |
| 281 | { # The serving context for this restriction. |
| 282 | "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. |
| 283 | "auctionTypes": [ # The auction types this restriction applies to. |
| 284 | "A String", |
| 285 | ], |
| 286 | }, |
| 287 | "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. |
| 288 | "platforms": [ # The platforms this restriction applies to. |
| 289 | "A String", |
| 290 | ], |
| 291 | }, |
| 292 | "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific |
| 293 | # location. |
| 294 | "geoCriteriaIds": [ # IDs representing the geo location for this context. |
| 295 | # Please refer to the |
| 296 | # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) |
| 297 | # file for different geo criteria IDs. |
| 298 | 42, |
| 299 | ], |
| 300 | }, |
| 301 | "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. |
| 302 | "appTypes": [ # The app types this restriction applies to. |
| 303 | "A String", |
| 304 | ], |
| 305 | }, |
| 306 | "all": "A String", # Matches all contexts. |
| 307 | "securityType": { # Output only. A security context. # Matches impressions for a particular security type. |
| 308 | "securities": [ # The security types in this context. |
| 309 | "A String", |
| 310 | ], |
| 311 | }, |
| 312 | }, |
| 313 | ], |
| 314 | }, |
| 315 | ], |
| 316 | "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. |
| 317 | "detectedDomains": [ # Output only. The detected domains for this creative. |
| 318 | "A String", |
| 319 | ], |
| 320 | "corrections": [ # Output only. Shows any corrections that were applied to this creative. |
| 321 | { # Output only. Shows any corrections that were applied to this creative. |
| 322 | "details": [ # Additional details about what was corrected. |
| 323 | "A String", |
| 324 | ], |
| 325 | "type": "A String", # The type of correction that was applied to the creative. |
| 326 | "contexts": [ # The contexts for the correction. |
| 327 | { # The serving context for this restriction. |
| 328 | "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. |
| 329 | "auctionTypes": [ # The auction types this restriction applies to. |
| 330 | "A String", |
| 331 | ], |
| 332 | }, |
| 333 | "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. |
| 334 | "platforms": [ # The platforms this restriction applies to. |
| 335 | "A String", |
| 336 | ], |
| 337 | }, |
| 338 | "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific |
| 339 | # location. |
| 340 | "geoCriteriaIds": [ # IDs representing the geo location for this context. |
| 341 | # Please refer to the |
| 342 | # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) |
| 343 | # file for different geo criteria IDs. |
| 344 | 42, |
| 345 | ], |
| 346 | }, |
| 347 | "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. |
| 348 | "appTypes": [ # The app types this restriction applies to. |
| 349 | "A String", |
| 350 | ], |
| 351 | }, |
| 352 | "all": "A String", # Matches all contexts. |
| 353 | "securityType": { # Output only. A security context. # Matches impressions for a particular security type. |
| 354 | "securities": [ # The security types in this context. |
| 355 | "A String", |
| 356 | ], |
| 357 | }, |
| 358 | }, |
| 359 | ], |
| 360 | }, |
| 361 | ], |
| 362 | "html": { # HTML content for a creative. # An HTML creative. |
| 363 | "width": 42, # The width of the HTML snippet in pixels. |
| 364 | "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. |
| 365 | "height": 42, # The height of the HTML snippet in pixels. |
| 366 | }, |
| 367 | "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 368 | } |
| 369 | |
| 370 | duplicateIdMode: string, Indicates if multiple creatives can share an ID or not. Default is |
| 371 | NO_DUPLICATES (one ID per creative). |
| 372 | x__xgafv: string, V1 error format. |
| 373 | Allowed values |
| 374 | 1 - v1 error format |
| 375 | 2 - v2 error format |
| 376 | |
| 377 | Returns: |
| 378 | An object of the form: |
| 379 | |
| 380 | { # A creative and its classification data. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 381 | "impressionTrackingUrls": [ # The set of URLs to be called to record an impression. |
| 382 | "A String", |
| 383 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 384 | "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 385 | "detectedProviderIds": [ # The detected ad technology provider IDs for this creative. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 386 | # See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for |
| 387 | # mapping of provider ID to provided name, a privacy policy URL, and a list |
| 388 | # of domains which can be attributed to the provider. |
| 389 | # |
| 390 | # If the creative contains provider IDs that are outside of those listed in |
| 391 | # the `BidRequest.adslot.consented_providers_settings.consented_providers` |
| 392 | # field on the (Google bid |
| 393 | # protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] |
| 394 | # and the |
| 395 | # `BidRequest.user.ext.consented_providers_settings.consented_providers` |
| 396 | # field on the (OpenRTB |
| 397 | # protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], |
| 398 | # and a bid is submitted with that creative for an impression that will |
| 399 | # serve to an EEA user, the bid will be filtered before the auction. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 400 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 401 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 402 | "hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. |
| 403 | # |
| 404 | # If true for a given creative, any bid submitted with that creative for an |
| 405 | # impression that will serve to an EEA user will be filtered before the |
| 406 | # auction. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 407 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 408 | "detectedLanguages": [ # Output only. The detected languages for this creative. The order is |
| 409 | # arbitrary. The codes are 2 or 5 characters and are documented at |
| 410 | # https://developers.google.com/adwords/api/docs/appendix/languagecodes. |
| 411 | "A String", |
| 412 | ], |
| 413 | "agencyId": "A String", # The agency ID for this creative. |
| 414 | "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative. |
| 415 | "A String", |
| 416 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 417 | "creativeId": "A String", # The buyer-defined creative ID of this creative. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 418 | # Can be used to filter the response of the |
| 419 | # creatives.list |
| 420 | # method. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 421 | "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative. |
| 422 | "A String", |
| 423 | ], |
| 424 | "accountId": "A String", # The account that this creative belongs to. |
| 425 | # Can be used to filter the response of the |
| 426 | # creatives.list |
| 427 | # method. |
| 428 | "advertiserName": "A String", # The name of the company being advertised in the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 429 | "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. |
| 430 | # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 431 | # serving_restrictions will also exist. Note |
| 432 | # that this may be nuanced with other contextual restrictions, in which case, |
| 433 | # it may be preferable to read from serving_restrictions directly. |
| 434 | # Can be used to filter the response of the |
| 435 | # creatives.list |
| 436 | # method. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 437 | "attributes": [ # All attributes for the ads that may be shown from this creative. |
| 438 | # Can be used to filter the response of the |
| 439 | # creatives.list |
| 440 | # method. |
| 441 | "A String", |
| 442 | ], |
| 443 | "version": 42, # Output only. The version of this creative. |
| 444 | "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. |
| 445 | # See the ad-sensitive-categories.txt file in the technical documentation for |
| 446 | # a list of IDs. You should use these IDs along with the |
| 447 | # excluded-sensitive-category field in the bid request to filter your bids. |
| 448 | 42, |
| 449 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 450 | "native": { # Native content for a creative. # A native creative. |
| 451 | "body": "A String", # A long description of the ad. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 452 | "image": { # An image resource. You may provide a larger image than was requested, # A large image. |
| 453 | # so long as the aspect ratio is preserved. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 454 | "width": 42, # Image width in pixels. |
| 455 | "height": 42, # Image height in pixels. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 456 | "url": "A String", # The URL of the image. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 457 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 458 | "priceDisplayText": "A String", # The price of the promoted app including currency info. |
| 459 | "logo": { # An image resource. You may provide a larger image than was requested, # A smaller image, for the advertiser's logo. |
| 460 | # so long as the aspect ratio is preserved. |
| 461 | "width": 42, # Image width in pixels. |
| 462 | "height": 42, # Image height in pixels. |
| 463 | "url": "A String", # The URL of the image. |
| 464 | }, |
| 465 | "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads. |
| 466 | # so long as the aspect ratio is preserved. |
| 467 | "width": 42, # Image width in pixels. |
| 468 | "height": 42, # Image height in pixels. |
| 469 | "url": "A String", # The URL of the image. |
| 470 | }, |
| 471 | "clickTrackingUrl": "A String", # The URL to use for click tracking. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 472 | "videoUrl": "A String", # The URL to fetch a native video ad. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 473 | "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5]. |
| 474 | "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app. |
| 475 | "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative. |
| 476 | "headline": "A String", # A short title for the ad. |
| 477 | "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad. |
| 478 | "callToAction": "A String", # A label for the button that the user is supposed to click. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 479 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 480 | "clickThroughUrls": [ # The set of destination URLs for the creative. |
| 481 | "A String", |
| 482 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 483 | "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any. |
| 484 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 485 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 486 | "dealsStatus": "A String", # Output only. The top-level deals status of this creative. |
| 487 | # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in |
| 488 | # serving_restrictions will also exist. Note |
| 489 | # that this may be nuanced with other contextual restrictions, in which case, |
| 490 | # it may be preferable to read from serving_restrictions directly. |
| 491 | # Can be used to filter the response of the |
| 492 | # creatives.list |
| 493 | # method. |
| 494 | "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. |
| 495 | # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt |
| 496 | # for possible values. |
| 497 | 42, |
| 498 | ], |
| 499 | "detectedProductCategories": [ # Output only. Detected product categories, if any. |
| 500 | # See the ad-product-categories.txt file in the technical documentation |
| 501 | # for a list of IDs. |
| 502 | 42, |
| 503 | ], |
| 504 | "video": { # Video content for a creative. # A video creative. |
| 505 | "videoVastXml": "A String", # The contents of a VAST document for a video ad. |
| 506 | # This document should conform to the VAST 2.0 or 3.0 standard. |
| 507 | "videoUrl": "A String", # The URL to fetch a video ad. |
| 508 | }, |
| 509 | "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. |
| 510 | # A context here relates to where something ultimately serves (for example, |
| 511 | # a physical location, a platform, an HTTPS vs HTTP request, or the type |
| 512 | # of auction). |
| 513 | { # Output only. A representation of the status of an ad in a |
| 514 | # specific context. A context here relates to where something ultimately serves |
| 515 | # (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, |
| 516 | # or the type of auction). |
| 517 | "disapprovalReasons": [ # Any disapprovals bound to this restriction. |
| 518 | # Only present if status=DISAPPROVED. |
| 519 | # Can be used to filter the response of the |
| 520 | # creatives.list |
| 521 | # method. |
| 522 | # Deprecated; please use |
| 523 | # disapproval |
| 524 | # field instead. |
| 525 | { # Output only. The reason and details for a disapproval. |
| 526 | "details": [ # Additional details about the reason for disapproval. |
| 527 | "A String", |
| 528 | ], |
| 529 | "reason": "A String", # The categorized reason for disapproval. |
| 530 | }, |
| 531 | ], |
| 532 | "status": "A String", # The status of the creative in this context (for example, it has been |
| 533 | # explicitly disapproved or is pending review). |
| 534 | "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. |
| 535 | # Only present if status=DISAPPROVED. |
| 536 | # Can be used to filter the response of the |
| 537 | # creatives.list |
| 538 | # method. |
| 539 | "details": [ # Additional details about the reason for disapproval. |
| 540 | "A String", |
| 541 | ], |
| 542 | "reason": "A String", # The categorized reason for disapproval. |
| 543 | }, |
| 544 | "contexts": [ # The contexts for the restriction. |
| 545 | { # The serving context for this restriction. |
| 546 | "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. |
| 547 | "auctionTypes": [ # The auction types this restriction applies to. |
| 548 | "A String", |
| 549 | ], |
| 550 | }, |
| 551 | "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. |
| 552 | "platforms": [ # The platforms this restriction applies to. |
| 553 | "A String", |
| 554 | ], |
| 555 | }, |
| 556 | "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific |
| 557 | # location. |
| 558 | "geoCriteriaIds": [ # IDs representing the geo location for this context. |
| 559 | # Please refer to the |
| 560 | # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) |
| 561 | # file for different geo criteria IDs. |
| 562 | 42, |
| 563 | ], |
| 564 | }, |
| 565 | "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. |
| 566 | "appTypes": [ # The app types this restriction applies to. |
| 567 | "A String", |
| 568 | ], |
| 569 | }, |
| 570 | "all": "A String", # Matches all contexts. |
| 571 | "securityType": { # Output only. A security context. # Matches impressions for a particular security type. |
| 572 | "securities": [ # The security types in this context. |
| 573 | "A String", |
| 574 | ], |
| 575 | }, |
| 576 | }, |
| 577 | ], |
| 578 | }, |
| 579 | ], |
| 580 | "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. |
| 581 | "detectedDomains": [ # Output only. The detected domains for this creative. |
| 582 | "A String", |
| 583 | ], |
| 584 | "corrections": [ # Output only. Shows any corrections that were applied to this creative. |
| 585 | { # Output only. Shows any corrections that were applied to this creative. |
| 586 | "details": [ # Additional details about what was corrected. |
| 587 | "A String", |
| 588 | ], |
| 589 | "type": "A String", # The type of correction that was applied to the creative. |
| 590 | "contexts": [ # The contexts for the correction. |
| 591 | { # The serving context for this restriction. |
| 592 | "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. |
| 593 | "auctionTypes": [ # The auction types this restriction applies to. |
| 594 | "A String", |
| 595 | ], |
| 596 | }, |
| 597 | "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. |
| 598 | "platforms": [ # The platforms this restriction applies to. |
| 599 | "A String", |
| 600 | ], |
| 601 | }, |
| 602 | "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific |
| 603 | # location. |
| 604 | "geoCriteriaIds": [ # IDs representing the geo location for this context. |
| 605 | # Please refer to the |
| 606 | # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) |
| 607 | # file for different geo criteria IDs. |
| 608 | 42, |
| 609 | ], |
| 610 | }, |
| 611 | "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. |
| 612 | "appTypes": [ # The app types this restriction applies to. |
| 613 | "A String", |
| 614 | ], |
| 615 | }, |
| 616 | "all": "A String", # Matches all contexts. |
| 617 | "securityType": { # Output only. A security context. # Matches impressions for a particular security type. |
| 618 | "securities": [ # The security types in this context. |
| 619 | "A String", |
| 620 | ], |
| 621 | }, |
| 622 | }, |
| 623 | ], |
| 624 | }, |
| 625 | ], |
| 626 | "html": { # HTML content for a creative. # An HTML creative. |
| 627 | "width": 42, # The width of the HTML snippet in pixels. |
| 628 | "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. |
| 629 | "height": 42, # The height of the HTML snippet in pixels. |
| 630 | }, |
| 631 | "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 632 | }</pre> |
| 633 | </div> |
| 634 | |
| 635 | <div class="method"> |
| 636 | <code class="details" id="get">get(accountId, creativeId, x__xgafv=None)</code> |
| 637 | <pre>Gets a creative. |
| 638 | |
| 639 | Args: |
| 640 | accountId: string, The account the creative belongs to. (required) |
| 641 | creativeId: string, The ID of the creative to retrieve. (required) |
| 642 | x__xgafv: string, V1 error format. |
| 643 | Allowed values |
| 644 | 1 - v1 error format |
| 645 | 2 - v2 error format |
| 646 | |
| 647 | Returns: |
| 648 | An object of the form: |
| 649 | |
| 650 | { # A creative and its classification data. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 651 | "impressionTrackingUrls": [ # The set of URLs to be called to record an impression. |
| 652 | "A String", |
| 653 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 654 | "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 655 | "detectedProviderIds": [ # The detected ad technology provider IDs for this creative. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 656 | # See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for |
| 657 | # mapping of provider ID to provided name, a privacy policy URL, and a list |
| 658 | # of domains which can be attributed to the provider. |
| 659 | # |
| 660 | # If the creative contains provider IDs that are outside of those listed in |
| 661 | # the `BidRequest.adslot.consented_providers_settings.consented_providers` |
| 662 | # field on the (Google bid |
| 663 | # protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] |
| 664 | # and the |
| 665 | # `BidRequest.user.ext.consented_providers_settings.consented_providers` |
| 666 | # field on the (OpenRTB |
| 667 | # protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], |
| 668 | # and a bid is submitted with that creative for an impression that will |
| 669 | # serve to an EEA user, the bid will be filtered before the auction. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 670 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 671 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 672 | "hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. |
| 673 | # |
| 674 | # If true for a given creative, any bid submitted with that creative for an |
| 675 | # impression that will serve to an EEA user will be filtered before the |
| 676 | # auction. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 677 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 678 | "detectedLanguages": [ # Output only. The detected languages for this creative. The order is |
| 679 | # arbitrary. The codes are 2 or 5 characters and are documented at |
| 680 | # https://developers.google.com/adwords/api/docs/appendix/languagecodes. |
| 681 | "A String", |
| 682 | ], |
| 683 | "agencyId": "A String", # The agency ID for this creative. |
| 684 | "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative. |
| 685 | "A String", |
| 686 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 687 | "creativeId": "A String", # The buyer-defined creative ID of this creative. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 688 | # Can be used to filter the response of the |
| 689 | # creatives.list |
| 690 | # method. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 691 | "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative. |
| 692 | "A String", |
| 693 | ], |
| 694 | "accountId": "A String", # The account that this creative belongs to. |
| 695 | # Can be used to filter the response of the |
| 696 | # creatives.list |
| 697 | # method. |
| 698 | "advertiserName": "A String", # The name of the company being advertised in the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 699 | "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. |
| 700 | # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 701 | # serving_restrictions will also exist. Note |
| 702 | # that this may be nuanced with other contextual restrictions, in which case, |
| 703 | # it may be preferable to read from serving_restrictions directly. |
| 704 | # Can be used to filter the response of the |
| 705 | # creatives.list |
| 706 | # method. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 707 | "attributes": [ # All attributes for the ads that may be shown from this creative. |
| 708 | # Can be used to filter the response of the |
| 709 | # creatives.list |
| 710 | # method. |
| 711 | "A String", |
| 712 | ], |
| 713 | "version": 42, # Output only. The version of this creative. |
| 714 | "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. |
| 715 | # See the ad-sensitive-categories.txt file in the technical documentation for |
| 716 | # a list of IDs. You should use these IDs along with the |
| 717 | # excluded-sensitive-category field in the bid request to filter your bids. |
| 718 | 42, |
| 719 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 720 | "native": { # Native content for a creative. # A native creative. |
| 721 | "body": "A String", # A long description of the ad. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 722 | "image": { # An image resource. You may provide a larger image than was requested, # A large image. |
| 723 | # so long as the aspect ratio is preserved. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 724 | "width": 42, # Image width in pixels. |
| 725 | "height": 42, # Image height in pixels. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 726 | "url": "A String", # The URL of the image. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 727 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 728 | "priceDisplayText": "A String", # The price of the promoted app including currency info. |
| 729 | "logo": { # An image resource. You may provide a larger image than was requested, # A smaller image, for the advertiser's logo. |
| 730 | # so long as the aspect ratio is preserved. |
| 731 | "width": 42, # Image width in pixels. |
| 732 | "height": 42, # Image height in pixels. |
| 733 | "url": "A String", # The URL of the image. |
| 734 | }, |
| 735 | "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads. |
| 736 | # so long as the aspect ratio is preserved. |
| 737 | "width": 42, # Image width in pixels. |
| 738 | "height": 42, # Image height in pixels. |
| 739 | "url": "A String", # The URL of the image. |
| 740 | }, |
| 741 | "clickTrackingUrl": "A String", # The URL to use for click tracking. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 742 | "videoUrl": "A String", # The URL to fetch a native video ad. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 743 | "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5]. |
| 744 | "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app. |
| 745 | "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative. |
| 746 | "headline": "A String", # A short title for the ad. |
| 747 | "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad. |
| 748 | "callToAction": "A String", # A label for the button that the user is supposed to click. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 749 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 750 | "clickThroughUrls": [ # The set of destination URLs for the creative. |
| 751 | "A String", |
| 752 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 753 | "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any. |
| 754 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 755 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 756 | "dealsStatus": "A String", # Output only. The top-level deals status of this creative. |
| 757 | # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in |
| 758 | # serving_restrictions will also exist. Note |
| 759 | # that this may be nuanced with other contextual restrictions, in which case, |
| 760 | # it may be preferable to read from serving_restrictions directly. |
| 761 | # Can be used to filter the response of the |
| 762 | # creatives.list |
| 763 | # method. |
| 764 | "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. |
| 765 | # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt |
| 766 | # for possible values. |
| 767 | 42, |
| 768 | ], |
| 769 | "detectedProductCategories": [ # Output only. Detected product categories, if any. |
| 770 | # See the ad-product-categories.txt file in the technical documentation |
| 771 | # for a list of IDs. |
| 772 | 42, |
| 773 | ], |
| 774 | "video": { # Video content for a creative. # A video creative. |
| 775 | "videoVastXml": "A String", # The contents of a VAST document for a video ad. |
| 776 | # This document should conform to the VAST 2.0 or 3.0 standard. |
| 777 | "videoUrl": "A String", # The URL to fetch a video ad. |
| 778 | }, |
| 779 | "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. |
| 780 | # A context here relates to where something ultimately serves (for example, |
| 781 | # a physical location, a platform, an HTTPS vs HTTP request, or the type |
| 782 | # of auction). |
| 783 | { # Output only. A representation of the status of an ad in a |
| 784 | # specific context. A context here relates to where something ultimately serves |
| 785 | # (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, |
| 786 | # or the type of auction). |
| 787 | "disapprovalReasons": [ # Any disapprovals bound to this restriction. |
| 788 | # Only present if status=DISAPPROVED. |
| 789 | # Can be used to filter the response of the |
| 790 | # creatives.list |
| 791 | # method. |
| 792 | # Deprecated; please use |
| 793 | # disapproval |
| 794 | # field instead. |
| 795 | { # Output only. The reason and details for a disapproval. |
| 796 | "details": [ # Additional details about the reason for disapproval. |
| 797 | "A String", |
| 798 | ], |
| 799 | "reason": "A String", # The categorized reason for disapproval. |
| 800 | }, |
| 801 | ], |
| 802 | "status": "A String", # The status of the creative in this context (for example, it has been |
| 803 | # explicitly disapproved or is pending review). |
| 804 | "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. |
| 805 | # Only present if status=DISAPPROVED. |
| 806 | # Can be used to filter the response of the |
| 807 | # creatives.list |
| 808 | # method. |
| 809 | "details": [ # Additional details about the reason for disapproval. |
| 810 | "A String", |
| 811 | ], |
| 812 | "reason": "A String", # The categorized reason for disapproval. |
| 813 | }, |
| 814 | "contexts": [ # The contexts for the restriction. |
| 815 | { # The serving context for this restriction. |
| 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 | "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. |
| 822 | "platforms": [ # The platforms this restriction applies to. |
| 823 | "A String", |
| 824 | ], |
| 825 | }, |
| 826 | "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific |
| 827 | # location. |
| 828 | "geoCriteriaIds": [ # IDs representing the geo location for this context. |
| 829 | # Please refer to the |
| 830 | # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) |
| 831 | # file for different geo criteria IDs. |
| 832 | 42, |
| 833 | ], |
| 834 | }, |
| 835 | "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. |
| 836 | "appTypes": [ # The app types this restriction applies to. |
| 837 | "A String", |
| 838 | ], |
| 839 | }, |
| 840 | "all": "A String", # Matches all contexts. |
| 841 | "securityType": { # Output only. A security context. # Matches impressions for a particular security type. |
| 842 | "securities": [ # The security types in this context. |
| 843 | "A String", |
| 844 | ], |
| 845 | }, |
| 846 | }, |
| 847 | ], |
| 848 | }, |
| 849 | ], |
| 850 | "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. |
| 851 | "detectedDomains": [ # Output only. The detected domains for this creative. |
| 852 | "A String", |
| 853 | ], |
| 854 | "corrections": [ # Output only. Shows any corrections that were applied to this creative. |
| 855 | { # Output only. Shows any corrections that were applied to this creative. |
| 856 | "details": [ # Additional details about what was corrected. |
| 857 | "A String", |
| 858 | ], |
| 859 | "type": "A String", # The type of correction that was applied to the creative. |
| 860 | "contexts": [ # The contexts for the correction. |
| 861 | { # The serving context for this restriction. |
| 862 | "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. |
| 863 | "auctionTypes": [ # The auction types this restriction applies to. |
| 864 | "A String", |
| 865 | ], |
| 866 | }, |
| 867 | "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. |
| 868 | "platforms": [ # The platforms this restriction applies to. |
| 869 | "A String", |
| 870 | ], |
| 871 | }, |
| 872 | "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific |
| 873 | # location. |
| 874 | "geoCriteriaIds": [ # IDs representing the geo location for this context. |
| 875 | # Please refer to the |
| 876 | # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) |
| 877 | # file for different geo criteria IDs. |
| 878 | 42, |
| 879 | ], |
| 880 | }, |
| 881 | "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. |
| 882 | "appTypes": [ # The app types this restriction applies to. |
| 883 | "A String", |
| 884 | ], |
| 885 | }, |
| 886 | "all": "A String", # Matches all contexts. |
| 887 | "securityType": { # Output only. A security context. # Matches impressions for a particular security type. |
| 888 | "securities": [ # The security types in this context. |
| 889 | "A String", |
| 890 | ], |
| 891 | }, |
| 892 | }, |
| 893 | ], |
| 894 | }, |
| 895 | ], |
| 896 | "html": { # HTML content for a creative. # An HTML creative. |
| 897 | "width": 42, # The width of the HTML snippet in pixels. |
| 898 | "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. |
| 899 | "height": 42, # The height of the HTML snippet in pixels. |
| 900 | }, |
| 901 | "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 902 | }</pre> |
| 903 | </div> |
| 904 | |
| 905 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 906 | <code class="details" id="list">list(accountId, pageToken=None, pageSize=None, query=None, x__xgafv=None)</code> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 907 | <pre>Lists creatives. |
| 908 | |
| 909 | Args: |
| 910 | accountId: string, The account to list the creatives from. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 911 | Specify "-" to list all creatives the current user has access to. (required) |
| 912 | pageToken: string, A token identifying a page of results the server should return. |
| 913 | Typically, this is the value of |
| 914 | ListCreativesResponse.next_page_token |
| 915 | returned from the previous call to 'ListCreatives' method. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 916 | pageSize: integer, Requested page size. The server may return fewer creatives than requested |
| 917 | (due to timeout constraint) even if more are available via another call. |
| 918 | If unspecified, server will pick an appropriate default. |
| 919 | Acceptable values are 1 to 1000, inclusive. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 920 | query: string, An optional query string to filter creatives. If no filter is specified, |
| 921 | all active creatives will be returned. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 922 | <p>Supported queries are: |
| 923 | <ul> |
| 924 | <li>accountId=<i>account_id_string</i> |
| 925 | <li>creativeId=<i>creative_id_string</i> |
| 926 | <li>dealsStatus: {approved, conditionally_approved, disapproved, |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 927 | not_checked} |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 928 | <li>openAuctionStatus: {approved, conditionally_approved, disapproved, |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 929 | not_checked} |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 930 | <li>attribute: {a numeric attribute from the list of attributes} |
| 931 | <li>disapprovalReason: {a reason from |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 932 | DisapprovalReason} |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 933 | </ul> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 934 | Example: 'accountId=12345 AND (dealsStatus:disapproved AND |
| 935 | disapprovalReason:unacceptable_content) OR attribute:47' |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 936 | x__xgafv: string, V1 error format. |
| 937 | Allowed values |
| 938 | 1 - v1 error format |
| 939 | 2 - v2 error format |
| 940 | |
| 941 | Returns: |
| 942 | An object of the form: |
| 943 | |
| 944 | { # A response for listing creatives. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 945 | "creatives": [ # The list of creatives. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 946 | { # A creative and its classification data. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 947 | "impressionTrackingUrls": [ # The set of URLs to be called to record an impression. |
| 948 | "A String", |
| 949 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 950 | "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 951 | "detectedProviderIds": [ # The detected ad technology provider IDs for this creative. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 952 | # See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for |
| 953 | # mapping of provider ID to provided name, a privacy policy URL, and a list |
| 954 | # of domains which can be attributed to the provider. |
| 955 | # |
| 956 | # If the creative contains provider IDs that are outside of those listed in |
| 957 | # the `BidRequest.adslot.consented_providers_settings.consented_providers` |
| 958 | # field on the (Google bid |
| 959 | # protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] |
| 960 | # and the |
| 961 | # `BidRequest.user.ext.consented_providers_settings.consented_providers` |
| 962 | # field on the (OpenRTB |
| 963 | # protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], |
| 964 | # and a bid is submitted with that creative for an impression that will |
| 965 | # serve to an EEA user, the bid will be filtered before the auction. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 966 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 967 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 968 | "hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. |
| 969 | # |
| 970 | # If true for a given creative, any bid submitted with that creative for an |
| 971 | # impression that will serve to an EEA user will be filtered before the |
| 972 | # auction. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 973 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 974 | "detectedLanguages": [ # Output only. The detected languages for this creative. The order is |
| 975 | # arbitrary. The codes are 2 or 5 characters and are documented at |
| 976 | # https://developers.google.com/adwords/api/docs/appendix/languagecodes. |
| 977 | "A String", |
| 978 | ], |
| 979 | "agencyId": "A String", # The agency ID for this creative. |
| 980 | "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative. |
| 981 | "A String", |
| 982 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 983 | "creativeId": "A String", # The buyer-defined creative ID of this creative. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 984 | # Can be used to filter the response of the |
| 985 | # creatives.list |
| 986 | # method. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 987 | "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative. |
| 988 | "A String", |
| 989 | ], |
| 990 | "accountId": "A String", # The account that this creative belongs to. |
| 991 | # Can be used to filter the response of the |
| 992 | # creatives.list |
| 993 | # method. |
| 994 | "advertiserName": "A String", # The name of the company being advertised in the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 995 | "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. |
| 996 | # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 997 | # serving_restrictions will also exist. Note |
| 998 | # that this may be nuanced with other contextual restrictions, in which case, |
| 999 | # it may be preferable to read from serving_restrictions directly. |
| 1000 | # Can be used to filter the response of the |
| 1001 | # creatives.list |
| 1002 | # method. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1003 | "attributes": [ # All attributes for the ads that may be shown from this creative. |
| 1004 | # Can be used to filter the response of the |
| 1005 | # creatives.list |
| 1006 | # method. |
| 1007 | "A String", |
| 1008 | ], |
| 1009 | "version": 42, # Output only. The version of this creative. |
| 1010 | "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. |
| 1011 | # See the ad-sensitive-categories.txt file in the technical documentation for |
| 1012 | # a list of IDs. You should use these IDs along with the |
| 1013 | # excluded-sensitive-category field in the bid request to filter your bids. |
| 1014 | 42, |
| 1015 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1016 | "native": { # Native content for a creative. # A native creative. |
| 1017 | "body": "A String", # A long description of the ad. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1018 | "image": { # An image resource. You may provide a larger image than was requested, # A large image. |
| 1019 | # so long as the aspect ratio is preserved. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1020 | "width": 42, # Image width in pixels. |
| 1021 | "height": 42, # Image height in pixels. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1022 | "url": "A String", # The URL of the image. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1023 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1024 | "priceDisplayText": "A String", # The price of the promoted app including currency info. |
| 1025 | "logo": { # An image resource. You may provide a larger image than was requested, # A smaller image, for the advertiser's logo. |
| 1026 | # so long as the aspect ratio is preserved. |
| 1027 | "width": 42, # Image width in pixels. |
| 1028 | "height": 42, # Image height in pixels. |
| 1029 | "url": "A String", # The URL of the image. |
| 1030 | }, |
| 1031 | "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads. |
| 1032 | # so long as the aspect ratio is preserved. |
| 1033 | "width": 42, # Image width in pixels. |
| 1034 | "height": 42, # Image height in pixels. |
| 1035 | "url": "A String", # The URL of the image. |
| 1036 | }, |
| 1037 | "clickTrackingUrl": "A String", # The URL to use for click tracking. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1038 | "videoUrl": "A String", # The URL to fetch a native video ad. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1039 | "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5]. |
| 1040 | "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app. |
| 1041 | "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative. |
| 1042 | "headline": "A String", # A short title for the ad. |
| 1043 | "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad. |
| 1044 | "callToAction": "A String", # A label for the button that the user is supposed to click. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1045 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1046 | "clickThroughUrls": [ # The set of destination URLs for the creative. |
| 1047 | "A String", |
| 1048 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1049 | "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any. |
| 1050 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1051 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1052 | "dealsStatus": "A String", # Output only. The top-level deals status of this creative. |
| 1053 | # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in |
| 1054 | # serving_restrictions will also exist. Note |
| 1055 | # that this may be nuanced with other contextual restrictions, in which case, |
| 1056 | # it may be preferable to read from serving_restrictions directly. |
| 1057 | # Can be used to filter the response of the |
| 1058 | # creatives.list |
| 1059 | # method. |
| 1060 | "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. |
| 1061 | # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt |
| 1062 | # for possible values. |
| 1063 | 42, |
| 1064 | ], |
| 1065 | "detectedProductCategories": [ # Output only. Detected product categories, if any. |
| 1066 | # See the ad-product-categories.txt file in the technical documentation |
| 1067 | # for a list of IDs. |
| 1068 | 42, |
| 1069 | ], |
| 1070 | "video": { # Video content for a creative. # A video creative. |
| 1071 | "videoVastXml": "A String", # The contents of a VAST document for a video ad. |
| 1072 | # This document should conform to the VAST 2.0 or 3.0 standard. |
| 1073 | "videoUrl": "A String", # The URL to fetch a video ad. |
| 1074 | }, |
| 1075 | "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. |
| 1076 | # A context here relates to where something ultimately serves (for example, |
| 1077 | # a physical location, a platform, an HTTPS vs HTTP request, or the type |
| 1078 | # of auction). |
| 1079 | { # Output only. A representation of the status of an ad in a |
| 1080 | # specific context. A context here relates to where something ultimately serves |
| 1081 | # (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, |
| 1082 | # or the type of auction). |
| 1083 | "disapprovalReasons": [ # Any disapprovals bound to this restriction. |
| 1084 | # Only present if status=DISAPPROVED. |
| 1085 | # Can be used to filter the response of the |
| 1086 | # creatives.list |
| 1087 | # method. |
| 1088 | # Deprecated; please use |
| 1089 | # disapproval |
| 1090 | # field instead. |
| 1091 | { # Output only. The reason and details for a disapproval. |
| 1092 | "details": [ # Additional details about the reason for disapproval. |
| 1093 | "A String", |
| 1094 | ], |
| 1095 | "reason": "A String", # The categorized reason for disapproval. |
| 1096 | }, |
| 1097 | ], |
| 1098 | "status": "A String", # The status of the creative in this context (for example, it has been |
| 1099 | # explicitly disapproved or is pending review). |
| 1100 | "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. |
| 1101 | # Only present if status=DISAPPROVED. |
| 1102 | # Can be used to filter the response of the |
| 1103 | # creatives.list |
| 1104 | # method. |
| 1105 | "details": [ # Additional details about the reason for disapproval. |
| 1106 | "A String", |
| 1107 | ], |
| 1108 | "reason": "A String", # The categorized reason for disapproval. |
| 1109 | }, |
| 1110 | "contexts": [ # The contexts for the restriction. |
| 1111 | { # The serving context for this restriction. |
| 1112 | "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. |
| 1113 | "auctionTypes": [ # The auction types this restriction applies to. |
| 1114 | "A String", |
| 1115 | ], |
| 1116 | }, |
| 1117 | "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. |
| 1118 | "platforms": [ # The platforms this restriction applies to. |
| 1119 | "A String", |
| 1120 | ], |
| 1121 | }, |
| 1122 | "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific |
| 1123 | # location. |
| 1124 | "geoCriteriaIds": [ # IDs representing the geo location for this context. |
| 1125 | # Please refer to the |
| 1126 | # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) |
| 1127 | # file for different geo criteria IDs. |
| 1128 | 42, |
| 1129 | ], |
| 1130 | }, |
| 1131 | "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. |
| 1132 | "appTypes": [ # The app types this restriction applies to. |
| 1133 | "A String", |
| 1134 | ], |
| 1135 | }, |
| 1136 | "all": "A String", # Matches all contexts. |
| 1137 | "securityType": { # Output only. A security context. # Matches impressions for a particular security type. |
| 1138 | "securities": [ # The security types in this context. |
| 1139 | "A String", |
| 1140 | ], |
| 1141 | }, |
| 1142 | }, |
| 1143 | ], |
| 1144 | }, |
| 1145 | ], |
| 1146 | "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. |
| 1147 | "detectedDomains": [ # Output only. The detected domains for this creative. |
| 1148 | "A String", |
| 1149 | ], |
| 1150 | "corrections": [ # Output only. Shows any corrections that were applied to this creative. |
| 1151 | { # Output only. Shows any corrections that were applied to this creative. |
| 1152 | "details": [ # Additional details about what was corrected. |
| 1153 | "A String", |
| 1154 | ], |
| 1155 | "type": "A String", # The type of correction that was applied to the creative. |
| 1156 | "contexts": [ # The contexts for the correction. |
| 1157 | { # The serving context for this restriction. |
| 1158 | "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. |
| 1159 | "auctionTypes": [ # The auction types this restriction applies to. |
| 1160 | "A String", |
| 1161 | ], |
| 1162 | }, |
| 1163 | "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. |
| 1164 | "platforms": [ # The platforms this restriction applies to. |
| 1165 | "A String", |
| 1166 | ], |
| 1167 | }, |
| 1168 | "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific |
| 1169 | # location. |
| 1170 | "geoCriteriaIds": [ # IDs representing the geo location for this context. |
| 1171 | # Please refer to the |
| 1172 | # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) |
| 1173 | # file for different geo criteria IDs. |
| 1174 | 42, |
| 1175 | ], |
| 1176 | }, |
| 1177 | "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. |
| 1178 | "appTypes": [ # The app types this restriction applies to. |
| 1179 | "A String", |
| 1180 | ], |
| 1181 | }, |
| 1182 | "all": "A String", # Matches all contexts. |
| 1183 | "securityType": { # Output only. A security context. # Matches impressions for a particular security type. |
| 1184 | "securities": [ # The security types in this context. |
| 1185 | "A String", |
| 1186 | ], |
| 1187 | }, |
| 1188 | }, |
| 1189 | ], |
| 1190 | }, |
| 1191 | ], |
| 1192 | "html": { # HTML content for a creative. # An HTML creative. |
| 1193 | "width": 42, # The width of the HTML snippet in pixels. |
| 1194 | "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. |
| 1195 | "height": 42, # The height of the HTML snippet in pixels. |
| 1196 | }, |
| 1197 | "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1198 | }, |
| 1199 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1200 | "nextPageToken": "A String", # A token to retrieve the next page of results. |
| 1201 | # Pass this value in the |
| 1202 | # ListCreativesRequest.page_token |
| 1203 | # field in the subsequent call to `ListCreatives` method to retrieve the next |
| 1204 | # page of results. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1205 | }</pre> |
| 1206 | </div> |
| 1207 | |
| 1208 | <div class="method"> |
| 1209 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 1210 | <pre>Retrieves the next page of results. |
| 1211 | |
| 1212 | Args: |
| 1213 | previous_request: The request for the previous page. (required) |
| 1214 | previous_response: The response from the request for the previous page. (required) |
| 1215 | |
| 1216 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1217 | A request object that you can call 'execute()' on to request the next |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1218 | page. Returns None if there are no more items in the collection. |
| 1219 | </pre> |
| 1220 | </div> |
| 1221 | |
| 1222 | <div class="method"> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1223 | <code class="details" id="stopWatching">stopWatching(accountId, creativeId, body=None, x__xgafv=None)</code> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1224 | <pre>Stops watching a creative. Will stop push notifications being sent to the |
| 1225 | topics when the creative changes status. |
| 1226 | |
| 1227 | Args: |
| 1228 | accountId: string, The account of the creative to stop notifications for. (required) |
| 1229 | creativeId: string, The creative ID of the creative to stop notifications for. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1230 | Specify "-" to specify stopping account level notifications. (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1231 | body: object, The request body. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1232 | The object takes the form of: |
| 1233 | |
| 1234 | { # A request for stopping notifications for changes to creative Status. |
| 1235 | } |
| 1236 | |
| 1237 | x__xgafv: string, V1 error format. |
| 1238 | Allowed values |
| 1239 | 1 - v1 error format |
| 1240 | 2 - v2 error format |
| 1241 | |
| 1242 | Returns: |
| 1243 | An object of the form: |
| 1244 | |
| 1245 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 1246 | # empty messages in your APIs. A typical example is to use it as the request |
| 1247 | # or the response type of an API method. For instance: |
| 1248 | # |
| 1249 | # service Foo { |
| 1250 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 1251 | # } |
| 1252 | # |
| 1253 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 1254 | }</pre> |
| 1255 | </div> |
| 1256 | |
| 1257 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1258 | <code class="details" id="update">update(accountId, creativeId, body=None, x__xgafv=None)</code> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1259 | <pre>Updates a creative. |
| 1260 | |
| 1261 | Args: |
| 1262 | accountId: string, The account that this creative belongs to. |
| 1263 | Can be used to filter the response of the |
| 1264 | creatives.list |
| 1265 | method. (required) |
| 1266 | creativeId: string, The buyer-defined creative ID of this creative. |
| 1267 | Can be used to filter the response of the |
| 1268 | creatives.list |
| 1269 | method. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1270 | body: object, The request body. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1271 | The object takes the form of: |
| 1272 | |
| 1273 | { # A creative and its classification data. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1274 | "impressionTrackingUrls": [ # The set of URLs to be called to record an impression. |
| 1275 | "A String", |
| 1276 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1277 | "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1278 | "detectedProviderIds": [ # The detected ad technology provider IDs for this creative. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1279 | # See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for |
| 1280 | # mapping of provider ID to provided name, a privacy policy URL, and a list |
| 1281 | # of domains which can be attributed to the provider. |
| 1282 | # |
| 1283 | # If the creative contains provider IDs that are outside of those listed in |
| 1284 | # the `BidRequest.adslot.consented_providers_settings.consented_providers` |
| 1285 | # field on the (Google bid |
| 1286 | # protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] |
| 1287 | # and the |
| 1288 | # `BidRequest.user.ext.consented_providers_settings.consented_providers` |
| 1289 | # field on the (OpenRTB |
| 1290 | # protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], |
| 1291 | # and a bid is submitted with that creative for an impression that will |
| 1292 | # serve to an EEA user, the bid will be filtered before the auction. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1293 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1294 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1295 | "hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. |
| 1296 | # |
| 1297 | # If true for a given creative, any bid submitted with that creative for an |
| 1298 | # impression that will serve to an EEA user will be filtered before the |
| 1299 | # auction. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1300 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1301 | "detectedLanguages": [ # Output only. The detected languages for this creative. The order is |
| 1302 | # arbitrary. The codes are 2 or 5 characters and are documented at |
| 1303 | # https://developers.google.com/adwords/api/docs/appendix/languagecodes. |
| 1304 | "A String", |
| 1305 | ], |
| 1306 | "agencyId": "A String", # The agency ID for this creative. |
| 1307 | "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative. |
| 1308 | "A String", |
| 1309 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1310 | "creativeId": "A String", # The buyer-defined creative ID of this creative. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1311 | # Can be used to filter the response of the |
| 1312 | # creatives.list |
| 1313 | # method. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1314 | "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative. |
| 1315 | "A String", |
| 1316 | ], |
| 1317 | "accountId": "A String", # The account that this creative belongs to. |
| 1318 | # Can be used to filter the response of the |
| 1319 | # creatives.list |
| 1320 | # method. |
| 1321 | "advertiserName": "A String", # The name of the company being advertised in the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1322 | "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. |
| 1323 | # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1324 | # serving_restrictions will also exist. Note |
| 1325 | # that this may be nuanced with other contextual restrictions, in which case, |
| 1326 | # it may be preferable to read from serving_restrictions directly. |
| 1327 | # Can be used to filter the response of the |
| 1328 | # creatives.list |
| 1329 | # method. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1330 | "attributes": [ # All attributes for the ads that may be shown from this creative. |
| 1331 | # Can be used to filter the response of the |
| 1332 | # creatives.list |
| 1333 | # method. |
| 1334 | "A String", |
| 1335 | ], |
| 1336 | "version": 42, # Output only. The version of this creative. |
| 1337 | "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. |
| 1338 | # See the ad-sensitive-categories.txt file in the technical documentation for |
| 1339 | # a list of IDs. You should use these IDs along with the |
| 1340 | # excluded-sensitive-category field in the bid request to filter your bids. |
| 1341 | 42, |
| 1342 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1343 | "native": { # Native content for a creative. # A native creative. |
| 1344 | "body": "A String", # A long description of the ad. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1345 | "image": { # An image resource. You may provide a larger image than was requested, # A large image. |
| 1346 | # so long as the aspect ratio is preserved. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1347 | "width": 42, # Image width in pixels. |
| 1348 | "height": 42, # Image height in pixels. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1349 | "url": "A String", # The URL of the image. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1350 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1351 | "priceDisplayText": "A String", # The price of the promoted app including currency info. |
| 1352 | "logo": { # An image resource. You may provide a larger image than was requested, # A smaller image, for the advertiser's logo. |
| 1353 | # so long as the aspect ratio is preserved. |
| 1354 | "width": 42, # Image width in pixels. |
| 1355 | "height": 42, # Image height in pixels. |
| 1356 | "url": "A String", # The URL of the image. |
| 1357 | }, |
| 1358 | "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads. |
| 1359 | # so long as the aspect ratio is preserved. |
| 1360 | "width": 42, # Image width in pixels. |
| 1361 | "height": 42, # Image height in pixels. |
| 1362 | "url": "A String", # The URL of the image. |
| 1363 | }, |
| 1364 | "clickTrackingUrl": "A String", # The URL to use for click tracking. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1365 | "videoUrl": "A String", # The URL to fetch a native video ad. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1366 | "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5]. |
| 1367 | "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app. |
| 1368 | "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative. |
| 1369 | "headline": "A String", # A short title for the ad. |
| 1370 | "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad. |
| 1371 | "callToAction": "A String", # A label for the button that the user is supposed to click. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1372 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1373 | "clickThroughUrls": [ # The set of destination URLs for the creative. |
| 1374 | "A String", |
| 1375 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1376 | "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any. |
| 1377 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1378 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1379 | "dealsStatus": "A String", # Output only. The top-level deals status of this creative. |
| 1380 | # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in |
| 1381 | # serving_restrictions will also exist. Note |
| 1382 | # that this may be nuanced with other contextual restrictions, in which case, |
| 1383 | # it may be preferable to read from serving_restrictions directly. |
| 1384 | # Can be used to filter the response of the |
| 1385 | # creatives.list |
| 1386 | # method. |
| 1387 | "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. |
| 1388 | # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt |
| 1389 | # for possible values. |
| 1390 | 42, |
| 1391 | ], |
| 1392 | "detectedProductCategories": [ # Output only. Detected product categories, if any. |
| 1393 | # See the ad-product-categories.txt file in the technical documentation |
| 1394 | # for a list of IDs. |
| 1395 | 42, |
| 1396 | ], |
| 1397 | "video": { # Video content for a creative. # A video creative. |
| 1398 | "videoVastXml": "A String", # The contents of a VAST document for a video ad. |
| 1399 | # This document should conform to the VAST 2.0 or 3.0 standard. |
| 1400 | "videoUrl": "A String", # The URL to fetch a video ad. |
| 1401 | }, |
| 1402 | "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. |
| 1403 | # A context here relates to where something ultimately serves (for example, |
| 1404 | # a physical location, a platform, an HTTPS vs HTTP request, or the type |
| 1405 | # of auction). |
| 1406 | { # Output only. A representation of the status of an ad in a |
| 1407 | # specific context. A context here relates to where something ultimately serves |
| 1408 | # (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, |
| 1409 | # or the type of auction). |
| 1410 | "disapprovalReasons": [ # Any disapprovals bound to this restriction. |
| 1411 | # Only present if status=DISAPPROVED. |
| 1412 | # Can be used to filter the response of the |
| 1413 | # creatives.list |
| 1414 | # method. |
| 1415 | # Deprecated; please use |
| 1416 | # disapproval |
| 1417 | # field instead. |
| 1418 | { # Output only. The reason and details for a disapproval. |
| 1419 | "details": [ # Additional details about the reason for disapproval. |
| 1420 | "A String", |
| 1421 | ], |
| 1422 | "reason": "A String", # The categorized reason for disapproval. |
| 1423 | }, |
| 1424 | ], |
| 1425 | "status": "A String", # The status of the creative in this context (for example, it has been |
| 1426 | # explicitly disapproved or is pending review). |
| 1427 | "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. |
| 1428 | # Only present if status=DISAPPROVED. |
| 1429 | # Can be used to filter the response of the |
| 1430 | # creatives.list |
| 1431 | # method. |
| 1432 | "details": [ # Additional details about the reason for disapproval. |
| 1433 | "A String", |
| 1434 | ], |
| 1435 | "reason": "A String", # The categorized reason for disapproval. |
| 1436 | }, |
| 1437 | "contexts": [ # The contexts for the restriction. |
| 1438 | { # The serving context for this restriction. |
| 1439 | "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. |
| 1440 | "auctionTypes": [ # The auction types this restriction applies to. |
| 1441 | "A String", |
| 1442 | ], |
| 1443 | }, |
| 1444 | "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. |
| 1445 | "platforms": [ # The platforms this restriction applies to. |
| 1446 | "A String", |
| 1447 | ], |
| 1448 | }, |
| 1449 | "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific |
| 1450 | # location. |
| 1451 | "geoCriteriaIds": [ # IDs representing the geo location for this context. |
| 1452 | # Please refer to the |
| 1453 | # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) |
| 1454 | # file for different geo criteria IDs. |
| 1455 | 42, |
| 1456 | ], |
| 1457 | }, |
| 1458 | "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. |
| 1459 | "appTypes": [ # The app types this restriction applies to. |
| 1460 | "A String", |
| 1461 | ], |
| 1462 | }, |
| 1463 | "all": "A String", # Matches all contexts. |
| 1464 | "securityType": { # Output only. A security context. # Matches impressions for a particular security type. |
| 1465 | "securities": [ # The security types in this context. |
| 1466 | "A String", |
| 1467 | ], |
| 1468 | }, |
| 1469 | }, |
| 1470 | ], |
| 1471 | }, |
| 1472 | ], |
| 1473 | "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. |
| 1474 | "detectedDomains": [ # Output only. The detected domains for this creative. |
| 1475 | "A String", |
| 1476 | ], |
| 1477 | "corrections": [ # Output only. Shows any corrections that were applied to this creative. |
| 1478 | { # Output only. Shows any corrections that were applied to this creative. |
| 1479 | "details": [ # Additional details about what was corrected. |
| 1480 | "A String", |
| 1481 | ], |
| 1482 | "type": "A String", # The type of correction that was applied to the creative. |
| 1483 | "contexts": [ # The contexts for the correction. |
| 1484 | { # The serving context for this restriction. |
| 1485 | "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. |
| 1486 | "auctionTypes": [ # The auction types this restriction applies to. |
| 1487 | "A String", |
| 1488 | ], |
| 1489 | }, |
| 1490 | "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. |
| 1491 | "platforms": [ # The platforms this restriction applies to. |
| 1492 | "A String", |
| 1493 | ], |
| 1494 | }, |
| 1495 | "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific |
| 1496 | # location. |
| 1497 | "geoCriteriaIds": [ # IDs representing the geo location for this context. |
| 1498 | # Please refer to the |
| 1499 | # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) |
| 1500 | # file for different geo criteria IDs. |
| 1501 | 42, |
| 1502 | ], |
| 1503 | }, |
| 1504 | "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. |
| 1505 | "appTypes": [ # The app types this restriction applies to. |
| 1506 | "A String", |
| 1507 | ], |
| 1508 | }, |
| 1509 | "all": "A String", # Matches all contexts. |
| 1510 | "securityType": { # Output only. A security context. # Matches impressions for a particular security type. |
| 1511 | "securities": [ # The security types in this context. |
| 1512 | "A String", |
| 1513 | ], |
| 1514 | }, |
| 1515 | }, |
| 1516 | ], |
| 1517 | }, |
| 1518 | ], |
| 1519 | "html": { # HTML content for a creative. # An HTML creative. |
| 1520 | "width": 42, # The width of the HTML snippet in pixels. |
| 1521 | "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. |
| 1522 | "height": 42, # The height of the HTML snippet in pixels. |
| 1523 | }, |
| 1524 | "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1525 | } |
| 1526 | |
| 1527 | x__xgafv: string, V1 error format. |
| 1528 | Allowed values |
| 1529 | 1 - v1 error format |
| 1530 | 2 - v2 error format |
| 1531 | |
| 1532 | Returns: |
| 1533 | An object of the form: |
| 1534 | |
| 1535 | { # A creative and its classification data. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1536 | "impressionTrackingUrls": [ # The set of URLs to be called to record an impression. |
| 1537 | "A String", |
| 1538 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1539 | "adTechnologyProviders": { # Detected ad technology provider information. # Output only. The detected ad technology providers. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1540 | "detectedProviderIds": [ # The detected ad technology provider IDs for this creative. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1541 | # See https://storage.googleapis.com/adx-rtb-dictionaries/providers.csv for |
| 1542 | # mapping of provider ID to provided name, a privacy policy URL, and a list |
| 1543 | # of domains which can be attributed to the provider. |
| 1544 | # |
| 1545 | # If the creative contains provider IDs that are outside of those listed in |
| 1546 | # the `BidRequest.adslot.consented_providers_settings.consented_providers` |
| 1547 | # field on the (Google bid |
| 1548 | # protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/realtime-bidding-proto] |
| 1549 | # and the |
| 1550 | # `BidRequest.user.ext.consented_providers_settings.consented_providers` |
| 1551 | # field on the (OpenRTB |
| 1552 | # protocol)[https://developers.google.com/authorized-buyers/rtb/downloads/openrtb-adx-proto], |
| 1553 | # and a bid is submitted with that creative for an impression that will |
| 1554 | # serve to an EEA user, the bid will be filtered before the auction. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1555 | "A String", |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1556 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1557 | "hasUnidentifiedProvider": True or False, # Whether the creative contains an unidentified ad technology provider. |
| 1558 | # |
| 1559 | # If true for a given creative, any bid submitted with that creative for an |
| 1560 | # impression that will serve to an EEA user will be filtered before the |
| 1561 | # auction. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1562 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1563 | "detectedLanguages": [ # Output only. The detected languages for this creative. The order is |
| 1564 | # arbitrary. The codes are 2 or 5 characters and are documented at |
| 1565 | # https://developers.google.com/adwords/api/docs/appendix/languagecodes. |
| 1566 | "A String", |
| 1567 | ], |
| 1568 | "agencyId": "A String", # The agency ID for this creative. |
| 1569 | "declaredClickThroughUrls": [ # The set of declared destination URLs for the creative. |
| 1570 | "A String", |
| 1571 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1572 | "creativeId": "A String", # The buyer-defined creative ID of this creative. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1573 | # Can be used to filter the response of the |
| 1574 | # creatives.list |
| 1575 | # method. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1576 | "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative. |
| 1577 | "A String", |
| 1578 | ], |
| 1579 | "accountId": "A String", # The account that this creative belongs to. |
| 1580 | # Can be used to filter the response of the |
| 1581 | # creatives.list |
| 1582 | # method. |
| 1583 | "advertiserName": "A String", # The name of the company being advertised in the creative. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1584 | "openAuctionStatus": "A String", # Output only. The top-level open auction status of this creative. |
| 1585 | # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1586 | # serving_restrictions will also exist. Note |
| 1587 | # that this may be nuanced with other contextual restrictions, in which case, |
| 1588 | # it may be preferable to read from serving_restrictions directly. |
| 1589 | # Can be used to filter the response of the |
| 1590 | # creatives.list |
| 1591 | # method. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1592 | "attributes": [ # All attributes for the ads that may be shown from this creative. |
| 1593 | # Can be used to filter the response of the |
| 1594 | # creatives.list |
| 1595 | # method. |
| 1596 | "A String", |
| 1597 | ], |
| 1598 | "version": 42, # Output only. The version of this creative. |
| 1599 | "detectedSensitiveCategories": [ # Output only. Detected sensitive categories, if any. |
| 1600 | # See the ad-sensitive-categories.txt file in the technical documentation for |
| 1601 | # a list of IDs. You should use these IDs along with the |
| 1602 | # excluded-sensitive-category field in the bid request to filter your bids. |
| 1603 | 42, |
| 1604 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1605 | "native": { # Native content for a creative. # A native creative. |
| 1606 | "body": "A String", # A long description of the ad. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1607 | "image": { # An image resource. You may provide a larger image than was requested, # A large image. |
| 1608 | # so long as the aspect ratio is preserved. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1609 | "width": 42, # Image width in pixels. |
| 1610 | "height": 42, # Image height in pixels. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1611 | "url": "A String", # The URL of the image. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1612 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1613 | "priceDisplayText": "A String", # The price of the promoted app including currency info. |
| 1614 | "logo": { # An image resource. You may provide a larger image than was requested, # A smaller image, for the advertiser's logo. |
| 1615 | # so long as the aspect ratio is preserved. |
| 1616 | "width": 42, # Image width in pixels. |
| 1617 | "height": 42, # Image height in pixels. |
| 1618 | "url": "A String", # The URL of the image. |
| 1619 | }, |
| 1620 | "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads. |
| 1621 | # so long as the aspect ratio is preserved. |
| 1622 | "width": 42, # Image width in pixels. |
| 1623 | "height": 42, # Image height in pixels. |
| 1624 | "url": "A String", # The URL of the image. |
| 1625 | }, |
| 1626 | "clickTrackingUrl": "A String", # The URL to use for click tracking. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1627 | "videoUrl": "A String", # The URL to fetch a native video ad. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1628 | "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5]. |
| 1629 | "storeUrl": "A String", # The URL to the app store to purchase/download the promoted app. |
| 1630 | "advertiserName": "A String", # The name of the advertiser or sponsor, to be displayed in the ad creative. |
| 1631 | "headline": "A String", # A short title for the ad. |
| 1632 | "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad. |
| 1633 | "callToAction": "A String", # A label for the button that the user is supposed to click. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 1634 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1635 | "clickThroughUrls": [ # The set of destination URLs for the creative. |
| 1636 | "A String", |
| 1637 | ], |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1638 | "detectedAdvertiserIds": [ # Output only. Detected advertiser IDs, if any. |
| 1639 | "A String", |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1640 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 1641 | "dealsStatus": "A String", # Output only. The top-level deals status of this creative. |
| 1642 | # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in |
| 1643 | # serving_restrictions will also exist. Note |
| 1644 | # that this may be nuanced with other contextual restrictions, in which case, |
| 1645 | # it may be preferable to read from serving_restrictions directly. |
| 1646 | # Can be used to filter the response of the |
| 1647 | # creatives.list |
| 1648 | # method. |
| 1649 | "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative. |
| 1650 | # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt |
| 1651 | # for possible values. |
| 1652 | 42, |
| 1653 | ], |
| 1654 | "detectedProductCategories": [ # Output only. Detected product categories, if any. |
| 1655 | # See the ad-product-categories.txt file in the technical documentation |
| 1656 | # for a list of IDs. |
| 1657 | 42, |
| 1658 | ], |
| 1659 | "video": { # Video content for a creative. # A video creative. |
| 1660 | "videoVastXml": "A String", # The contents of a VAST document for a video ad. |
| 1661 | # This document should conform to the VAST 2.0 or 3.0 standard. |
| 1662 | "videoUrl": "A String", # The URL to fetch a video ad. |
| 1663 | }, |
| 1664 | "servingRestrictions": [ # Output only. The granular status of this ad in specific contexts. |
| 1665 | # A context here relates to where something ultimately serves (for example, |
| 1666 | # a physical location, a platform, an HTTPS vs HTTP request, or the type |
| 1667 | # of auction). |
| 1668 | { # Output only. A representation of the status of an ad in a |
| 1669 | # specific context. A context here relates to where something ultimately serves |
| 1670 | # (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request, |
| 1671 | # or the type of auction). |
| 1672 | "disapprovalReasons": [ # Any disapprovals bound to this restriction. |
| 1673 | # Only present if status=DISAPPROVED. |
| 1674 | # Can be used to filter the response of the |
| 1675 | # creatives.list |
| 1676 | # method. |
| 1677 | # Deprecated; please use |
| 1678 | # disapproval |
| 1679 | # field instead. |
| 1680 | { # Output only. The reason and details for a disapproval. |
| 1681 | "details": [ # Additional details about the reason for disapproval. |
| 1682 | "A String", |
| 1683 | ], |
| 1684 | "reason": "A String", # The categorized reason for disapproval. |
| 1685 | }, |
| 1686 | ], |
| 1687 | "status": "A String", # The status of the creative in this context (for example, it has been |
| 1688 | # explicitly disapproved or is pending review). |
| 1689 | "disapproval": { # Output only. The reason and details for a disapproval. # Disapproval bound to this restriction. |
| 1690 | # Only present if status=DISAPPROVED. |
| 1691 | # Can be used to filter the response of the |
| 1692 | # creatives.list |
| 1693 | # method. |
| 1694 | "details": [ # Additional details about the reason for disapproval. |
| 1695 | "A String", |
| 1696 | ], |
| 1697 | "reason": "A String", # The categorized reason for disapproval. |
| 1698 | }, |
| 1699 | "contexts": [ # The contexts for the restriction. |
| 1700 | { # The serving context for this restriction. |
| 1701 | "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. |
| 1702 | "auctionTypes": [ # The auction types this restriction applies to. |
| 1703 | "A String", |
| 1704 | ], |
| 1705 | }, |
| 1706 | "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. |
| 1707 | "platforms": [ # The platforms this restriction applies to. |
| 1708 | "A String", |
| 1709 | ], |
| 1710 | }, |
| 1711 | "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific |
| 1712 | # location. |
| 1713 | "geoCriteriaIds": [ # IDs representing the geo location for this context. |
| 1714 | # Please refer to the |
| 1715 | # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) |
| 1716 | # file for different geo criteria IDs. |
| 1717 | 42, |
| 1718 | ], |
| 1719 | }, |
| 1720 | "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. |
| 1721 | "appTypes": [ # The app types this restriction applies to. |
| 1722 | "A String", |
| 1723 | ], |
| 1724 | }, |
| 1725 | "all": "A String", # Matches all contexts. |
| 1726 | "securityType": { # Output only. A security context. # Matches impressions for a particular security type. |
| 1727 | "securities": [ # The security types in this context. |
| 1728 | "A String", |
| 1729 | ], |
| 1730 | }, |
| 1731 | }, |
| 1732 | ], |
| 1733 | }, |
| 1734 | ], |
| 1735 | "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page. |
| 1736 | "detectedDomains": [ # Output only. The detected domains for this creative. |
| 1737 | "A String", |
| 1738 | ], |
| 1739 | "corrections": [ # Output only. Shows any corrections that were applied to this creative. |
| 1740 | { # Output only. Shows any corrections that were applied to this creative. |
| 1741 | "details": [ # Additional details about what was corrected. |
| 1742 | "A String", |
| 1743 | ], |
| 1744 | "type": "A String", # The type of correction that was applied to the creative. |
| 1745 | "contexts": [ # The contexts for the correction. |
| 1746 | { # The serving context for this restriction. |
| 1747 | "auctionType": { # Output only. The auction type the restriction applies to. # Matches impressions for a particular auction type. |
| 1748 | "auctionTypes": [ # The auction types this restriction applies to. |
| 1749 | "A String", |
| 1750 | ], |
| 1751 | }, |
| 1752 | "platform": { # Output only. The type of platform the restriction applies to. # Matches impressions coming from a particular platform. |
| 1753 | "platforms": [ # The platforms this restriction applies to. |
| 1754 | "A String", |
| 1755 | ], |
| 1756 | }, |
| 1757 | "location": { # Output only. The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific |
| 1758 | # location. |
| 1759 | "geoCriteriaIds": [ # IDs representing the geo location for this context. |
| 1760 | # Please refer to the |
| 1761 | # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv) |
| 1762 | # file for different geo criteria IDs. |
| 1763 | 42, |
| 1764 | ], |
| 1765 | }, |
| 1766 | "appType": { # Output only. The app type the restriction applies to for mobile device. # Matches impressions for a particular app type. |
| 1767 | "appTypes": [ # The app types this restriction applies to. |
| 1768 | "A String", |
| 1769 | ], |
| 1770 | }, |
| 1771 | "all": "A String", # Matches all contexts. |
| 1772 | "securityType": { # Output only. A security context. # Matches impressions for a particular security type. |
| 1773 | "securities": [ # The security types in this context. |
| 1774 | "A String", |
| 1775 | ], |
| 1776 | }, |
| 1777 | }, |
| 1778 | ], |
| 1779 | }, |
| 1780 | ], |
| 1781 | "html": { # HTML content for a creative. # An HTML creative. |
| 1782 | "width": 42, # The width of the HTML snippet in pixels. |
| 1783 | "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. |
| 1784 | "height": 42, # The height of the HTML snippet in pixels. |
| 1785 | }, |
| 1786 | "apiUpdateTime": "A String", # Output only. The last update timestamp of the creative via API. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1787 | }</pre> |
| 1788 | </div> |
| 1789 | |
| 1790 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1791 | <code class="details" id="watch">watch(accountId, creativeId, body=None, x__xgafv=None)</code> |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1792 | <pre>Watches a creative. Will result in push notifications being sent to the |
| 1793 | topic when the creative changes status. |
| 1794 | |
| 1795 | Args: |
| 1796 | accountId: string, The account of the creative to watch. (required) |
| 1797 | creativeId: string, The creative ID to watch for status changes. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1798 | Specify "-" to watch all creatives under the above account. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1799 | If both creative-level and account-level notifications are |
| 1800 | sent, only a single notification will be sent to the |
| 1801 | creative-level notification topic. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 1802 | body: object, The request body. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1803 | The object takes the form of: |
| 1804 | |
| 1805 | { # A request for watching changes to creative Status. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1806 | "topic": "A String", # The Pub/Sub topic to publish notifications to. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1807 | # This topic must already exist and must give permission to |
| 1808 | # ad-exchange-buyside-reports@google.com to write to the topic. |
| 1809 | # This should be the full resource name in |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1810 | # "projects/{project_id}/topics/{topic_id}" format. |
| Sai Cheemalapati | c30d2b5 | 2017-03-13 12:12:03 -0400 | [diff] [blame] | 1811 | } |
| 1812 | |
| 1813 | x__xgafv: string, V1 error format. |
| 1814 | Allowed values |
| 1815 | 1 - v1 error format |
| 1816 | 2 - v2 error format |
| 1817 | |
| 1818 | Returns: |
| 1819 | An object of the form: |
| 1820 | |
| 1821 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 1822 | # empty messages in your APIs. A typical example is to use it as the request |
| 1823 | # or the response type of an API method. For instance: |
| 1824 | # |
| 1825 | # service Foo { |
| 1826 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 1827 | # } |
| 1828 | # |
| 1829 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 1830 | }</pre> |
| 1831 | </div> |
| 1832 | |
| 1833 | </body></html> |