Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 0a471d3d1d3c16eeda1d1a1288f99be9f8027475 / . / docs / dyn / adexchangebuyer2_v2beta1.accounts.clients.html
blob: 791a96b4d22886439b054282756aa2c9d24b8a26 [file] [log] [blame]
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[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.clients.html">clients</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="adexchangebuyer2_v2beta1.accounts.clients.invitations.html">invitations()</a></code>
79</p>
80<p class="firstline">Returns the invitations Resource.</p>
81
82<p class="toc_element">
83 <code><a href="adexchangebuyer2_v2beta1.accounts.clients.users.html">users()</a></code>
84</p>
85<p class="firstline">Returns the users Resource.</p>
86
87<p class="toc_element">
88 <code><a href="#create">create(accountId=None, body, x__xgafv=None)</a></code></p>
89<p class="firstline">Creates a new client buyer.</p>
90<p class="toc_element">
91 <code><a href="#get">get(accountId, clientAccountId, x__xgafv=None)</a></code></p>
92<p class="firstline">Gets a client buyer with a given client account ID.</p>
93<p class="toc_element">
94 <code><a href="#list">list(accountId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
95<p class="firstline">Lists all the clients for the current sponsor buyer.</p>
96<p class="toc_element">
97 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
98<p class="firstline">Retrieves the next page of results.</p>
99<p class="toc_element">
100 <code><a href="#update">update(accountId=None, clientAccountId, body, x__xgafv=None)</a></code></p>
101<p class="firstline">Updates an existing client buyer.</p>
102<h3>Method Details</h3>
103<div class="method">
104 <code class="details" id="create">create(accountId=None, body, x__xgafv=None)</code>
105 <pre>Creates a new client buyer.
106
107Args:
108 accountId: string, Unique numerical account ID for the buyer of which the client buyer
109is a customer; the sponsor buyer to create a client for. (required) (required)
110 body: object, The request body. (required)
111 The object takes the form of:
112
113{ # A client resource represents a client buyer&mdash;an agency,
114 # a brand, or an advertiser customer of the sponsor buyer.
115 # Users associated with the client buyer have restricted access to
116 # the Ad Exchange Marketplace and certain other sections
117 # of the Ad Exchange Buyer UI based on the role
118 # granted to the client buyer.
119 # All fields are required unless otherwise specified.
120 "status": "A String", # The status of the client buyer.
121 "clientAccountId": "A String", # The globally-unique numerical ID of the client.
122 # The value of this field is ignored in create and update operations.
123 "entityName": "A String", # The name of the entity. This field is automatically fetched based on
124 # the type and ID.
125 # The value of this field is ignored in create and update operations.
126 "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
127 "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
128 # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
129 # `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
130 "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
131 "entityId": "A String", # Numerical identifier of the client entity.
132 # The entity can be an advertiser, a brand, or an agency.
133 # This identifier is unique among all the entities with the same type.
134 #
135 # A list of all known advertisers with their identifiers is available in the
136 # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
137 # file.
138 #
139 # A list of all known brands with their identifiers is available in the
140 # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
141 # file.
142 #
143 # A list of all known agencies with their identifiers is available in the
144 # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
145 # file.
146 "clientName": "A String", # Name used to represent this client to publishers.
147 # You may have multiple clients that map to the same entity,
148 # but for each client the combination of `clientName` and entity
149 # must be unique.
150 # You can specify this field as empty.
151 }
152
153 x__xgafv: string, V1 error format.
154 Allowed values
155 1 - v1 error format
156 2 - v2 error format
157
158Returns:
159 An object of the form:
160
161 { # A client resource represents a client buyer&mdash;an agency,
162 # a brand, or an advertiser customer of the sponsor buyer.
163 # Users associated with the client buyer have restricted access to
164 # the Ad Exchange Marketplace and certain other sections
165 # of the Ad Exchange Buyer UI based on the role
166 # granted to the client buyer.
167 # All fields are required unless otherwise specified.
168 "status": "A String", # The status of the client buyer.
169 "clientAccountId": "A String", # The globally-unique numerical ID of the client.
170 # The value of this field is ignored in create and update operations.
171 "entityName": "A String", # The name of the entity. This field is automatically fetched based on
172 # the type and ID.
173 # The value of this field is ignored in create and update operations.
174 "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
175 "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
176 # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
177 # `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
178 "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
179 "entityId": "A String", # Numerical identifier of the client entity.
180 # The entity can be an advertiser, a brand, or an agency.
181 # This identifier is unique among all the entities with the same type.
182 #
183 # A list of all known advertisers with their identifiers is available in the
184 # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
185 # file.
186 #
187 # A list of all known brands with their identifiers is available in the
188 # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
189 # file.
190 #
191 # A list of all known agencies with their identifiers is available in the
192 # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
193 # file.
194 "clientName": "A String", # Name used to represent this client to publishers.
195 # You may have multiple clients that map to the same entity,
196 # but for each client the combination of `clientName` and entity
197 # must be unique.
198 # You can specify this field as empty.
199 }</pre>
200</div>
201
202<div class="method">
203 <code class="details" id="get">get(accountId, clientAccountId, x__xgafv=None)</code>
204 <pre>Gets a client buyer with a given client account ID.
205
206Args:
207 accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
208 clientAccountId: string, Numerical account ID of the client buyer to retrieve. (required) (required)
209 x__xgafv: string, V1 error format.
210 Allowed values
211 1 - v1 error format
212 2 - v2 error format
213
214Returns:
215 An object of the form:
216
217 { # A client resource represents a client buyer&mdash;an agency,
218 # a brand, or an advertiser customer of the sponsor buyer.
219 # Users associated with the client buyer have restricted access to
220 # the Ad Exchange Marketplace and certain other sections
221 # of the Ad Exchange Buyer UI based on the role
222 # granted to the client buyer.
223 # All fields are required unless otherwise specified.
224 "status": "A String", # The status of the client buyer.
225 "clientAccountId": "A String", # The globally-unique numerical ID of the client.
226 # The value of this field is ignored in create and update operations.
227 "entityName": "A String", # The name of the entity. This field is automatically fetched based on
228 # the type and ID.
229 # The value of this field is ignored in create and update operations.
230 "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
231 "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
232 # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
233 # `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
234 "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
235 "entityId": "A String", # Numerical identifier of the client entity.
236 # The entity can be an advertiser, a brand, or an agency.
237 # This identifier is unique among all the entities with the same type.
238 #
239 # A list of all known advertisers with their identifiers is available in the
240 # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
241 # file.
242 #
243 # A list of all known brands with their identifiers is available in the
244 # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
245 # file.
246 #
247 # A list of all known agencies with their identifiers is available in the
248 # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
249 # file.
250 "clientName": "A String", # Name used to represent this client to publishers.
251 # You may have multiple clients that map to the same entity,
252 # but for each client the combination of `clientName` and entity
253 # must be unique.
254 # You can specify this field as empty.
255 }</pre>
256</div>
257
258<div class="method">
259 <code class="details" id="list">list(accountId, pageSize=None, pageToken=None, x__xgafv=None)</code>
260 <pre>Lists all the clients for the current sponsor buyer.
261
262Args:
263 accountId: string, Unique numerical account ID of the sponsor buyer to list the clients for. (required)
264 pageSize: integer, Requested page size. The server may return fewer clients than requested.
265If unspecified, the server will pick an appropriate default.
266 pageToken: string, A token identifying a page of results the server should return.
267Typically, this is the value of
268ListClientsResponse.nextPageToken
269returned from the previous call to the
270accounts.clients.list method.
271 x__xgafv: string, V1 error format.
272 Allowed values
273 1 - v1 error format
274 2 - v2 error format
275
276Returns:
277 An object of the form:
278
279 {
280 "nextPageToken": "A String", # A token to retrieve the next page of results.
281 # Pass this value in the
282 # ListClientsRequest.pageToken
283 # field in the subsequent call to the
284 # accounts.clients.list method
285 # to retrieve the next page of results.
286 "clients": [ # The returned list of clients.
287 { # A client resource represents a client buyer&mdash;an agency,
288 # a brand, or an advertiser customer of the sponsor buyer.
289 # Users associated with the client buyer have restricted access to
290 # the Ad Exchange Marketplace and certain other sections
291 # of the Ad Exchange Buyer UI based on the role
292 # granted to the client buyer.
293 # All fields are required unless otherwise specified.
294 "status": "A String", # The status of the client buyer.
295 "clientAccountId": "A String", # The globally-unique numerical ID of the client.
296 # The value of this field is ignored in create and update operations.
297 "entityName": "A String", # The name of the entity. This field is automatically fetched based on
298 # the type and ID.
299 # The value of this field is ignored in create and update operations.
300 "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
301 "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
302 # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
303 # `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
304 "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
305 "entityId": "A String", # Numerical identifier of the client entity.
306 # The entity can be an advertiser, a brand, or an agency.
307 # This identifier is unique among all the entities with the same type.
308 #
309 # A list of all known advertisers with their identifiers is available in the
310 # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
311 # file.
312 #
313 # A list of all known brands with their identifiers is available in the
314 # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
315 # file.
316 #
317 # A list of all known agencies with their identifiers is available in the
318 # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
319 # file.
320 "clientName": "A String", # Name used to represent this client to publishers.
321 # You may have multiple clients that map to the same entity,
322 # but for each client the combination of `clientName` and entity
323 # must be unique.
324 # You can specify this field as empty.
325 },
326 ],
327 }</pre>
328</div>
329
330<div class="method">
331 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
332 <pre>Retrieves the next page of results.
333
334Args:
335 previous_request: The request for the previous page. (required)
336 previous_response: The response from the request for the previous page. (required)
337
338Returns:
339 A request object that you can call 'execute()' on to request the next
340 page. Returns None if there are no more items in the collection.
341 </pre>
342</div>
343
344<div class="method">
345 <code class="details" id="update">update(accountId=None, clientAccountId, body, x__xgafv=None)</code>
346 <pre>Updates an existing client buyer.
347
348Args:
349 accountId: string, Unique numerical account ID for the buyer of which the client buyer
350is a customer; the sponsor buyer to update a client for. (required) (required)
351 clientAccountId: string, Unique numerical account ID of the client to update. (required) (required)
352 body: object, The request body. (required)
353 The object takes the form of:
354
355{ # A client resource represents a client buyer&mdash;an agency,
356 # a brand, or an advertiser customer of the sponsor buyer.
357 # Users associated with the client buyer have restricted access to
358 # the Ad Exchange Marketplace and certain other sections
359 # of the Ad Exchange Buyer UI based on the role
360 # granted to the client buyer.
361 # All fields are required unless otherwise specified.
362 "status": "A String", # The status of the client buyer.
363 "clientAccountId": "A String", # The globally-unique numerical ID of the client.
364 # The value of this field is ignored in create and update operations.
365 "entityName": "A String", # The name of the entity. This field is automatically fetched based on
366 # the type and ID.
367 # The value of this field is ignored in create and update operations.
368 "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
369 "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
370 # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
371 # `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
372 "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
373 "entityId": "A String", # Numerical identifier of the client entity.
374 # The entity can be an advertiser, a brand, or an agency.
375 # This identifier is unique among all the entities with the same type.
376 #
377 # A list of all known advertisers with their identifiers is available in the
378 # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
379 # file.
380 #
381 # A list of all known brands with their identifiers is available in the
382 # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
383 # file.
384 #
385 # A list of all known agencies with their identifiers is available in the
386 # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
387 # file.
388 "clientName": "A String", # Name used to represent this client to publishers.
389 # You may have multiple clients that map to the same entity,
390 # but for each client the combination of `clientName` and entity
391 # must be unique.
392 # You can specify this field as empty.
393 }
394
395 x__xgafv: string, V1 error format.
396 Allowed values
397 1 - v1 error format
398 2 - v2 error format
399
400Returns:
401 An object of the form:
402
403 { # A client resource represents a client buyer&mdash;an agency,
404 # a brand, or an advertiser customer of the sponsor buyer.
405 # Users associated with the client buyer have restricted access to
406 # the Ad Exchange Marketplace and certain other sections
407 # of the Ad Exchange Buyer UI based on the role
408 # granted to the client buyer.
409 # All fields are required unless otherwise specified.
410 "status": "A String", # The status of the client buyer.
411 "clientAccountId": "A String", # The globally-unique numerical ID of the client.
412 # The value of this field is ignored in create and update operations.
413 "entityName": "A String", # The name of the entity. This field is automatically fetched based on
414 # the type and ID.
415 # The value of this field is ignored in create and update operations.
416 "entityType": "A String", # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
417 "role": "A String", # The role which is assigned to the client buyer. Each role implies a set of
418 # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
419 # `CLIENT_DEAL_NEGOTIATOR`, or `CLIENT_DEAL_APPROVER`.
420 "visibleToSeller": True or False, # Whether the client buyer will be visible to sellers.
421 "entityId": "A String", # Numerical identifier of the client entity.
422 # The entity can be an advertiser, a brand, or an agency.
423 # This identifier is unique among all the entities with the same type.
424 #
425 # A list of all known advertisers with their identifiers is available in the
426 # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
427 # file.
428 #
429 # A list of all known brands with their identifiers is available in the
430 # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
431 # file.
432 #
433 # A list of all known agencies with their identifiers is available in the
434 # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
435 # file.
436 "clientName": "A String", # Name used to represent this client to publishers.
437 # You may have multiple clients that map to the same entity,
438 # but for each client the combination of `clientName` and entity
439 # must be unique.
440 # You can specify this field as empty.
441 }</pre>
442</div>
443
444</body></html>