Obtenir des informations sur un événement d'un espace Google Chat

Ce guide explique comment utiliser la méthode get() sur la ressource SpaceEvent de l'API Google Chat pour obtenir des informations sur un événement à partir d'un espace Google Chat.

La ressource SpaceEvent représente une modification apportée à un espace ou à ses ressources enfants, telles que les messages, les réactions et les adhésions. Pour en savoir plus sur les types d'événements compatibles, consultez le champ eventType de la documentation de référence sur la ressource SpaceEvent.

Vous pouvez demander des événements jusqu'à 28 jours avant la date de la demande. L'événement contient la version la plus récente de la ressource qui a été modifiée. Par exemple, si vous demandez un événement concernant un nouveau message, mais que le message a été mis à jour ultérieurement, le serveur renvoie la ressource Message mise à jour dans la charge utile de l'événement.

Pour appeler cette méthode, vous devez utiliser l'authentification des utilisateurs. Pour obtenir un événement, l'utilisateur authentifié doit être membre de l'espace où l'événement s'est produit.

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 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 un niveau d'autorisation compatible avec l'authentification des utilisateurs.

Les exemples de code de cette page utilisent l'interface de l'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 des informations sur un événement dans un espace

Pour obtenir des informations sur un événement dans un espace dans Google Chat, transmettez les éléments suivants dans votre requête:

• Spécifiez un champ d'application de l'autorisation compatible avec le type d'événement dans votre requête. Nous vous recommandons de choisir le champ d'application le plus restrictif qui permet toujours à votre application de fonctionner.
• Appelez la méthode GetSpaceEvent(), en transmettant le name de l'événement d'espace à obtenir.

L'exemple suivant récupère un événement d'espace:

Node.js

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

Afficher sur GitHub

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

// Replace SCOPE_NAME here with an authorization scope based on the event type
const USER_AUTH_OAUTH_SCOPES = ['SCOPE_NAME'];

// This sample shows how to get space event with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME and SPACE_EVENT_NAME here
    name: 'spaces/SPACE_NAME/spaceEvents/SPACE_EVENT_NAME'
  };

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

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

main().catch(console.error);

Pour exécuter cet exemple, remplacez les éléments suivants:

• SCOPE_NAME: champ d'application d'autorisation en fonction du type d'événement. Par exemple, si vous recevez un événement d'espace concernant un nouvel abonnement, utilisez la portée chat.memberships.readonly, au format https://www.googleapis.com/auth/chat.memberships.readonly. Vous pouvez obtenir le type d'événement à l'aide de la méthode ListSpaceEvents(). Pour savoir comment utiliser cette méthode, consultez la section Lister les événements d'un espace.
• SPACE_NAME: 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.
• SPACE_EVENT_NAME: ID de l'name de l'événement spatial. Vous pouvez obtenir l'ID à partir de la méthode ListSpaceEvents(). Pour savoir comment utiliser cette méthode, consultez la section Lister les événements d'un espace.

L'API Chat renvoie une instance de SpaceEvent avec des informations sur l'événement.

Articles associés

• Gérer les événements Google Chat
• Lister les événements d'un espace Google Chat