Mit dem erweiterten Google Workspace Events-Dienst können Sie die Google Workspace Events API in Apps Script verwenden. Mit dieser API können Sie Google Workspace-Ressourcen abonnieren, um über für Sie relevante Ereignisse informiert zu werden. Ereignisse beschreiben Änderungen an Ressourcen, z. B. wenn Ressourcen erstellt, aktualisiert oder gelöscht werden.
Vorbereitung
- Ein Apps Script-Projekt, das ein Google Cloud-Standardprojekt anstelle des automatisch von Apps Script erstellten Standardprojekts verwendet.
- Ein Pub/Sub-Thema, das im selben Google Cloud-Projekt erstellt wurde, um Aboereignisse zu empfangen. Informationen zum Erstellen eines Pub/Sub-Themas finden Sie unter Pub/Sub-Thema erstellen und abonnieren.
- Wenn Sie Chat-Ereignisse abonnieren möchten, müssen Sie in der Google Cloud Console auf der Seite „Chat API-Konfiguration“ eine Google Chat-App konfiguriert haben. Informationen zum Erstellen einer Google Chat-App finden Sie unter Google Chat-App mit Apps Script erstellen.
Die erforderlichen Autorisierungsbereiche, die der
appsscript.json
-Datei des Apps Script-Projekts hinzugefügt wurden. Die erforderlichen Bereiche hängen von den Arten der Zielressourcen und Ereignisse der Abos ab. Weitere Informationen finden Sie unter Google Workspace Events API-Bereiche auswählen. Beispiel:"oauthScopes": [ "https://www.googleapis.com/auth/chat.messages.readonly" ]
Referenz
Weitere Informationen zu diesem Dienst finden Sie in der Referenzdokumentation zur Google Workspace Events API. Wie alle erweiterten Dienste in Apps Script verwendet der Google Workspace Events-Dienst dieselben Objekte, Methoden und Parameter wie die öffentliche API.
Beispielcode
In diesen Beispielen wird gezeigt, wie Sie mit dem erweiterten Dienst gängige Aktionen der Google Workspace Events API ausführen.
Abo erstellen
Wenn Sie ein Abo für eine Google Workspace-Ressource erstellen möchten, fügen Sie dem Code des Apps Script-Projekts die folgende Funktion hinzu:
Abos auflisten
Wenn Sie Abos auflisten möchten, die nach Ereignistypen und Zielressource gefiltert sind, fügen Sie dem Code des Apps Script-Projekts die folgende Funktion hinzu:
Abo abrufen
Wenn Sie Informationen zu einem Abo abrufen möchten, fügen Sie dem Code des Apps Script-Projekts die folgende Funktion hinzu:
Abo aktualisieren
Wenn Sie ein Abo aktualisieren oder verlängern möchten, fügen Sie dem Code des Apps Script-Projekts die folgende Funktion hinzu:
Abo reaktivieren
Wenn Sie ein Abo reaktivieren möchten, fügen Sie dem Code des Apps Script-Projekts die folgende Funktion hinzu:
Abo löschen
Wenn Sie ein Abo löschen möchten, fügen Sie dem Code des Apps Script-Projekts die folgende Funktion hinzu:
Vorgang abrufen
Die meisten Methoden der Google Workspace Events API geben einen Vorgang mit langer Ausführungszeit zurück.
Mit der Methode operations.get()
können Sie den Status des Vorgangs ermitteln.
Wenn Sie Informationen zu einem Vorgang abrufen möchten, fügen Sie dem Code des Apps Script-Projekts die folgende Funktion hinzu:
Um den Namen eines Vorgangs abzurufen, verwenden Sie den Wert aus dem Feld name
, das von einer der Google Workspace Events API-Methoden zurückgegeben wird, z. B. subscriptions.create()
oder subscriptions.patch()
.