获取有关 Google Chat 聊天室活动的详细信息

本指南介绍了如何对 Google Chat API 的 SpaceEvent 资源使用 get() 方法，以获取 Google Chat 聊天室中事件的详细信息。

SpaceEvent 资源表示聊天室或其子资源（例如消息、回应和成员资格）发生了更改。如需了解支持的事件类型，请参阅 SpaceEvent 资源的 eventType 字段。

您最多可以请求 28 天前发生的事件。该事件包含更改的资源的最新版本。例如，如果您请求有关新消息的事件，但该消息后来被更新了，服务器会在事件载荷中返回更新后的 Message 资源。

如需调用此方法，您必须使用用户身份验证。如需获取事件，经过身份验证的用户必须是发生事件的聊天室的成员。

前提条件

Node.js

• 拥有对 Google Chat 访问权限的商务版或企业版 Google Workspace 账号。

• 设置环境：
  • 创建 Google Cloud 项目。
  • 配置 OAuth 权限请求页面。
  • 启用和配置 Google Chat API，为 Chat 应用提供名称、图标和说明。
  • 安装 Node.js Cloud 客户端库。
  • 为桌面应用 创建 OAuth 客户端 ID 凭据。如需运行本指南中的示例，请将凭据保存为名为 client_secrets.json 的 JSON 文件，并保存到本地目录。
  如需相关指导，请完成此快速入门中关于设置环境的步骤。
• 选择支持用户身份验证的授权范围。

本页中的代码示例使用 gRPC API 与 Google Cloud 客户端库交互。或者，您也可以使用 REST API 接口。如需详细了解 gRPC 和 REST 接口，请参阅 Google Chat API 概览。

获取有关聊天室活动的详细信息

如需获取 Google Chat 中聊天室事件的详细信息，请在请求中传递以下内容：

• 在请求中指定支持相应事件类型的授权范围。最佳实践是选择最严格的范围，但仍允许应用正常运行。
• 调用 GetSpaceEvent() 方法，将聊天室事件的 name 传递给 get。

以下示例会获取聊天室事件：

Node.js

chat/client-libraries/cloud/get-space-event-user-cred.js

在 GitHub 上查看

import {createClientWithUserCredentials} from './authentication-utils.js';

// Replace SCOPE_NAME here with an authorization scope based on the event type
const USER_AUTH_OAUTH_SCOPES = ['SCOPE_NAME'];

// This sample shows how to get space event 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 and SPACE_EVENT_NAME here
    name: 'spaces/SPACE_NAME/spaceEvents/SPACE_EVENT_NAME'
  };

  // Make the request
  const response = await chatClient.getSpaceEvent(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

如需运行此示例，请替换以下内容：

• SCOPE_NAME：基于事件类型的授权范围。例如，如果您要获取有关新会员的聊天室事件，请使用格式为 https://www.googleapis.com/auth/chat.memberships.readonly 的 chat.memberships.readonly 范围。您可以通过 ListSpaceEvents() 方法获取事件类型。如需了解如何使用此方法，请参阅列出聊天室中的事件。
• SPACE_NAME：聊天室的 name 中的 ID。您可以通过调用 ListSpaces() 方法或从聊天室的网址中获取 ID。
• SPACE_EVENT_NAME：聊天室事件的 name 中的 ID。您可以通过 ListSpaceEvents() 方法获取 ID。如需了解如何使用此方法，请参阅列出聊天室中的事件。

Chat API 会返回一个 SpaceEvent 实例，其中包含有关事件的详细信息。

相关主题

• 处理 Google Chat 中的事件
• 列出 Google Chat 聊天室中的事件