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.invitations.html">invitations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#create">create(accountId, clientAccountId, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates and sends out an email invitation to access</p>
80<p class="toc_element">
81  <code><a href="#get">get(accountId, clientAccountId, invitationId, x__xgafv=None)</a></code></p>
82<p class="firstline">Retrieves an existing client user invitation.</p>
83<p class="toc_element">
84  <code><a href="#list">list(accountId, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Lists all the client users invitations for a client</p>
86<p class="toc_element">
87  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
91    <code class="details" id="create">create(accountId, clientAccountId, body, x__xgafv=None)</code>
92  <pre>Creates and sends out an email invitation to access
93an Ad Exchange client buyer account.
94
95Args:
96  accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
97  clientAccountId: string, Numerical account ID of the client buyer that the user
98should be associated with. (required) (required)
99  body: object, The request body. (required)
100    The object takes the form of:
101
102{ # An invitation for a new client user to get access to the Authorized Buyers
103      # UI. All fields are required unless otherwise specified.
104    "clientAccountId": "A String", # Numerical account ID of the client buyer
105        # that the invited user is associated with.
106        # The value of this field is ignored in create operations.
107    "email": "A String", # The email address to which the invitation is sent. Email
108        # addresses should be unique among all client users under each sponsor
109        # buyer.
110    "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
111        # The value of this field is ignored in create operations.
112  }
113
114  x__xgafv: string, V1 error format.
115    Allowed values
116      1 - v1 error format
117      2 - v2 error format
118
119Returns:
120  An object of the form:
121
122    { # An invitation for a new client user to get access to the Authorized Buyers
123        # UI. All fields are required unless otherwise specified.
124      "clientAccountId": "A String", # Numerical account ID of the client buyer
125          # that the invited user is associated with.
126          # The value of this field is ignored in create operations.
127      "email": "A String", # The email address to which the invitation is sent. Email
128          # addresses should be unique among all client users under each sponsor
129          # buyer.
130      "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
131          # The value of this field is ignored in create operations.
132    }</pre>
133</div>
134
135<div class="method">
136    <code class="details" id="get">get(accountId, clientAccountId, invitationId, x__xgafv=None)</code>
137  <pre>Retrieves an existing client user invitation.
138
139Args:
140  accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
141  clientAccountId: string, Numerical account ID of the client buyer that the user invitation
142to be retrieved is associated with. (required) (required)
143  invitationId: string, Numerical identifier of the user invitation to retrieve. (required) (required)
144  x__xgafv: string, V1 error format.
145    Allowed values
146      1 - v1 error format
147      2 - v2 error format
148
149Returns:
150  An object of the form:
151
152    { # An invitation for a new client user to get access to the Authorized Buyers
153        # UI. All fields are required unless otherwise specified.
154      "clientAccountId": "A String", # Numerical account ID of the client buyer
155          # that the invited user is associated with.
156          # The value of this field is ignored in create operations.
157      "email": "A String", # The email address to which the invitation is sent. Email
158          # addresses should be unique among all client users under each sponsor
159          # buyer.
160      "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
161          # The value of this field is ignored in create operations.
162    }</pre>
163</div>
164
165<div class="method">
166    <code class="details" id="list">list(accountId, clientAccountId, pageSize=None, pageToken=None, x__xgafv=None)</code>
167  <pre>Lists all the client users invitations for a client
168with a given account ID.
169
170Args:
171  accountId: string, Numerical account ID of the client's sponsor buyer. (required) (required)
172  clientAccountId: string, Numerical account ID of the client buyer to list invitations for.
173(required)
174You must either specify a string representation of a
175numerical account identifier or the `-` character
176to list all the invitations for all the clients
177of a given sponsor buyer. (required)
178  pageSize: integer, Requested page size. Server may return fewer clients than requested.
179If unspecified, server will pick an appropriate default.
180  pageToken: string, A token identifying a page of results the server should return.
181Typically, this is the value of
182ListClientUserInvitationsResponse.nextPageToken
183returned from the previous call to the
184clients.invitations.list
185method.
186  x__xgafv: string, V1 error format.
187    Allowed values
188      1 - v1 error format
189      2 - v2 error format
190
191Returns:
192  An object of the form:
193
194    {
195    "nextPageToken": "A String", # A token to retrieve the next page of results.
196        # Pass this value in the
197        # ListClientUserInvitationsRequest.pageToken
198        # field in the subsequent call to the
199        # clients.invitations.list
200        # method to retrieve the next
201        # page of results.
202    "invitations": [ # The returned list of client users.
203      { # An invitation for a new client user to get access to the Authorized Buyers
204            # UI. All fields are required unless otherwise specified.
205          "clientAccountId": "A String", # Numerical account ID of the client buyer
206              # that the invited user is associated with.
207              # The value of this field is ignored in create operations.
208          "email": "A String", # The email address to which the invitation is sent. Email
209              # addresses should be unique among all client users under each sponsor
210              # buyer.
211          "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
212              # The value of this field is ignored in create operations.
213        },
214    ],
215  }</pre>
216</div>
217
218<div class="method">
219    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
220  <pre>Retrieves the next page of results.
221
222Args:
223  previous_request: The request for the previous page. (required)
224  previous_response: The response from the request for the previous page. (required)
225
226Returns:
227  A request object that you can call 'execute()' on to request the next
228  page. Returns None if there are no more items in the collection.
229    </pre>
230</div>
231
232</body></html>