Method: accounts.list
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Перечисляет все учетные записи для аутентифицированного пользователя. Сюда входят все учетные записи, которыми владеет пользователь, а также любые учетные записи, для которых у пользователя есть права управления.
HTTP-запрос
GET https://mybusinessaccountmanagement.googleapis.com/v1/accounts
URL-адрес использует синтаксис транскодирования gRPC .
Параметры запроса
| Параметры |
|---|
parentAccount | string Необязательный. Имя ресурса учетной записи, для которой необходимо получить список учетных записей с прямым доступом. Это имеет смысл только для организаций и групп пользователей. Если пусто, вернет accounts.list для аутентифицированного пользователя. accounts/{account_id} . |
pageSize | integer Необязательный. Сколько аккаунтов нужно получить на страницу. По умолчанию и максимум — 20. |
pageToken | string Необязательный. Если указано, извлекается следующая страница учетных записей. pageToken возвращается, когда вызов accounts.list возвращает больше результатов, чем может поместиться в запрошенный размер страницы. |
filter | string Необязательный. Фильтр, ограничивающий возврат учетных записей. Ответ включает только записи, соответствующие фильтру. Если filter пуст, ограничения не применяются, и для запрошенной учетной записи извлекаются все учетные записи (с разбивкой на страницы). Например, запрос с type=USER_GROUP вернет только группы пользователей. Поле type — единственный поддерживаемый фильтр. |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
Ответное сообщение для Accounts.ListAccounts.
В случае успеха тело ответа содержит данные следующей структуры:
| JSON-представление |
|---|
{
"accounts": [
{
object (Account)
}
],
"nextPageToken": string
} |
| Поля |
|---|
accounts[] | object ( Account ) Коллекция учетных записей, к которым у пользователя есть доступ. Личный аккаунт пользователя, выполняющего запрос, всегда будет первым элементом результата, если он не отфильтрован. |
nextPageToken | string Если количество учетных записей превышает запрошенный размер страницы, это поле заполняется токеном для получения следующей страницы учетных записей при последующем accounts.list . Если учетных записей больше нет, это поле отсутствует в ответе. |
Области авторизации
Требуется следующая область действия OAuth:
-
https://www.googleapis.com/auth/business.manage
Дополнительную информацию см. в обзоре OAuth 2.0 .
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-25 UTC.
[null,null,["Последнее обновление: 2025-07-25 UTC."],[[["\u003cp\u003eLists all accounts owned by or accessible to the authenticated user, including their personal account.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering accounts by type and specifying the parent account for retrieval.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination to retrieve large lists of accounts using \u003ccode\u003epageToken\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes an array of \u003ccode\u003eAccount\u003c/code\u003e objects and a \u003ccode\u003enextPageToken\u003c/code\u003e for further results.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ehttps://www.googleapis.com/auth/business.manage\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],["This API retrieves a list of accounts for an authenticated user via a `GET` request to a specified URL. The user can filter the accounts by type, specify the page size, and use a `pageToken` for pagination. An optional `parentAccount` parameter retrieves accounts directly accessible from that account. The request body must be empty, and the successful response includes an array of account objects and, if applicable, a `nextPageToken` for further pagination. This uses OAuth 2.0 with the `business.manage` scope.\n"],null,["# Method: accounts.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListAccountsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n\nLists all of the accounts for the authenticated user. This includes all accounts that the user owns, as well as any accounts for which the user has management rights.\n\n### HTTP request\n\n`GET https://mybusinessaccountmanagement.googleapis.com/v1/accounts`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parentAccount` | `string` Optional. The resource name of the account for which the list of directly accessible accounts is to be retrieved. This only makes sense for Organizations and User Groups. If empty, will return `accounts.list` for the authenticated user. `accounts/{account_id}`. |\n| `pageSize` | `integer` Optional. How many accounts to fetch per page. The default and maximum is 20. |\n| `pageToken` | `string` Optional. If specified, the next page of accounts is retrieved. The `pageToken` is returned when a call to `accounts.list` returns more results than can fit into the requested page size. |\n| `filter` | `string` Optional. A filter constraining the accounts to return. The response includes only entries that match the filter. If `filter` is empty, then no constraints are applied and all accounts (paginated) are retrieved for the requested account. For example, a request with the filter `type=USER_GROUP` will only return user groups. The `type` field is the only supported filter. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for Accounts.ListAccounts.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"accounts\": [ { object (/my-business/reference/accountmanagement/rest/v1/accounts#Account) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `accounts[]` | `object (`[Account](/my-business/reference/accountmanagement/rest/v1/accounts#Account)`)` A collection of accounts to which the user has access. The personal account of the user doing the query will always be the first item of the result, unless it is filtered out. |\n| `nextPageToken` | `string` If the number of accounts exceeds the requested page size, this field is populated with a token to fetch the next page of accounts on a subsequent call to `accounts.list`. If there are no more accounts, this field is not present in the response. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/business.manage`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
