Obtén detalles sobre el estado de lectura de la conversación de un usuario

En esta guía, se explica cómo usar el método getThreadReadState en el El recurso ThreadReadState de la API de Google Chat para obtener detalles sobre el lee el estado dentro de una cadena de mensajes. Para obtener el estado de lectura de un mensaje en una en el espacio, consulta Obtén detalles sobre el estado de lectura del espacio de un usuario.

El Recurso ThreadReadState es un recurso singleton que representa detalles sobre un el último mensaje leído del usuario especificado en una conversación de Google Chat.

Requisitos previos

Python

  • Python 3.6 o superior
  • La herramienta de administración de paquetes pip
  • Las bibliotecas cliente de Google más recientes. Para instalarlas o actualizarlas, Ejecuta el siguiente comando en tu interfaz de línea de comandos: 
    pip3 install --upgrade google-api-python-client google-auth-oauthlib

Node.js

  • Node.js 14 o versiones posteriores
  • La herramienta npm herramienta de administración de paquetes
  • Las bibliotecas cliente de Google más recientes. Para instalarlas o actualizarlas, Ejecuta el siguiente comando en tu interfaz de línea de comandos: 
    npm install @google-cloud/local-auth @googleapis/chat

Apps Script

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 dentro de una conversación, incluye el siguiente en tu solicitud:

  • Especifica el chat.users.readstate o la chat.users.readstate.readonly. el permiso de la autorización.
  • Llama al Método getThreadReadState en la Recurso ThreadReadState.
  • Pasa el name del estado de lectura del subproceso a obtener, que incluye un ID de usuario o alias y un ID de espacio. Obtener el estado de lectura de subprocesos solo admite la obtención del estado de lectura estado del usuario que realiza la llamada, que se puede especificar configurando uno de los lo siguiente:
    • El alias me. Por ejemplo, users/me/spaces/SPACE/threads/THREAD/threadReadState
    • La dirección de correo electrónico de Workspace del usuario que llama. Por ejemplo, users/user@example.com/spaces/SPACEthreads/THREAD/threadReadState.
    • El ID de usuario del usuario que llama. 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:

Python

  1. En tu directorio de trabajo, crea un archivo llamado chat_threadReadState_get.py

  2. Incluye el siguiente código en chat_threadReadState_get.py:

    from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Define your app's authorization scopes.
# When modifying these scopes, delete the file token.json, if it exists.
SCOPES = ["https://www.googleapis.com/auth/chat.users.readstate.readonly"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then gets the thread read state for the calling user.
    '''

    # Authenticate with Google Workspace
    # and get user authorization.
    flow = InstalledAppFlow.from_client_secrets_file(
                      'client_secrets.json', SCOPES)
    creds = flow.run_local_server()

    # Build a service endpoint for Chat API.
    chat = build('chat', 'v1', credentials=creds)

    # Use the service endpoint to call Chat API.
    result = chat.users().spaces().threads().getThreadReadState(

        # The thread read state to get.
        #
        # Replace USER with the calling user's ID, Workspace email,
        # or the alias me.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        #
        # Replace THREAD with a thread name.
        # Obtain the thread name from the messages resource of Chat API.
        name='users/me/spaces/SPACE/threads/THREAD/threadReadState'

      ).execute()

    # Prints the API's response.
    print(result)

if __name__ == '__main__':
    main()

  3. En el código, reemplaza lo siguiente:

    • SPACE: Es un nombre de espacio, que que puedes obtener de la Método spaces.list en la API de Chat o desde la URL de un espacio.

    • THREAD: Es un nombre de subproceso, que que puedes obtener de la Método spaces.messages.get en la API de Chat.

  4. En tu directorio de trabajo, compila y ejecuta la muestra:

    python3 chat_threadReadState_get.py

Node.js

  1. En tu directorio de trabajo, crea un archivo llamado chat_threadReadState_get.js

  2. Incluye el siguiente código en chat_threadReadState_get:

    const chat = require('@googleapis/chat');
const {authenticate} = require('@google-cloud/local-auth');

/**
* Authenticates with Chat API via user credentials,
* then gets the thread read state for the calling user.
* @return {!Promise<!Object>}
*/
async function getThreadReadState() {

  /**
  * Authenticate with Google Workspace
  * and get user authorization.
  */
  const scopes = [
    'https://www.googleapis.com/auth/chat.users.readstate.readonly',
  ];

  const authClient =
      await authenticate({scopes, keyfilePath: 'client_secrets.json'});

  /**
  * Build a service endpoint for Chat API.
  */
  const chatClient = await chat.chat({version: 'v1', auth: authClient});

  /**
  * Use the service endpoint to call Chat API.
  */
  return await chatClient.users.spaces.threads.getThreadReadState({

    /**
    * The thread read state to get.
    *
    * Replace USER with the calling user's ID, Workspace email,
    * or the alias me.
    *
    * Replace SPACE with a space name.
    * Obtain the space name from the spaces resource of Chat API,
    * or from a space's URL.
    */
    name: 'users/me/spaces/SPACE/threads/THREADS/threadReadState'
  });
}

/**
* Use the service endpoint to call Chat API.
*/
getThreadReadState().then(console.log);

  3. En el código, reemplaza lo siguiente:

    • SPACE: Es un nombre de espacio, que que puedes obtener de la Método spaces.list en la API de Chat o desde la URL de un espacio.

    • THREAD: Es un nombre de subproceso, que que puedes obtener de la Método spaces.messages.get en la API de Chat.

  4. En tu directorio de trabajo, compila y ejecuta la muestra:

    node chat_threadReadState_get.js

Apps Script

En este ejemplo, se llama a la API de Chat con el Servicio de chat avanzado.

  1. Agrega el permiso de autorización chat.users.readstate.readonly al Archivo appsscript.json del proyecto de Apps Script:

    "oauthScopes": [
  "https://www.googleapis.com/auth/chat.users.readstate.readonly"
]

  2. Agrega una función como esta al conjunto de datos código:

    /**
* Authenticates with Chat API via user credentials,
* then gets the thread read state for the calling user.
* @param {string} threadReadStateName The resource name of the thread read state.
*/
function getThreadReadState(threadReadStateName) {
  try {
    Chat.Users.Spaces.Threads.getThreadReadState(threadReadStateName);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to get read state with error %s', err.message);
  }
}

La API de Google Chat obtiene el estado de lectura de conversación especificado y muestra una instancia de Recurso ThreadReadState.