Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 20b54fbefa94c545bea868dc1fecafd99649b9ba / . / docs / dyn / adexchangebuyer_v1.creatives.html
blob: 678507cae8e2e375e28617737ac223c06b461e02 [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>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="get">get(accountId, buyerCreativeId, adgroupId)</code>
89 <pre>Gets the status for a single creative.
90
91Args:
92 accountId: integer, The id for the account that will serve this creative. (required)
93 buyerCreativeId: string, The buyer-specific id for this creative. (required)
94 adgroupId: string, The adgroup this creative belongs to. (required)
95
96Returns:
97 An object of the form:
98
99 {
100 "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
101 42,
102 ],
103 "advertiserName": "A String", # The name of the company being advertised in the creative.
104 "adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.
105 "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
106 "width": 42, # Ad width.
107 "attribute": [ # All attributes for the ads that may be shown from this snippet.
108 42,
109 ],
110 "kind": "adexchangebuyer#creative", # Resource type.
111 "height": 42, # Ad height.
112 "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
113 "A String",
114 ],
115 "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
116 "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
117 "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
118 "clickThroughUrl": [ # The set of destination urls for the snippet.
119 "A String",
120 ],
121 "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
122 42,
123 ],
124 "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.
125 "A String",
126 ],
127 "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
128 42,
129 ],
130 "accountId": 42, # Account id.
131 }</pre>
132</div>
133
134<div class="method">
135 <code class="details" id="insert">insert(body)</code>
136 <pre>Submit a new creative.
137
138Args:
139 body: object, The request body. (required)
140 The object takes the form of:
141
142{
143 "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
144 42,
145 ],
146 "advertiserName": "A String", # The name of the company being advertised in the creative.
147 "adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.
148 "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
149 "width": 42, # Ad width.
150 "attribute": [ # All attributes for the ads that may be shown from this snippet.
151 42,
152 ],
153 "kind": "adexchangebuyer#creative", # Resource type.
154 "height": 42, # Ad height.
155 "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
156 "A String",
157 ],
158 "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
159 "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
160 "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
161 "clickThroughUrl": [ # The set of destination urls for the snippet.
162 "A String",
163 ],
164 "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
165 42,
166 ],
167 "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.
168 "A String",
169 ],
170 "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
171 42,
172 ],
173 "accountId": 42, # Account id.
174 }
175
176
177Returns:
178 An object of the form:
179
180 {
181 "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
182 42,
183 ],
184 "advertiserName": "A String", # The name of the company being advertised in the creative.
185 "adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.
186 "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
187 "width": 42, # Ad width.
188 "attribute": [ # All attributes for the ads that may be shown from this snippet.
189 42,
190 ],
191 "kind": "adexchangebuyer#creative", # Resource type.
192 "height": 42, # Ad height.
193 "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
194 "A String",
195 ],
196 "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
197 "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
198 "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
199 "clickThroughUrl": [ # The set of destination urls for the snippet.
200 "A String",
201 ],
202 "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
203 42,
204 ],
205 "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.
206 "A String",
207 ],
208 "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
209 42,
210 ],
211 "accountId": 42, # Account id.
212 }</pre>
213</div>
214
215<div class="method">
216 <code class="details" id="list">list(pageToken=None, maxResults=None)</code>
217 <pre>Retrieves a list of the authenticated user's active creatives.
218
219Args:
220 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.
221 maxResults: integer, Maximum number of entries returned on one result page. If not set, the default is 100. Optional.
222
223Returns:
224 An object of the form:
225
226 {
227 "items": [ # A list of creatives.
228 {
229 "productCategories": [ # Detected product categories, if any. Read-only. This field should not be set in requests.
230 42,
231 ],
232 "advertiserName": "A String", # The name of the company being advertised in the creative.
233 "adgroupId": "A String", # The pretargeting adgroup id that this creative will be associated with.
234 "videoURL": "A String", # The url to fetch a video ad. If set, HTMLSnippet should not be set.
235 "width": 42, # Ad width.
236 "attribute": [ # All attributes for the ads that may be shown from this snippet.
237 42,
238 ],
239 "kind": "adexchangebuyer#creative", # Resource type.
240 "height": 42, # Ad height.
241 "advertiserId": [ # Detected advertiser id, if any. Read-only. This field should not be set in requests.
242 "A String",
243 ],
244 "HTMLSnippet": "A String", # The HTML snippet that displays the ad when inserted in the web page. If set, videoURL should not be set.
245 "status": "A String", # Creative serving status. Read-only. This field should not be set in requests.
246 "buyerCreativeId": "A String", # A buyer-specific id identifying the creative in this ad.
247 "clickThroughUrl": [ # The set of destination urls for the snippet.
248 "A String",
249 ],
250 "vendorType": [ # All vendor types for the ads that may be shown from this snippet.
251 42,
252 ],
253 "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.
254 "A String",
255 ],
256 "sensitiveCategories": [ # Detected sensitive categories, if any. Read-only. This field should not be set in requests.
257 42,
258 ],
259 "accountId": 42, # Account id.
260 },
261 ],
262 "kind": "adexchangebuyer#creativesList", # Resource type.
263 }</pre>
264</div>
265
266</body></html>