Dieses Dokument enthält die Gmail 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.
Gmail API-Bereiche
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.
Die Gmail API unterstützt folgende Bereiche:
| Bereichscode | Beschreibung | Nutzung |
|---|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
Entwürfe verwalten und E-Mails senden, wenn Sie mit dem Add-on. | Nicht sensibel |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
Zeigen Sie Ihre E-Mails an, wenn Sie mit dem Add-on. | Nicht sensibel |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
Metadaten der E-Mail-Nachrichten beim Add-on abrufen ausgeführt wird. | Sensibel |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
E-Mails abrufen, wenn das Add-on aktiviert ist ausgeführt wird. | Sensibel |
https://www.googleapis.com/auth/gmail.labels |
Nur Labels erstellen, lesen, aktualisieren und löschen. | Nicht sensibel |
https://www.googleapis.com/auth/gmail.send |
Nur Nachrichten senden. Keine Berechtigungen zum Lesen oder Ändern des Postfachs. | Sensibel |
https://www.googleapis.com/auth/gmail.readonly |
Alle Ressourcen und deren Metadaten lesen, keine Schreibvorgänge. | Eingeschränkt |
https://www.googleapis.com/auth/gmail.compose |
Entwürfe erstellen, lesen, aktualisieren und löschen Nachrichten und Entwürfe senden | Eingeschränkt |
https://www.googleapis.com/auth/gmail.insert |
Nur Nachrichten einfügen und importieren. | Eingeschränkt |
https://www.googleapis.com/auth/gmail.modify |
Alle Lese-/Schreibvorgänge mit Ausnahme des sofortigen, endgültigen Löschens von und Nachrichten, wodurch der Papierkorb umgangen wird. | Eingeschränkt |
https://www.googleapis.com/auth/gmail.metadata |
Ressourcenmetadaten lesen, einschließlich Labels, Verlaufseinträgen und E-Mails Nachrichten-Header, aber nicht den Nachrichtentext oder die Anhänge. | Eingeschränkt |
https://www.googleapis.com/auth/gmail.settings.basic |
Grundlegende E-Mail-Einstellungen verwalten | Eingeschränkt |
https://www.googleapis.com/auth/gmail.settings.sharing |
Vertrauliche E-Mail-Einstellungen verwalten, einschließlich Weiterleitungsregeln und Aliassen.
Hinweis:Vorgänge, die durch diesen Bereich überwacht werden, sind beschränkt auf nur für den administrativen Gebrauch. Sie sind nur für Google Workspace-Kunden verfügbar mit einem Dienstkonto mit domainweiter Delegierung. |
Eingeschränkt |
https://mail.google.com/ |
Vollständiger Zugriff auf die Postfächer des Kontos, einschließlich der endgültigen Löschung von Threads und Nachrichten. Dieser Bereich sollte nur angefordert werden, wenn Ihre Anwendung Threads und Nachrichten sofort und endgültig löschen muss, Papierkorb: Alle anderen Aktionen können mit weniger eingeschränkten Bereichen ausgeführt werden. | Eingeschränkt |
In der Spalte „Nutzung“ in der Tabelle oben ist die Vertraulichkeit der einzelnen Bereiche angegeben. folgenden Definitionen:
Nicht vertraulich – Diese Umfänge bieten den kleinsten und erfordern nur eine einfache App-Überprüfung. Weitere Informationen zu dieser Anforderung finden Sie unter So bereiten Sie die Überprüfung vor
Vertraulich: Diese Bereiche ermöglichen den Zugriff auf Google-Nutzerdaten und erfordern ein Prozess zur Überprüfung vertraulicher Bereiche. Informationen zu dieser Anforderung finden Sie unter Google API-Dienste: Nutzerdatenrichtlinie Für diese Bereiche ist keine Sicherheitsbewertung erforderlich.
Eingeschränkt: Diese Bereiche bieten umfassenden Zugriff auf Google-Nutzerdaten und müssen Sie einen Überprüfungsprozess für einen eingeschränkten Bereich durchlaufen. Für Informationen zu dieser Anforderung finden Sie unter Google API Services: User Data Policy und Zusätzliche Anforderungen für bestimmte API-Bereiche. Wenn Sie eingeschränkte Bereichsdaten auf Servern speichern (oder übertragen), müssen Sie eine Sicherheitsprüfung durchlaufen.
Zusätzliche Informationen, die Ihre Nutzung und den Zugriff auf die Gmail APIs regeln, wenn Sie auf Nutzerdaten zugreifen zu können, finden Sie in der Nutzerdaten und Entwicklerrichtlinien für Gmail API-Dienste
Wenn Ihre App Zugriff auf andere Google APIs benötigt, können Sie auch diese Umfänge nutzen. Weitere Informationen zu Google API-Bereichen Siehe Mit OAuth 2.0 auf Google APIs zugreifen
OAuth-Überprüfung
Wenn Sie bestimmte vertrauliche OAuth-Bereiche verwenden, muss Ihre App OAuth-Überprüfungsprozess von Google. Häufig gestellte Fragen zur OAuth-Bestätigung wann Ihre App überprüft werden sollte und welche Art von Bestätigung erforderlich. Weitere Informationen finden Sie in der Google API-Dienste: Nutzerdatenrichtlinie