Method: spaces.spaceEvents.list

Liệt kê các sự kiện từ một phòng Google Chat. Đối với mỗi sự kiện, payload chứa phiên bản mới nhất của tài nguyên trong Chat. Ví dụ: nếu bạn liệt kê sự kiện về thành viên mới của không gian, máy chủ sẽ trả về các tài nguyên Membership chứa thông tin chi tiết mới nhất về thành viên. Nếu các thành viên mới bị xoá trong khoảng thời gian được yêu cầu, thì tải trọng sự kiện sẽ chứa một tài nguyên Membership trống.

Yêu cầu xác thực người dùng. Để liệt kê các sự kiện, người dùng đã xác thực phải là thành viên của không gian.

Ví dụ: hãy xem bài viết Liệt kê các sự kiện từ một phòng Google Chat.

Yêu cầu HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/spaceEvents

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 phòng Google Chat nơi diễn ra sự kiệ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 sự kiện trong không gian được trả về. Dịch vụ có thể trả về ít hơn giá trị này.

Giá trị âm trả về lỗi INVALID_ARGUMENT.
pageToken

string

Mã thông báo trang, nhận được từ lệnh gọi sự kiện không gian danh sách trước đó. Cung cấp mã 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 để liệt kê sự kiện của không gian 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 thông số khác có thể dẫn đến kết quả không mong muốn.
filter

string

Bắt buộc. Bộ lọc truy vấn.

Bạn phải chỉ định ít nhất một loại sự kiện (eventType) bằng toán tử có :. Để lọc theo nhiều loại sự kiện, hãy sử dụng toán tử OR. Hãy bỏ qua các loại sự kiện theo lô trong bộ lọc của bạn. Yêu cầu này tự động trả về mọi sự kiện theo lô có liên quan. Ví dụ: nếu bạn lọc theo biểu tượng cảm xúc mới (google.workspace.chat.reaction.v1.created), máy chủ cũng sẽ trả về sự kiện phản ứng mới hàng loạt (google.workspace.chat.reaction.v1.batchCreated). Để biết danh sách các loại sự kiện được hỗ trợ, hãy xem tài liệu tham khảo về SpaceEvents.

Nếu muốn, bạn cũng có thể lọc theo thời gian bắt đầu (startTime) và thời gian kết thúc (endTime):

  • startTime: Dấu thời gian dành riêng dùng để bắt đầu liệt kê các sự kiện trong không gian. Bạn có thể liệt kê những sự kiện đã xảy ra cách đây tối đa 28 ngày. Nếu bạn chưa chỉ định, hãy liệt kê các sự kiện trong không gian trong 28 ngày qua.
  • endTime: Dấu thời gian bao gồm cho đến khi các sự kiện trong không gian được liệt kê. Nếu bạn chưa chỉ định, tính năng này sẽ liệt kê các sự kiện cho đến thời điểm yêu cầu.

Để chỉ định thời gian bắt đầu hoặc kết thúc, hãy sử dụng toán tử bằng = và định dạng trong RFC-3339. Để lọc theo cả startTime và endTime, hãy sử dụng toán tử AND.

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

startTime="2023-08-23T19:20:33+00:00" AND
endTime="2023-08-23T19:21:54+00:00"

startTime="2023-08-23T19:20:33+00:00" AND
(eventTypes:"google.workspace.chat.space.v1.updated" OR
eventTypes:"google.workspace.chat.message.v1.created")

Các truy vấn sau không hợp lệ:

startTime="2023-08-23T19:20:33+00:00" OR
endTime="2023-08-23T19:21:54+00:00"

eventTypes:"google.workspace.chat.space.v1.updated" AND
eventTypes:"google.workspace.chat.message.v1.created"

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

Tin nhắn phản hồi cho các sự kiện trong không gian liệt kê.

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

object (SpaceEvent)

Kết quả được trả về theo thứ tự thời gian (sự kiện cũ nhất được xếp trước).
nextPageToken

string

Mã thông báo tiếp tục được dùng để tìm nạp thêm sự kiện. Nếu trường này bị bỏ qua thì 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.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.readonly
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly
  • https://www.googleapis.com/auth/chat.messages.reactions
  • https://www.googleapis.com/auth/chat.messages.reactions.readonly

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