Method: spaces.members.list

Liệt kê thành viên trong một không gian. Ví dụ: hãy xem bài viết Liệt kê người dùng và ứng dụng Google Chat trong một không gian. Thành viên của trang thông tin có phương thức xác thực ứng dụng liệt kê tư cách thành viên trong những không gian mà ứng dụng Chat có quyền truy cập, nhưng không bao gồm tư cách thành viên của ứng dụng Chat, kể cả không gian của chính ứng dụng đó. Thành viên của trang thông tin có chế độ Xác thực người dùng liệt kê thành viên trong những không gian mà người dùng đã xác thực có quyền truy cập.

Bạn cần xác thực. Hỗ trợ xác thực ứng dụng và xác thực người dùng.

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

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: dấu cách/{space}

Tham số truy vấn

Tham số
pageSize

integer

Không bắt buộc. Số lượng gói hội viên tối đa cần trả lại. Dịch vụ có thể trả về ít hơn giá trị này.

Nếu bạn không xác định, hệ thống sẽ trả lại tối đa 100 gói hội viên.

Giá trị tối đa là 1000. Nếu bạn sử dụng giá trị lớn hơn 1000, giá trị này sẽ tự động thay đổi thành 1000.

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

string

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

Khi phân trang, tất cả các thông số khác đượ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 tư cách thành viên theo vai trò (role) và loại của thành viên (member.type).

Để 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. Bản dùng thử cho nhà phát triển: Bạn cũng có thể lọc member.type bằng toán tử !=.

Để 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 sử dụng toán tử OR.

Bạn phải nhập member.type = "HUMAN" hoặc member.type != "BOT" khi đặt useAdminAccess thành true. Các bộ lọc loại thành viên khác sẽ bị từ chối.

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"

member.type != "BOT"

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

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

Máy chủ có lỗi INVALID_ARGUMENT từ chối các truy vấn không hợp lệ.
showGroups

boolean

Không bắt buộc. Khi true, cũng trả về các gói hội viên liên kết với một Google Group, ngoài các loại gói hội viên khác. Nếu bạn đặt filter, thì hệ thống sẽ không trả về những gói thành viên của Google Group không khớp với tiêu chí lọc.
showInvited

boolean

Không bắt buộc. Khi true, cũng trả về các gói hội viên liên kết với các thành viên invited, ngoài các loại gói hội viên khác. Nếu bạn đặt bộ lọc, thì những gói thành viên invited không khớp với tiêu chí bộ lọc sẽ không được trả về.

Hiện yêu cầu xác thực người dùng.
useAdminAccess

boolean

Khi true, phương thức này sẽ chạy bằng đặc quyền của quản trị viên Google Workspace của người dùng.

Người dùng gọi phải là quản trị viên Google Workspace có đặc quyền quản lý cuộc trò chuyện và không gian trên Chat.

Yêu cầu phạm vi OAuth 2.0 chat.admin.memberships.readonly hoặc chat.admin.memberships.

Không hỗ trợ việc liệt kê tư cách thành viên của ứng dụng trong một không gian khi sử dụng quyền quản 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

Phản hồi danh sách thành viên của không gian.

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
}
Trường
memberships[]

object (Membership)

Danh sách không theo thứ tự. Danh sách thành viên trên trang yêu cầu (hoặc trang đầu tiên).
nextPageToken

string

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

Phạm vi uỷ quyền

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

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