Method: accounts.list
Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang
Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
Liệt kê tất cả tài khoản của người dùng đã xác thực. Quyền này bao gồm tất cả tài khoản mà người dùng sở hữu cũng như mọi tài khoản mà người dùng có quyền quản lý.
Yêu cầu HTTP
GET https://mybusinessaccountmanagement.googleapis.com/v1/accounts
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số truy vấn
| Tham số |
parentAccount |
string
Không bắt buộc. Tên tài nguyên của tài khoản mà bạn cần truy xuất danh sách các tài khoản có thể truy cập trực tiếp. Điều này chỉ có ý nghĩa đối với Tổ chức và Nhóm người dùng. Nếu trống, hàm sẽ trả về accounts.list cho người dùng đã được xác thực. accounts/{account_id}.
|
pageSize |
integer
Không bắt buộc. Số lượng tài khoản cần tìm nạp trên mỗi trang. Giá trị mặc định và tối đa là 20.
|
pageToken |
string
Không bắt buộc. Nếu được chỉ định, trang tiếp theo của tài khoản sẽ được truy xuất. pageToken được trả về khi lệnh gọi đến accounts.list trả về nhiều kết quả hơn kích thước trang được yêu cầu.
|
filter |
string
Không bắt buộc. Bộ lọc ràng buộc các tài khoản trả về. Phản hồi chỉ bao gồm các mục khớp với bộ lọc. Nếu filter trống, thì không có điều kiện ràng buộc nào được áp dụng và tất cả các tài khoản (được phân trang) sẽ được truy xuất cho tài khoản được yêu cầu. Ví dụ: một yêu cầu có bộ lọc type=USER_GROUP sẽ chỉ trả về nhóm người dùng. Trường type là bộ lọc duy nhất được hỗ trợ.
|
Nội dung yêu cầu
Nội dung yêu cầu phải trống.
Nội dung phản hồi
Thông báo phản hồi cho accounts.ListAccounts.
Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:
| Biểu diễn dưới dạng JSON |
{
"accounts": [
{
object (Account)
}
],
"nextPageToken": string
} |
| Trường |
accounts[] |
object (Account)
Một tập hợp những tài khoản mà người dùng có quyền truy cập. Tài khoản cá nhân của người dùng thực hiện truy vấn sẽ luôn là mục đầu tiên của kết quả, trừ phi tài khoản đó bị lọc ra.
|
nextPageToken |
string
Nếu số lượng tài khoản vượt quá kích thước trang đã yêu cầu, thì trường này sẽ được điền sẵn một mã thông báo để tìm nạp trang tài khoản tiếp theo trong lệnh gọi tiếp theo đến accounts.list. Nếu không còn tài khoản nào khác, thì trường này sẽ không xuất hiện trong phản hồi.
|
Phạm vi uỷ quyền
Yêu cầu phạm vi OAuth sau:
https://www.googleapis.com/auth/business.manage
Để biết thêm thông tin, hãy xem bài viết Tổng quan về OAuth 2.0.
Trừ phi có lưu ý khác, nội dung của trang này được cấp phép theo Giấy phép ghi nhận tác giả 4.0 của Creative Commons và các mẫu mã lập trình được cấp phép theo Giấy phép Apache 2.0. Để biết thông tin chi tiết, vui lòng tham khảo Chính sách trang web của Google Developers. Java là nhãn hiệu đã đăng ký của Oracle và/hoặc các đơn vị liên kết với Oracle.
Cập nhật lần gần đây nhất: 2025-07-25 UTC.
[null,null,["Cập nhật lần gần đây nhất: 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)."]]
