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 d'un espace Google Chat.

La ressource SpaceEvent représente une modification apportée à un espace ou à ses ressources enfants, comme les messages, les réactions et les membres. Pour en savoir plus sur les types d'événements acceptés, 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é modifié par la suite, 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 de l'utilisateur. Pour obtenir un événement, l'utilisateur authentifié doit être membre de l'espace dans lequel l'événement s'est produit.

Prérequis

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

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

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

L'exemple suivant permet d'obtenir un événement d'espace :

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 de l'autorisation basé sur le type d'événement. Par exemple, si vous recevez un événement d'espace concernant un nouveau membre, utilisez le champ d'application chat.memberships.readonly, au format https://www.googleapis.com/auth/chat.memberships.readonly. Vous pouvez obtenir le type d'événement à partir de la méthode ListSpaceEvents(). Pour savoir comment utiliser cette méthode, consultez 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 de l'espace. Vous pouvez obtenir l'ID à partir de la méthode ListSpaceEvents(). Pour savoir comment utiliser cette méthode, consultez 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

• Travailler avec des événements depuis Google Chat
• Lister les événements d'un espace Google Chat