Auf dieser Seite wird erläutert, wie Sie ein Google Workspace-Abo mit der Methode subscriptions.update()
verlängern. Mit dieser Methode können Sie die Ablaufzeit eines Abos aktualisieren, einschließlich der Verlängerung des Abos auf die maximal mögliche Ablaufzeit. Außerdem können Sie die Liste der Ereignistypen aktualisieren, die über die Zielressource empfangen werden sollen.
Apps Script
- Ein Google Workspace-Abo. Wie Sie ein Abo erstellen, erfahren Sie unter Abo erstellen.
Erfordert die Nutzerauthentifizierung mit einem oder mehreren Bereichen, die alle Ereignistypen für das Abo unterstützen.
- 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: - Aktivieren Sie den erweiterten Dienst
Google Workspace Events
.
"oauthScopes": [ "https://www.googleapis.com/auth/chat.messages.readonly" ]
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.
Erfordert die Nutzerauthentifizierung mit einem oder mehreren Bereichen, die alle Ereignistypen für das Abo unterstützen.
Google Workspace-Abo verlängern
In diesem Abschnitt verwenden Sie die Methode subscriptions.update()
der Google Workspace Events API, um ein Abo bis zum maximalen Ablaufdatum zu verlängern. Um die maximale Ablaufzeit anzugeben, aktualisieren Sie das Feld ttl
der Ressource Subscription
auf 0
.
Die maximale Ablaufzeit hängt davon ab, welche Ressourcendaten in der Ereignisnutzlast enthalten sind. Weitere Informationen zu Ablaufzeiten finden Sie unter Ereignisdaten für Google Workspace-Ereignisse.
So verlängern Sie ein Google Workspace-Abo:
Apps Script
Erstellen Sie in Ihrem Apps Script-Projekt eine neue Scriptdatei mit dem Namen
updateSubscription
und fügen Sie den folgenden Code hinzu:function updateSubscription() { // The name of the subscription to update. const name = 'subscriptions/SUBSCRIPTION_ID'; // Call the Workspace Events API using the advanced service. const response = WorkspaceEvents.Subscriptions.patch({ ttl: '0s', }, name); console.log(response); }
Ersetzen Sie Folgendes:
Führen Sie die Funktion
updateSubscription
in Ihrem Apps Script-Projekt aus, um das Google Workspace-Abo zu aktualisieren.
Python
Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
update_subscription.py
und fügen Sie den folgenden Code hinzu:"""Update subscription.""" from google_auth_oauthlib.flow import InstalledAppFlow from googleapiclient.discovery import build # Specify required scopes. SCOPES = [SCOPES] # 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, ) BODY = { 'ttl': {'seconds': 0}, } NAME = 'subscriptions/SUBSCRIPTION_ID' response = ( service.subscriptions() .patch(name=NAME, updateMask='ttl', body=BODY) .execute() ) print(response)
Ersetzen Sie Folgendes:
SCOPES
: Einer oder mehrere OAuth-Bereiche, die jeden Ereignistyp für das Abo unterstützen. Als Array von Strings formatiert. Wenn Sie mehrere Bereiche angeben möchten, trennen Sie sie durch Kommas. Beispiel:'https://www.googleapis.com/auth/chat.spaces.readonly', 'https://www.googleapis.com/auth/chat.memberships.readonly'
SUBSCRIPTION_ID
: Die ID des Abos. Sie haben folgende Möglichkeiten, die ID abzurufen:
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.Führen Sie zum Aktualisieren des Google Workspace-Abos den folgenden Befehl in Ihrem Terminal aus:
python3 update_subscription.py
Subscription
-Ressource enthält.
Wenn Sie Details zur aktualisierten Subscription
-Ressource abrufen möchten, verwenden Sie die Methode operations.get()
und geben Sie die Operation
-Ressource an, die von Ihrer subscriptions.update()
-Anfrage zurückgegeben wurde. Andernfalls, wenn du eine Operation
-Ressource aus einer früheren Version des Abos angibst, ist die Antwort leer.