Method: users.spaces.threads.getThreadReadState
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
返回有关用户在会话中的阅读状态的详细信息,用于识别已读和未读消息。如需查看示例,请参阅获取有关用户会话读取状态的详细信息。
需要用户身份验证,并具有以下某个授权范围:
https://www.googleapis.com/auth/chat.users.readstate.readonly
https://www.googleapis.com/auth/chat.users.readstate
HTTP 请求
GET https://chat.googleapis.com/v1/{name=users/*/spaces/*/threads/*/threadReadState}
网址采用 gRPC 转码语法。
路径参数
参数 |
name |
string
必需。要检索的线程读取状态的资源名称。 仅支持获取调用方用户的读取状态。 如需引用调用方用户,请设置以下任一项:
me 别名。例如 users/me/spaces/{space}/threads/{thread}/threadReadState 。
用户的 Workspace 电子邮件地址。例如 users/user@example.com/spaces/{space}/threads/{thread}/threadReadState 。
用户 ID。例如 users/123456789/spaces/{space}/threads/{thread}/threadReadState 。
格式:users/{user}/spaces/{space}/threads/{thread}/threadReadState
|
响应正文
如果成功,则响应正文包含一个 ThreadReadState
实例。
授权范围
需要以下 OAuth 范围之一:
https://www.googleapis.com/auth/chat.users.readstate
https://www.googleapis.com/auth/chat.users.readstate.readonly
如需了解详情,请参阅授权指南。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):2025-07-25。"],[[["\u003cp\u003eRetrieves a user's read state within a specific thread, indicating read and unread messages.\u003c/p\u003e\n"],["\u003cp\u003eRequires user authentication and uses a specific HTTP GET request format with path parameters.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty, while a successful response includes a \u003ccode\u003eThreadReadState\u003c/code\u003e object.\u003c/p\u003e\n"],["\u003cp\u003eAuthorisation is necessary, using specific OAuth scopes related to read state permissions.\u003c/p\u003e\n"]]],["This describes retrieving a user's read state within a specific thread. To do so, send a `GET` HTTP request to a URL constructed with user, space, and thread identifiers, using either the `me` alias, their email, or ID. The request body must be empty. Successful requests return a `ThreadReadState` object, and requests require authorization via OAuth scopes, such as `chat.users.readstate`. The user must be authenticated to access this resource.\n"],null,["# Method: users.spaces.threads.getThreadReadState\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nReturns details about a user's read state within a thread, used to identify read and unread messages. For an example, see [Get details about a user's thread read state](https://developers.google.com/workspace/chat/get-thread-read-state).\n\nRequires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes):\n\n- `https://www.googleapis.com/auth/chat.users.readstate.readonly`\n- `https://www.googleapis.com/auth/chat.users.readstate`\n\n### HTTP request\n\n`GET https://chat.googleapis.com/v1/{name=users/*/spaces/*/threads/*/threadReadState}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. Resource name of the thread read state to retrieve. Only supports getting read state for the calling user. To refer to the calling user, set one of the following: - The `me` alias. For example, `users/me/spaces/{space}/threads/{thread}/threadReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/threads/{thread}/threadReadState`. - Their user id. For example, `users/123456789/spaces/{space}/threads/{thread}/threadReadState`. Format: users/{user}/spaces/{space}/threads/{thread}/threadReadState |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [ThreadReadState](/workspace/chat/api/reference/rest/v1/users.spaces.threads#ThreadReadState).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/chat.users.readstate`\n- `https://www.googleapis.com/auth/chat.users.readstate.readonly`\n\nFor more information, see the [Authorization guide](/workspace/chat/authenticate-authorize)."]]