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

Ce guide explique comment utiliser le Méthode get activée le SpaceEvent la ressource de API Google Chat pour obtenir des informations sur un événement dans un espace Google Chat.

La ressource SpaceEvent représente une modification apportée à un espace ou à son enfant les ressources comme les messages, les réactions et les abonnements. Pour apprendre sur les types d'événements compatibles, consultez le champ eventType de la Ressource SpaceEvent documentation de référence.

Vous pouvez demander des événements jusqu'à 28 jours avant l'heure 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 pour un nouveau message, mais que celui-ci a été mis à jour par la suite, le Le serveur renvoie la ressource Message mise à jour dans la charge utile de l'événement.

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

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

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

Pour obtenir des informations sur une SpaceEvent dans Google Chat, procédez comme suit:

  • Appelez la méthode get. le SpaceEvent ressource.
  • Transmettez le name de SpaceEvent pour obtenir. Obtenir le nom SpaceEvent à partir de SpaceEvent ressource de Google Chat.
  • Avec utilisateur authentication, spécifiez un champ d'application d'autorisation compatible avec le type d'événement de votre requête. En tant que bonne pratique, choisissez le champ d'application le plus restrictif qui autorise toujours votre application pour qu'elles fonctionnent.

Voici comment obtenir un SpaceEvent avec authentification des utilisateurs:

Python

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

  2. Ajoutez le code suivant dans chat_space_event_get.py:

    """Gets a SpaceEvent resource from the Chat API."""

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 = ['SCOPE']

# 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.spaces()
    .spaceEvents()
    .get(
        # The space event to get.
        #
        # Replace SPACE with a space name.
        # Obtain the space name from the spaces resource of Chat API,
        # or from a space's URL.
        #
        # Replace SPACE_EVENT with a SpaceEvent name.
        # Obtain the spaceEvent name from the SpaceEvent resource of
        # Chat API.
        name='spaces/SPACE/spaceEvents/SPACE_EVENT'
    )
    .execute()
)

# Prints details about the created spaceEvent.
print(result)

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

    • SCOPE: un champ d'application d'autorisation basé sur le type d'événement. Par exemple, si vous recevez un événement d'espace sur un nouvel abonnement, 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 spaces.spaceEvents.list. Pour savoir comment utiliser cette méthode, consultez Lister les événements d'un espace
    • SPACE: nom d'espace, que vous pouvez obtenir à partir de la méthode spaces.list. dans l'API Chat ou depuis l'URL d'un espace.
    • SPACE_EVENT: nom de l'espace que vous pouvez obtenir à partir de Méthode spaces.spaceEvents.list.

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

    python3 chat_space_event_get.py

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