Method: spaces.spaceEvents.list

Liệt kê các sự kiện từ một phòng Chat. Đối với mỗi sự kiện, tải trọng 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, thì máy chủ sẽ trả về các tài nguyên Membership chứa thông tin mới nhất về tư cách 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.

Hỗ trợ các loại xác thực sau đây với phạm vi uỷ quyền phù hợp để đọc dữ liệu được yêu cầu:

  • Xác thực ứng dụng có sự phê duyệt của quản trị viên với một trong các phạm vi uỷ quyền sau:

    • https://www.googleapis.com/auth/chat.app.spaces
    • https://www.googleapis.com/auth/chat.app.spaces.readonly
    • https://www.googleapis.com/auth/chat.app.messages.readonly
    • https://www.googleapis.com/auth/chat.app.memberships
    • https://www.googleapis.com/auth/chat.app.memberships.readonly

  • 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.spaces.readonly
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.messages.readonly
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.messages.reactions.readonly
    • https://www.googleapis.com/auth/chat.messages.reactions
    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships

Để liệt kê các sự kiện, người gọi đã 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ê các sự kiện từ một phòng Chat trong 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 không gian Google Chat nơi xảy ra các 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 tối đa sự kiện không gian được trả về. Dịch vụ có thể trả về ít hơn giá trị này.

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ừ 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 tham số khác được cung cấp cho sự kiện không gian danh sách 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

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 cách sử dụng toán tử có :. Để 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 sẽ tự động trả về mọi sự kiện hàng loạt có liên quan. Ví dụ: nếu bạn lọc theo các phản ứng mới (google.workspace.chat.reaction.v1.created), thì máy chủ cũng sẽ trả về các sự kiện phản ứng mới hàng loạt (google.workspace.chat.reaction.v1.batchCreated). Để xem danh sách các loại sự kiện được hỗ trợ, hãy xem tài liệu tham khảo 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):

  • startTime: Dấu thời gian độc quyền để bắt đầu liệt kê các sự kiện 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 không được chỉ định, hãy liệt kê các sự kiện 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 không gian được liệt kê. Nếu không được 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 thời gian 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 đây 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ủ sẽ từ chối các truy vấn không hợp lệ bằng 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

Thông báo phản hồi để liệt kê các sự kiện 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 trình tự thời gian (sự kiện cũ nhất trước). Lưu ý: Trường permissionSettings không được trả về trong đối tượng Không gian cho các yêu cầu danh sách.
nextPageToken

string

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