Dieses Dokument enthält API-spezifische Autorisierungs- und Authentifizierungsinformationen für die Google Workspace Events API. Lesen Sie sich vor diesem Dokument die allgemeinen Informationen zur Authentifizierung und Autorisierung in Google Workspace unter Weitere Informationen zur Authentifizierung und Autorisierung durch.
OAuth 2.0 für die Autorisierung konfigurieren
Konfigurieren Sie den OAuth-Zustimmungsbildschirm und wählen Sie Bereiche aus, um festzulegen, welche Informationen Nutzern und App-Rezensenten angezeigt werden. Registrieren Sie dann Ihre App, damit Sie sie später veröffentlichen können.
Google Workspace Events API-Bereiche
Um die Zugriffsebene für Ihre App zu definieren, müssen Sie Autorisierungsbereiche angeben. Ein Autorisierungsbereich ist ein OAuth 2.0-URI-String, der den Namen der Google Workspace-App, die Art der Daten, auf die zugegriffen wird, und die Zugriffsebene enthält. Bereiche sind die Anfragen Ihrer App zur Verarbeitung von Google Workspace-Daten, einschließlich der Google-Kontodaten der Nutzer.
Wenn Ihre App installiert wird, wird ein Nutzer aufgefordert, die von der App verwendeten Bereiche zu bestätigen. Im Allgemeinen sollten Sie den möglichst eng gefassten Bereich auswählen und Bereiche vermeiden, die für Ihre App nicht erforderlich sind. Nutzer gewähren eher Zugriff auf eingeschränkte, klar beschriebene Bereiche.
Wir empfehlen, nach Möglichkeit nicht vertrauliche Bereiche zu verwenden, da dadurch der Zugriff pro Datei gewährt und auf bestimmte Funktionen beschränkt wird, die für eine App erforderlich sind.
Die Google Workspace Events API verwendet Bereiche von Google Workspace-Anwendungen, die Abos unterstützen. Wenn Ihre App bereits die für Ihr Abo erforderlichen Bereiche verwendet, müssen Sie keine zusätzlichen Bereiche hinzufügen, um die Google Workspace Events API zu verwenden.
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 |
Ermöglicht es Google Chat-Apps, Chats aufzurufen und Nachrichten zu senden. 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 Google Chat-Unterhaltungen abrufen, hinzufügen und entfernen | Sensible Daten |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
Mitglieder in Google Chat-Unterhaltungen aufrufen. | Sensible Daten |
||
https://www.googleapis.com/auth/chat.spaces |
In Google Chat Unterhaltungen und Gruppenbereiche erstellen sowie Metadaten (einschließlich Verlaufseinstellungen) abrufen oder aktualisieren | Sensibel | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
Chats und Gruppenbereiche in Google Chat aufrufen | Sensible Daten |
||
https://www.googleapis.com/auth/chat.messages.reaction s |
Reaktionen auf Nachrichten in Google Chat ansehen, hinzufügen und löschen | Sensible Daten |
||
https://www.googleapis.com/auth/chat.messages.reactions.readonly |
Reaktionen auf eine Nachricht in Google Chat ansehen | Sensible Daten |
||
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 Google Chat aufrufen | Eingeschränkt |
||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
Ermöglicht Apps, Metadaten zu Besprechungsräumen zu erstellen, zu ändern und zu lesen, die von Ihrer App erstellt wurden. | Sensible Daten |
||
https://www.googleapis.com/auth/meetings.space.readonly |
Apps dürfen Metadaten zu allen Besprechungsräumen lesen, auf die der Nutzer Zugriff hat. | Sensible Daten |
||
In der Spalte „Nutzung“ der vorstehenden Tabelle wird die Sensibilität der einzelnen Bereiche gemäß den folgenden Definitionen angegeben:
Nicht vertraulich: Diese Bereiche bieten den geringsten Autorisierungszugriff und erfordern nur eine grundlegende App-Überprüfung. Weitere Informationen zu dieser Anforderung finden Sie unter Vorbereitung auf die Bestätigung.
Vertraulich: Diese Bereiche gewähren Zugriff auf bestimmte Google-Nutzerdaten, die vom Nutzer für Ihre App autorisiert wurden. Sie müssen eine zusätzliche App-Überprüfung durchlaufen. Weitere Informationen zu dieser Anforderung finden Sie unter Vorgehensweise für Apps, die sensible Bereiche anfordern.
Eingeschränkt: Diese Bereiche gewähren umfassenden Zugriff auf Nutzerdaten von Google. Sie müssen ein Überprüfungsverfahren für eingeschränkte Bereiche durchlaufen. 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änktem Umfang 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 auch diese Bereiche hinzufügen. Weitere Informationen zu Google API-Bereichen finden Sie im Hilfeartikel 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
Wenn Sie bestimmte OAuth-Bereiche verwenden, muss Ihre App möglicherweise den OAuth-Bestätigungsprozess von Google durchlaufen. In den häufig gestellten Fragen zur Bestätigung über die OAuth API erfahren Sie, wann Ihre App bestätigt werden muss und welche Art der Bestätigung erforderlich ist. Weitere Informationen finden Sie in den Zusatzbedingungen für Google Drive.
Arten der erforderlichen Authentifizierung
In diesem Abschnitt wird erläutert, welche Authentifizierungstypen erforderlich oder unterstützt sind. Außerdem werden die unterstützten Bereiche für jede Methode der Google Workspace Events API angegeben.
Für Abos von Google Chat-Ereignissen 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 Anmeldedaten unterstützt, wirkt sich die Art der Anmeldedaten, die beim Aufruf verwendet werden, auf das zurückgegebene Ergebnis aus. Wenn du beispielsweise die Methode subscriptions.list() mit Nutzerauthentifizierung aufrufst, 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 Authentifizierungstypen für Google Chat finden Sie unter Chat-Apps und Google Chat API-Anfragen authentifizieren und autorisieren.
In der folgenden Tabelle sehen Sie, welche Gültigkeitsbereiche 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 Google Chat-Apps) | Unterstützte Autorisierungsbereiche | |
|---|---|---|---|---|
| Abo erstellen | – |
Für jeden Ereignistyp ist ein unterstützter Umfang erforderlich:
|
||
| Abo abschließen |
Bei der Nutzerauthentifizierung ist für diese Methode ein Umfang erforderlich, der mindestens einen Ereignistyp für das Abo unterstützt.
Mit App-Authentifizierung (nur Google Chat-Apps):
|
|||
| Abos auflisten |
Bei der Nutzerauthentifizierung ist für diese Methode ein Umfang erforderlich, der mindestens einen Ereignistyp für das Abo unterstützt.
Mit App-Authentifizierung (nur Google Chat-Apps):
|
|||
| Abo aktualisieren | – |
Für jeden Ereignistyp ist ein unterstützter Umfang erforderlich:
|
||
| Abo reaktivieren | – |
Für jeden Ereignistyp ist ein unterstützter Umfang erforderlich:
|
||
| Abo löschen |
Bei der Nutzerauthentifizierung ist für diese Methode ein Umfang erforderlich, der mindestens einen Ereignistyp für das Abo unterstützt.
Mit App-Authentifizierung (nur Google Chat-Apps):
|
|||
Gültigkeitsbereich 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 jeden Ereignistyp unterstützt werden:
| Ereignisse | Ereignistypen | Unterstützte Autorisierungsbereiche | ||||||
|---|---|---|---|---|---|---|---|---|
| Google Chat | ||||||||
| Eine Nachricht wird gepostet oder aktualisiert. |
|
|
||||||
| 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. |
|
|
||||||
| Ein Gruppenbereich wird aktualisiert oder gelöscht. |
|
|
||||||
| Google Meet | ||||||||
| Eine Konferenz beginnt oder endet. |
|
|
||||||
| Ein Teilnehmer tritt einer Konferenz bei oder verlässt sie. |
|
|
||||||
| Es wurde eine Aufzeichnung erstellt. |
|
|
||||||
| Ein Transkript wurde erstellt. |
|
|
||||||