2024-04-26
▼ ▲ chat.users.spaces.getSpaceReadState
Path: v1/{+name}
Flat Path: v1/users/{usersId}/spaces/{spacesId}/spaceReadState
HTTP Method: GET
Parameters:
name
Description: 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
Pattern: ^users/[^/]+/spaces/[^/]+/spaceReadState$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Returns details about a user's read state within a space, used to identify read and unread messages. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
▼ ▲ chat.users.spaces.updateSpaceReadState
Path: v1/{+name}
Flat Path: v1/users/{usersId}/spaces/{spacesId}/spaceReadState
HTTP Method: PATCH
Parameters:
name
Description: Resource name of the space read state. Format: `users/{user}/spaces/{space}/spaceReadState`
Pattern: ^users/[^/]+/spaces/[^/]+/spaceReadState$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. The field paths to update. Currently supported field paths: - `last_read_time` When the `last_read_time` is before the latest message create time, the space appears as unread in the UI. To mark the space as read, set `last_read_time` to any value later (larger) than the latest message create time. The `last_read_time` is coerced to match the latest message create time. Note that the space read state only affects the read state of messages that are visible in the space's top-level conversation. Replies in threads are unaffected by this timestamp, and instead rely on the thread read state.
Location: query
Type: string
Format: google-fieldmask
Parameter Order: name
Scopes: https://www.googleapis.com/auth/chat.users.readstate
Description: Updates a user's read state within a space, used to identify read and unread messages. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
▼ ▲ chat.users.spaces.threads.getThreadReadState
Path: v1/{+name}
Flat Path: v1/users/{usersId}/spaces/{spacesId}/threads/{threadsId}/threadReadState
HTTP Method: GET
Parameters:
name
Description: 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
Pattern: ^users/[^/]+/spaces/[^/]+/threads/[^/]+/threadReadState$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes:
Description: Returns details about a user's read state within a thread, used to identify read and unread messages. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).