1+ < html > < body >
2+ < style >
3+
4+ body , 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+
15+ body {
16+ font-size : 13px ;
17+ padding : 1em ;
18+ }
19+
20+ h1 {
21+ font-size : 26px ;
22+ margin-bottom : 1em ;
23+ }
24+
25+ h2 {
26+ font-size : 24px ;
27+ margin-bottom : 1em ;
28+ }
29+
30+ h3 {
31+ font-size : 20px ;
32+ margin-bottom : 1em ;
33+ margin-top : 1em ;
34+ }
35+
36+ pre , code {
37+ line-height : 1.5 ;
38+ font-family : Monaco, 'DejaVu Sans Mono' , 'Bitstream Vera Sans Mono' , 'Lucida Console' , monospace;
39+ }
40+
41+ pre {
42+ margin-top : 0.5em ;
43+ }
44+
45+ h1 , h2 , h3 , p {
46+ font-family : Arial, sans serif;
47+ }
48+
49+ h1 , 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=None, 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=None, 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=None, 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=None, body, x__xgafv=None)</ code >
92+ < pre > Creates and sends out an email invitation to access
93+ an Ad Exchange client buyer account.
94+
95+ Args:
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
98+ should 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 AdExchange Buyer UI.
103+ #
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.
108+ "email": "A String", # The email address to which the invitation is sent. Email
109+ # addresses should be unique among all client users under each sponsor
110+ # buyer.
111+ "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
112+ # The value of this field is ignored in create operations.
113+ }
114+
115+ x__xgafv: string, V1 error format.
116+ Allowed values
117+ 1 - v1 error format
118+ 2 - v2 error format
119+
120+ Returns:
121+ An object of the form:
122+
123+ { # An invitation for a new client user to get access to the AdExchange Buyer UI.
124+ #
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.
129+ "email": "A String", # The email address to which the invitation is sent. Email
130+ # addresses should be unique among all client users under each sponsor
131+ # buyer.
132+ "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
133+ # The value of this field is ignored in create operations.
134+ }</ pre >
135+ </ div >
136+
137+ < div class ="method ">
138+ < code class ="details " id ="get "> get(accountId, clientAccountId=None, invitationId, x__xgafv=None)</ code >
139+ < pre > Retrieves an existing client user invitation.
140+
141+ Args:
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
144+ to 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+
151+ Returns:
152+ An object of the form:
153+
154+ { # An invitation for a new client user to get access to the AdExchange Buyer UI.
155+ #
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.
160+ "email": "A String", # The email address to which the invitation is sent. Email
161+ # addresses should be unique among all client users under each sponsor
162+ # buyer.
163+ "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
164+ # The value of this field is ignored in create operations.
165+ }</ pre >
166+ </ div >
167+
168+ < div class ="method ">
169+ < code class ="details " id ="list "> list(accountId, clientAccountId=None, pageSize=None, pageToken=None, x__xgafv=None)</ code >
170+ < pre > Lists all the client users invitations for a client
171+ with a given account ID.
172+
173+ Args:
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)
177+ You must either specify a string representation of a
178+ numerical account identifier or the `-` character
179+ to list all the invitations for all the clients
180+ of a given sponsor buyer. (required)
181+ pageSize: integer, Requested page size. Server may return fewer clients than requested.
182+ If unspecified, server will pick an appropriate default.
183+ pageToken: string, A token identifying a page of results the server should return.
184+ Typically, this is the value of
185+ ListClientUserInvitationsResponse.nextPageToken
186+ returned from the previous call to the
187+ clients.invitations.list
188+ method.
189+ x__xgafv: string, V1 error format.
190+ Allowed values
191+ 1 - v1 error format
192+ 2 - v2 error format
193+
194+ Returns:
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.
206+ { # An invitation for a new client user to get access to the AdExchange Buyer UI.
207+ #
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.
212+ "email": "A String", # The email address to which the invitation is sent. Email
213+ # addresses should be unique among all client users under each sponsor
214+ # buyer.
215+ "invitationId": "A String", # The unique numerical ID of the invitation that is sent to the user.
216+ # The value of this field is ignored in create operations.
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+
226+ Args:
227+ previous_request: The request for the previous page. (required)
228+ previous_response: The response from the request for the previous page. (required)
229+
230+ Returns:
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 >
0 commit comments