Method: spaces.members.list

Liệt kê các thành viên trong một không gian. Để xem ví dụ, hãy xem phần Liệt kê người dùng và các ứng dụng Google Chat trong một không gian. Việc liệt kê thành viên bằng xác thực ứng dụng sẽ 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 thành viên của ứng dụng Chat, kể cả thành viên của chính ứng dụng đó. Lệnh liệt kê tư cách thành viên có Xác thực người dùng sẽ liệt kê tư cách 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.

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

  • Xác thực ứng dụng bằng một trong các phạm vi uỷ quyền sau:

  • Xác thực người dùng bằng một trong các phạm vi uỷ quyền sau:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • https://www.googleapis.com/auth/chat.import (chỉ có khoảng trống ở chế độ nhập)
    • Xác thực người dùng cấp đặc quyền quản trị khi một tài khoản quản trị xác thực, useAdminAccess là true và một trong các phạm vi uỷ quyền sau được sử dụng:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships

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 mà bạn muố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 tối đa các thành viên cần trả về. 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 thành viên.

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

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ừ một lệnh gọi trước đó để liệt kê các 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 tham 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 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 truy vấn.

Bạn có thể lọc hội viên theo vai trò (role) và loại hội 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 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 bắt buộc phải sử dụng member.type = "HUMAN" hoặc member.type != "BOT" khi useAdminAccess được đặt 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 đây không hợp lệ:

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

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

boolean

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

boolean

Không bắt buộc. Khi true, ngoài các loại gói thành viên khác, hệ thống cũng trả về các gói thành viên được liên kết với hội viên invited. Nếu bạn đặt bộ lọc, thì những invited thành viên không đáp ứng 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.
useAdminAccess

boolean

Không bắt buộc. Khi true, phương thức này sẽ chạy bằng đặ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à 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.

Chúng tôi không hỗ trợ việc liệt kê các gói thành viên của ứng dụng trong một không gian khi bạn sử dụng quyền truy cập của quản trị viên.

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 cho yêu cầu liệt kê tư cá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 các 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, tức là không có trang nào 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.app.memberships
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • 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.