Répertorier les événements d'un espace Google Chat

Ce guide explique comment utiliser la méthode list() sur la ressource SpaceEvent de l'API Google Chat pour lister les modifications apportées aux ressources d'un espace.

La ressource SpaceEvent représente une modification apportée à l'espace cible, y compris aux ressources enfants de l'espace, telles que les messages, les réactions et les membres. Pour en savoir plus sur la liste des types d'événements et des charges utiles d'événements compatibles, consultez les champs eventType et payload de la documentation de référence sur les ressources SpaceEvent.

Vous pouvez lister les événements jusqu'à 28 jours avant la date de la demande. Le serveur renvoie les événements qui contiennent la version la plus récente de la ressource concernée. Par exemple, si vous listez des événements concernant de nouveaux membres d'un espace, le serveur renvoie des ressources Membership contenant les dernières informations sur les membres. Si de nouveaux membres ont été supprimés au cours de la période demandée, la charge utile de l'événement contient une ressource Membership vide.

Pour appeler cette méthode, vous devez utiliser l'authentification de l'utilisateur. Pour lister les événements d'un espace, l'utilisateur authentifié doit en être membre.

Prérequis

Lister les événements d'un espace

Pour lister les événements d'un espace Chat, transmettez les informations suivantes dans votre requête :

• Spécifiez un ou plusieurs champs d'application d'autorisation pour prendre en charge chaque type d'événement dans votre requête. Il est recommandé de choisir le champ d'application le plus restrictif qui permet à votre application de fonctionner. Pour choisir un champ d'application, consultez la présentation de l'authentification et de l'autorisation.

• Appelez la méthode ListSpaceEvents() en transmettant le filter des types d'événements à lister. Vous devez spécifier au moins un type d'événement. Vous pouvez également filtrer par date. Pour obtenir la liste des types d'événements acceptés, consultez le champ eventType de la documentation de référence sur la ressource SpaceEvent.

L'exemple suivant liste les événements concernant les nouveaux membres et les messages dans un espace :

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

// Authorization scopes based on the event types
const USER_AUTH_OAUTH_SCOPES = [
  'https://www.googleapis.com/auth/chat.memberships.readonly',
  'https://www.googleapis.com/auth/chat.messages.readonly'
];

// This sample shows how to list space events 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 here
    parent: 'spaces/SPACE_NAME',
    // A required filter. Filters events about new memberships and messages
    filter: 'eventTypes:"google.workspace.chat.membership.v1.created" OR eventTypes:"google.workspace.chat.message.v1.created"'
  };

  // Make the request
  const pageResult = chatClient.listSpaceEventsAsync(request);

  // Handle the response. Iterating over pageResult will yield results and
  // resolve additional pages automatically.
  for await (const response of pageResult) {
    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 Chat renvoie une liste paginée des événements d'un espace concernant les nouveaux membres et les nouveaux messages.

Articles associés

• Travailler avec des événements depuis Google Chat
• Obtenir des informations sur un événement dans un espace