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

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

SpaceEvent 资源 表示对聊天室或其子资源（例如消息、 表情符号和成员资格）的更改。如需了解受支持的事件类型，请参阅 eventType资源SpaceEvent 参考文档的字段。

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

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

前提条件

Node.js

Python

获取有关聊天室事件的详细信息（用户身份验证）

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

  • 在请求中指定支持事件类型的授权范围。 最佳实践是选择限制性最强的范围，但仍允许应用正常运行。
  • 调用 GetSpaceEvent() 方法，并传递要获取的聊天室事件的 name。

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

Node.js

此 Node.js 代码示例使用 Chat RPC API。

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);
}

await main();

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

  • 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 的实例，其中包含有关该事件的详细信息。

获取有关聊天室事件的详细信息（Chat 应用身份验证）

应用身份验证需要管理员一次性 批准。

如需使用Chat REST API从通过 应用身份验证 的聊天室获取有关聊天室事件的详细信息， 请在请求中传递以下内容：

  • 指定一个或多个授权范围，以支持请求中的每种事件类型。最佳实践是选择限制性最强的范围，但仍允许应用正常运行。如需详细了解如何选择范围，请参阅 身份验证和授权概览。
    • 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
  • 对 spaceEvents 资源 调用 get 方法 。
  • 传递要从中获取事件详细信息的聊天室的 name。

编写调用 Chat API 的脚本

以下介绍了如何使用 应用身份验证和 Chat REST API获取有关聊天室事件的详细信息：

Python

此 Python 代码示例使用 Chat REST API。

  1. 在工作目录中，创建一个名为 chat_spaceevents_get_app.py 的文件。

  2. 在 chat_spaceevents_get_app.py 中添加以下代码：

    from google.oauth2 import service_account
from apiclient.discovery import build

# Define your app's authorization scopes.
# Set authorization scopes based on the
# event type. For example, if you are getting a space event
# about a new membership, use the `chat.app.memberships` scope.
#
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["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"]

def main():
    '''
    Authenticates with Chat API using app authentication,
    then lists space events from a specified space.
    '''

    # Specify service account details.
    creds = (
        service_account.Credentials.from_service_account_file('credentials.json')
        .with_scopes(SCOPES)
    )

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.spaces().spaceEvents().get(

        # The space to get event details from.
        #
        # Replace SPACE_NAME with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        name='spaces/SPACE_NAME/spaceEvents/SPACE_EVENT_NAME',

    ).execute()

    # Print Chat API's response in your command line interface.
    print(result)

if __name__ == '__main__':
    main()

  3. 在代码中，替换以下内容：

  4. 在工作目录中，构建并运行示例：

    python3 chat_spaceevents_get_app.py

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