Method: spaces.members.list

Liệt kê thành viên trong một không gian. Ví dụ: hãy xem phần Liệt kê người dùng và ứng dụng Google Chat trong một không gian. Tính năng liệt kê thành viên bằng quy trình xác thực ứng dụng sẽ liệt kê các thành viên trong những không gian mà ứng dụng Chat có quyền truy cập, nhưng loại trừ các thành viên của ứng dụng Chat, bao gồm cả thành viên của chính ứng dụng đó. Liệt kê gói thành viên bằng tính năng Xác thực người dùng sẽ liệt kê các gói thành viên trong không gian mà người dùng đã xác thực có quyền truy cập.

Hỗ trợ các loại xác thực sau:

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

Thông 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: spaces/{space}

Tham số truy vấn

Thông 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 không chỉ định, hệ thống sẽ trả về 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 sẽ trả về lỗi INVALID_ARGUMENT.
pageToken

string

Không bắt buộc. Mã thông báo trang, nhận được từ lệnh gọi trước đó để liệt kê các gói thành viên. Cung cấp thông 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 truyền các giá trị khác nhau đến các tham 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 gói thành viên theo vai trò của thành viên (role) và loại (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 cũng có thể lọc tìm 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 bắt buộc phải sử dụng 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 cụm từ tìm kiếm sau đây không hợp lệ:

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

Các truy vấn không hợp lệ sẽ bị máy chủ từ chối bằng lỗi INVALID_ARGUMENT.
showGroups

boolean

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

boolean

Không bắt buộc. Khi true, cũng trả về các gói thành viên được liên kết với thành viên invited, ngoài các loại gói thành 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

Không bắt buộc. Khi true, phương thức này sẽ chạy bằng các đặc quyền 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à cuộc trò chuyện trong không gian.

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 để liệt kê các gói 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 gói thành viên trong trang được yêu cầu (hoặc trang đầu tiên).
nextPageToken

string

Một 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, sẽ không có trang tiếp theo.

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.