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

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

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

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

如需调用此方法,您必须使用用户身份验证。如需获取活动,经过身份验证的用户必须是相应活动所在空间的成员。

前提条件

Node.js

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

如需获取 Google Chat 中聊天室活动的详细信息,请在请求中传递以下内容:

  • 指定支持请求中事件类型的授权范围。 最佳实践是选择最严格的范围,同时仍允许应用正常运行。
  • 调用 GetSpaceEvent() 方法,并传递要获取的会议室事件的 name

以下示例获取了空间事件:

Node.js

chat/client-libraries/cloud/get-space-event-user-cred.js
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:基于事件类型的授权范围。例如,如果您要获取有关新会员资格的聊天室事件,请使用 chat.memberships.readonly 范围,格式为 https://www.googleapis.com/auth/chat.memberships.readonly。您可以通过 ListSpaceEvents() 方法获取事件类型。如需了解如何使用此方法,请参阅列出会议室中的活动
  • SPACE_NAME:来自空间的 name 的 ID。 您可以通过调用 ListSpaces() 方法或从空间的网址中获取 ID。
  • SPACE_EVENT_NAME:空间事件的 name 中的 ID。您可以通过 ListSpaceEvents() 方法获取 ID。如需了解如何使用此方法,请参阅列出会议室中的活动

Chat API 会返回一个 SpaceEvent 实例,其中包含有关活动的详细信息。