Obtén detalles sobre el estado de lectura de la conversación de un usuario
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
En esta guía, se explica cómo usar el método get() en el recurso ThreadReadState de la API de Google Chat para obtener detalles sobre el estado de lectura de un usuario en una conversación. Para obtener el estado de lectura de un
mensaje en un espacio, consulta
Obtén detalles sobre el estado de lectura de un espacio de un usuario.
El recurso ThreadReadState es un recurso singleton que representa detalles sobre el último mensaje leído de un usuario específico en una conversación de Google Chat.
Crea credenciales de ID de cliente de OAuth para una aplicación de escritorio. Para ejecutar la muestra de esta guía, guarda las credenciales como un archivo JSON llamado credentials.json en tu directorio local.
Para obtener orientación, completa los pasos para configurar tu entorno en esta
guía de inicio rápido.
Obtén el estado de lectura del subproceso del usuario que realiza la llamada
Para obtener detalles sobre el estado de lectura de un usuario en una conversación, incluye lo siguiente en tu solicitud:
Especifica el permiso de autorización chat.users.readstate o chat.users.readstate.readonly.
Llama al método GetThreadReadState() y pasa el name del estado de lectura del subproceso para obtener lo que incluye un ID de usuario o alias y un ID de espacio. Obtener el estado de lectura del subproceso solo admite obtener el estado de lectura del usuario que realiza la llamada, que se puede especificar configurando una de las siguientes opciones:
El alias me. Por ejemplo, users/me/spaces/SPACE/threads/THREAD/threadReadState
Es la dirección de correo electrónico de Workspace del usuario que realiza la llamada. Por ejemplo, users/user@example.com/spaces/SPACE/threads/THREAD/threadReadState.
El ID de usuario del usuario que realiza la llamada. Por ejemplo, users/USER/spaces/SPACE/threads/THREAD/threadReadState.
En el siguiente ejemplo, se obtiene el estado de lectura del subproceso del usuario que realiza la llamada:
import{createClientWithUserCredentials}from'./authentication-utils.js';constUSER_AUTH_OAUTH_SCOPES=['https://www.googleapis.com/auth/chat.users.readstate.readonly'];// This sample shows how to get the thread read state for a space and calling userasyncfunctionmain(){// Create a clientconstchatClient=awaitcreateClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);// Initialize request argument(s)constrequest={// Replace SPACE_NAME and THREAD_NAME herename:'users/me/spaces/SPACE_NAME/threads/THREAD_NAME/threadReadState'};// Make the requestconstresponse=awaitchatClient.getThreadReadState(request);// Handle the responseconsole.log(response);}main().catch(console.error);
Para ejecutar esta muestra, reemplaza lo siguiente:
SPACE_NAME: Es el ID del name del espacio.
Para obtener el ID, llama al método ListSpaces() o desde la URL del espacio.
THREAD_NAME: Es el ID del name del subproceso.
Puedes obtener el ID del cuerpo de la respuesta que se muestra después de crear un mensaje de forma asíncrona con la API de Chat o con el nombre personalizado asignado al mensaje en el momento de su creación.
La API de Google Chat obtiene el estado de lectura del subproceso especificado y muestra una instancia de ThreadReadState.
[null,null,["Última actualización: 2025-05-30 (UTC)"],[[["\u003cp\u003eThis guide explains how to use the \u003ccode\u003eget()\u003c/code\u003e method to retrieve a user's read state within a Google Chat message thread using the Google Chat API.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eThreadReadState\u003c/code\u003e resource provides details about a user's last read message in a thread.\u003c/p\u003e\n"],["\u003cp\u003eTo get the thread read state, you need a Google Workspace account, a configured Google Cloud project with the Google Chat API enabled, and the Node.js Cloud Client Library installed.\u003c/p\u003e\n"],["\u003cp\u003eYou must use the \u003ccode\u003echat.users.readstate\u003c/code\u003e or \u003ccode\u003echat.users.readstate.readonly\u003c/code\u003e authorization scope and call the \u003ccode\u003eGetThreadReadState()\u003c/code\u003e method, specifying the thread read state's name.\u003c/p\u003e\n"],["\u003cp\u003eThe API returns a \u003ccode\u003eThreadReadState\u003c/code\u003e instance containing the user's read state information.\u003c/p\u003e\n"]]],["This guide details retrieving a user's read state within a Google Chat message thread using the `get()` method on the `ThreadReadState` resource. Key actions involve setting up a Google Cloud project, enabling the Chat API, and obtaining OAuth credentials. The process requires specifying either the `chat.users.readstate` or `chat.users.readstate.readonly` authorization scope, then calling `GetThreadReadState()` with the thread read state's `name`, including a user ID/alias and space ID. The method returns a `ThreadReadState` instance.\n"],null,["# Get details about a user's thread read state\n\nThis guide explains how to use the\n[`get()`](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.ChatService.GetThreadReadState)\nmethod on the `ThreadReadState` resource of the Google Chat API to get details\nabout a user's read state within a message thread. To get the read state of a\nmessage in a space, see\n[Get details about a user's space read state](/workspace/chat/get-space-read-state).\n\nThe\n[`ThreadReadState` resource](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.ThreadReadState)\nis a singleton resource that represents details about a\nspecified user's last read message in a Google Chat message thread.\n\nPrerequisites\n-------------\n\n\n### Node.js\n\n- A Business or Enterprise [Google Workspace](https://support.google.com/a/answer/6043576) account with access to [Google Chat](https://workspace.google.com/products/chat/).\n\n\u003c!-- --\u003e\n\n- Set up your environment:\n - [Create a Google Cloud project](/workspace/guides/create-project).\n - [Configure the OAuth consent screen](/workspace/guides/configure-oauth-consent).\n - [Enable and configure the Google Chat API](/workspace/chat/configure-chat-api) with a name, icon, and description for your Chat app.\n - Install the Node.js [Cloud Client Library](/workspace/chat/libraries?tab=nodejs#cloud-client-libraries).\n - [Create OAuth client ID credentials](/workspace/chat/authenticate-authorize-chat-user#step-2:) 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.\n\n For guidance, complete the steps for setting up your environment in this [quickstart](/workspace/chat/api/guides/quickstart/nodejs\n #set-up-environment).\n- [Choose an authorization scope](/workspace/chat/authenticate-authorize#asynchronous-chat-calls) that supports user authentication.\n\n\n| 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](/workspace/chat/api/reference).\n\n\u003cbr /\u003e\n\nGet the calling user's thread read state\n----------------------------------------\n\nTo get details about a user's read state within a message thread, include the\nfollowing in your request:\n\n- Specify the `chat.users.readstate` or `chat.users.readstate.readonly` authorization scope.\n- Call the [`GetThreadReadState()`](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.ChatService.GetThreadReadState) method, passing the `name` of the thread read state to get which includes a user ID or alias and a space ID. Getting thread read state only supports getting the read state of the calling user, which can be specified by setting one of the following:\n - The `me` alias. For example, `users/me/spaces/`\u003cvar translate=\"no\"\u003eSPACE\u003c/var\u003e`/threads/`\u003cvar translate=\"no\"\u003eTHREAD\u003c/var\u003e`/threadReadState`.\n - The calling user's Workspace email address. For example, `users/user@example.com/spaces/`\u003cvar translate=\"no\"\u003eSPACE\u003c/var\u003e`/threads/`\u003cvar translate=\"no\"\u003eTHREAD\u003c/var\u003e`/threadReadState`.\n - The calling user's user ID. For example, `users/`\u003cvar translate=\"no\"\u003eUSER\u003c/var\u003e`/spaces/`\u003cvar translate=\"no\"\u003eSPACE\u003c/var\u003e`/threads/`\u003cvar translate=\"no\"\u003eTHREAD\u003c/var\u003e`/threadReadState`.\n\nThe following example gets the calling user's thread read state: \n\n### Node.js\n\nchat/client-libraries/cloud/get-thread-read-state-user-cred.js \n[View on GitHub](https://github.com/googleworkspace/node-samples/blob/main/chat/client-libraries/cloud/get-thread-read-state-user-cred.js) \n\n```javascript\nimport {createClientWithUserCredentials} from './authentication-utils.js';\n\nconst USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.users.readstate.readonly'];\n\n// This sample shows how to get the thread read state for a space and calling user\nasync function main() {\n // Create a client\n const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);\n\n // Initialize request argument(s)\n const request = {\n // Replace SPACE_NAME and THREAD_NAME here\n name: 'users/me/spaces/SPACE_NAME/threads/THREAD_NAME/threadReadState'\n };\n\n // Make the request\n const response = await chatClient.getThreadReadState(request);\n\n // Handle the response\n console.log(response);\n}\n\nmain().catch(console.error);\n```\n\nTo run this sample, replace the following:\n\n- \u003cvar translate=\"no\"\u003eSPACE_NAME\u003c/var\u003e: the ID from the space's [`name`](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.Space.FIELDS.string.google.chat.v1.Space.name). You can obtain the ID by calling the [`ListSpaces()`](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.ChatService.ListSpaces) method or from the space's URL.\n- \u003cvar translate=\"no\"\u003eTHREAD_NAME\u003c/var\u003e: the ID from the thread's [`name`](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.Thread.FIELDS.string.google.chat.v1.Thread.name). You can obtain the ID from the response body returned after creating a message asynchronously with the Chat API, or with the [custom name](/workspace/chat/create-messages#name_a_created_message) assigned to the message at creation.\n\nThe Google Chat API gets the specified thread read state and returns\nan instance of\n[`ThreadReadState`](/workspace/chat/api/reference/rpc/google.chat.v1#google.chat.v1.ThreadReadState).\n\nRelated topics\n--------------\n\n- [Update the calling user's space read state](/workspace/chat/update-space-read-state).\n- [Get the calling user's space read state](/workspace/chat/get-space-read-state)."]]