Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 98b51f044ede8b9b24e584ab9680e3f35f4bd469 / . / docs / dyn / adexchangebuyer2_v2beta1.accounts.creatives.html
blob: 679f8a77b231509e25180fa28248b30bd40a7c4e [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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]125 "count": "A String", # The number of times the creative was filtered for the status. The
126 # count is aggregated across all publishers on the exchange.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]127 "status": 42, # The filtering status code. Please refer to the
128 # [creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)
129 # file for different statuses.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]159 "openAuctionStatus": "A String", # @OutputOnly The top-level open auction status of this creative.
160 # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in
161 # serving_restrictions will also exist. Note
162 # that this may be nuanced with other contextual restrictions, in which case,
163 # it may be preferable to read from serving_restrictions directly.
164 # Can be used to filter the response of the
165 # creatives.list
166 # method.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]167 "detectedSensitiveCategories": [ # @OutputOnly Detected sensitive categories, if any.
168 # See the ad-sensitive-categories.txt file in the technical documentation for
169 # a list of IDs. You should use these IDs along with the
170 # excluded-sensitive-category field in the bid request to filter your bids.
171 42,
172 ],
173 "creativeId": "A String", # The buyer-defined creative ID of this creative.
174 # Can be used to filter the response of the
175 # creatives.list
176 # method.
177 "detectedAdvertiserIds": [ # @OutputOnly Detected advertiser IDs, if any.
178 "A String",
179 ],
180 "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]181 "accountId": "A String", # The account that this creative belongs to.
182 # Can be used to filter the response of the
183 # creatives.list
184 # method.
185 "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative.
186 # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt
187 # for possible values.
188 42,
189 ],
190 "agencyId": "A String", # The agency ID for this creative.
191 "html": { # HTML content for a creative. # An HTML creative.
192 "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
193 "width": 42, # The width of the HTML snippet in pixels.
194 "height": 42, # The height of the HTML snippet in pixels.
195 },
196 "apiUpdateTime": "A String", # @OutputOnly The last update timestamp of the creative via API.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]197 "native": { # Native content for a creative. # A native creative.
198 "body": "A String", # A long description of the ad.
199 "videoUrl": "A String", # The URL to fetch a native video ad.
200 "headline": "A String", # A short title for the ad.
201 "image": { # An image resource. You may provide a larger image than was requested, # A large image.
202 # so long as the aspect ratio is preserved.
203 "url": "A String", # The URL of the image.
204 "width": 42, # Image width in pixels.
205 "height": 42, # Image height in pixels.
206 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]207 "clickTrackingUrl": "A String", # The URL to use for click tracking.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]208 "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
209 "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]210 "priceDisplayText": "A String", # The price of the promoted app including currency info.
211 "callToAction": "A String", # A label for the button that the user is supposed to click.
212 "logo": { # An image resource. You may provide a larger image than was requested, # A smaller image, for the advertiser's logo.
213 # so long as the aspect ratio is preserved.
214 "url": "A String", # The URL of the image.
215 "width": 42, # Image width in pixels.
216 "height": 42, # Image height in pixels.
217 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]218 "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads.
219 # so long as the aspect ratio is preserved.
220 "url": "A String", # The URL of the image.
221 "width": 42, # Image width in pixels.
222 "height": 42, # Image height in pixels.
223 },
224 "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]225 "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
226 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]227 "detectedProductCategories": [ # @OutputOnly Detected product categories, if any.
228 # See the ad-product-categories.txt file in the technical documentation
229 # for a list of IDs.
230 42,
231 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]232 "detectedDomains": [ # @OutputOnly
233 # The detected domains for this creative.
234 "A String",
235 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]236 "attributes": [ # All attributes for the ads that may be shown from this creative.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]237 # Can be used to filter the response of the
238 # creatives.list
239 # method.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]240 "A String",
241 ],
242 "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
243 # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]244 # serving_restrictions will also exist. Note
245 # that this may be nuanced with other contextual restrictions, in which case,
246 # it may be preferable to read from serving_restrictions directly.
247 # Can be used to filter the response of the
248 # creatives.list
249 # method.
250 "servingRestrictions": [ # @OutputOnly The granular status of this ad in specific contexts.
251 # A context here relates to where something ultimately serves (for example,
252 # a physical location, a platform, an HTTPS vs HTTP request, or the type
253 # of auction).
254 { # @OutputOnly A representation of the status of an ad in a
255 # specific context. A context here relates to where something ultimately serves
256 # (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,
257 # or the type of auction).
258 "contexts": [ # The contexts for the restriction.
259 { # The serving context for this restriction.
260 "all": "A String", # Matches all contexts.
261 "appType": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
262 "appTypes": [ # The app types this restriction applies to.
263 "A String",
264 ],
265 },
266 "securityType": { # @OutputOnly A security context. # Matches impressions for a particular security type.
267 "securities": [ # The security types in this context.
268 "A String",
269 ],
270 },
271 "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
272 "platforms": [ # The platforms this restriction applies to.
273 "A String",
274 ],
275 },
276 "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
277 # location.
278 "geoCriteriaIds": [ # IDs representing the geo location for this context.
279 # Please refer to the
280 # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)
281 # file for different geo criteria IDs.
282 42,
283 ],
284 },
285 "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
286 "auctionTypes": [ # The auction types this restriction applies to.
287 "A String",
288 ],
289 },
290 },
291 ],
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]292 "status": "A String", # The status of the creative in this context (for example, it has been
293 # explicitly disapproved or is pending review).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]294 "disapprovalReasons": [ # Any disapprovals bound to this restriction.
295 # Only present if status=DISAPPROVED.
296 # Can be used to filter the response of the
297 # creatives.list
298 # method.
299 { # @OutputOnly The reason and details for a disapproval.
300 "reason": "A String", # The categorized reason for disapproval.
301 "details": [ # Additional details about the reason for disapproval.
302 "A String",
303 ],
304 },
305 ],
306 },
307 ],
308 "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
309 "A String",
310 ],
311 "corrections": [ # @OutputOnly Shows any corrections that were applied to this creative.
312 { # @OutputOnly Shows any corrections that were applied to this creative.
313 "contexts": [ # The contexts for the correction.
314 { # The serving context for this restriction.
315 "all": "A String", # Matches all contexts.
316 "appType": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
317 "appTypes": [ # The app types this restriction applies to.
318 "A String",
319 ],
320 },
321 "securityType": { # @OutputOnly A security context. # Matches impressions for a particular security type.
322 "securities": [ # The security types in this context.
323 "A String",
324 ],
325 },
326 "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
327 "platforms": [ # The platforms this restriction applies to.
328 "A String",
329 ],
330 },
331 "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
332 # location.
333 "geoCriteriaIds": [ # IDs representing the geo location for this context.
334 # Please refer to the
335 # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)
336 # file for different geo criteria IDs.
337 42,
338 ],
339 },
340 "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
341 "auctionTypes": [ # The auction types this restriction applies to.
342 "A String",
343 ],
344 },
345 },
346 ],
347 "type": "A String", # The type of correction that was applied to the creative.
348 "details": [ # Additional details about what was corrected.
349 "A String",
350 ],
351 },
352 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]353 "video": { # Video content for a creative. # A video creative.
354 "videoUrl": "A String", # The URL to fetch a video ad.
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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]377 "count": "A String", # The number of times the creative was filtered for the status. The
378 # count is aggregated across all publishers on the exchange.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]379 "status": 42, # The filtering status code. Please refer to the
380 # [creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)
381 # file for different statuses.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]411 "openAuctionStatus": "A String", # @OutputOnly The top-level open auction status of this creative.
412 # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in
413 # serving_restrictions will also exist. Note
414 # that this may be nuanced with other contextual restrictions, in which case,
415 # it may be preferable to read from serving_restrictions directly.
416 # Can be used to filter the response of the
417 # creatives.list
418 # method.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]419 "detectedSensitiveCategories": [ # @OutputOnly Detected sensitive categories, if any.
420 # See the ad-sensitive-categories.txt file in the technical documentation for
421 # a list of IDs. You should use these IDs along with the
422 # excluded-sensitive-category field in the bid request to filter your bids.
423 42,
424 ],
425 "creativeId": "A String", # The buyer-defined creative ID of this creative.
426 # Can be used to filter the response of the
427 # creatives.list
428 # method.
429 "detectedAdvertiserIds": [ # @OutputOnly Detected advertiser IDs, if any.
430 "A String",
431 ],
432 "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]433 "accountId": "A String", # The account that this creative belongs to.
434 # Can be used to filter the response of the
435 # creatives.list
436 # method.
437 "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative.
438 # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt
439 # for possible values.
440 42,
441 ],
442 "agencyId": "A String", # The agency ID for this creative.
443 "html": { # HTML content for a creative. # An HTML creative.
444 "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
445 "width": 42, # The width of the HTML snippet in pixels.
446 "height": 42, # The height of the HTML snippet in pixels.
447 },
448 "apiUpdateTime": "A String", # @OutputOnly The last update timestamp of the creative via API.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]449 "native": { # Native content for a creative. # A native creative.
450 "body": "A String", # A long description of the ad.
451 "videoUrl": "A String", # The URL to fetch a native video ad.
452 "headline": "A String", # A short title for the ad.
453 "image": { # An image resource. You may provide a larger image than was requested, # A large image.
454 # so long as the aspect ratio is preserved.
455 "url": "A String", # The URL of the image.
456 "width": 42, # Image width in pixels.
457 "height": 42, # Image height in pixels.
458 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]459 "clickTrackingUrl": "A String", # The URL to use for click tracking.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]460 "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
461 "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]462 "priceDisplayText": "A String", # The price of the promoted app including currency info.
463 "callToAction": "A String", # A label for the button that the user is supposed to click.
464 "logo": { # An image resource. You may provide a larger image than was requested, # A smaller image, for the advertiser's logo.
465 # so long as the aspect ratio is preserved.
466 "url": "A String", # The URL of the image.
467 "width": 42, # Image width in pixels.
468 "height": 42, # Image height in pixels.
469 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]470 "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads.
471 # so long as the aspect ratio is preserved.
472 "url": "A String", # The URL of the image.
473 "width": 42, # Image width in pixels.
474 "height": 42, # Image height in pixels.
475 },
476 "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]477 "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
478 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]479 "detectedProductCategories": [ # @OutputOnly Detected product categories, if any.
480 # See the ad-product-categories.txt file in the technical documentation
481 # for a list of IDs.
482 42,
483 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]484 "detectedDomains": [ # @OutputOnly
485 # The detected domains for this creative.
486 "A String",
487 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]488 "attributes": [ # All attributes for the ads that may be shown from this creative.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]489 # Can be used to filter the response of the
490 # creatives.list
491 # method.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]492 "A String",
493 ],
494 "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
495 # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]496 # serving_restrictions will also exist. Note
497 # that this may be nuanced with other contextual restrictions, in which case,
498 # it may be preferable to read from serving_restrictions directly.
499 # Can be used to filter the response of the
500 # creatives.list
501 # method.
502 "servingRestrictions": [ # @OutputOnly The granular status of this ad in specific contexts.
503 # A context here relates to where something ultimately serves (for example,
504 # a physical location, a platform, an HTTPS vs HTTP request, or the type
505 # of auction).
506 { # @OutputOnly A representation of the status of an ad in a
507 # specific context. A context here relates to where something ultimately serves
508 # (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,
509 # or the type of auction).
510 "contexts": [ # The contexts for the restriction.
511 { # The serving context for this restriction.
512 "all": "A String", # Matches all contexts.
513 "appType": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
514 "appTypes": [ # The app types this restriction applies to.
515 "A String",
516 ],
517 },
518 "securityType": { # @OutputOnly A security context. # Matches impressions for a particular security type.
519 "securities": [ # The security types in this context.
520 "A String",
521 ],
522 },
523 "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
524 "platforms": [ # The platforms this restriction applies to.
525 "A String",
526 ],
527 },
528 "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
529 # location.
530 "geoCriteriaIds": [ # IDs representing the geo location for this context.
531 # Please refer to the
532 # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)
533 # file for different geo criteria IDs.
534 42,
535 ],
536 },
537 "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
538 "auctionTypes": [ # The auction types this restriction applies to.
539 "A String",
540 ],
541 },
542 },
543 ],
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]544 "status": "A String", # The status of the creative in this context (for example, it has been
545 # explicitly disapproved or is pending review).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]546 "disapprovalReasons": [ # Any disapprovals bound to this restriction.
547 # Only present if status=DISAPPROVED.
548 # Can be used to filter the response of the
549 # creatives.list
550 # method.
551 { # @OutputOnly The reason and details for a disapproval.
552 "reason": "A String", # The categorized reason for disapproval.
553 "details": [ # Additional details about the reason for disapproval.
554 "A String",
555 ],
556 },
557 ],
558 },
559 ],
560 "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
561 "A String",
562 ],
563 "corrections": [ # @OutputOnly Shows any corrections that were applied to this creative.
564 { # @OutputOnly Shows any corrections that were applied to this creative.
565 "contexts": [ # The contexts for the correction.
566 { # The serving context for this restriction.
567 "all": "A String", # Matches all contexts.
568 "appType": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
569 "appTypes": [ # The app types this restriction applies to.
570 "A String",
571 ],
572 },
573 "securityType": { # @OutputOnly A security context. # Matches impressions for a particular security type.
574 "securities": [ # The security types in this context.
575 "A String",
576 ],
577 },
578 "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
579 "platforms": [ # The platforms this restriction applies to.
580 "A String",
581 ],
582 },
583 "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
584 # location.
585 "geoCriteriaIds": [ # IDs representing the geo location for this context.
586 # Please refer to the
587 # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)
588 # file for different geo criteria IDs.
589 42,
590 ],
591 },
592 "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
593 "auctionTypes": [ # The auction types this restriction applies to.
594 "A String",
595 ],
596 },
597 },
598 ],
599 "type": "A String", # The type of correction that was applied to the creative.
600 "details": [ # Additional details about what was corrected.
601 "A String",
602 ],
603 },
604 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]605 "video": { # Video content for a creative. # A video creative.
606 "videoUrl": "A String", # The URL to fetch a video ad.
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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]635 "count": "A String", # The number of times the creative was filtered for the status. The
636 # count is aggregated across all publishers on the exchange.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]637 "status": 42, # The filtering status code. Please refer to the
638 # [creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)
639 # file for different statuses.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]669 "openAuctionStatus": "A String", # @OutputOnly The top-level open auction status of this creative.
670 # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in
671 # serving_restrictions will also exist. Note
672 # that this may be nuanced with other contextual restrictions, in which case,
673 # it may be preferable to read from serving_restrictions directly.
674 # Can be used to filter the response of the
675 # creatives.list
676 # method.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]677 "detectedSensitiveCategories": [ # @OutputOnly Detected sensitive categories, if any.
678 # See the ad-sensitive-categories.txt file in the technical documentation for
679 # a list of IDs. You should use these IDs along with the
680 # excluded-sensitive-category field in the bid request to filter your bids.
681 42,
682 ],
683 "creativeId": "A String", # The buyer-defined creative ID of this creative.
684 # Can be used to filter the response of the
685 # creatives.list
686 # method.
687 "detectedAdvertiserIds": [ # @OutputOnly Detected advertiser IDs, if any.
688 "A String",
689 ],
690 "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]691 "accountId": "A String", # The account that this creative belongs to.
692 # Can be used to filter the response of the
693 # creatives.list
694 # method.
695 "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative.
696 # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt
697 # for possible values.
698 42,
699 ],
700 "agencyId": "A String", # The agency ID for this creative.
701 "html": { # HTML content for a creative. # An HTML creative.
702 "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
703 "width": 42, # The width of the HTML snippet in pixels.
704 "height": 42, # The height of the HTML snippet in pixels.
705 },
706 "apiUpdateTime": "A String", # @OutputOnly The last update timestamp of the creative via API.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]707 "native": { # Native content for a creative. # A native creative.
708 "body": "A String", # A long description of the ad.
709 "videoUrl": "A String", # The URL to fetch a native video ad.
710 "headline": "A String", # A short title for the ad.
711 "image": { # An image resource. You may provide a larger image than was requested, # A large image.
712 # so long as the aspect ratio is preserved.
713 "url": "A String", # The URL of the image.
714 "width": 42, # Image width in pixels.
715 "height": 42, # Image height in pixels.
716 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]717 "clickTrackingUrl": "A String", # The URL to use for click tracking.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]718 "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
719 "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]720 "priceDisplayText": "A String", # The price of the promoted app including currency info.
721 "callToAction": "A String", # A label for the button that the user is supposed to click.
722 "logo": { # An image resource. You may provide a larger image than was requested, # A smaller image, for the advertiser's logo.
723 # so long as the aspect ratio is preserved.
724 "url": "A String", # The URL of the image.
725 "width": 42, # Image width in pixels.
726 "height": 42, # Image height in pixels.
727 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]728 "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads.
729 # so long as the aspect ratio is preserved.
730 "url": "A String", # The URL of the image.
731 "width": 42, # Image width in pixels.
732 "height": 42, # Image height in pixels.
733 },
734 "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]735 "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
736 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]737 "detectedProductCategories": [ # @OutputOnly Detected product categories, if any.
738 # See the ad-product-categories.txt file in the technical documentation
739 # for a list of IDs.
740 42,
741 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]742 "detectedDomains": [ # @OutputOnly
743 # The detected domains for this creative.
744 "A String",
745 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]746 "attributes": [ # All attributes for the ads that may be shown from this creative.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]747 # Can be used to filter the response of the
748 # creatives.list
749 # method.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]750 "A String",
751 ],
752 "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
753 # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]754 # serving_restrictions will also exist. Note
755 # that this may be nuanced with other contextual restrictions, in which case,
756 # it may be preferable to read from serving_restrictions directly.
757 # Can be used to filter the response of the
758 # creatives.list
759 # method.
760 "servingRestrictions": [ # @OutputOnly The granular status of this ad in specific contexts.
761 # A context here relates to where something ultimately serves (for example,
762 # a physical location, a platform, an HTTPS vs HTTP request, or the type
763 # of auction).
764 { # @OutputOnly A representation of the status of an ad in a
765 # specific context. A context here relates to where something ultimately serves
766 # (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,
767 # or the type of auction).
768 "contexts": [ # The contexts for the restriction.
769 { # The serving context for this restriction.
770 "all": "A String", # Matches all contexts.
771 "appType": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
772 "appTypes": [ # The app types this restriction applies to.
773 "A String",
774 ],
775 },
776 "securityType": { # @OutputOnly A security context. # Matches impressions for a particular security type.
777 "securities": [ # The security types in this context.
778 "A String",
779 ],
780 },
781 "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
782 "platforms": [ # The platforms this restriction applies to.
783 "A String",
784 ],
785 },
786 "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
787 # location.
788 "geoCriteriaIds": [ # IDs representing the geo location for this context.
789 # Please refer to the
790 # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)
791 # file for different geo criteria IDs.
792 42,
793 ],
794 },
795 "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
796 "auctionTypes": [ # The auction types this restriction applies to.
797 "A String",
798 ],
799 },
800 },
801 ],
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]802 "status": "A String", # The status of the creative in this context (for example, it has been
803 # explicitly disapproved or is pending review).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]804 "disapprovalReasons": [ # Any disapprovals bound to this restriction.
805 # Only present if status=DISAPPROVED.
806 # Can be used to filter the response of the
807 # creatives.list
808 # method.
809 { # @OutputOnly The reason and details for a disapproval.
810 "reason": "A String", # The categorized reason for disapproval.
811 "details": [ # Additional details about the reason for disapproval.
812 "A String",
813 ],
814 },
815 ],
816 },
817 ],
818 "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
819 "A String",
820 ],
821 "corrections": [ # @OutputOnly Shows any corrections that were applied to this creative.
822 { # @OutputOnly Shows any corrections that were applied to this creative.
823 "contexts": [ # The contexts for the correction.
824 { # The serving context for this restriction.
825 "all": "A String", # Matches all contexts.
826 "appType": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
827 "appTypes": [ # The app types this restriction applies to.
828 "A String",
829 ],
830 },
831 "securityType": { # @OutputOnly A security context. # Matches impressions for a particular security type.
832 "securities": [ # The security types in this context.
833 "A String",
834 ],
835 },
836 "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
837 "platforms": [ # The platforms this restriction applies to.
838 "A String",
839 ],
840 },
841 "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
842 # location.
843 "geoCriteriaIds": [ # IDs representing the geo location for this context.
844 # Please refer to the
845 # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)
846 # file for different geo criteria IDs.
847 42,
848 ],
849 },
850 "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
851 "auctionTypes": [ # The auction types this restriction applies to.
852 "A String",
853 ],
854 },
855 },
856 ],
857 "type": "A String", # The type of correction that was applied to the creative.
858 "details": [ # Additional details about what was corrected.
859 "A String",
860 ],
861 },
862 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]863 "video": { # Video content for a creative. # A video creative.
864 "videoUrl": "A String", # The URL to fetch a video ad.
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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]922 "count": "A String", # The number of times the creative was filtered for the status. The
923 # count is aggregated across all publishers on the exchange.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]924 "status": 42, # The filtering status code. Please refer to the
925 # [creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)
926 # file for different statuses.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]956 "openAuctionStatus": "A String", # @OutputOnly The top-level open auction status of this creative.
957 # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in
958 # serving_restrictions will also exist. Note
959 # that this may be nuanced with other contextual restrictions, in which case,
960 # it may be preferable to read from serving_restrictions directly.
961 # Can be used to filter the response of the
962 # creatives.list
963 # method.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]964 "detectedSensitiveCategories": [ # @OutputOnly Detected sensitive categories, if any.
965 # See the ad-sensitive-categories.txt file in the technical documentation for
966 # a list of IDs. You should use these IDs along with the
967 # excluded-sensitive-category field in the bid request to filter your bids.
968 42,
969 ],
970 "creativeId": "A String", # The buyer-defined creative ID of this creative.
971 # Can be used to filter the response of the
972 # creatives.list
973 # method.
974 "detectedAdvertiserIds": [ # @OutputOnly Detected advertiser IDs, if any.
975 "A String",
976 ],
977 "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]978 "accountId": "A String", # The account that this creative belongs to.
979 # Can be used to filter the response of the
980 # creatives.list
981 # method.
982 "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative.
983 # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt
984 # for possible values.
985 42,
986 ],
987 "agencyId": "A String", # The agency ID for this creative.
988 "html": { # HTML content for a creative. # An HTML creative.
989 "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
990 "width": 42, # The width of the HTML snippet in pixels.
991 "height": 42, # The height of the HTML snippet in pixels.
992 },
993 "apiUpdateTime": "A String", # @OutputOnly The last update timestamp of the creative via API.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]994 "native": { # Native content for a creative. # A native creative.
995 "body": "A String", # A long description of the ad.
996 "videoUrl": "A String", # The URL to fetch a native video ad.
997 "headline": "A String", # A short title for the ad.
998 "image": { # An image resource. You may provide a larger image than was requested, # A large image.
999 # so long as the aspect ratio is preserved.
1000 "url": "A String", # The URL of the image.
1001 "width": 42, # Image width in pixels.
1002 "height": 42, # Image height in pixels.
1003 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]1004 "clickTrackingUrl": "A String", # The URL to use for click tracking.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1005 "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
1006 "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]1007 "priceDisplayText": "A String", # The price of the promoted app including currency info.
1008 "callToAction": "A String", # A label for the button that the user is supposed to click.
1009 "logo": { # An image resource. You may provide a larger image than was requested, # A smaller image, for the advertiser's logo.
1010 # so long as the aspect ratio is preserved.
1011 "url": "A String", # The URL of the image.
1012 "width": 42, # Image width in pixels.
1013 "height": 42, # Image height in pixels.
1014 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]1015 "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads.
1016 # so long as the aspect ratio is preserved.
1017 "url": "A String", # The URL of the image.
1018 "width": 42, # Image width in pixels.
1019 "height": 42, # Image height in pixels.
1020 },
1021 "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]1022 "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
1023 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]1024 "detectedProductCategories": [ # @OutputOnly Detected product categories, if any.
1025 # See the ad-product-categories.txt file in the technical documentation
1026 # for a list of IDs.
1027 42,
1028 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1029 "detectedDomains": [ # @OutputOnly
1030 # The detected domains for this creative.
1031 "A String",
1032 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1033 "attributes": [ # All attributes for the ads that may be shown from this creative.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1034 # Can be used to filter the response of the
1035 # creatives.list
1036 # method.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1037 "A String",
1038 ],
1039 "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
1040 # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1041 # serving_restrictions will also exist. Note
1042 # that this may be nuanced with other contextual restrictions, in which case,
1043 # it may be preferable to read from serving_restrictions directly.
1044 # Can be used to filter the response of the
1045 # creatives.list
1046 # method.
1047 "servingRestrictions": [ # @OutputOnly The granular status of this ad in specific contexts.
1048 # A context here relates to where something ultimately serves (for example,
1049 # a physical location, a platform, an HTTPS vs HTTP request, or the type
1050 # of auction).
1051 { # @OutputOnly A representation of the status of an ad in a
1052 # specific context. A context here relates to where something ultimately serves
1053 # (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,
1054 # or the type of auction).
1055 "contexts": [ # The contexts for the restriction.
1056 { # The serving context for this restriction.
1057 "all": "A String", # Matches all contexts.
1058 "appType": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
1059 "appTypes": [ # The app types this restriction applies to.
1060 "A String",
1061 ],
1062 },
1063 "securityType": { # @OutputOnly A security context. # Matches impressions for a particular security type.
1064 "securities": [ # The security types in this context.
1065 "A String",
1066 ],
1067 },
1068 "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
1069 "platforms": [ # The platforms this restriction applies to.
1070 "A String",
1071 ],
1072 },
1073 "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
1074 # location.
1075 "geoCriteriaIds": [ # IDs representing the geo location for this context.
1076 # Please refer to the
1077 # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)
1078 # file for different geo criteria IDs.
1079 42,
1080 ],
1081 },
1082 "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
1083 "auctionTypes": [ # The auction types this restriction applies to.
1084 "A String",
1085 ],
1086 },
1087 },
1088 ],
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]1089 "status": "A String", # The status of the creative in this context (for example, it has been
1090 # explicitly disapproved or is pending review).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1091 "disapprovalReasons": [ # Any disapprovals bound to this restriction.
1092 # Only present if status=DISAPPROVED.
1093 # Can be used to filter the response of the
1094 # creatives.list
1095 # method.
1096 { # @OutputOnly The reason and details for a disapproval.
1097 "reason": "A String", # The categorized reason for disapproval.
1098 "details": [ # Additional details about the reason for disapproval.
1099 "A String",
1100 ],
1101 },
1102 ],
1103 },
1104 ],
1105 "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
1106 "A String",
1107 ],
1108 "corrections": [ # @OutputOnly Shows any corrections that were applied to this creative.
1109 { # @OutputOnly Shows any corrections that were applied to this creative.
1110 "contexts": [ # The contexts for the correction.
1111 { # The serving context for this restriction.
1112 "all": "A String", # Matches all contexts.
1113 "appType": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
1114 "appTypes": [ # The app types this restriction applies to.
1115 "A String",
1116 ],
1117 },
1118 "securityType": { # @OutputOnly A security context. # Matches impressions for a particular security type.
1119 "securities": [ # The security types in this context.
1120 "A String",
1121 ],
1122 },
1123 "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
1124 "platforms": [ # The platforms this restriction applies to.
1125 "A String",
1126 ],
1127 },
1128 "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
1129 # location.
1130 "geoCriteriaIds": [ # IDs representing the geo location for this context.
1131 # Please refer to the
1132 # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)
1133 # file for different geo criteria IDs.
1134 42,
1135 ],
1136 },
1137 "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
1138 "auctionTypes": [ # The auction types this restriction applies to.
1139 "A String",
1140 ],
1141 },
1142 },
1143 ],
1144 "type": "A String", # The type of correction that was applied to the creative.
1145 "details": [ # Additional details about what was corrected.
1146 "A String",
1147 ],
1148 },
1149 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1150 "video": { # Video content for a creative. # A video creative.
1151 "videoUrl": "A String", # The URL to fetch a video ad.
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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1232 "count": "A String", # The number of times the creative was filtered for the status. The
1233 # count is aggregated across all publishers on the exchange.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1234 "status": 42, # The filtering status code. Please refer to the
1235 # [creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)
1236 # file for different statuses.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1266 "openAuctionStatus": "A String", # @OutputOnly The top-level open auction status of this creative.
1267 # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in
1268 # serving_restrictions will also exist. Note
1269 # that this may be nuanced with other contextual restrictions, in which case,
1270 # it may be preferable to read from serving_restrictions directly.
1271 # Can be used to filter the response of the
1272 # creatives.list
1273 # method.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1274 "detectedSensitiveCategories": [ # @OutputOnly Detected sensitive categories, if any.
1275 # See the ad-sensitive-categories.txt file in the technical documentation for
1276 # a list of IDs. You should use these IDs along with the
1277 # excluded-sensitive-category field in the bid request to filter your bids.
1278 42,
1279 ],
1280 "creativeId": "A String", # The buyer-defined creative ID of this creative.
1281 # Can be used to filter the response of the
1282 # creatives.list
1283 # method.
1284 "detectedAdvertiserIds": [ # @OutputOnly Detected advertiser IDs, if any.
1285 "A String",
1286 ],
1287 "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1288 "accountId": "A String", # The account that this creative belongs to.
1289 # Can be used to filter the response of the
1290 # creatives.list
1291 # method.
1292 "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative.
1293 # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt
1294 # for possible values.
1295 42,
1296 ],
1297 "agencyId": "A String", # The agency ID for this creative.
1298 "html": { # HTML content for a creative. # An HTML creative.
1299 "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
1300 "width": 42, # The width of the HTML snippet in pixels.
1301 "height": 42, # The height of the HTML snippet in pixels.
1302 },
1303 "apiUpdateTime": "A String", # @OutputOnly The last update timestamp of the creative via API.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1304 "native": { # Native content for a creative. # A native creative.
1305 "body": "A String", # A long description of the ad.
1306 "videoUrl": "A String", # The URL to fetch a native video ad.
1307 "headline": "A String", # A short title for the ad.
1308 "image": { # An image resource. You may provide a larger image than was requested, # A large image.
1309 # so long as the aspect ratio is preserved.
1310 "url": "A String", # The URL of the image.
1311 "width": 42, # Image width in pixels.
1312 "height": 42, # Image height in pixels.
1313 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]1314 "clickTrackingUrl": "A String", # The URL to use for click tracking.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1315 "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
1316 "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]1317 "priceDisplayText": "A String", # The price of the promoted app including currency info.
1318 "callToAction": "A String", # A label for the button that the user is supposed to click.
1319 "logo": { # An image resource. You may provide a larger image than was requested, # A smaller image, for the advertiser's logo.
1320 # so long as the aspect ratio is preserved.
1321 "url": "A String", # The URL of the image.
1322 "width": 42, # Image width in pixels.
1323 "height": 42, # Image height in pixels.
1324 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]1325 "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads.
1326 # so long as the aspect ratio is preserved.
1327 "url": "A String", # The URL of the image.
1328 "width": 42, # Image width in pixels.
1329 "height": 42, # Image height in pixels.
1330 },
1331 "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]1332 "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
1333 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]1334 "detectedProductCategories": [ # @OutputOnly Detected product categories, if any.
1335 # See the ad-product-categories.txt file in the technical documentation
1336 # for a list of IDs.
1337 42,
1338 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1339 "detectedDomains": [ # @OutputOnly
1340 # The detected domains for this creative.
1341 "A String",
1342 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1343 "attributes": [ # All attributes for the ads that may be shown from this creative.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1344 # Can be used to filter the response of the
1345 # creatives.list
1346 # method.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1347 "A String",
1348 ],
1349 "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
1350 # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1351 # serving_restrictions will also exist. Note
1352 # that this may be nuanced with other contextual restrictions, in which case,
1353 # it may be preferable to read from serving_restrictions directly.
1354 # Can be used to filter the response of the
1355 # creatives.list
1356 # method.
1357 "servingRestrictions": [ # @OutputOnly The granular status of this ad in specific contexts.
1358 # A context here relates to where something ultimately serves (for example,
1359 # a physical location, a platform, an HTTPS vs HTTP request, or the type
1360 # of auction).
1361 { # @OutputOnly A representation of the status of an ad in a
1362 # specific context. A context here relates to where something ultimately serves
1363 # (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,
1364 # or the type of auction).
1365 "contexts": [ # The contexts for the restriction.
1366 { # The serving context for this restriction.
1367 "all": "A String", # Matches all contexts.
1368 "appType": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
1369 "appTypes": [ # The app types this restriction applies to.
1370 "A String",
1371 ],
1372 },
1373 "securityType": { # @OutputOnly A security context. # Matches impressions for a particular security type.
1374 "securities": [ # The security types in this context.
1375 "A String",
1376 ],
1377 },
1378 "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
1379 "platforms": [ # The platforms this restriction applies to.
1380 "A String",
1381 ],
1382 },
1383 "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
1384 # location.
1385 "geoCriteriaIds": [ # IDs representing the geo location for this context.
1386 # Please refer to the
1387 # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)
1388 # file for different geo criteria IDs.
1389 42,
1390 ],
1391 },
1392 "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
1393 "auctionTypes": [ # The auction types this restriction applies to.
1394 "A String",
1395 ],
1396 },
1397 },
1398 ],
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]1399 "status": "A String", # The status of the creative in this context (for example, it has been
1400 # explicitly disapproved or is pending review).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1401 "disapprovalReasons": [ # Any disapprovals bound to this restriction.
1402 # Only present if status=DISAPPROVED.
1403 # Can be used to filter the response of the
1404 # creatives.list
1405 # method.
1406 { # @OutputOnly The reason and details for a disapproval.
1407 "reason": "A String", # The categorized reason for disapproval.
1408 "details": [ # Additional details about the reason for disapproval.
1409 "A String",
1410 ],
1411 },
1412 ],
1413 },
1414 ],
1415 "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
1416 "A String",
1417 ],
1418 "corrections": [ # @OutputOnly Shows any corrections that were applied to this creative.
1419 { # @OutputOnly Shows any corrections that were applied to this creative.
1420 "contexts": [ # The contexts for the correction.
1421 { # The serving context for this restriction.
1422 "all": "A String", # Matches all contexts.
1423 "appType": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
1424 "appTypes": [ # The app types this restriction applies to.
1425 "A String",
1426 ],
1427 },
1428 "securityType": { # @OutputOnly A security context. # Matches impressions for a particular security type.
1429 "securities": [ # The security types in this context.
1430 "A String",
1431 ],
1432 },
1433 "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
1434 "platforms": [ # The platforms this restriction applies to.
1435 "A String",
1436 ],
1437 },
1438 "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
1439 # location.
1440 "geoCriteriaIds": [ # IDs representing the geo location for this context.
1441 # Please refer to the
1442 # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)
1443 # file for different geo criteria IDs.
1444 42,
1445 ],
1446 },
1447 "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
1448 "auctionTypes": [ # The auction types this restriction applies to.
1449 "A String",
1450 ],
1451 },
1452 },
1453 ],
1454 "type": "A String", # The type of correction that was applied to the creative.
1455 "details": [ # Additional details about what was corrected.
1456 "A String",
1457 ],
1458 },
1459 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1460 "video": { # Video content for a creative. # A video creative.
1461 "videoUrl": "A String", # The URL to fetch a video ad.
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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1482 "count": "A String", # The number of times the creative was filtered for the status. The
1483 # count is aggregated across all publishers on the exchange.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1484 "status": 42, # The filtering status code. Please refer to the
1485 # [creative-status-codes.txt](https://storage.googleapis.com/adx-rtb-dictionaries/creative-status-codes.txt)
1486 # file for different statuses.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]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 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1516 "openAuctionStatus": "A String", # @OutputOnly The top-level open auction status of this creative.
1517 # If disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in
1518 # serving_restrictions will also exist. Note
1519 # that this may be nuanced with other contextual restrictions, in which case,
1520 # it may be preferable to read from serving_restrictions directly.
1521 # Can be used to filter the response of the
1522 # creatives.list
1523 # method.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1524 "detectedSensitiveCategories": [ # @OutputOnly Detected sensitive categories, if any.
1525 # See the ad-sensitive-categories.txt file in the technical documentation for
1526 # a list of IDs. You should use these IDs along with the
1527 # excluded-sensitive-category field in the bid request to filter your bids.
1528 42,
1529 ],
1530 "creativeId": "A String", # The buyer-defined creative ID of this creative.
1531 # Can be used to filter the response of the
1532 # creatives.list
1533 # method.
1534 "detectedAdvertiserIds": [ # @OutputOnly Detected advertiser IDs, if any.
1535 "A String",
1536 ],
1537 "adChoicesDestinationUrl": "A String", # The link to AdChoices destination page.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1538 "accountId": "A String", # The account that this creative belongs to.
1539 # Can be used to filter the response of the
1540 # creatives.list
1541 # method.
1542 "vendorIds": [ # All vendor IDs for the ads that may be shown from this creative.
1543 # See https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt
1544 # for possible values.
1545 42,
1546 ],
1547 "agencyId": "A String", # The agency ID for this creative.
1548 "html": { # HTML content for a creative. # An HTML creative.
1549 "snippet": "A String", # The HTML snippet that displays the ad when inserted in the web page.
1550 "width": 42, # The width of the HTML snippet in pixels.
1551 "height": 42, # The height of the HTML snippet in pixels.
1552 },
1553 "apiUpdateTime": "A String", # @OutputOnly The last update timestamp of the creative via API.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1554 "native": { # Native content for a creative. # A native creative.
1555 "body": "A String", # A long description of the ad.
1556 "videoUrl": "A String", # The URL to fetch a native video ad.
1557 "headline": "A String", # A short title for the ad.
1558 "image": { # An image resource. You may provide a larger image than was requested, # A large image.
1559 # so long as the aspect ratio is preserved.
1560 "url": "A String", # The URL of the image.
1561 "width": 42, # Image width in pixels.
1562 "height": 42, # Image height in pixels.
1563 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]1564 "clickTrackingUrl": "A String", # The URL to use for click tracking.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1565 "starRating": 3.14, # The app rating in the app store. Must be in the range [0-5].
1566 "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]1567 "priceDisplayText": "A String", # The price of the promoted app including currency info.
1568 "callToAction": "A String", # A label for the button that the user is supposed to click.
1569 "logo": { # An image resource. You may provide a larger image than was requested, # A smaller image, for the advertiser's logo.
1570 # so long as the aspect ratio is preserved.
1571 "url": "A String", # The URL of the image.
1572 "width": 42, # Image width in pixels.
1573 "height": 42, # Image height in pixels.
1574 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]1575 "appIcon": { # An image resource. You may provide a larger image than was requested, # The app icon, for app download ads.
1576 # so long as the aspect ratio is preserved.
1577 "url": "A String", # The URL of the image.
1578 "width": 42, # Image width in pixels.
1579 "height": 42, # Image height in pixels.
1580 },
1581 "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]1582 "clickLinkUrl": "A String", # The URL that the browser/SDK will load when the user clicks the ad.
1583 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]1584 "detectedProductCategories": [ # @OutputOnly Detected product categories, if any.
1585 # See the ad-product-categories.txt file in the technical documentation
1586 # for a list of IDs.
1587 42,
1588 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1589 "detectedDomains": [ # @OutputOnly
1590 # The detected domains for this creative.
1591 "A String",
1592 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1593 "attributes": [ # All attributes for the ads that may be shown from this creative.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1594 # Can be used to filter the response of the
1595 # creatives.list
1596 # method.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1597 "A String",
1598 ],
1599 "dealsStatus": "A String", # @OutputOnly The top-level deals status of this creative.
1600 # If disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1601 # serving_restrictions will also exist. Note
1602 # that this may be nuanced with other contextual restrictions, in which case,
1603 # it may be preferable to read from serving_restrictions directly.
1604 # Can be used to filter the response of the
1605 # creatives.list
1606 # method.
1607 "servingRestrictions": [ # @OutputOnly The granular status of this ad in specific contexts.
1608 # A context here relates to where something ultimately serves (for example,
1609 # a physical location, a platform, an HTTPS vs HTTP request, or the type
1610 # of auction).
1611 { # @OutputOnly A representation of the status of an ad in a
1612 # specific context. A context here relates to where something ultimately serves
1613 # (for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,
1614 # or the type of auction).
1615 "contexts": [ # The contexts for the restriction.
1616 { # The serving context for this restriction.
1617 "all": "A String", # Matches all contexts.
1618 "appType": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
1619 "appTypes": [ # The app types this restriction applies to.
1620 "A String",
1621 ],
1622 },
1623 "securityType": { # @OutputOnly A security context. # Matches impressions for a particular security type.
1624 "securities": [ # The security types in this context.
1625 "A String",
1626 ],
1627 },
1628 "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
1629 "platforms": [ # The platforms this restriction applies to.
1630 "A String",
1631 ],
1632 },
1633 "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
1634 # location.
1635 "geoCriteriaIds": [ # IDs representing the geo location for this context.
1636 # Please refer to the
1637 # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)
1638 # file for different geo criteria IDs.
1639 42,
1640 ],
1641 },
1642 "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
1643 "auctionTypes": [ # The auction types this restriction applies to.
1644 "A String",
1645 ],
1646 },
1647 },
1648 ],
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]1649 "status": "A String", # The status of the creative in this context (for example, it has been
1650 # explicitly disapproved or is pending review).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1651 "disapprovalReasons": [ # Any disapprovals bound to this restriction.
1652 # Only present if status=DISAPPROVED.
1653 # Can be used to filter the response of the
1654 # creatives.list
1655 # method.
1656 { # @OutputOnly The reason and details for a disapproval.
1657 "reason": "A String", # The categorized reason for disapproval.
1658 "details": [ # Additional details about the reason for disapproval.
1659 "A String",
1660 ],
1661 },
1662 ],
1663 },
1664 ],
1665 "restrictedCategories": [ # All restricted categories for the ads that may be shown from this creative.
1666 "A String",
1667 ],
1668 "corrections": [ # @OutputOnly Shows any corrections that were applied to this creative.
1669 { # @OutputOnly Shows any corrections that were applied to this creative.
1670 "contexts": [ # The contexts for the correction.
1671 { # The serving context for this restriction.
1672 "all": "A String", # Matches all contexts.
1673 "appType": { # @OutputOnly The app type the restriction applies to for mobile device. # Matches impressions for a particular app type.
1674 "appTypes": [ # The app types this restriction applies to.
1675 "A String",
1676 ],
1677 },
1678 "securityType": { # @OutputOnly A security context. # Matches impressions for a particular security type.
1679 "securities": [ # The security types in this context.
1680 "A String",
1681 ],
1682 },
1683 "platform": { # @OutputOnly The type of platform the restriction applies to. # Matches impressions coming from a particular platform.
1684 "platforms": [ # The platforms this restriction applies to.
1685 "A String",
1686 ],
1687 },
1688 "location": { # @OutputOnly The Geo criteria the restriction applies to. # Matches impressions coming from users *or* publishers in a specific
1689 # location.
1690 "geoCriteriaIds": [ # IDs representing the geo location for this context.
1691 # Please refer to the
1692 # [geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)
1693 # file for different geo criteria IDs.
1694 42,
1695 ],
1696 },
1697 "auctionType": { # @OutputOnly The auction type the restriction applies to. # Matches impressions for a particular auction type.
1698 "auctionTypes": [ # The auction types this restriction applies to.
1699 "A String",
1700 ],
1701 },
1702 },
1703 ],
1704 "type": "A String", # The type of correction that was applied to the creative.
1705 "details": [ # Additional details about what was corrected.
1706 "A String",
1707 ],
1708 },
1709 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1710 "video": { # Video content for a creative. # A video creative.
1711 "videoUrl": "A String", # The URL to fetch a video ad.
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>