Method: spaces.list

Liệt kê các không gian có người gọi là thành viên. Bạn cần phải xác thực. Hỗ trợ đầy đủ xác thực tài khoản dịch vụ.

Hỗ trợ việc xác thực người dùng trong Chương trình dùng thử dành cho nhà phát triển Google Workspace, một chương trình cấp quyền truy cập sớm vào một số tính năng. Xác thực người dùng yêu cầu phạm vi ủy quyền chat.spaces hoặc chat.spaces.readonly.

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 tin nhắn trò chuyện và tin nhắn trực tiếp trong nhóm không được liệt kê cho đến khi tin nhắn đầu tiên được gửi.

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

Các tham số
pageSize

integer

Không bắt buộc. Số lượng không gian tối đa để 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ì tối đa 100 dấu cách sẽ được trả về.

Giá trị tối đa là 1000; các giá trị trên 1000 được ép buộc thành 1000.

Các 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 không gian trong danh sách trước. Hãy cung cấp thông tin 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.

Yêu cầu xác thực người dùng.

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ủ từ chối những truy vấn không hợp lệ do lỗi INVALID_ARGUMENT.

Trong phần xác thực tài khoản dịch vụ, trường này bị bỏ qua và truy vấn luôn trả về tất cả các dấu cách. Nhưng Chat API vẫn xác thực cú pháp truy vấn với các tài khoản dịch vụ, vì vậy các truy vấn không hợp lệ vẫn bị từ chối.

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

object (Space)

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

string

Một mã thông báo có thể được 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 nào.

Phạm vi cấp phép

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.