Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 650209194f8080f37a5f20846931790f4c70ed46 / . / docs / dyn / adexchangebuyer2_v2beta1.accounts.clients.html
blob: 6a68c90417e726eda2fc5a9895add03017048418 [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 Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]94 <code><a href="#list">list(accountId, pageToken=None, partnerClientId=None, pageSize=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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]118 &quot;status&quot;: &quot;A String&quot;, # The status of the client buyer.
119 &quot;partnerClientId&quot;: &quot;A String&quot;, # Optional arbitrary unique identifier of this client buyer from the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]120 # standpoint of its Ad Exchange sponsor buyer.
121 #
122 # This field can be used to associate a client buyer with the identifier
123 # in the namespace of its sponsor buyer, lookup client buyers by that
124 # identifier and verify whether an Ad Exchange counterpart of a given client
125 # buyer already exists.
126 #
127 # If present, must be unique among all the client buyers for its
128 # Ad Exchange sponsor buyer.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]129 &quot;entityType&quot;: &quot;A String&quot;, # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
130 &quot;clientName&quot;: &quot;A String&quot;, # Name used to represent this client to publishers.
131 # You may have multiple clients that map to the same entity,
132 # but for each client the combination of `clientName` and entity
133 # must be unique.
134 # You can specify this field as empty.
135 &quot;role&quot;: &quot;A String&quot;, # The role which is assigned to the client buyer. Each role implies a set of
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]138 &quot;visibleToSeller&quot;: True or False, # Whether the client buyer will be visible to sellers.
139 &quot;entityId&quot;: &quot;A String&quot;, # Numerical identifier of the client entity.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]154 &quot;clientAccountId&quot;: &quot;A String&quot;, # The globally-unique numerical ID of the client.
155 # The value of this field is ignored in create and update operations.
156 &quot;entityName&quot;: &quot;A String&quot;, # The name of the entity. This field is automatically fetched based on
157 # the type and ID.
158 # The value of this field is ignored in create and update operations.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]174 &quot;status&quot;: &quot;A String&quot;, # The status of the client buyer.
175 &quot;partnerClientId&quot;: &quot;A String&quot;, # Optional arbitrary unique identifier of this client buyer from the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]176 # standpoint of its Ad Exchange sponsor buyer.
177 #
178 # This field can be used to associate a client buyer with the identifier
179 # in the namespace of its sponsor buyer, lookup client buyers by that
180 # identifier and verify whether an Ad Exchange counterpart of a given client
181 # buyer already exists.
182 #
183 # If present, must be unique among all the client buyers for its
184 # Ad Exchange sponsor buyer.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]185 &quot;entityType&quot;: &quot;A String&quot;, # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
186 &quot;clientName&quot;: &quot;A String&quot;, # Name used to represent this client to publishers.
187 # You may have multiple clients that map to the same entity,
188 # but for each client the combination of `clientName` and entity
189 # must be unique.
190 # You can specify this field as empty.
191 &quot;role&quot;: &quot;A String&quot;, # The role which is assigned to the client buyer. Each role implies a set of
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]194 &quot;visibleToSeller&quot;: True or False, # Whether the client buyer will be visible to sellers.
195 &quot;entityId&quot;: &quot;A String&quot;, # Numerical identifier of the client entity.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]210 &quot;clientAccountId&quot;: &quot;A String&quot;, # The globally-unique numerical ID of the client.
211 # The value of this field is ignored in create and update operations.
212 &quot;entityName&quot;: &quot;A String&quot;, # The name of the entity. This field is automatically fetched based on
213 # the type and ID.
214 # The value of this field is ignored in create and update operations.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]223 accountId: string, Numerical account ID of the client&#x27;s sponsor buyer. (required) (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]238 &quot;status&quot;: &quot;A String&quot;, # The status of the client buyer.
239 &quot;partnerClientId&quot;: &quot;A String&quot;, # Optional arbitrary unique identifier of this client buyer from the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]240 # standpoint of its Ad Exchange sponsor buyer.
241 #
242 # This field can be used to associate a client buyer with the identifier
243 # in the namespace of its sponsor buyer, lookup client buyers by that
244 # identifier and verify whether an Ad Exchange counterpart of a given client
245 # buyer already exists.
246 #
247 # If present, must be unique among all the client buyers for its
248 # Ad Exchange sponsor buyer.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]249 &quot;entityType&quot;: &quot;A String&quot;, # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
250 &quot;clientName&quot;: &quot;A String&quot;, # 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 &quot;role&quot;: &quot;A String&quot;, # The role which is assigned to the client buyer. Each role implies a set of
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]258 &quot;visibleToSeller&quot;: True or False, # Whether the client buyer will be visible to sellers.
259 &quot;entityId&quot;: &quot;A String&quot;, # Numerical identifier of the client entity.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]274 &quot;clientAccountId&quot;: &quot;A String&quot;, # The globally-unique numerical ID of the client.
275 # The value of this field is ignored in create and update operations.
276 &quot;entityName&quot;: &quot;A String&quot;, # The name of the entity. This field is automatically fetched based on
277 # the type and ID.
278 # The value of this field is ignored in create and update operations.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]279 }</pre>
280</div>
281
282<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]283 <code class="details" id="list">list(accountId, pageToken=None, partnerClientId=None, pageSize=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)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]288 pageToken: string, A token identifying a page of results the server should return.
289Typically, this is the value of
290ListClientsResponse.nextPageToken
291returned from the previous call to the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]292accounts.clients.list
293method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]294 partnerClientId: string, Optional unique identifier (from the standpoint of an Ad Exchange sponsor
295buyer partner) of the client to return.
296If specified, at most one client will be returned in the response.
297 pageSize: integer, Requested page size. The server may return fewer clients than requested.
298If unspecified, the server will pick an appropriate default.
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 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]308 &quot;clients&quot;: [ # The returned list of clients.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]309 { # 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]310 # advertiser customer of the sponsor buyer. Users associated with the client
311 # buyer have restricted access to the Marketplace and certain other sections of
312 # the Authorized Buyers UI based on the role granted to the client buyer. All
313 # fields are required unless otherwise specified.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]314 &quot;status&quot;: &quot;A String&quot;, # The status of the client buyer.
315 &quot;partnerClientId&quot;: &quot;A String&quot;, # Optional arbitrary unique identifier of this client buyer from the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]316 # standpoint of its Ad Exchange sponsor buyer.
317 #
318 # This field can be used to associate a client buyer with the identifier
319 # in the namespace of its sponsor buyer, lookup client buyers by that
320 # identifier and verify whether an Ad Exchange counterpart of a given client
321 # buyer already exists.
322 #
323 # If present, must be unique among all the client buyers for its
324 # Ad Exchange sponsor buyer.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]325 &quot;entityType&quot;: &quot;A String&quot;, # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
326 &quot;clientName&quot;: &quot;A String&quot;, # Name used to represent this client to publishers.
327 # You may have multiple clients that map to the same entity,
328 # but for each client the combination of `clientName` and entity
329 # must be unique.
330 # You can specify this field as empty.
331 &quot;role&quot;: &quot;A String&quot;, # The role which is assigned to the client buyer. Each role implies a set of
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]332 # permissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]333 # `CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]334 &quot;visibleToSeller&quot;: True or False, # Whether the client buyer will be visible to sellers.
335 &quot;entityId&quot;: &quot;A String&quot;, # Numerical identifier of the client entity.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]336 # The entity can be an advertiser, a brand, or an agency.
337 # This identifier is unique among all the entities with the same type.
338 #
339 # A list of all known advertisers with their identifiers is available in the
340 # [advertisers.txt](https://storage.googleapis.com/adx-rtb-dictionaries/advertisers.txt)
341 # file.
342 #
343 # A list of all known brands with their identifiers is available in the
344 # [brands.txt](https://storage.googleapis.com/adx-rtb-dictionaries/brands.txt)
345 # file.
346 #
347 # A list of all known agencies with their identifiers is available in the
348 # [agencies.txt](https://storage.googleapis.com/adx-rtb-dictionaries/agencies.txt)
349 # file.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]350 &quot;clientAccountId&quot;: &quot;A String&quot;, # The globally-unique numerical ID of the client.
351 # The value of this field is ignored in create and update operations.
352 &quot;entityName&quot;: &quot;A String&quot;, # The name of the entity. This field is automatically fetched based on
353 # the type and ID.
354 # The value of this field is ignored in create and update operations.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]355 },
356 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]357 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results.
358 # Pass this value in the
359 # ListClientsRequest.pageToken
360 # field in the subsequent call to the
361 # accounts.clients.list
362 # method to retrieve the next page of results.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]375 A request object that you can call &#x27;execute()&#x27; on to request the next
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]396 &quot;status&quot;: &quot;A String&quot;, # The status of the client buyer.
397 &quot;partnerClientId&quot;: &quot;A String&quot;, # Optional arbitrary unique identifier of this client buyer from the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]398 # standpoint of its Ad Exchange sponsor buyer.
399 #
400 # This field can be used to associate a client buyer with the identifier
401 # in the namespace of its sponsor buyer, lookup client buyers by that
402 # identifier and verify whether an Ad Exchange counterpart of a given client
403 # buyer already exists.
404 #
405 # If present, must be unique among all the client buyers for its
406 # Ad Exchange sponsor buyer.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]407 &quot;entityType&quot;: &quot;A String&quot;, # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
408 &quot;clientName&quot;: &quot;A String&quot;, # Name used to represent this client to publishers.
409 # You may have multiple clients that map to the same entity,
410 # but for each client the combination of `clientName` and entity
411 # must be unique.
412 # You can specify this field as empty.
413 &quot;role&quot;: &quot;A String&quot;, # The role which is assigned to the client buyer. Each role implies a set of
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]416 &quot;visibleToSeller&quot;: True or False, # Whether the client buyer will be visible to sellers.
417 &quot;entityId&quot;: &quot;A String&quot;, # Numerical identifier of the client entity.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]432 &quot;clientAccountId&quot;: &quot;A String&quot;, # The globally-unique numerical ID of the client.
433 # The value of this field is ignored in create and update operations.
434 &quot;entityName&quot;: &quot;A String&quot;, # The name of the entity. This field is automatically fetched based on
435 # the type and ID.
436 # The value of this field is ignored in create and update operations.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]452 &quot;status&quot;: &quot;A String&quot;, # The status of the client buyer.
453 &quot;partnerClientId&quot;: &quot;A String&quot;, # Optional arbitrary unique identifier of this client buyer from the
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]454 # standpoint of its Ad Exchange sponsor buyer.
455 #
456 # This field can be used to associate a client buyer with the identifier
457 # in the namespace of its sponsor buyer, lookup client buyers by that
458 # identifier and verify whether an Ad Exchange counterpart of a given client
459 # buyer already exists.
460 #
461 # If present, must be unique among all the client buyers for its
462 # Ad Exchange sponsor buyer.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]463 &quot;entityType&quot;: &quot;A String&quot;, # The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.
464 &quot;clientName&quot;: &quot;A String&quot;, # Name used to represent this client to publishers.
465 # You may have multiple clients that map to the same entity,
466 # but for each client the combination of `clientName` and entity
467 # must be unique.
468 # You can specify this field as empty.
469 &quot;role&quot;: &quot;A String&quot;, # The role which is assigned to the client buyer. Each role implies a set of
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]472 &quot;visibleToSeller&quot;: True or False, # Whether the client buyer will be visible to sellers.
473 &quot;entityId&quot;: &quot;A String&quot;, # Numerical identifier of the client entity.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame^]488 &quot;clientAccountId&quot;: &quot;A String&quot;, # The globally-unique numerical ID of the client.
489 # The value of this field is ignored in create and update operations.
490 &quot;entityName&quot;: &quot;A String&quot;, # The name of the entity. This field is automatically fetched based on
491 # the type and ID.
492 # The value of this field is ignored in create and update operations.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]493 }</pre>
494</div>
495
496</body></html>