Method: users.spaces.threads.getThreadReadState
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
בקשת HTTP
GET https://chat.googleapis.com/v1/{name=users/*/spaces/*/threads/*/threadReadState}
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של נתיב
פרמטרים |
name |
string
חובה. שם המשאב של מצב הקריאה של השרשור שרוצים לאחזר. התכונה תומכת רק בקבלת סטטוס הקריאה של המשתמש הקורא. כדי להפנות למשתמש הקורא, מגדירים את אחת מהאפשרויות הבאות:
הכינוי me . לדוגמה, users/me/spaces/{space}/threads/{thread}/threadReadState .
כתובת האימייל שלהם ב-Workspace. לדוגמה, users/user@example.com/spaces/{space}/threads/{thread}/threadReadState .
מזהה המשתמש שלהם. לדוגמה, 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
מידע נוסף זמין במדריך ההרשאות.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[null,null,["עדכון אחרון: 2025-07-25 (שעון UTC)."],[[["\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)."]]