Method: spaces.members.list

Liệt kê thành viên trong một không gian. Để xem ví dụ, hãy xem bài viết Thành viên trong danh sách. Trang thông tin thành viên có xác thực ứng dụng liệt kê 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ả thành viên của không gian đó. Trang thông tin thành viên có Xác thực người dùng liệt kê thành viên trong các không gian mà người dùng đã xác thực có quyền truy cập.

Cần phải xác thực. Hỗ trợ xác thực ứng dụngxá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 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à 1.000. Nếu bạn sử dụng một giá trị lớn hơn 1.000, giá trị này sẽ tự động thay đổi thành 1.000.

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ừ lệnh 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 cho 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 cụm từ tìm kiếm.

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 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.

Để 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.

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 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ệ bị máy chủ từ chối, có lỗi INVALID_ARGUMENT.

showGroups

boolean

Không bắt buộc. Khi true, giá trị trả về cũng sẽ trả về các gói hội viên liên kết với 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 thành viên Google Group không khớp với tiêu chí lọc.

showInvited

boolean

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

Hiện tại, bạn cần phải 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
}
Trường
memberships[]

object (Membership)

Danh sách không theo thứ tự. Danh sách thành viên trên trang được yêu cầu (hoặc đầ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, 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 đây:

  • 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 bài viết Hướng dẫn uỷ quyền.