Method: accounts.list

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://mybusiness.googleapis.com/v4/accounts

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số truy vấn

Tham số
pageSize

integer

Số lượng tài khoản cần tìm nạp trên mỗi trang. Giá trị mặc định là 20, tối thiểu là 2 và kích thước trang tối đa là 20.

pageToken

string

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.

name

string

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.

filter

string

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.

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

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:

Thông báo phản hồi cho accounts.ListAccounts.

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 cấp phép

Yêu cầu một trong các phạm vi OAuth sau:

  • https://www.googleapis.com/auth/plus.business.manage
  • 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.