Dieses Dokument enthält Informationen zur Autorisierung und Authentifizierung 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 Informationen zur Authentifizierung und Autorisierung durchlesen.
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-Prüfern angezeigt werden, und registrieren Sie Ihre App, damit Sie sie später veröffentlichen können.
Google Workspace Events API-Bereiche
Wenn Sie die Zugriffsebene für Ihre App definieren möchten, 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 der Nutzer.
Wenn Ihre App installiert wird, wird der Nutzer aufgefordert, die von der App verwendeten Bereiche zu validieren. 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 Anwendung bereits die für Ihr Abo erforderlichen Bereiche verwendet, müssen Sie keine Bereiche hinzufügen, um die Google Workspace Events API zu verwenden. Wenn Sie Bereiche hinzufügen, wählen Sie den am wenigsten sensiblen Bereich aus, mit dem Ihre App noch funktioniert. 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:
| Bereichscode | Beschreibung | Nutzung | ||
|---|---|---|---|---|
| Google Chat | ||||
https://www.googleapis.com/auth/chat.bot |
Chat-Apps können Chats abrufen und Nachrichten 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 | Sensibel |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
Mitglieder in Google Chat-Unterhaltungen aufrufen. | Sensibel |
||
https://www.googleapis.com/auth/chat.app.memberships |
Mitglieder in Google Chat-Unterhaltungen und ‑Gruppenbereichen als Chat-App abrufen, hinzufügen, aktualisieren und entfernen Erfordert die Genehmigung des Administrators. Dieser Bereich unterstützt nur die App-Authentifizierung mit Dienstkonten. Sie können sich mit diesem Bereich nicht mit Nutzeranmeldedaten oder mit der domainweiten Delegierung authentifizieren. |
Sensibel |
||
https://www.googleapis.com/auth/chat.app.memberships.readonly |
Mitglieder in Google Chat-Unterhaltungen und ‑Gruppenbereichen als Chat-App abrufen. Erfordert die Genehmigung des Administrators. Dieser Bereich unterstützt nur die App-Authentifizierung mit Dienstkonten. Sie können sich mit diesem Bereich nicht mit Nutzeranmeldedaten oder mit der domainweiten Delegierung authentifizieren. |
Sensibel |
||
https://www.googleapis.com/auth/chat.spaces |
In Google Chat Unterhaltungen und Gruppenbereiche erstellen sowie Metadaten (einschließlich Einstellungen für den Verlauf) abrufen oder aktualisieren | Vertraulich | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
Chats und Gruppenbereiche in Google Chat aufrufen | Sensibel |
||
https://www.googleapis.com/auth/chat.app.spaces |
Als Chat-App Unterhaltungen und Gruppenbereiche erstellen sowie Metadaten (einschließlich Einstellungen für den Verlauf) in Google Chat aufrufen oder aktualisieren. Erfordert die Genehmigung des Administrators. Dieser Bereich unterstützt nur die App-Authentifizierung mit Dienstkonten. Sie können sich mit diesem Bereich nicht mit Nutzeranmeldedaten oder mit der domainweiten Delegierung authentifizieren. |
Sensibel |
||
https://www.googleapis.com/auth/chat.app.spaces.readonly |
Metadaten (einschließlich Einstellungen für den Verlauf) in Google Chat als Chat-App aufrufen. Erfordert die Genehmigung des Administrators. Dieser Bereich unterstützt nur die App-Authentifizierung mit Dienstkonten. Sie können sich mit diesem Bereich nicht mit Nutzeranmeldedaten oder mit der domainweiten Delegierung authentifizieren. |
Sensibel |
||
https://www.googleapis.com/auth/chat.messages.reactions |
Reaktionen auf Nachrichten in Google Chat abrufen, 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 Google Chat aufrufen | Eingeschränkt |
||
https://www.googleapis.com/auth/chat.app.messages.readonly |
Nachrichten und Reaktionen in Google Chat als Chat-App ansehen Erfordert die Genehmigung des Administrators. Dieser Bereich unterstützt nur die App-Authentifizierung mit Dienstkonten. Sie können sich mit diesem Bereich nicht mit Nutzeranmeldedaten oder mit der domainweiten Delegierung authentifizieren. |
Eingeschränkt |
||
https://www.googleapis.com/auth/chat.users.readstate |
Lesestatus von Nutzern in Google Chat abrufen und aktualisieren. | Sensibel |
||
https://www.googleapis.com/auth/chat.users.readstate.readonly |
Lesestatus von Nutzern in Google Chat abrufen. | Sensibel |
||
https://www.googleapis.com/auth/chat.users.availability |
Verfügbarkeitsstatus in Google Chat aufrufen und ändern. | Sensibel |
||
https://www.googleapis.com/auth/chat.users.availability.readonly |
Verfügbarkeitsstatus in Google Chat abrufen. | Sensibel |
||
https://www.googleapis.com/auth/chat.app.all.spaces.readonly |
Metadaten zu allen Gruppenbereichen und Unterhaltungen in Google Chat in Ihrer gesamten Google Workspace-Organisation abrufen, auch wenn die Chat-App nicht Teil davon ist. Dieser Bereich wird nur mit Kundenabos unterstützt. Erfordert die Genehmigung des Administrators. Dieser Bereich unterstützt nur die App-Authentifizierung mit Dienstkonten. Sie können sich mit diesem Bereich nicht mit Nutzeranmeldedaten oder mit der domainweiten Delegierung authentifizieren. |
Eingeschränkt | ||
https://www.googleapis.com/auth/chat.app.all.memberships.readonly |
Alle Mitglieder in Google Chat-Bereichen und ‑Unterhaltungen in Ihrer Google Workspace-Organisation abrufen, auch wenn die Chat-App nicht Teil davon ist. Dieser Bereich wird nur mit Kundenabos unterstützt. Erfordert die Genehmigung des Administrators. Dieser Bereich unterstützt nur die App-Authentifizierung mit Dienstkonten. Sie können sich mit diesem Bereich nicht mit Nutzeranmeldedaten oder mit der domainweiten Delegierung authentifizieren. |
Eingeschränkt | ||
https://www.googleapis.com/auth/chat.app.all.messages.readonly |
Alle Nachrichten und Reaktionen in Ihrer Google Workspace-Organisation abrufen, auch wenn die Chat-App nicht zu einem Gruppenbereich oder einer Unterhaltung gehört. Dieser Bereich wird nur mit Kundenabos unterstützt. Erfordert die Genehmigung des Administrators. Dieser Bereich unterstützt nur die App-Authentifizierung mit Dienstkonten. Sie können sich mit diesem Bereich nicht mit Nutzeranmeldedaten oder mit der domainweiten Delegierung authentifizieren. |
Eingeschränkt | ||
https://www.googleapis.com/auth/chat.app.all.users.readstate.readonly |
Die „Zuletzt gelesen“-Zeit für alle Nutzer in sämtlichen Gruppenbereichen und Unterhaltungen in Ihrer Google Workspace-Organisation abrufen, auch wenn die Chat-App nicht dazu gehört. Dieser Bereich wird nur mit Kundenabos unterstützt. Erfordert die Genehmigung des Administrators. Dieser Bereich unterstützt nur die App-Authentifizierung mit Dienstkonten. Sie können sich mit diesem Bereich nicht mit Nutzeranmeldedaten oder mit der domainweiten Delegierung authentifizieren. |
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 mit einer App teilt, während er die Google Picker API oder die Dateiauswahl der App verwendet. | Nicht vertraulich | ||
https://www.googleapis.com/auth/drive |
Alle Ihre Drive-Dateien abrufen 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 Google Drive abrufen und verwalten | Eingeschränkt | ||
https://www.googleapis.com/auth/drive.metadata.readonly |
Metadaten für Dateien in Google Drive abrufen | Eingeschränkt | ||
| Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
Apps erlauben, Metadaten zu von Ihrer App erstellten Konferenzräumen zu erstellen, zu ändern und zu lesen. | Sensibel |
||
https://www.googleapis.com/auth/meetings.space.readonly |
Apps dürfen Metadaten zu allen Konferenzräumen lesen, auf die der Nutzer Zugriff hat. | Sensibel |
||
Die Spalte „Nutzung“ in der vorherigen Tabelle gibt die Sensitivität der einzelnen Bereiche an:
Nicht sensibel: Diese Bereiche bieten den geringsten Umfang an Autorisierungszugriff und erfordern nur eine grundlegende App-Überprüfung. Informationen zu dieser Anforderung finden Sie unter Bestätigungsanforderungen.
Sensibel: Diese Bereiche ermöglichen den Zugriff auf bestimmte Google-Nutzerdaten, die der Nutzer für Ihre App autorisiert hat. Hierfür ist eine zusätzliche App-Überprüfung erforderlich. 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 eine Überprüfung des eingeschränkten Bereichs. Informationen zu dieser Anforderung finden Sie unter Google API-Dienste: Richtlinie zu Nutzerdaten und Zusätzliche Anforderungen für bestimmte API-Bereiche. Wenn Sie Daten mit eingeschränktem Zugriff 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 OAuth 2.0 für den Zugriff auf Google APIs verwenden.
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 die OAuth-App-Überprüfung durchlaufen. In den FAQs zu OAuth-Anwendungen erfahren Sie, wann Ihre Anwendung überprüft werden sollte und welche Art der Überprüfung erforderlich ist. Weitere Informationen finden Sie in den Nutzungsbedingungen 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 aufgeführt.
Für Abos von 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 Arten von Anmeldedaten unterstützt, wirkt sich der im Aufruf verwendete Typ der Anmeldedaten auf das zurückgegebene Ergebnis aus. Wenn Sie beispielsweise die Methode subscriptions.list mit Nutzerauthentifizierung aufrufen, gibt die API eine Liste von 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 Google Workspace Events API-Methoden erforderlich oder unterstützt sind:
| 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:
Bei der App-Authentifizierung und Administratorgenehmigung (nur Google Chat-Apps) ist für jeden Ereignistyp ein unterstützter Bereich 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.
Mit 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.
Mit App-Authentifizierung (nur Chat-Apps):
|
|||
| Abo aktualisieren | – |
Bei der Nutzerauthentifizierung ist für jeden Ereignistyp ein unterstützter Bereich erforderlich:
Bei der App-Authentifizierung und Administratorgenehmigung (nur Google Chat-Apps) ist für jeden Ereignistyp ein unterstützter Bereich erforderlich:
|
||
| Abo reaktivieren | – |
Bei der Nutzerauthentifizierung ist für jeden Ereignistyp ein unterstützter Bereich erforderlich:
Bei der 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.
Mit 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. |
|
Mit Nutzerauthentifizierung:
|
||||||
| Eine Mitgliedschaft wird erstellt, aktualisiert oder entfernt oder mehrere Mitgliedschaften werden geändert. |
|
Mit Nutzerauthentifizierung:
|
||||||
| Ein Space wird aktualisiert oder gelöscht. |
|
Mit Nutzerauthentifizierung:
|
||||||
| Der Lesestatus eines Gruppenbereichs oder der Lesestatus eines Threads eines Nutzers wird aktualisiert. |
|
Mit Nutzerauthentifizierung:
|
||||||
| Eine Verfügbarkeit wird aktualisiert. |
|
Mit Nutzerauthentifizierung:
|
||||||
| Drive | ||||||||
| Eine Datei wird erstellt, geändert, verschoben, gelöscht, umbenannt, in den Papierkorb verschoben oder aus dem Papierkorb entfernt. |
|
|
||||||
| Ein Zugriffsvorschlag für eine Datei wird erstellt oder geklärt. |
|
|
||||||
| Eine Genehmigung wird abgebrochen, abgeschlossen, erstellt, zurückgesetzt, die Prüfer werden geändert oder die Prüfer haben auf eine Datei geantwortet. |
|
|
||||||
| 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 für eine Datei wird erstellt, gelöscht oder bearbeitet. |
|
|
||||||
| Meet | ||||||||
| Eine Konferenz beginnt oder endet. |
|
|
||||||
| Ein Teilnehmer tritt einer Konferenz bei oder verlässt sie. |
|
|
||||||
| Eine Aufzeichnung wurde erstellt. |
|
|
||||||
| Ein Transkript wurde erstellt. |
|
|
||||||