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