Details zu einem Google Workspace-Abo

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

Wenn Sie diese Methode mit Nutzerauthentifizierung aufrufen, gibt die Methode Details zu einem vom Nutzer autorisierten Abo zurück. Wenn Sie die Anwendungsauthentifizierung verwenden, kann die Methode Details zu jedem Abo für die Anwendung zurückgeben.

Voraussetzungen

Apps Script

  • Ein Apps Script-Projekt:
    • Verwenden Sie Ihr Google Cloud-Projekt anstelle des von Apps Script automatisch erstellten Standardprojekts.
    • Für alle Bereiche, die Sie zum Konfigurieren des OAuth-Zustimmungsbildschirms hinzugefügt haben, müssen Sie die Bereiche 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 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 Workspace-Abo. Informationen zum Erstellen eines Abos findest du unter Abo erstellen.

  • Authentifizierung erforderlich:

    • Erfordert für die Nutzerauthentifizierung einen Bereich, der mindestens einen der Ereignistypen für das Abo unterstützt. Informationen zum Identifizieren von Bereichen finden Sie unter Bereiche nach Ereignistyp.
    • Für die App-Authentifizierung ist der Bereich chat.bot erforderlich (nur Google Chat-Apps).

Von einem Nutzer autorisiertes Abo erhalten

Im folgenden Codebeispiel werden Details zu einer Subscription-Ressource mithilfe der Nutzerauthentifizierung abgerufen. Nach der Authentifizierung als Nutzer gibt die Methode ein Abo zurück, für das der Nutzer die App autorisiert hat.

So erhalten Sie ein Abo, das von einem Nutzer autorisiert wurde:

Apps Script

  1. Erstellen Sie in Ihrem Apps Script-Projekt eine neue Skriptdatei 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. Zum Abrufen der ID haben Sie folgende Möglichkeiten:
      • Der Wert des Felds uid.
      • Die ID des Ressourcennamens, der im Feld name dargestellt wird. Lautet der Ressourcenname beispielsweise subscriptions/subscription-123, verwenden Sie subscription-123.

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

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. Beispiel: Wenn Ihr Abo Ereignisse in einem aktualisierten Chatbereich empfängt, https://www.googleapis.com/auth/chat.spaces.readonly.
    • SUBSCRIPTION_ID: Die ID des Abos. Zum Abrufen der ID haben Sie folgende Möglichkeiten:
      • Der Wert des Felds uid.
      • Die ID des Ressourcennamens, der im Feld name dargestellt wird. Lautet der Ressourcenname beispielsweise subscriptions/subscription-123, verwenden Sie subscription-123.

  2. Achten Sie in Ihrem Arbeitsverzeichnis darauf, dass Sie Ihre OAuth-Client-ID-Anmeldedaten gespeichert und die Datei client_secrets.json genannt haben. Im Codebeispiel wird diese JSON-Datei zur Authentifizierung bei Google Workspace und zum Abrufen von Nutzeranmeldedaten verwendet. Eine Anleitung findest du unter Anmeldedaten mit OAuth-Client-ID erstellen.

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

    python3 get_subscription.py