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 und das Abo für die maximal mögliche Ablaufzeit verlängern.
Apps Script
- Ein Google Workspace-Abo. Informationen zum Erstellen eines Abos findest du unter Abo erstellen.
Erfordert eine 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 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.
Erfordert eine 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 zu seiner maximalen Ablaufzeit zu verlängern. Aktualisieren Sie das Feld ttl
der Ressource Subscription
auf 0
, um die maximale Ablaufzeit anzugeben.
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 Skriptdatei 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
: Ein oder mehrere OAuth-Bereiche, die jeden Ereignistyp für das Abo unterstützen. Formatiert als String-Array. Trennen Sie mehrere Bereiche 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. Zum Abrufen der ID haben Sie folgende Möglichkeiten:
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.Führen Sie folgenden Befehl in Ihrem Terminal aus, um das Google Workspace-Abo zu aktualisieren:
python3 update_subscription.py
Subscription
enthält.
Wenn Sie Details zur aktualisierten Ressource Subscription
abrufen möchten, verwenden Sie die Methode operations.get()
und geben Sie die Ressource Operation
an, die von Ihrer subscriptions.update()
-Anfrage zurückgegeben wurde. Wenn Sie eine Operation
-Ressource aus einer vorherigen Version des Abos angeben, ist die Antwort leer.