Details zu einem Google Workspace-Abo

Auf dieser Seite wird erläutert, wie Sie Details zu einem Google Workspace-Abo mit der Methode subscriptions.get() abrufen.

Wenn du diese Methode mit Nutzerauthentifizierung aufrufst, gibt sie Details zu einem vom Nutzer autorisierten Abo zurück. Wenn Sie die App-Authentifizierung verwenden, kann die Methode Details zu jedem Abo für die App zurückgeben.

Vorbereitung

Apps Script

  • Ein Apps Script-Projekt:
    • Verwenden Sie Ihr Google Cloud-Projekt anstelle des automatisch von Apps Script erstellten Standardprojekts.
    • Alle Bereiche, die Sie zum Konfigurieren des OAuth-Zustimmungsbildschirms hinzugefügt haben, müssen Sie auch der Datei appsscript.json in Ihrem Apps Script-Projekt hinzufügen. Beispiel: 
      • "oauthScopes": [
  "https://www.googleapis.com/auth/chat.messages.readonly"
]
    • Aktivieren Sie den erweiterten Dienst Google Workspace Events.

Python

  • Python 3.6 oder höher
  • Das Paketverwaltungstool pip
  • Die neuesten 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 Workspace-Abo. Wie Sie ein Abo erstellen, erfahren Sie unter Abo erstellen.

  • Authentifizierung erforderlich:

    • Für die Nutzerauthentifizierung ist ein Umfang erforderlich, der mindestens einen der Ereignistypen für das Abo unterstützt. Informationen zum Identifizieren eines Gültigkeitsbereichs finden Sie unter Gültigkeitsbereich nach Ereignistyp.
    • Für die App-Authentifizierung ist der Bereich chat.bot erforderlich (nur Google Chat-Apps).

Von einem Nutzer autorisiertes Abo abrufen

Im folgenden Codebeispiel werden Details zu einer Subscription-Ressource mithilfe der Nutzerauthentifizierung abgerufen. Wenn du als Nutzer authentifiziert bist, gibt die Methode ein Abo zurück, das der Nutzer die App zum Erstellen autorisiert hat.

So autorisieren Sie ein Abo durch einen Nutzer:

Apps Script

  1. Erstellen Sie in Ihrem Apps Script-Projekt eine neue Scriptdatei mit dem Namen getSubscription und fügen Sie den folgenden Code hinzu:

    function getSubscription() {
  // The name of the subscription to get.
  const name = 'subscriptions/SUBSCRIPTION_ID';

  // Call the Workspace Events API using the advanced service.
  const subscription = WorkspaceEvents.Subscriptions.get(name);
  console.log(subscription);
}

    Ersetzen Sie Folgendes:

    • SUBSCRIPTION_ID: Die ID des Abos. Sie haben folgende Möglichkeiten, die ID abzurufen:
      • Der Wert des Felds uid.
      • Die ID des Ressourcennamens, der im Feld name dargestellt ist. Wenn der Ressourcenname beispielsweise subscriptions/subscription-123 lautet, verwenden Sie subscription-123.

  2. Um das Abo abzurufen, führen Sie die Funktion getSubscription in Ihrem Apps Script-Projekt aus.

Python

  1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen get_subscription.py und fügen Sie den folgenden Code hinzu:

    """Get subscription."""

from google_auth_oauthlib.flow import InstalledAppFlow
from googleapiclient.discovery import build

# Specify required scopes.
SCOPES = ['SCOPE']

# Authenticate with Google Workspace and get user authentication.
flow = InstalledAppFlow.from_client_secrets_file('client_secrets.json', SCOPES)
CREDENTIALS = flow.run_local_server()

# Call the Workspace Events API using the service endpoint.
service = build(
    'workspaceevents',
    'v1',
    credentials=CREDENTIALS,
)

NAME = 'subscriptions/SUBSCRIPTION_ID'
subscription = service.subscriptions().get(name=NAME).execute()
print(subscription)

    Ersetzen Sie Folgendes:

    • SCOPE: Ein OAuth-Bereich, der mindestens einen Ereignistyp aus dem Abo unterstützt. Wenn Ihr Abo beispielsweise Ereignisse für einen aktualisierten Chatbereich erhält, https://www.googleapis.com/auth/chat.spaces.readonly.
    • SUBSCRIPTION_ID: Die ID des Abos. Sie haben folgende Möglichkeiten, die ID abzurufen:
      • Der Wert des Felds uid.
      • Die ID des Ressourcennamens, der im Feld name dargestellt ist. Wenn der Ressourcenname beispielsweise subscriptions/subscription-123 lautet, verwenden Sie subscription-123.

  2. Achten Sie darauf, dass Sie Ihre Anmeldedaten für die OAuth-Client-ID in Ihrem Arbeitsverzeichnis gespeichert und die Datei client_secrets.json genannt haben. Im Codebeispiel wird diese JSON-Datei verwendet, um sich bei Google Workspace zu authentifizieren und Nutzeranmeldedaten abzurufen. Eine Anleitung dazu finden Sie unter Anmeldedaten mit OAuth-Client-ID erstellen.

  3. Führen Sie im Terminal den folgenden Befehl aus, um das Abo abzurufen:

    python3 get_subscription.py