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> . <a href="adexchangebuyer2_v2beta1.accounts.clients.users.html">users</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#get">get(accountId, clientAccountId, userId, x__xgafv=None)</a></code></p>
79<p class="firstline">Retrieves an existing client user.</p>
80<p class="toc_element">
81  <code><a href="#list">list(accountId, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Lists all the known client users for a specified</p>
83<p class="toc_element">
84  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<p class="toc_element">
87  <code><a href="#update">update(accountId, clientAccountId, userId, body, x__xgafv=None)</a></code></p>
88<p class="firstline">Updates an existing client user.</p>
89<h3>Method Details</h3>
90<div class="method">
91    <code class="details" id="get">get(accountId, clientAccountId, userId, x__xgafv=None)</code>
92  <pre>Retrieves an existing client user.
93
94Args:
95  accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
96  clientAccountId: string, Numerical account ID of the client buyer
97that the user to be retrieved is associated with. (required) (required)
98  userId: string, Numerical identifier of the user to retrieve. (required) (required)
99  x__xgafv: string, V1 error format.
100    Allowed values
101      1 - v1 error format
102      2 - v2 error format
103
104Returns:
105  An object of the form:
106
107    { # A client user is created under a client buyer and has restricted access to
108      # the Marketplace and certain other sections of the Authorized Buyers UI based
109      # on the role granted to the associated client buyer.
110      #
111      # The only way a new client user can be created is via accepting an
112      # email invitation
113      # (see the
114      # accounts.clients.invitations.create
115      # method).
116      #
117      # All fields are required unless otherwise specified.
118    "status": "A String", # The status of the client user.
119    "clientAccountId": "A String", # Numerical account ID of the client buyer
120        # with which the user is associated; the
121        # buyer must be a client of the current sponsor buyer.
122        # The value of this field is ignored in an update operation.
123    "userId": "A String", # The unique numerical ID of the client user
124        # that has accepted an invitation.
125        # The value of this field is ignored in an update operation.
126    "email": "A String", # User's email address. The value of this field
127        # is ignored in an update operation.
128  }</pre>
129</div>
130
131<div class="method">
132    <code class="details" id="list">list(accountId, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None)</code>
133  <pre>Lists all the known client users for a specified
134sponsor buyer account ID.
135
136Args:
137  accountId: string, Numerical account ID of the sponsor buyer of the client to list users for.
138(required) (required)
139  clientAccountId: string, The account ID of the client buyer to list users for. (required)
140You must specify either a string representation of a
141numerical account identifier or the `-` character
142to list all the client users for all the clients
143of a given sponsor buyer. (required)
144  pageSize: integer, Requested page size. The server may return fewer clients than requested.
145If unspecified, the server will pick an appropriate default.
146  pageToken: string, A token identifying a page of results the server should return.
147Typically, this is the value of
148ListClientUsersResponse.nextPageToken
149returned from the previous call to the
150accounts.clients.users.list
151method.
152  x__xgafv: string, V1 error format.
153    Allowed values
154      1 - v1 error format
155      2 - v2 error format
156
157Returns:
158  An object of the form:
159
160    {
161    "nextPageToken": "A String", # A token to retrieve the next page of results.
162        # Pass this value in the
163        # ListClientUsersRequest.pageToken
164        # field in the subsequent call to the
165        # clients.invitations.list
166        # method to retrieve the next
167        # page of results.
168    "users": [ # The returned list of client users.
169      { # A client user is created under a client buyer and has restricted access to
170          # the Marketplace and certain other sections of the Authorized Buyers UI based
171          # on the role granted to the associated client buyer.
172          #
173          # The only way a new client user can be created is via accepting an
174          # email invitation
175          # (see the
176          # accounts.clients.invitations.create
177          # method).
178          #
179          # All fields are required unless otherwise specified.
180        "status": "A String", # The status of the client user.
181        "clientAccountId": "A String", # Numerical account ID of the client buyer
182            # with which the user is associated; the
183            # buyer must be a client of the current sponsor buyer.
184            # The value of this field is ignored in an update operation.
185        "userId": "A String", # The unique numerical ID of the client user
186            # that has accepted an invitation.
187            # The value of this field is ignored in an update operation.
188        "email": "A String", # User's email address. The value of this field
189            # is ignored in an update operation.
190      },
191    ],
192  }</pre>
193</div>
194
195<div class="method">
196    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
197  <pre>Retrieves the next page of results.
198
199Args:
200  previous_request: The request for the previous page. (required)
201  previous_response: The response from the request for the previous page. (required)
202
203Returns:
204  A request object that you can call 'execute()' on to request the next
205  page. Returns None if there are no more items in the collection.
206    </pre>
207</div>
208
209<div class="method">
210    <code class="details" id="update">update(accountId, clientAccountId, userId, body, x__xgafv=None)</code>
211  <pre>Updates an existing client user.
212Only the user status can be changed on update.
213
214Args:
215  accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
216  clientAccountId: string, Numerical account ID of the client buyer that the user to be retrieved
217is associated with. (required) (required)
218  userId: string, Numerical identifier of the user to retrieve. (required) (required)
219  body: object, The request body. (required)
220    The object takes the form of:
221
222{ # A client user is created under a client buyer and has restricted access to
223    # the Marketplace and certain other sections of the Authorized Buyers UI based
224    # on the role granted to the associated client buyer.
225    #
226    # The only way a new client user can be created is via accepting an
227    # email invitation
228    # (see the
229    # accounts.clients.invitations.create
230    # method).
231    #
232    # All fields are required unless otherwise specified.
233  "status": "A String", # The status of the client user.
234  "clientAccountId": "A String", # Numerical account ID of the client buyer
235      # with which the user is associated; the
236      # buyer must be a client of the current sponsor buyer.
237      # The value of this field is ignored in an update operation.
238  "userId": "A String", # The unique numerical ID of the client user
239      # that has accepted an invitation.
240      # The value of this field is ignored in an update operation.
241  "email": "A String", # User's email address. The value of this field
242      # is ignored in an update operation.
243}
244
245  x__xgafv: string, V1 error format.
246    Allowed values
247      1 - v1 error format
248      2 - v2 error format
249
250Returns:
251  An object of the form:
252
253    { # A client user is created under a client buyer and has restricted access to
254      # the Marketplace and certain other sections of the Authorized Buyers UI based
255      # on the role granted to the associated client buyer.
256      #
257      # The only way a new client user can be created is via accepting an
258      # email invitation
259      # (see the
260      # accounts.clients.invitations.create
261      # method).
262      #
263      # All fields are required unless otherwise specified.
264    "status": "A String", # The status of the client user.
265    "clientAccountId": "A String", # Numerical account ID of the client buyer
266        # with which the user is associated; the
267        # buyer must be a client of the current sponsor buyer.
268        # The value of this field is ignored in an update operation.
269    "userId": "A String", # The unique numerical ID of the client user
270        # that has accepted an invitation.
271        # The value of this field is ignored in an update operation.
272    "email": "A String", # User's email address. The value of this field
273        # is ignored in an update operation.
274  }</pre>
275</div>
276
277</body></html>