This guide explains how to use the
get()
method on the SpaceReadState
resource of the Google Chat API to get details about
a user's read state within a space. To get the read state of a message in a
message thread, see
Get details about a user's thread read state.
The
SpaceReadState
resource
is a singleton resource that represents details about a
specified user's last read message in a Google Chat space.
Prerequisites
Node.js
- A Business or Enterprise Google Workspace account with access to Google Chat.
- Set up your environment:
- Create a Google Cloud project.
- Configure the OAuth consent screen.
- Enable and configure the Google Chat API with a name, icon, and description for your Chat app.
- Install the Node.js Cloud Client Library.
-
Create OAuth client ID credentials for a desktop application. To run the sample in this
guide, save the credentials as a JSON file named
client_secrets.json
to your local directory.
- Choose an authorization scope that supports user authentication.
Get the calling user's space read state
To get details about a user's read state within a space, include the following in your request:
- Specify the
chat.users.readstate
orchat.users.readstate.readonly
authorization scope. - Call the
GetSpaceReadState()
method, passing thename
of the space read state to get which includes a user ID or alias and a space ID. Getting space read state only supports getting the read state of the calling user, which can be specified by setting one of the following:- The
me
alias. For example,users/me/spaces/SPACE/spaceReadState
. - The calling user's Workspace email address. For example,
users/user@example.com/spaces/SPACE/spaceReadState
. - The calling user's user ID. For example,
users/USER/spaces/SPACE/spaceReadState
.
- The
The following example gets the calling user's space read state:
Node.js
To run this sample, replace SPACE_NAME
with the ID from
the space's
name
.
You can obtain the ID by calling the
ListSpaces()
method or from the space's URL.
The Google Chat API gets the specified space read state and returns
an instance of
SpaceReadState
.