获取有关用户的线程读取状态的详细信息

本指南将介绍如何使用 get() 方法（针对 Google Chat API 的 ThreadReadState 资源）来获取详细信息 有关用户在消息线程中的读取状态的信息。如需获取聊天室中消息的读取状态，请参阅详细了解用户的聊天室读取状态。

ThreadReadState 资源是一个单例资源，用于表示指定用户在 Google Chat 消息会话中上次读取的消息的详细信息。

前提条件

Node.js

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

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

<ph type="x-smartling-placeholder">

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

获取调用用户的线程读取状态

如需详细了解用户在消息会话中的阅读状态，请在请求中添加以下内容：

• 指定 chat.users.readstate 或 chat.users.readstate.readonly 授权范围。
• 调用 GetThreadReadState() 方法，传递线程读取状态的 name 以获取包含用户 ID 或别名和聊天室 ID 的值。获取线程读取状态仅支持 获取调用用户的读取状态，这可以通过 设置以下任一选项： <ph type="x-smartling-placeholder">
  </ph>
  • me 别名。例如 users/me/spaces/SPACE/threads/THREAD/threadReadState。
  • 发起调用的用户的 Workspace 电子邮件地址。例如，users/[e-mail]/spaces/SPACE/threads/THREAD/threadReadState。
  • 发起调用的用户的用户 ID。例如，users/USER/spaces/SPACE/threads/THREAD/threadReadState。

以下示例会获取调用用户的线程读取状态：

Node.js

chat/client-libraries/cloud/get-thread-read-state-user-cred.js

在 GitHub 上查看

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

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.users.readstate.readonly'];

// This sample shows how to get the thread read state for a space and calling user
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME and THREAD_NAME here
    name: 'users/me/spaces/SPACE_NAME/threads/THREAD_NAME/threadReadState'
  };

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

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

main().catch(console.error);

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

• SPACE_NAME：聊天室的 ID name。 您可以通过调用 ListSpaces() 方法或从聊天室的网址中获取 ID。
• THREAD_NAME：来自线程的 name。 您可以在创建 与 Chat API 异步发送消息，或使用 自定义名称 分配给消息。

Google Chat API 获取指定的线程读取状态并返回 实例 ThreadReadState。

相关主题

• 更新发起调用的用户的聊天室读取状态。
• 获取发起调用的用户的空间读取状态。