Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 81fde8e0f11e18d41b770d076097870160143c1b / . / docs / dyn / adexchangebuyer_v1.creatives.html
blob: 5c0d8b76270d4584f584592d8190ae22a79347a0 [file] [log] [blame]
Joe Gregorio075572b2012-07-09 16:53:09 -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="adexchangebuyer_v1.html">Ad Exchange Buyer API</a> . <a href="adexchangebuyer_v1.creatives.html">creatives</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(accountId, buyerCreativeId, adgroupId)</a></code></p>
79<p class="firstline">Gets the status for a single creative.</p>
80<p class="toc_element">
81 <code><a href="#insert">insert(body)</a></code></p>
82<p class="firstline">Submit a new creative.</p>
83<p class="toc_element">
84 <code><a href="#list">list(pageToken=None, maxResults=None)</a></code></p>
85<p class="firstline">Retrieves a list of the authenticated user's active creatives.</p>
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="get">get(accountId, buyerCreativeId, adgroupId)</code>
92 <pre>Gets the status for a single creative.
93
94Args:
95 accountId: integer, The id for the account that will serve this creative. (required)
96 buyerCreativeId: string, The buyer-specific id for this creative. (required)
97 adgroupId: string, The adgroup this creative belongs to. (required)
98
99Returns:
100 An object of the form:
101
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]102 { # A creative and its classification data.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]103 "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
104 42,
105 ],
106 "advertiserName": "A String", # The name of the company being advertised in the creative.
107 "adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.
108 "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
109 "width": 42, # Ad width.
110 "attribute": [ # All attributes for the ads that may be shown from this snippet.
111 42,
112 ],
113 "kind": "adexchangebuyer#creative", # Resource type.
114 "height": 42, # Ad height.
115 "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
116 "A String",
117 ],
118 "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
119 "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
120 "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
121 "clickThroughUrl": [ # The set of destination urls for the snippet.
122 "A String",
123 ],
124 "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
125 42,
126 ],
127 "disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
128 "A String",
129 ],
130 "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
131 42,
132 ],
133 "accountId": 42, # Account id.
134 }</pre>
135</div>
136
137<div class="method">
138 <code class="details" id="insert">insert(body)</code>
139 <pre>Submit a new creative.
140
141Args:
142 body: object, The request body. (required)
143 The object takes the form of:
144
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]145{ # A creative and its classification data.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]146 "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
147 42,
148 ],
149 "advertiserName": "A String", # The name of the company being advertised in the creative.
150 "adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.
151 "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
152 "width": 42, # Ad width.
153 "attribute": [ # All attributes for the ads that may be shown from this snippet.
154 42,
155 ],
156 "kind": "adexchangebuyer#creative", # Resource type.
157 "height": 42, # Ad height.
158 "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
159 "A String",
160 ],
161 "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
162 "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
163 "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
164 "clickThroughUrl": [ # The set of destination urls for the snippet.
165 "A String",
166 ],
167 "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
168 42,
169 ],
170 "disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
171 "A String",
172 ],
173 "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
174 42,
175 ],
176 "accountId": 42, # Account id.
177 }
178
179
180Returns:
181 An object of the form:
182
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]183 { # A creative and its classification data.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]184 "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
185 42,
186 ],
187 "advertiserName": "A String", # The name of the company being advertised in the creative.
188 "adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.
189 "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
190 "width": 42, # Ad width.
191 "attribute": [ # All attributes for the ads that may be shown from this snippet.
192 42,
193 ],
194 "kind": "adexchangebuyer#creative", # Resource type.
195 "height": 42, # Ad height.
196 "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
197 "A String",
198 ],
199 "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
200 "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
201 "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
202 "clickThroughUrl": [ # The set of destination urls for the snippet.
203 "A String",
204 ],
205 "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
206 42,
207 ],
208 "disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
209 "A String",
210 ],
211 "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
212 42,
213 ],
214 "accountId": 42, # Account id.
215 }</pre>
216</div>
217
218<div class="method">
219 <code class="details" id="list">list(pageToken=None, maxResults=None)</code>
220 <pre>Retrieves a list of the authenticated user's active creatives.
221
222Args:
223 pageToken: string, A continuation token, used to page through ad clients. To retrieve the next page, set this parameter to the value of "nextPageToken" from the previous response. Optional.
224 maxResults: integer, Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
225
226Returns:
227 An object of the form:
228
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]229 { # The creatives feed lists the active creatives for the Ad Exchange buyer accounts that the user has access to. Each entry in the feed corresponds to a single creative.
230 "nextPageToken": "A String", # Continuation token used to page through creatives. To retrieve the next page of results, set the next request's "pageToken" value to this.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]231 "items": [ # A list of creatives.
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]232 { # A creative and its classification data.
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]233 "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
234 42,
235 ],
236 "advertiserName": "A String", # The name of the company being advertised in the creative.
237 "adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.
238 "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
239 "width": 42, # Ad width.
240 "attribute": [ # All attributes for the ads that may be shown from this snippet.
241 42,
242 ],
243 "kind": "adexchangebuyer#creative", # Resource type.
244 "height": 42, # Ad height.
245 "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
246 "A String",
247 ],
248 "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
249 "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
250 "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
251 "clickThroughUrl": [ # The set of destination urls for the snippet.
252 "A String",
253 ],
254 "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
255 42,
256 ],
257 "disapprovalReasons": [ # The reason for disapproval, if any. Note that not all disapproval reasons may be categorized, so it is possible for the creative to have a status of DISAPPROVED with an empty list for disapproval_reasons. In this case, please reach out to your TAM to help debug the issue. Read-only. This field should not be set in requests.
258 "A String",
259 ],
260 "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
261 42,
262 ],
263 "accountId": 42, # Account id.
264 },
265 ],
266 "kind": "adexchangebuyer#creativesList", # Resource type.
267 }</pre>
268</div>
269
Joe Gregorio1b425aa2012-08-24 12:04:34 -0400[diff] [blame]270<div class="method">
271 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
272 <pre>Retrieves the next page of results.
273
274Args:
275 previous_request: The request for the previous page. (required)
276 previous_response: The response from the request for the previous page. (required)
277
278Returns:
279 A request object that you can call 'execute()' on to request the next
280 page. Returns None if there are no more items in the collection.
281 </pre>
282</div>
283
Joe Gregorio075572b2012-07-09 16:53:09 -0400[diff] [blame]284</body></html>