Obtenir des informations sur l'état de lecture d'un espace utilisateur

Ce guide explique comment utiliser la méthode getSpaceReadState sur le Ressource SpaceReadState de l'API Google Chat pour obtenir les détails de la lecture d'un utilisateur dans un espace. Pour obtenir l'état de lecture d'un message dans une conversation, voir Obtenez des informations sur l'état de lecture d'un fil de discussion d'un utilisateur.

La Ressource SpaceReadState est une ressource singleton qui représente les détails d'une le dernier message lu par l'utilisateur spécifié dans un espace Google Chat.

Prérequis

Python

  • Python 3.6 ou version ultérieure
  • L'outil de gestion de packages pip
  • Les dernières bibliothèques clientes Google Pour les installer ou les mettre à jour, exécutez la commande suivante dans votre interface de ligne de commande: 
    pip3 install --upgrade google-api-python-client google-auth-oauthlib

Node.js

  • Node.js 14 ou version ultérieure
  • La commande npm outil de gestion des paquets
  • Les dernières bibliothèques clientes Google Pour les installer ou les mettre à jour, exécutez la commande suivante dans votre interface de ligne de commande: 
    npm install @google-cloud/local-auth @googleapis/chat

Apps Script ;

Obtenir l'état de lecture de l'espace de l'utilisateur appelant

Pour obtenir des informations sur l'état de lecture d'un utilisateur dans un espace, incluez les éléments suivants : dans votre demande:

  • Spécifiez chat.users.readstate ou chat.users.readstate.readonly. le champ d'application de l'autorisation.
  • Appelez la méthode Méthode getSpaceReadState le Ressource SpaceReadState.
  • Transmettez le name de l'état de lecture de l'espace à obtenir, qui inclut un ID utilisateur ou un alias et un identifiant d'espace. L'obtention de l'état de lecture de l'espace ne permet d'obtenir que la lecture l'état de l'utilisateur appelant, qui peut être spécifié en définissant l'une des suivantes:
    • L'alias me. Exemple : users/me/spaces/SPACE/spaceReadState.
    • Adresse e-mail Workspace de l'utilisateur appelant. Par exemple : users/user@example.com/spaces/SPACE/spaceReadState.
    • ID utilisateur de l'utilisateur appelant. Par exemple : users/USER/spaces/SPACE/spaceReadState.

L'exemple suivant récupère l'état de lecture de l'espace de l'utilisateur appelant:

Python

  1. Dans votre répertoire de travail, créez un fichier nommé chat_spaceReadState_get.py

  2. Ajoutez le code suivant dans chat_spaceReadState_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 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().getSpaceReadState(

        # The space 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/spaceReadState'

      ).execute()

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

if __name__ == '__main__':
    main()

  3. Dans le code, remplacez les éléments suivants:

    • SPACE: un nom d'espace, qui que vous pouvez obtenir Méthode spaces.list dans l'API Chat ou depuis l'URL d'un espace.

  4. Dans votre répertoire de travail, créez et exécutez l'exemple:

    python3 chat_spaceReadState_get.py

Node.js

  1. Dans votre répertoire de travail, créez un fichier nommé chat_spaceReadState_get.js

  2. Ajoutez le code suivant dans chat_spaceReadState_get:

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

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

  /**
  * 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.getSpaceReadState({

    /**
    * The space 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/spaceReadState'
  });
}

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

  3. Dans le code, remplacez les éléments suivants:

    • SPACE: un nom d'espace, qui que vous pouvez obtenir Méthode spaces.list dans l'API Chat ou depuis l'URL d'un espace.

  4. Dans votre répertoire de travail, créez et exécutez l'exemple:

    node chat_spaceReadState_get.js

Apps Script ;

Cet exemple appelle l'API Chat à l'aide de la méthode Service de chat avancé.

  1. Ajoutez le niveau d'autorisation chat.users.readstate.readonly au Fichier appsscript.json du projet Apps Script:

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

  2. Ajoutez une fonction comme celle-ci au fichier code:

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

L'API Google Chat obtient l'état de lecture des espaces spécifié et renvoie une instance de Ressource SpaceReadState.