列出 Google Chat 聊天室中的活动

本指南介绍了如何使用 Google Chat API 的 SpaceEvent 资源中的 list() 方法列出空间中资源的更改。

SpaceEvent 资源表示对目标聊天室的更改，包括聊天室的子资源，例如消息、回应和成员资格。如需详细了解支持的事件类型和事件载荷列表，请参阅 SpaceEvent 资源参考文档的 eventType 和 payload 字段。

您可以列出请求时间之前最多 28 天的活动。服务器会返回包含受影响资源最新版本的事件。例如，如果您列出有关新聊天室成员的事件，服务器会返回包含最新成员资格详细信息的 Membership 资源。如果新会员在请求的时间段内被移除，则事件载荷包含空的 Membership 资源。

如需调用此方法，您必须使用用户身份验证。如需列出聊天室中的活动，经过身份验证的用户必须是相应聊天室的成员。

前提条件

Node.js

列出空间事件

如需列出 Chat 聊天室中的聊天室活动，请在请求中传递以下内容：

  • 指定一个或多个授权范围，以支持请求中的每种事件类型。最佳实践是，选择最严格的范围，同时仍允许您的应用正常运行。如需选择范围，请参阅身份验证和授权概览。

  • 调用 ListSpaceEvents() 方法，并传递要列出的事件类型的 filter。 您必须至少指定一种事件类型，也可以按日期进行过滤。 如需查看支持的事件类型列表，请参阅 SpaceEvent 资源的 eventType 字段参考文档。

以下示例列出了有关新会员和聊天室中消息的事件：

Node.js

chat/client-libraries/cloud/list-space-events-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

// Authorization scopes based on the event types
const USER_AUTH_OAUTH_SCOPES = [
  'https://www.googleapis.com/auth/chat.memberships.readonly',
  'https://www.googleapis.com/auth/chat.messages.readonly',
];

// This sample shows how to list space events with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(
      USER_AUTH_OAUTH_SCOPES,
  );

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here
    parent: 'spaces/SPACE_NAME',
    // A required filter. Filters events about new memberships and messages
    filter:
      'eventTypes:"google.workspace.chat.membership.v1.created" OR eventTypes:"google.workspace.chat.message.v1.created"',
  };

  // Make the request
  const pageResult = chatClient.listSpaceEventsAsync(request);

  // Handle the response. Iterating over pageResult will yield results and
  // resolve additional pages automatically.
  for await (const response of pageResult) {
    console.log(response);
  }
}

await main();

如需运行此示例，请将 SPACE_NAME 替换为相应空间的 name 中的 ID。 您可以通过调用 ListSpaces() 方法或从空间的网址中获取 ID。

Chat API 会返回有关新会员和消息的分页聊天室事件列表。