Method: spaces.list

Liệt kê các không gian mà phương thức gọi là thành viên. Các cuộc trò chuyện nhóm và tin nhắn trực tiếp không được liệt kê cho đến khi tin nhắn đầu tiên được gửi. Để biết ví dụ, hãy xem phần Liệt kê không gian.

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.

Liệt kê các không gian hiển thị cho người gọi hoặc người dùng đã xác thực. Các cuộc trò chuyện nhóm và tin nhắn trực tiếp không được liệt kê cho đến khi tin nhắn đầu tiên được gửi.

Để liệt kê tất cả không gian có tên theo tổ chức trên Google Workspace, hãy sử dụng phương thức spaces.search() bằng các đặc quyền của quản trị viên Workspace.

Yêu cầu HTTP

GET https://chat.googleapis.com/v1/spaces

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

Tham số truy vấn

Tham số
pageSize

integer

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

Nếu bạn không chỉ định thì hệ thống sẽ trả về tối đa 100 dấu cách.

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 lệnh gọi không gian danh sách trước đó. Cung cấp tham số này để truy xuất trang tiếp theo.

Khi phân trang, giá trị bộ lọc phải khớp với lệnh gọi đã cung cấp mã thông báo trang. Việc chuyển một giá trị 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 không gian theo loại không gian (spaceType).

Để lọc theo loại không gian, bạn phải chỉ định giá trị enum hợp lệ, chẳng hạn như SPACE hoặc GROUP_CHAT (spaceType không được là SPACE_TYPE_UNSPECIFIED). Để truy vấn nhiều loại không gian, hãy sử dụng toán tử OR.

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

spaceType = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

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

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 về không gian danh sách.

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 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string
}
Trường
spaces[]

object (Space)

Danh sách các không gian trong trang được yêu cầu (hoặc trang đầu tiên).
nextPageToken

string

Bạn có thể gửi mã thông báo 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.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

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