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