Dieses Dokument enthält API-spezifische Autorisierungs- und Authentifizierungsinformationen für die Google Workspace Events API. Bevor Sie dieses Dokument lesen, sollten Sie sich die allgemeinen Informationen zur Authentifizierung und Autorisierung in Google Workspace unter Authentifizierung und Autorisierung ansehen.
OAuth 2.0 für die Autorisierung konfigurieren
OAuth-Zustimmungsbildschirm konfigurieren und Bereiche auswählen: Legen Sie fest, welche Informationen Nutzern und App-Prüfern angezeigt werden, und registrieren Sie Ihre App, damit Sie sie später veröffentlichen können.
Bereiche der Google Workspace Events API
Um den Zugriff zu definieren, der Ihrer App gewährt wird, müssen Sie Autorisierungsbereiche identifizieren und deklarieren. Ein Autorisierungsbereich ist ein OAuth 2.0-URI-String, der den Namen der Google Workspace-App, die Art der Daten, auf die sie zugreift, und die Zugriffsebene enthält. Bereiche sind die Anfragen Ihrer App, mit Google Workspace-Daten zu arbeiten, einschließlich der Google-Kontodaten von Nutzern.
Wenn Ihre App installiert wird, werden Nutzer aufgefordert, die von der App verwendeten Bereiche zu bestätigen. Im Allgemeinen sollten Sie den engsten möglichen Bereich auswählen und keine Bereiche anfordern, die Ihre App nicht benötigt. Nutzer gewähren eher Zugriff auf eingeschränkte, klar beschriebene Bereiche.
Die Google Workspace Events API verwendet Bereiche aus Google Workspace-Anwendungen, die Abos unterstützen. Wenn Ihre App bereits die für Ihr Abo erforderlichen Bereiche verwendet, müssen Sie keine Bereiche hinzufügen, um die Google Workspace Events API zu nutzen. Wenn Sie Bereiche hinzufügen, wählen Sie den am wenigsten sensiblen Bereich aus, der für die Funktion Ihrer App erforderlich ist. Weitere Informationen zu Bereichskategorien finden Sie unter Bereichskategorien.
In der folgenden Tabelle sind die unterstützten Bereiche für die Google Workspace Events API aufgeführt:
| Umfangscode | Beschreibung | Nutzung | ||
|---|---|---|---|---|
| Google Chat | ||||
https://www.googleapis.com/auth/chat.bot |
Mit Lets Chat-Apps können Chats aufgerufen und Nachrichten gesendet werden. Gewährt Zugriff auf alle Funktionen, die für Chat-Apps verfügbar sind. | Nicht vertraulich | ||
https://www.googleapis.com/auth/chat.memberships |
Mitglieder in Chat-Unterhaltungen ansehen, hinzufügen und entfernen | Sensibel |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
Mitglieder in Chat-Unterhaltungen ansehen. | Sensibel |
||
https://www.googleapis.com/auth/chat.app.memberships |
Mitglieder in Unterhaltungen und Gruppenbereichen in Chat als Chat-App abrufen, hinzufügen, aktualisieren und entfernen Erfordert Administratorgenehmigung. Dieser Bereich unterstützt nur die App-Authentifizierung mit Dienstkonten. Mit diesem Bereich ist keine Authentifizierung mit Nutzeranmeldedaten oder mit domainweiter Delegierung möglich. |
Sensibel |
||
https://www.googleapis.com/auth/chat.spaces |
Unterhaltungen und Gruppenbereiche in Google Chat erstellen sowie Metadaten (einschließlich Einstellungen für den Verlauf) abrufen oder aktualisieren. | Sensibel | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
Chats und Gruppenbereiche in Google Chat aufrufen | Sensibel |
||
https://www.googleapis.com/auth/chat.app.spaces |
Unterhaltungen und Gruppenbereiche erstellen sowie Metadaten (einschließlich Einstellungen für den Verlauf) in Chat als Chat-App abrufen oder aktualisieren. Erfordert Administratorgenehmigung. Dieser Bereich unterstützt nur die App-Authentifizierung mit Dienstkonten. Mit diesem Bereich ist keine Authentifizierung mit Nutzeranmeldedaten oder mit domainweiter Delegierung möglich. |
Sensibel |
||
https://www.googleapis.com/auth/chat.messages.reaction s |
Reaktionen auf Nachrichten in Chat ansehen, hinzufügen und löschen | Sensibel |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
Reaktionen auf eine Nachricht in Google Chat ansehen | Sensibel |
||
https://www.googleapis.com/auth/chat.messages |
Nachrichten abrufen, verfassen, senden, aktualisieren und löschen sowie Reaktionen auf Nachrichten hinzufügen, abrufen und löschen. | Eingeschränkt | ||
https://www.googleapis.com/auth/chat.messages.readonly |
Nachrichten und Reaktionen in Chat ansehen | Eingeschränkt |
||
https://www.googleapis.com/auth/chat.app.messages.readonly |
Nachrichten und Reaktionen in Chat als Chat-App ansehen Erfordert Administratorgenehmigung. Dieser Bereich unterstützt nur die App-Authentifizierung mit Dienstkonten. Mit diesem Bereich ist keine Authentifizierung mit Nutzeranmeldedaten oder mit domainweiter Delegierung möglich. |
Eingeschränkt |
||
| Google Drive | ||||
https://www.googleapis.com/auth/drive.file |
Neue Drive-Dateien erstellen oder vorhandene Dateien ändern, die Sie mit einer App öffnen oder die der Nutzer während der Verwendung der Google Picker API oder der Dateiauswahl der App für eine App freigibt. | Nicht vertraulich | ||
https://www.googleapis.com/auth/drive |
Alle Ihre Drive-Dateien ansehen und verwalten. | Eingeschränkt | ||
https://www.googleapis.com/auth/drive.readonly |
Alle Ihre Drive-Dateien ansehen und herunterladen | Eingeschränkt | ||
https://www.googleapis.com/auth/drive.metadata |
Metadaten von Dateien in Drive ansehen und verwalten | Eingeschränkt | ||
https://www.googleapis.com/auth/drive.metadata.readonly |
Metadaten für Dateien in Drive ansehen. | Eingeschränkt | ||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
Apps dürfen Metadaten zu von Ihrer App erstellten Besprechungsräumen erstellen, ändern und lesen. | Sensibel |
||
https://www.googleapis.com/auth/meetings.space.readonly |
Apps dürfen Metadaten zu allen Besprechungsbereichen lesen, auf die der Nutzer Zugriff hat. | Sensibel |
||
In der Spalte „Verwendung“ in der obigen Tabelle wird die Sensibilität der einzelnen Bereiche angegeben:
Nicht vertraulich: Diese Bereiche bieten den geringsten Umfang an Autorisierungszugriff und erfordern nur eine grundlegende App-Überprüfung. Weitere Informationen zu dieser Anforderung finden Sie unter Voraussetzungen für die Bestätigung.
Vertraulich: Diese Bereiche bieten Zugriff auf bestimmte Google-Nutzerdaten, die vom Nutzer für Ihre App autorisiert wurden. Sie erfordern eine zusätzliche App-Überprüfung. Weitere Informationen zu dieser Anforderung finden Sie unter Anforderungen für sensible und eingeschränkte Bereiche.
Eingeschränkt: Diese Bereiche bieten umfassenden Zugriff auf Google-Nutzerdaten und erfordern einen Überprüfungsprozess für eingeschränkte Bereiche. Weitere Informationen zu dieser Anforderung finden Sie in der Nutzerdatenrichtlinie für Google API-Dienste und in den Zusätzlichen Anforderungen für bestimmte API-Bereiche. Wenn Sie Daten mit eingeschränkten Bereichen auf Servern speichern oder übertragen, müssen Sie eine Sicherheitsprüfung durchlaufen.
Wenn Ihre App Zugriff auf andere Google-APIs benötigt, können Sie diese Bereiche ebenfalls hinzufügen. Weitere Informationen zu Google API-Bereichen finden Sie unter Mit OAuth 2.0 auf Google APIs zugreifen.
Weitere Informationen zu bestimmten OAuth 2.0-Bereichen finden Sie unter OAuth 2.0-Bereiche für Google APIs.
OAuth-Überprüfung
Für die Verwendung bestimmter OAuth-Bereiche ist möglicherweise eine OAuth-App-Überprüfung erforderlich. Lesen Sie die FAQs zu OAuth-Apps, um herauszufinden, wann Ihre App überprüft werden muss und welche Art der Überprüfung erforderlich ist. Weitere Informationen finden Sie in den Google Drive-Nutzungsbedingungen.
Arten der erforderlichen Authentifizierung
In diesem Abschnitt wird erläutert, welche Arten der Authentifizierung erforderlich oder unterstützt werden. Außerdem werden die unterstützten Bereiche für jede Methode der Google Workspace Events API aufgeführt.
Für Abos für Chat-Ereignisse unterstützt die Google Workspace Events API sowohl die Nutzer- als auch die App-Authentifizierung, um einige ihrer Methoden aufzurufen. Wenn eine API-Methode beide Arten von Anmeldedaten unterstützt, wirkt sich die Art der im Aufruf verwendeten Anmeldedaten auf das zurückgegebene Ergebnis aus. Wenn Sie beispielsweise die Methode subscriptions.list mit Nutzerauthentifizierung aufrufen, gibt die API eine Liste der Abos zurück, auf die der authentifizierte Nutzer zugreifen kann. Wenn Sie die App-Authentifizierung verwenden, gibt die API eine Liste der Abos zurück, auf die die App zugreifen kann. Weitere Informationen zu den Arten der Chat-Authentifizierung finden Sie unter Chat-Apps und Chat API-Anfragen authentifizieren und autorisieren.
In der folgenden Tabelle sehen Sie, welche Bereiche und Authentifizierungstypen für die einzelnen Methoden der Google Workspace Events API erforderlich oder unterstützt werden:
| Methode | Nutzerauthentifizierung erforderlich oder unterstützt | App-Authentifizierung wird unterstützt (nur Chat-Apps) | Unterstützte Autorisierungsbereiche | |
|---|---|---|---|---|
| Abo erstellen | – |
Bei der Nutzerauthentifizierung ist für jeden Ereignistyp ein unterstützter Bereich erforderlich:
Entwicklervorschau: Bei der App-Authentifizierung mit Administratorgenehmigung (nur Chat-Apps) ist ein unterstützter Bereich für jeden Ereignistyp erforderlich:
|
||
| Abo abschließen |
Bei der Nutzerauthentifizierung ist für diese Methode ein Bereich erforderlich, der mindestens einen Ereignistyp für das Abo unterstützt.
Bei der App-Authentifizierung (nur Chat-Apps):
|
|||
| Abos auflisten |
Bei der Nutzerauthentifizierung ist für diese Methode ein Bereich erforderlich, der mindestens einen Ereignistyp für das Abo unterstützt.
Bei der App-Authentifizierung (nur Chat-Apps):
|
|||
| Abo aktualisieren | – |
Bei der Nutzerauthentifizierung ist für jeden Ereignistyp ein unterstützter Bereich erforderlich:
Entwicklervorschau: Bei der App-Authentifizierung mit Administratorgenehmigung (nur Chat-Apps) ist ein unterstützter Bereich für jeden Ereignistyp erforderlich:
|
||
| Abo reaktivieren | – |
Bei der Nutzerauthentifizierung ist für jeden Ereignistyp ein unterstützter Bereich erforderlich:
Entwicklervorschau: Bei App-Authentifizierung und Administratorgenehmigung (nur Chat-Apps) ist ein unterstützter Bereich für jeden Ereignistyp erforderlich:
|
||
| Abo löschen |
Bei der Nutzerauthentifizierung ist für diese Methode ein Bereich erforderlich, der mindestens einen Ereignistyp für das Abo unterstützt.
Bei der App-Authentifizierung (nur Chat-Apps):
|
|||
Bereiche nach Ereignistyp
Wenn Sie die Google Workspace Events API mit Nutzerauthentifizierung aufrufen, müssen Sie einen oder mehrere Bereiche angeben, die den Ereignistypen des Abos entsprechen.
In der folgenden Tabelle sehen Sie, welche Autorisierungsbereiche für die einzelnen Ereignistypen unterstützt werden:
| Ereignisse | Ereignistypen | Unterstützte Autorisierungsbereiche | ||||||
|---|---|---|---|---|---|---|---|---|
| Chat | ||||||||
| Eine Nachricht wird gepostet oder aktualisiert. |
|
Mit Nutzerauthentifizierung:
|
||||||
| Eine Reaktion wird hinzugefügt oder gelöscht oder mehrere Reaktionen werden geändert. |
|
|
||||||
| Eine Mitgliedschaft wird erstellt, aktualisiert oder entfernt oder mehrere Mitgliedschaften werden geändert. |
|
Mit Nutzerauthentifizierung:
|
||||||
| Ein Gruppenbereich wird aktualisiert oder gelöscht. |
|
Mit Nutzerauthentifizierung:
|
||||||
| Drive | ||||||||
| Eine Datei wird erstellt, geändert, verschoben, gelöscht, umbenannt, in den Papierkorb verschoben oder aus dem Papierkorb entfernt. |
|
|
||||||
| Ein Zugriffsvorschlag wird für eine Datei erstellt oder aufgelöst. |
|
|
||||||
| Eine Genehmigung wird abgebrochen, abgeschlossen, erstellt oder zurückgesetzt, die Überprüfer werden geändert oder die Überprüfer antworten auf eine Datei. |
|
|
||||||
| Ein Kommentar wird in einer Datei erstellt, gelöscht, bearbeitet, wieder geöffnet oder geklärt. |
|
|
||||||
| Eine Antwort wird in einer Datei erstellt, gelöscht oder bearbeitet. |
|
|
||||||
| Eine Berechtigung wird für eine Datei erstellt, gelöscht oder bearbeitet. |
|
|
||||||
| Meet | ||||||||
| Eine Videokonferenz beginnt oder endet. |
|
|
||||||
| Ein Teilnehmer tritt einer Videokonferenz bei oder verlässt sie. |
|
|
||||||
| Es wurde eine Aufnahme erstellt. |
|
|
||||||
| Ein Transkript wurde erstellt. |
|
|
||||||