Get details about a user's space read state

AI-generated Key Takeaways

• This guide explains how to use the get() method to retrieve a user's read state within a Google Chat space using the Google Chat API.

• You need a Google Workspace account and a configured Google Cloud project with the Google Chat API enabled to use this functionality.

• The guide provides instructions and code samples (Node.js) to retrieve the calling user's space read state using the GetSpaceReadState() method.

• To get the read state, you need to specify the appropriate authorization scope and provide the space name in the request.

• For message-specific read states within a thread, refer to the separate guide on getting thread read states.

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 credentials.json to your local directory.
  For guidance, complete the steps for setting up your environment in this quickstart.
• Choose an authorization scope that supports user authentication.

The code samples in this page use the gRPC API interface with the Google Cloud client libraries. Alternatively, you can use the REST API interface. For more information about the gRPC and REST interfaces, see Google Chat API overview.

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 or chat.users.readstate.readonly authorization scope.
• Call the GetSpaceReadState() method, passing the name 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/[e-mail]/spaces/SPACE/spaceReadState.
  • The calling user's user ID. For example, users/USER/spaces/SPACE/spaceReadState.

The following example gets the calling user's space read state:

Node.js

chat/client-libraries/cloud/get-space-read-state-user-cred.js

View on GitHub

import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = [
  'https://www.googleapis.com/auth/chat.users.readstate.readonly',
];

// This sample shows how to get the space read state for the calling user
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(
    USER_AUTH_OAUTH_SCOPES,
  );

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here
    name: 'users/me/spaces/SPACE_NAME/spaceReadState',
  };

  // Make the request
  const response = await chatClient.getSpaceReadState(request);

  // Handle the response
  console.log(response);
}

await main();

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.

Related topics

• Update the calling user's space read state.
• Get the calling user's thread read state.