Method: accounts.clients.invitations.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all the client users invitations for a client with a given account ID.
HTTP request
GET https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
accountId |
string (int64 format)
Numerical account ID of the client's sponsor buyer. (required)
|
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.
|
Query parameters
| Parameters |
pageSize |
integer
Requested page size. Server may return fewer clients than requested. If unspecified, server will pick an appropriate default.
|
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.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| JSON representation |
{
"invitations": [
{
object (ClientUserInvitation)
}
],
"nextPageToken": string
} |
| Fields |
invitations[] |
object (ClientUserInvitation)
The returned list of client users.
|
nextPageToken |
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.
|
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/adexchange.buyer
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eLists all client user invitations for a specified client or all clients under a sponsor buyer.\u003c/p\u003e\n"],["\u003cp\u003eUses an HTTP GET request with path and query parameters to filter results.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes an array of client user invitations and a token for pagination.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/adexchange.buyer\u003c/code\u003e scope.\u003c/p\u003e\n"]]],[],null,["# Method: accounts.clients.invitations.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListClientUserInvitationsResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all the client users invitations for a client with a given account ID.\n\n### HTTP request\n\n`GET https://adexchangebuyer.googleapis.com/v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `accountId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Numerical account ID of the client's sponsor buyer. (required) |\n| `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. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Requested page size. Server may return fewer clients than requested. If unspecified, server will pick an appropriate default. |\n| `pageToken` | `string` A token identifying a page of results the server should return. Typically, this is the value of [ListClientUserInvitationsResponse.nextPageToken](/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients.invitations/list#body.ListClientUserInvitationsResponse.FIELDS.next_page_token) returned from the previous call to the [clients.invitations.list](/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients.invitations/list#google.ads.adexchange.buyer.v2beta1.ClientUserInvitationService.ListClientUserInvitations) method. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation ||\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"invitations\": [ { object (/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients.invitations#ClientUserInvitation) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `invitations[]` | `object (`[ClientUserInvitation](/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients.invitations#ClientUserInvitation)`)` The returned list of client users. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Pass this value in the [ListClientUserInvitationsRequest.pageToken](/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients.invitations/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to the [clients.invitations.list](/authorized-buyers/apis/reference/rest/v2beta1/accounts.clients.invitations/list#google.ads.adexchange.buyer.v2beta1.ClientUserInvitationService.ListClientUserInvitations) method to retrieve the next page of results. |\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/adexchange.buyer`"]]
