Dieses Dokument enthält die Google Workspace Events API-spezifische Autorisierung und Authentifizierungsinformationen. Bevor Sie dieses Dokument lesen, sollten Sie die die allgemeinen Informationen zur Authentifizierung und Autorisierung von Google Workspace unter Informationen zur Authentifizierung und Autorisierung
OAuth 2.0 für die Autorisierung konfigurieren
OAuth-Zustimmungsbildschirm konfigurieren und Bereiche auswählen definieren, welche Informationen Nutzern und App-Prüfern angezeigt werden, und registrieren um sie später veröffentlichen zu können.
Bereiche der Google Workspace Events API
Um die Zugriffsebene für Ihre App festzulegen, müssen Sie Autorisierungsbereiche deklarieren Ein Autorisierungsbereich ist ein OAuth 2.0-URI-String die den Namen der Google Workspace-App enthält, auf welche Art von Daten die App zugreift die Zugriffsebene. Bereiche sind die Anfragen Ihrer Anwendung zur Verwendung von Google Workspace-Daten, einschließlich des Nutzers Google-Kontodaten.
Wenn Ihre App installiert ist, wird ein Nutzer aufgefordert, die verwendeten Bereiche zu validieren durch die App. Im Allgemeinen sollten Sie den am engsten fokussierten Umfang und vermeiden Sie, Bereiche anzufordern, die Ihre App nicht benötigt. Nutzer mehr Zugriff auf eingeschränkte, klar beschriebene Bereiche zu gewähren.
Wir empfehlen, nach Möglichkeit nicht vertrauliche Bereiche zu verwenden, da die Berechtigungen pro Datei gewährt werden. und schränkt den Zugriff auf bestimmte Funktionen ein, die eine App benötigt.
Die Google Workspace Events API verwendet Bereiche aus Google Workspace Anwendungen, die Abos unterstützen. Wenn Ihre App die Bereiche bereits verwendet die für Ihr Abo erforderlich sind, müssen Sie keine weiteren Bereiche zur Verwendung der Google Workspace Events API.
In der folgenden Tabelle sind die unterstützten Bereiche für die Google Workspace Events API:
Bereichscode | Beschreibung | Nutzung | ||
---|---|---|---|---|
Google Chat | ||||
https://www.googleapis.com/auth/chat.bot |
Erlaubt Google Chat-Apps, Chats anzusehen und Nachrichten zu senden. Gibt Zugriff auf alle Funktionen, die in Chat-Apps verfügbar sind. <ph type="x-smartling-placeholder"> | Nicht sensibel | ||
https://www.googleapis.com/auth/chat.memberships |
Mitglieder in Google Chat-Unterhaltungen aufrufen, sie 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.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 s |
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 Konferenzräumen erstellen, ändern und lesen die von Ihrer App erstellt wurden. | Sensibel |
||
https://www.googleapis.com/auth/meetings.space.readonly |
Apps erlauben, die Metadaten aller Konferenzräume zu lesen, auf die der Nutzer Zugriff hat. | Sensibel |
Die Spalte „Nutzung“ in der vorherigen Tabelle gibt die Vertraulichkeit der einzelnen Bereiche an. folgenden Definitionen:
Nicht vertraulich: Diese Umfänge bieten den geringsten Autorisierungszugriff erforderlich und erfordert nur die grundlegende App-Überprüfung. Für Informationen zu dieser Anforderung finden Sie unter Vorbereitung auf .
Vertraulich: Über diese Bereiche ist der Zugriff auf bestimmte Google-Nutzerdaten möglich. der vom Nutzer für Ihre App autorisiert wurde. Dazu müssen Sie zusätzliche App-Bestätigung. Informationen zu dieser Anforderung finden Sie unter Schritte für Apps, die sensible Umfang
Eingeschränkt: Diese Bereiche bieten umfassenden Zugriff auf Google-Nutzerdaten. und erfordern eine Überprüfung des eingeschränkten Bereichs. Für Informationen zu dieser Anforderung finden Sie unter Google API-Dienste: Nutzerdaten Richtlinien und Zusätzliche Anforderungen für bestimmte APIs Bereiche. Wenn Sie eingeschränkte Bereichsdaten 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 hinzufügen. . Weitere Informationen zu den Google API-Bereichen finden Sie unter OAuth 2.0 für Folgendes verwenden: 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 App möglicherweise die Anforderungen von Google OAuth-Überprüfung Lesen Sie den Artikel zur OAuth API-Überprüfung FAQs wann Ihre App überprüft werden sollte und welche Art von Bestätigung erforderlich. Weitere Informationen finden Sie in den zusätzlichen Nutzungsbedingungen für Google Drive Dienst.
Erforderliche Authentifizierungstypen
In diesem Abschnitt wird erläutert, welche Authentifizierungstypen erforderlich oder unterstützt werden, und gibt die unterstützten Bereiche für jede Methode des Google Workspace Events API
Für Abos von Google Chat-Ereignissen: die Google Workspace Events API
unterstützt sowohl die Nutzer- als auch die App-Authentifizierung, um einige der Methoden aufzurufen. Wenn eine API
-Methode unterstützt beide Anmeldedaten, d. h. den Typ der im Aufruf verwendeten Anmeldedaten.
das zurückgegebene Ergebnis beeinflusst. Wenn Sie beispielsweise die Methode
subscriptions.list()
mit Nutzerauthentifizierung verwendet, gibt die API eine Liste der Abos zurück,
auf die der authentifizierte Nutzer zugreifen kann. Wenn Sie die Anwendungsauthentifizierung verwenden,
gibt eine Liste der Abos zurück, auf die die App zugreifen kann. Weitere Informationen über
Informationen zu den Arten der Chat-Authentifizierung finden Sie unter Authentifizierung und Autorisierung
Chat-Apps und Google Chat API
-Anfragen.
In der folgenden Tabelle sehen Sie, welche Bereiche und Typen -Authentifizierung sind für jede Google Workspace Events API erforderlich oder werden diese unterstützt. :
Methode | Nutzerauthentifizierung erforderlich oder unterstützt | App-Authentifizierung unterstützt (nur Google Chat-Apps) | Unterstützte Autorisierungsbereiche | |
---|---|---|---|---|
Abo erstellen | – |
Erfordert einen unterstützten Umfang für jeden Ereignistyp:
|
||
Abo abschließen |
Für die 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 |
Für die 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):
|
|||
Abo aktualisieren | – |
Erfordert einen unterstützten Umfang für jeden Ereignistyp:
|
||
Abo reaktivieren | – |
Erfordert einen unterstützten Umfang für jeden Ereignistyp:
|
||
Abos löschen |
Für die 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):
|
Umfang nach Ereignistyp
Wenn Sie die Google Workspace Events API mithilfe der Nutzerauthentifizierung aufrufen, muss einen oder mehrere Bereiche angeben, die den Ereignistypen der Abo.
In der folgenden Tabelle sehen Sie, welche Autorisierungsbereiche jeweils unterstützt werden Ereignistyp:
Ereignisse | Ereignistypen | Unterstützte Autorisierungsbereiche | ||||||
---|---|---|---|---|---|---|---|---|
Google Chat | ||||||||
Eine Nachricht wird gepostet oder aktualisiert. |
|
|
||||||
Eine Reaktion wurde hinzugefügt oder gelöscht oder mehrere Reaktionen werden geändert. |
|
|
||||||
Mitgliedschaft erstellt, aktualisiert oder entfernt wird oder mehrere Mitgliedschaften geändert werden. |
|
|
||||||
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. |
|
|