Details zu einem Termin in einem Google Chat-Bereich abrufen

In diesem Leitfaden wird erläutert, wie Sie mit der Methode get für die Ressource SpaceEvent der Google Chat API Details zu einem Ereignis aus einem Google Chat-Bereich abrufen können.

Die Ressource SpaceEvent stellt eine Änderung an einem Gruppenbereich oder seinen untergeordneten Ressourcen wie Nachrichten, Reaktionen und Mitgliedschaften dar. Informationen zu den unterstützten Ereignistypen finden Sie in der Referenzdokumentation zur SpaceEvent-Ressource im Feld eventType.

Sie können Ereignisse bis zu 28 Tage vor dem Zeitpunkt der Anfrage anfordern. Das Ereignis enthält die neueste Version der Ressource, die geändert wurde. Wenn Sie beispielsweise ein Ereignis zu einer neuen Nachricht anfordern, die Nachricht aber später aktualisiert wurde, gibt der Server die aktualisierte Message-Ressource in der Ereignisnutzlast zurück.

Für den Aufruf dieser Methode muss die Nutzerauthentifizierung verwendet werden. Um ein Ereignis abzurufen, muss der authentifizierte Nutzer Mitglied des Bereichs sein, in dem das Ereignis aufgetreten ist.

Voraussetzungen

Python

  • Python 3.6 oder höher
  • Das Paketverwaltungstool pip

  • Die aktuellen Google-Clientbibliotheken für Python. Führen Sie den folgenden Befehl in der Befehlszeile aus, um sie zu installieren oder zu aktualisieren:

    pip3 install --upgrade google-api-python-client google-auth-oauthlib
  • Ein Google Cloud-Projekt, in dem die Google Chat API aktiviert und konfiguriert ist. Eine entsprechende Anleitung finden Sie unter Google Chat-App erstellen.

  • Für die Chat-App konfigurierte Autorisierung. Für ein Gruppenbereichsereignis ist eine Nutzerauthentifizierung mit einem Bereich erforderlich, der den Ereignistyp unterstützt. Informationen zum Auswählen eines Bereichs finden Sie in der Authentifizierung und Autorisierung – Übersicht.

Details zu einem Gruppenbereich in einem Gruppenbereich abrufen

So rufen Sie Details zu SpaceEvent in Google Chat ab:

  • Rufen Sie die Methode get für die Ressource SpaceEvent auf.
  • Übergeben Sie den name von SpaceEvent, um zu erhalten. Rufen Sie den Namen SpaceEvent aus der Ressource SpaceEvent von Google Chat ab.
  • Geben Sie für die Nutzerauthentifizierung einen Autorisierungsbereich an, der den Ereignistyp in Ihrer Anfrage unterstützt. Wählen Sie als Best Practice den restriktivsten Bereich aus, bei dem Ihre Anwendung noch funktioniert.

So rufen Sie ein SpaceEvent mit der Nutzerauthentifizierung ab:

Python

  1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen chat_space_event_get.py.

  2. Fügen Sie den folgenden Code in chat_space_event_get.py ein:

    """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. Ersetzen Sie im Code Folgendes:

    • SCOPE: Ein Autorisierungsbereich, der auf dem Ereignistyp basiert. Wenn Sie beispielsweise ein Gruppenbereichsereignis zu einer neuen Mitgliedschaft erhalten, verwenden Sie den Bereich chat.memberships.readonly im Format https://www.googleapis.com/auth/chat.memberships.readonly. Sie können den Ereignistyp über die Methode spaces.spaceEvents.list abrufen. Informationen zur Verwendung dieser Methode finden Sie unter Ereignisse aus einem Gruppenbereich auflisten.
    • SPACE: Der Name eines Gruppenbereichs, den Sie über die Methode spaces.list in der Chat API oder aus der URL eines Gruppenbereichs abrufen können.
    • SPACE_EVENT: Der Name des Gruppenbereichsereignisses, den Sie über die Methode spaces.spaceEvents.list abrufen können.

  4. Erstellen Sie das Beispiel in Ihrem Arbeitsverzeichnis und führen Sie es aus:

    python3 chat_space_event_get.py

Die Chat API gibt eine Instanz von SpaceEvent mit Details zum Ereignis zurück.