Google Workspace-Abo löschen

Auf dieser Seite wird erläutert, wie Sie ein Google Workspace-Abo mit der Methode subscriptions.delete() löschen.

Wenn Sie ein Abo löschen, empfängt Ihre App keine Ereignisse mehr. Wenn ein Abo abläuft, wird es von der Google Workspace Events API automatisch gelöscht.

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).

Ein von einem Nutzer autorisiertes Abo löschen

Im folgenden Codebeispiel wird eine Subscription-Ressource mithilfe der Nutzerauthentifizierung gelöscht.

So löschen Sie ein Abo:

Apps Script

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

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

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

    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 in Ihrem Apps Script-Projekt die Funktion deleteSubscription aus, um das Abo zu löschen.

Python

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

    """Delete 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'
response = service.subscriptions().delete(name=NAME).execute()
print(response)

    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 in Ihrem Terminal folgenden Befehl aus, um das Abo zu löschen:

    python3 delete_subscription.py
Die Google Workspace Events API gibt einen lang andauernden Vorgang zurück, der die Instanz der Ressource Subscription enthält.