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