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