Method: users.spaces.getSpaceReadState
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
傳回使用者在聊天室中的已讀狀態詳細資料,用於識別已讀和未讀訊息。如需範例,請參閱「取得使用者空間讀取狀態的詳細資料」。
需要使用下列其中一個授權範圍進行使用者驗證:
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/*/spaceReadState}
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 |
name |
string
必要欄位。要擷取的聊天室讀取狀態資源名稱。 僅支援取得呼叫使用者的讀取狀態。 如要參照呼叫使用者,請設定下列其中一個項目:
me 別名。例如 users/me/spaces/{space}/spaceReadState 。
使用者的 Workspace 電子郵件地址。例如 users/user@example.com/spaces/{space}/spaceReadState 。
使用者 ID。例如 users/123456789/spaces/{space}/spaceReadState 。
格式:users/{user}/spaces/{space}/spaceReadState
|
回應主體
如果成功,回應主體會包含 SpaceReadState
的執行例項。
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/chat.users.readstate
https://www.googleapis.com/auth/chat.users.readstate.readonly
詳情請參閱授權指南。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-07-25 (世界標準時間)。
[null,null,["上次更新時間:2025-07-25 (世界標準時間)。"],[[["\u003cp\u003eThis document explains how to retrieve a user's read state within a Google Chat space, indicating read and unread messages.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve read state information for the calling user using their user ID, email address, or the "me" alias.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires specific authorization scopes (\u003ccode\u003echat.users.readstate\u003c/code\u003e or \u003ccode\u003echat.users.readstate.readonly\u003c/code\u003e) for access.\u003c/p\u003e\n"],["\u003cp\u003eA successful response returns a \u003ccode\u003eSpaceReadState\u003c/code\u003e object containing details of the user's read state in the specified space.\u003c/p\u003e\n"],["\u003cp\u003eRefer to the provided links for a practical example and further details on authentication and authorization.\u003c/p\u003e\n"]]],["This resource retrieves a user's read state within a specific space to determine read/unread messages. It uses a `GET` HTTP request to `https://chat.googleapis.com/v1/{name=users/*/spaces/*/spaceReadState}`, employing gRPC Transcoding syntax. The `name` path parameter, which is required, identifies the user and space. The request body must be empty, while a successful response returns a `SpaceReadState` instance. User authentication with specified OAuth scopes is necessary.\n"],null,["# Method: users.spaces.getSpaceReadState\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 space, used to identify read and unread messages. For an example, see [Get details about a user's space read state](https://developers.google.com/workspace/chat/get-space-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/*/spaceReadState}`\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 space 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}/spaceReadState`. - Their Workspace email address. For example, `users/user@example.com/spaces/{space}/spaceReadState`. - Their user id. For example, `users/123456789/spaces/{space}/spaceReadState`. Format: users/{user}/spaces/{space}/spaceReadState |\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 [SpaceReadState](/workspace/chat/api/reference/rest/v1/users.spaces#SpaceReadState).\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)."]]