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