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