REST Resource: users.spaces

  • SpaceReadState tracks a user's read progress within a Google Chat space, indicating which messages are read and unread.

  • It's represented in JSON format with a name field (identifying the user and space) and an optional lastReadTime field (indicating the last read message or user-defined position).

  • You can retrieve and update a user's SpaceReadState using the getSpaceReadState and updateSpaceReadState methods, respectively, allowing developers to manage read receipts and user progress within Chat spaces.

Resource: SpaceReadState

A user's read state within a space, used to identify read and unread messages.

JSON representation
{
  "name": string,
  "lastReadTime": string
}
Fields
name

string

Resource name of the space read state.

Format: users/{user}/spaces/{space}/spaceReadState

lastReadTime

string (Timestamp format)

Optional. The time when the user's space read state was updated. Usually this corresponds with either the timestamp of the last read message, or a timestamp specified by the user to mark the last read position in a space.

Methods

getSpaceReadState

Returns details about a user's read state within a space, used to identify read and unread messages.

updateSpaceReadState

Updates a user's read state within a space, used to identify read and unread messages.