本指南介绍了如何对 Google Chat API 的 ThreadReadState
资源使用 get()
方法,以获取消息会话中用户的阅读状态的详细信息。如需获取聊天室中消息的读取状态,请参阅详细了解用户的聊天室读取状态。
ThreadReadState
资源是一个单例资源,用于表示指定用户在 Google Chat 消息会话中上次读取的消息的详细信息。
前提条件
Node.js
- 拥有对 Google Chat 访问权限的商务版或企业版 Google Workspace 账号。
- 设置您的环境:
- 创建 Google Cloud 项目。
- 配置 OAuth 同意屏幕。
- 启用和配置 Google Chat API,为 Chat 应用提供名称、图标和说明。
- 安装 Node.js Cloud 客户端库。
- 为桌面应用
创建 OAuth 客户端 ID 凭据。如需运行本指南中的示例,请将凭据保存为名为
client_secrets.json
的 JSON 文件,并保存到本地目录。
- 选择支持用户身份验证的授权范围。
获取调用用户的线程读取状态
如需详细了解用户在消息会话中的阅读状态,请在请求中添加以下内容:
- 指定
chat.users.readstate
或chat.users.readstate.readonly
授权范围。 - 调用
GetThreadReadState()
方法,传递线程读取状态的name
以获取包含用户 ID 或别名和聊天室 ID 的值。获取线程读取状态仅支持获取调用方用户的读取状态,您可以通过设置以下任一项来指定该状态:me
别名。例如users/me/spaces/SPACE/threads/THREAD/threadReadState
。- 发起调用的用户的 Workspace 电子邮件地址。例如,
users/user@example.com/spaces/SPACE/threads/THREAD/threadReadState
。 - 发起调用的用户的用户 ID。例如,
users/USER/spaces/SPACE/threads/THREAD/threadReadState
。
以下示例可获取调用用户的线程读取状态:
Node.js
如需运行此示例,请替换以下内容:
SPACE_NAME
:聊天室的name
中的 ID。您可以通过调用ListSpaces()
方法或从聊天室的网址中获取 ID。THREAD_NAME
:线程的name
中的 ID。您可以通过以下方式获取 ID:使用 Chat API 异步创建消息后从返回的响应正文中获取,或者使用在创建消息时分配给消息的自定义名称获取。
Google Chat API 会获取指定会话的读取状态,并返回 ThreadReadState
的实例。