Method: spaces.members.list

Liệt kê tư cách thành viên trong một không gian.

Bạn cần phải xác thực. Hỗ trợ đầy đủ xác thực tài khoản dịch vụ.

Hỗ trợ việc xác thực người dùng trong Chương trình dùng thử dành cho nhà phát triển Google Workspace, một chương trình cấp quyền truy cập sớm vào một số tính năng. Xác thực người dùng yêu cầu phạm vi ủy quyền chat.memberships hoặc chat.memberships.readonly.

Yêu cầu HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/members

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

Tham số đường dẫn

Các tham số
parent

string

Bắt buộc. Tên tài nguyên của không gian cần tìm nạp danh sách thành viên.

Định dạng: space/{space}

Tham số truy vấn

Các tham số
pageSize

integer

Số lượng hội viên tối đa sẽ trả lại. Dịch vụ có thể trả về ít hơn giá trị này.

Nếu không xác định thì tối đa 100 gói thành viên sẽ được trả về.

Giá trị tối đa là 1000; các giá trị trên 1000 được ép buộc thành 1000.

Giá trị âm trả về lỗi INVALID_ISBN.
pageToken

string

Một mã thông báo trang, nhận được từ một cuộc gọi trước đó để liệt kê các thành viên. Hãy cung cấp thông tin này để truy xuất trang tiếp theo.

Khi phân trang, tất cả các thông số khác đã cung cấp phải khớp với lệnh gọi đã cung cấp mã thông báo trang. Việc chuyển các giá trị khác nhau sang các thông số khác có thể dẫn đến kết quả không mong muốn.
filter

string

Không bắt buộc. Bộ lọc truy vấn.

Bạn có thể lọc thành viên theo vai trò (role) và loại thành viên (member.type) của một thành viên.

Để lọc theo vai trò, hãy đặt role thành ROLE_MEMBER hoặc ROLE_MANAGER.

Để lọc theo loại, hãy đặt member.type thành HUMAN hoặc BOT.

Để lọc theo cả vai trò và loại, hãy sử dụng toán tử AND. Để lọc theo vai trò hoặc loại, hãy dùng toán tử OR.

Ví dụ: các truy vấn sau đây là hợp lệ:

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

Các truy vấn sau đây không hợp lệ:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

Máy chủ từ chối những truy vấn không hợp lệ do lỗi INVALID_ARGUMENT.
showInvited

boolean

Không bắt buộc. Khi true, chế độ này cũng trả về gói hội viên của những hội viên invited cùng những loại gói hội viên khác. Nếu bạn đặt [filter][google.chat.v1.memberships.filter], thì những gói thành viên invited không khớp với tiêu chí lọc sẽ không được trả về.

Hiện yêu cầu xác thực 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:

Biểu diễn dưới dạng JSON 
{
  "memberships": [
    {
      object (Membership)
    }
  ],
  "nextPageToken": string
}
Các trường
memberships[]

object (Membership)

Danh sách gói hội viên trên trang được yêu cầu (hoặc trang đầu tiên).
nextPageToken

string

Một mã thông báo có thể được gửi dưới dạng pageToken để truy xuất trang kết quả tiếp theo. Nếu trống, sẽ không có trang tiếp theo nào.

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/chat.bot
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.