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