Dieses Dokument enthält Informationen zur Autorisierung und Authentifizierung für die Google Workspace Events API. Bevor Sie dieses Dokument lesen, sollten Sie die allgemeinen Informationen zur Authentifizierung und Autorisierung von Google Workspace unter Informationen zur Authentifizierung und Autorisierung lesen.
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 Anwendungsprüfern angezeigt werden. Registrieren Sie Ihre Anwendung, damit Sie sie später veröffentlichen können.
Bereiche der Google Workspace Events API
Zum Definieren der Zugriffsebene für Ihre Anwendung müssen Sie Autorisierungsbereiche identifizieren und deklarieren. Ein Autorisierungsbereich ist ein OAuth 2.0-URI-String, der den Namen der Google Workspace-Anwendung, die Art der Daten, auf die sie zugreift, und die Zugriffsebene enthält. Bereiche sind die Anfragen Ihrer Anwendung zur Arbeit mit Google Workspace-Daten, einschließlich der Google-Kontodaten der Nutzer.
Bei der Installation Ihrer Anwendung wird ein Nutzer aufgefordert, die von der Anwendung verwendeten Bereiche zu validieren. Im Allgemeinen sollten Sie den Bereich mit sehr eng gefasster Ausrichtung auswählen und vermeiden, Bereiche anzufordern, die Ihre Anwendung nicht benötigt. Nutzer gewähren leichter Zugriff auf begrenzte, klar beschriebene Bereiche.
Wir empfehlen, nach Möglichkeit nicht vertrauliche Bereiche zu verwenden, da dadurch der Zugriffsbereich pro Datei gewährt und der Zugriff auf bestimmte Funktionen eingeschränkt wird, die von einer Anwendung benötigt werden.
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 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:
Bereichscode | Beschreibung | Nutzung | ||
---|---|---|---|---|
Google Chat | ||||
https://www.googleapis.com/auth/chat.bot |
Hiermit können Google Chat-Apps Chats ansehen 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 können in Google Chat-Unterhaltungen aufgerufen, hinzugefügt und entfernt werden. | Sensibel |
||
https://www.googleapis.com/auth/chat.memberships.readonly |
Mitglieder in Google Chat-Unterhaltungen aufrufen. | Sensibel |
||
https://www.googleapis.com/auth/chat.spaces |
In Google Chat Unterhaltungen und Gruppenbereiche erstellen sowie Metadaten (einschließlich Einstellungen für den Verlauf) aufrufen oder aktualisieren. | Sensibel | ||
https://www.googleapis.com/auth/chat.spaces.readonly |
Chats und Gruppenbereiche in Google Chat ansehen. | Sensibel |
||
https://www.googleapis.com/auth/chat.messages.reaction Sek. |
Reaktionen auf Nachrichten in Google 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 Google Chat ansehen. | Eingeschränkt |
||
Google Meet | ||||
https://www.googleapis.com/auth/meetings.space.created |
Apps dürfen Metadaten zu von der Anwendung erstellten Konferenzräumen erstellen, ändern und lesen. | Sensibel |
||
https://www.googleapis.com/auth/meetings.space.readonly |
Apps dürfen Metadaten zu jedem Konferenzraum lesen, auf den der Nutzer Zugriff hat. | Sensibel |
Die Spalte „Nutzung“ in der vorherigen Tabelle gibt die Vertraulichkeit der einzelnen Bereiche entsprechend den folgenden Definitionen an:
Nicht vertraulich: Diese Bereiche bieten den kleinsten Autorisierungszugriff und erfordern nur eine einfache App-Überprüfung. Informationen zu dieser Anforderung finden Sie unter Schritte zur Vorbereitung der Überprüfung.
Vertraulich: Diese Bereiche ermöglichen den Zugriff auf bestimmte Google-Nutzerdaten, die vom Nutzer für Ihre Anwendung autorisiert wurden. Hierfür müssen Sie eine zusätzliche App-Überprüfung durchlaufen. Informationen zu dieser Anforderung finden Sie unter Schritte für Anwendungen, die vertrauliche Bereiche anfordern.
Eingeschränkt – Diese Bereiche ermöglichen einen umfassenden Zugriff auf Google-Nutzerdaten und erfordern eine Überprüfung des eingeschränkten Bereichs. Informationen zu dieser Anforderung finden Sie unter Nutzerdatenrichtlinie der Google API-Dienste und Zusätzliche Anforderungen für bestimmte API-Bereiche. Wenn Sie Daten aus eingeschränkten Bereichen auf Servern speichern oder übertragen, müssen Sie eine Sicherheitsprüfung durchlaufen.
Wenn Ihre Anwendung 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 muss Ihre Anwendung möglicherweise den OAuth-Überprüfungsprozess von Google durchlaufen. In den FAQs zur OAuth API-Überprüfung erfahren Sie, wann Ihre Anwendung verifiziert werden soll und welche Art von Überprüfung erforderlich ist. Weitere Informationen finden Sie in den zusätzlichen Nutzungsbedingungen für Google Drive.
Arten erforderlicher Authentifizierungen
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 angegeben.
Bei Abos für Google 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 Anmeldedaten unterstützt, wirkt sich der im Aufruf verwendete Anmeldedatentyp 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 Chatanwendungen und Google 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 sind oder unterstützt werden:
Methode | Nutzerauthentifizierung erforderlich oder wird unterstützt | App-Authentifizierung unterstützt (nur Google Chat-Apps) | Unterstützte Autorisierungsbereiche | |
---|---|---|---|---|
Abo erstellen | — |
Erfordert einen unterstützten Bereich für jeden Ereignistyp:
|
||
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 Google 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 Google Chat-Apps):
|
|||
Abos aktualisieren | — |
Erfordert einen unterstützten Bereich für jeden Ereignistyp:
|
||
Abo reaktivieren | — |
Erfordert einen unterstützten Bereich für jeden Ereignistyp:
|
||
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 Google Chat-Apps):
|
Bereiche nach Ereignistyp
Wenn Sie die Google Workspace Events API mit der 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 nimmt an einer Konferenz teil oder verlässt sie. |
|
|
||||||
Eine Aufzeichnung wurde generiert. |
|
|
||||||
Ein Transkript wurde generiert. |
|
|