Method: spaces.spaceEvents.list

列出 Google Chat 聊天室中的事件。每个事件的payload都包含最新版本的 Chat 资源。例如，如果您列出聊天室新成员的相关活动，服务器会返回包含最新成员详细信息的 Membership 资源。如果新成员在请求的期限内被移除，则事件载荷将包含空的 Membership 资源。

要求进行用户身份验证。如需列出活动，经过身份验证的用户必须是聊天室的成员。

如需查看示例，请参阅列出 Google Chat 聊天室中的活动。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
parent

string

必需。发生事件的 Google Chat 聊天室的资源名称。

格式：spaces/{space}。

查询参数

参数
pageSize

integer

可选。返回的最大聊天室事件数。服务返回的值可能会少于此值。

负值会返回 INVALID_ARGUMENT 错误。
pageToken

string

从上一个列表空间事件调用接收的页面令牌。利用其进行后续页面检索。

进行分页时，为列出聊天室事件提供的所有其他参数必须与提供页面令牌的调用匹配。向其他参数传递不同的值可能会导致意外结果。
filter

string

必需。查询过滤条件。

您必须使用 has : 运算符指定至少一个事件类型 (eventType)。如需按多个事件类型进行过滤，请使用 OR 运算符。在过滤器中忽略批量事件类型。请求会自动返回所有相关的批量事件。例如，如果您按新回应 (google.workspace.chat.reaction.v1.created) 进行过滤，服务器也会返回批量新的回应事件 (google.workspace.chat.reaction.v1.batchCreated)。如需查看支持的事件类型列表，请参阅 SpaceEvents 参考文档。

您还可以按开始时间（startTime）和结束时间（endTime）进行过滤：

  • startTime：开始列出聊天室事件的独占时间戳。您可以列出最多 28 天前发生的事件。如果未指定，系统会列出过去 28 天内的聊天室活动。
  • endTime：包含时间戳，此时间戳之前会列出聊天室事件。如果未指定，则列出截至请求时间的事件。

如需指定开始时间或结束时间，请使用 RFC-3339 中的等号 = 运算符和格式。如需同时按 startTime 和 endTime 过滤，请使用 AND 运算符。

例如，以下查询是有效的：

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")

以下查询无效：

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"

服务器拒绝无效查询并显示 INVALID_ARGUMENT 错误。

请求正文

请求正文必须为空。

响应正文

列出聊天室活动的响应消息。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "spaceEvents": [
    {
      object (SpaceEvent)
    }
  ],
  "nextPageToken": string
}
字段
spaceEvents[]

object (SpaceEvent)

系统会按时间顺序返回结果（事件最早的数据在最前面）。
nextPageToken

string

用于提取更多事件的延续令牌。如果省略此字段，则不存在后续页面。

授权范围

需要以下 OAuth 范围之一：

  • 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

有关详情，请参阅授权指南。