Actualiza el estado de lectura de la conversación de un usuario

En esta guía, se explica cómo usar el método update en el recurso ThreadReadState de la API de Google Chat para marcar las conversaciones de mensajes como leídas o no leídas.

El recurso ThreadReadState es un recurso singleton que representa detalles sobre el último mensaje leído de un usuario especificado en un hilo de mensajes de Google Chat.

Requisitos previos

Node.js

Python

Actualiza el estado de lectura de la conversación del usuario que llama.

Para actualizar el estado de lectura de un usuario en un hilo de mensajes, incluye lo siguiente en tu solicitud:

  • Especifica el permiso de autorización chat.users.readstate.
  • Realiza una llamada al método UpdateThreadReadState.
  • Pasa updateMask con el valor lastReadTime.
  • Pasa threadReadState como una instancia de ThreadReadState con lo siguiente:
    • El campo name se establece en el estado de lectura de la conversación que se actualizará, que incluye un ID o alias de usuario, un ID de espacio y un ID de conversación. La actualización del estado de lectura de la conversación solo admite la actualización del estado de lectura del usuario que realiza la llamada, que se puede especificar configurando una de las siguientes opciones:
      • Es el alias de 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.
      • Es el ID de usuario del usuario que realiza la llamada. Por ejemplo, users/USER/spaces/SPACE/threads/THREAD/threadReadState.
    • El campo lastReadTime se establece en la marca de tiempo que indica la última posición de lectura del usuario que realiza la llamada en el hilo, como la marca de tiempo del último mensaje leído o la hora actual:
      • Marcar como no leído: Establece lastReadTime en una marca de tiempo anterior a la hora de creación del mensaje más reciente del hilo. En Chat, el hilo aparece como no leído a partir de esa marca de tiempo, se actualizan las insignias de no leído, se muestra el hilo en negrita y aparece en la Página principal.
      • Marcar como leído: Establece lastReadTime en una marca de tiempo igual o posterior a la hora de creación del mensaje más reciente de la conversación. Si especificas una marca de tiempo futura, la API fuerza lastReadTime a la hora de la solicitud actual.
      • Marca de tiempo mínima: El campo lastReadTime debe ser igual o posterior al tiempo Unix (1970-01-01T00:00:00Z). Si configuras una marca de tiempo negativa (antes de 1970-01-01T00:00:00Z), se muestra un error INVALID_ARGUMENT (400).

En el siguiente ejemplo, se actualiza el estado de lectura de la conversación del usuario que llama:

Node.js

/**
 * This sample shows how to update the calling user's thread read state.
 *
 * It relies on the @google-apps/chat npm package.
 */
// Read the documentation for more details:
// https://developers.google.com/workspace/chat/api/reference/rest/v1/users.spaces.threads/updateThreadReadState

const {ChatServiceClient} = require('@google-apps/chat');
const {auth} = require('google-auth-library');

async function main() {
  // Create a client
  const chatClient = new ChatServiceClient({
    authClient: await auth.getClient({
      scopes: ['https://www.googleapis.com/auth/chat.users.readstate']
    })
  });

  // Initialize request arguments.
  const request = {
    threadReadState: {
      name: 'users/me/spaces/SPACE_NAME/threads/THREAD_NAME/threadReadState',
      lastReadTime: {
        seconds: Math.floor(Date.now() / 1000),
        nanos: 0
      }
    },
    updateMask: {
      paths: ['last_read_time']
    }
  };

  // Make the request
  const response = await chatClient.updateThreadReadState(request);
  console.log(response);
}

main().catch(console.error);

Python

"""
This sample shows how to update the calling user's thread read state.
"""
from google.apps import chat_v1
import google.auth
from google.protobuf import timestamp_pb2

# Read the documentation for more details:
# https://developers.google.com/workspace/chat/api/reference/rest/v1/users.spaces.threads/updateThreadReadState

def update_thread_read_state():
    # Authenticate with Chat API using user credentials.
    credentials, _ = google.auth.default(
        scopes=["https://www.googleapis.com/auth/chat.users.readstate"]
    )
    client = chat_v1.ChatServiceClient(credentials=credentials)

    # Set timestamp for last read time.
    now = timestamp_pb2.Timestamp()
    now.GetCurrentTime()

    thread_read_state = chat_v1.ThreadReadState(
        name="users/me/spaces/SPACE_NAME/threads/THREAD_NAME/threadReadState",
        last_read_time=now,
    )

    request = chat_v1.UpdateThreadReadStateRequest(
        thread_read_state=thread_read_state,
        update_mask={"paths": ["last_read_time"]},
    )

    response = client.update_thread_read_state(request=request)
    print(response)

if __name__ == "__main__":
    update_thread_read_state()

Para ejecutar este ejemplo, reemplaza lo siguiente:

  • SPACE_NAME: Es el ID del name del espacio. Puedes obtener el ID llamando al método ListSpaces o desde la URL del espacio.
  • THREAD_NAME: Es el ID del name de la conversación. Puedes obtener el ID del cuerpo de la respuesta que se devuelve 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 la creación.

La API de Chat actualiza el estado de lectura de la conversación especificada y devuelve una instancia de ThreadReadState.