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

Ce guide explique comment utiliser la méthode get() sur la ressource SpaceReadState de l'API Google Chat pour obtenir des informations sur l'état de lecture d'un utilisateur dans un espace. Pour obtenir l'état de lecture d'un message dans un fil de discussion, consultez Obtenir 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 du dernier message lu par un utilisateur spécifié dans un espace Google Chat.

Prérequis

Node.js

• Compte Google Workspace Business ou Enterprise ayant accès à Google Chat.

• Configurez votre environnement :
  • Créez un projet Google Cloud.
  • Configurez l'écran de consentement OAuth.
  • Activez et configurez l'API Google Chat avec un nom, une icône et une description pour votre application Chat.
  • Installez la bibliothèque cliente Cloud Node.js.
  • Créez des identifiants d'ID client OAuth pour une application de bureau. Pour exécuter l'exemple de ce guide, enregistrez les identifiants dans un fichier JSON nommé client_secrets.json dans votre répertoire local.
  Pour obtenir des conseils, suivez la procédure de configuration de votre environnement dans ce guide de démarrage rapide.
• Choisissez une portée d'autorisation compatible avec l'authentification des utilisateurs.

Les exemples de code de cette page utilisent l'interface API gRPC avec les bibliothèques clientes Google Cloud. Vous pouvez également utiliser l'interface de l'API REST. Pour en savoir plus sur les interfaces gRPC et REST, consultez la présentation de l'API Google Chat.

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 requête:

• Spécifiez le champ d'application d'autorisation chat.users.readstate ou chat.users.readstate.readonly.
• Appelez la méthode GetSpaceReadState() en transmettant l'name de l'état de lecture de l'espace à obtenir, qui comprend un ID utilisateur ou un alias et un ID d'espace. L'obtention de l'état de lecture de l'espace n'est compatible qu'avec l'état de lecture de l'utilisateur appelant, qui peut être spécifié en définissant l'un des éléments suivants :
  • Alias me. Exemple : users/me/spaces/SPACE/spaceReadState.
  • Adresse e-mail Workspace de l'utilisateur appelant. Par exemple : users/[e-mail]/spaces/SPACE/spaceReadState.
  • ID utilisateur de l'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:

Node.js

chat/client-libraries/cloud/get-space-read-state-user-cred.js

Afficher sur GitHub

import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.users.readstate.readonly'];

// This sample shows how to get the space read state for the calling user
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here
    name: 'users/me/spaces/SPACE_NAME/spaceReadState'
  };

  // Make the request
  const response = await chatClient.getSpaceReadState(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

Pour exécuter cet exemple, remplacez SPACE_NAME par l'ID de l'name de l'espace. Vous pouvez obtenir l'ID en appelant la méthode ListSpaces() ou à partir de l'URL de l'espace.

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

Articles associés

• Mettez à jour l'état de lecture de l'espace de l'utilisateur appelant.
• Obtenir l'état de lecture du thread de l'utilisateur appelant