Se usó la API de Cloud Translation para traducir esta página.

Actualiza el estado de lectura del espacio de un usuario

En esta guía, se explica cómo usar el método updateSpaceReadState en el recurso SpaceReadState de la API de Google Chat para marcar espacios como leídos o no leídos.

El recurso SpaceReadState es un recurso singleton que representa detalles sobre el último mensaje leído de un usuario específico en un espacio 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 Python. Para instalarlos o actualizarlos, ejecuta el siguiente comando en tu interfaz de línea de comandos:
```
pip3 install --upgrade google-api-python-client google-auth-oauthlib
```
Un proyecto de Google Cloud con la API de Google Chat habilitada y configurada Para conocer los pasos, consulta Compila una app de Google Chat.
Autorización configurada para la app de Chat. Para obtener detalles sobre el estado de lectura de un usuario en un espacio, se requiere autenticación de usuario con el permiso de autorización chat.users.readstate.

Node.js

Node.js y npm
Las bibliotecas cliente de Google más recientes para Node.js. Para instalarlos, ejecuta el siguiente comando en tu interfaz de línea de comandos:
```
npm install @google-cloud/local-auth @googleapis/chat
```
Un proyecto de Google Cloud con la API de Google Chat habilitada y configurada Para conocer los pasos, consulta Compila una app de Google Chat.
Autorización configurada para la app de Chat. Para obtener detalles sobre el estado de lectura de un usuario en un espacio, se requiere autenticación de usuario con el permiso de autorización chat.users.readstate.

Apps Script

Una cuenta de Google Workspace con acceso a Google Chat
Una app de Chat publicada. Para compilar una app de Chat, sigue esta quickstart.
Autorización configurada para la app de Chat. Para obtener detalles sobre el estado de lectura de un usuario en un espacio, se requiere autenticación de usuario con el permiso de autorización chat.users.readstate.

Actualiza el estado de lectura del espacio del usuario que realiza la llamada

Para actualizar el estado de lectura de un usuario dentro de un espacio, incluye lo siguiente en la solicitud:

Especifica el alcance de la autorización de chat.users.readstate.
Llama al método updateSpaceReadState en el recurso SpaceReadState.
Pasa el name del estado de lectura del espacio que deseas obtener, que incluye un ID o alias de usuario y un ID de espacio. La obtención del estado de lectura del espacio solo admite obtener el estado de lectura del usuario que llama, que se puede especificar configurando una de las siguientes opciones:
- El alias me. Por ejemplo, users/me/spaces/SPACE/spaceReadState
- Dirección de correo electrónico de Workspace del usuario que llama. Por ejemplo, users/user@example.com/spaces/SPACE/spaceReadState.
- El ID de usuario del usuario que realiza la llamada Por ejemplo, users/USER/spaces/SPACE/spaceReadState.
Pasa updateMask, que especifica los aspectos del estado de lectura del espacio que se actualizará y que admite las siguientes rutas de campo:
- lastReadTime: Es la hora en que se actualizó el estado de lectura del espacio del usuario. Por lo general, esto corresponde a la marca de tiempo del último mensaje leído o a una marca de tiempo que especifica el usuario para marcar la última posición de lectura en un espacio. Cuando lastReadTime es anterior a la última hora de creación del mensaje, el espacio aparece como no leído en la IU. Para marcar el espacio como leído, configura lastReadTime en cualquier valor posterior (más grande) que la hora de creación del mensaje más reciente. El elemento lastReadTime se fuerza para que coincida con la hora de creación del mensaje más reciente. Ten en cuenta que el estado de lectura del espacio solo afecta el estado de lectura de los mensajes visibles en la conversación de nivel superior del espacio. Las respuestas en las conversaciones no se ven afectadas por esta marca de tiempo y, en su lugar, dependen del estado de lectura de la conversación.

En el siguiente ejemplo, se actualiza el estado de lectura del espacio del usuario que realiza la llamada:

Python

En el directorio de trabajo, crea un archivo llamado chat_spaceReadState_update.py.

Incluye el siguiente código en chat_spaceReadState_update.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"]

def main():
    '''
    Authenticates with Chat API via user credentials,
    then updates the space 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().updateSpaceReadState(

        # The space read state to update.
        #
        # 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/spaceReadState',
        updateMask='lastReadTime',
        body={'lastReadTime': f'{datetime.datetime(2000, 1, 3).isoformat()}Z'}

      ).execute()

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

if __name__ == '__main__':
    main()

En el código, reemplaza lo siguiente:
- SPACE: Es un nombre de espacio, que puedes obtener del método spaces.list en la API de Chat, o bien desde la URL de un espacio.
En el directorio de trabajo, compila y ejecuta la muestra:
```
python3 chat_spaceReadState_update.py
```

Node.js

En el directorio de trabajo, crea un archivo llamado chat_spaceReadState_update.js.

Incluye el siguiente código en chat_spaceReadState_update:

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

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

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

  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.updateSpaceReadState({

    /**
    * The space read state to update.
    *
    * 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/spaceReadState',
    updateMask: 'lastReadTime',
    requestBody: {
      lastReadTime: '{datetime.datetime(2000, 1, 3).isoformat()}Z'
    }
  });
}

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

En el código, reemplaza lo siguiente:
- SPACE: Es un nombre de espacio, que puedes obtener del método spaces.list en la API de Chat, o bien desde la URL de un espacio.
En el directorio de trabajo, compila y ejecuta la muestra:
```
node chat_spaceReadState_update.js
```

Apps Script

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

Agrega el alcance de autorización chat.users.readstate al archivo appsscript.json del proyecto de Apps Script:
```
"oauthScopes": [
  "https://www.googleapis.com/auth/chat.users.readstate"
]
```

Agrega una función como esta al código del proyecto de Apps Script:

/**
* Authenticates with Chat API via user credentials,
* then updates the space read state for the calling user.
* @param {string} spaceReadStateName The resource name of the space read state.
*/
function updateSpaceReadState(spaceReadStateName) {
  try {
    const time = new Date('January 1, 2000')).toJSON();
    const body = {'lastReadTime': time};
    Chat.Users.Spaces.updateSpaceReadState(spaceReadStateName, body);
  } catch (err) {
    // TODO (developer) - Handle exception
    console.log('Failed to update read state with error %s', err.message);
  }
}

La API de Google Chat actualiza el estado de lectura del espacio especificado y muestra una instancia del recurso SpaceReadState.

Actualiza el estado de lectura del espacio de un usuario

Requisitos previos

Python

Node.js

Apps Script

Actualiza el estado de lectura del espacio del usuario que realiza la llamada

Python

Node.js

Apps Script

Temas relacionados