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 Chat. Ví dụ: nếu bạn liệt kê các sự kiện về thành viên mới trong không gian, máy chủ sẽ trả về những tài nguyên Membership chứa thông tin 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 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ê sự kiện, người dùng đã xác thực phải là thành viên của không gian.

Để xem ví dụ, hãy xem bài viết Liệt kê 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

Tham 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

Tham số
pageSize

integer

Không bắt buộc. Số lượng sự kiện không gian tối đa đượ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 danh sách trước đó. Cung cấp URL 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 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 tham 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 cụm từ tìm kiếm.

Bạn phải chỉ định ít nhất một loại sự kiện (eventType) bằng cách sử dụng toán tử has :. Để lọc theo nhiều loại sự kiện, hãy sử dụng toán tử OR. Bỏ qua các loại sự kiện hàng loạt trong bộ lọc. Yêu cầu này sẽ tự động trả về mọi sự kiện theo lô có liên quan. Ví dụ: nếu bạn lọc theo lượt thể hiện cảm xúc mới (google.workspace.chat.reaction.v1.created), thì máy chủ cũng sẽ trả về hàng loạt các sự kiện phản ứng mới (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.

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) nếu muốn:

  • startTime: Dấu thời gian dành riêng để bắt đầu liệt kê các sự kiện trong không gian. Bạn có thể liệt kê các sự kiện đã xảy ra cách đây tối đa 28 ngày. Nếu bạn không chỉ định, thì hãy liệt kê các sự kiện diễn ra trong không gian 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 chưa chỉ định, hãy 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"

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

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 để liệt kê các sự kiện trong 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 
{
  "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 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ì 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.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 bài viết Hướng dẫn uỷ quyền.