Dieses Dokument enthält Gmail API-spezifische Informationen zur Autorisierung und Authentifizierung. 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.
Gmail 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.
Die Gmail API unterstützt die folgenden Bereiche:
| Umfangscode | Beschreibung | Nutzung |
|---|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
Entwürfe verwalten und E-Mails senden, wenn mit dem Add-on interagiert wird. | Nicht vertraulich |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
E-Mails abrufen, wenn mit dem Add-on interagiert wird | Nicht vertraulich |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
E-Mail-Metadaten abrufen, wenn das Add-on verwendet wird. | Sensibel |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
E-Mails abrufen, wenn das Add-on ausgeführt wird | Sensibel |
https://www.googleapis.com/auth/gmail.labels |
Nur Labels erstellen, lesen, aktualisieren und löschen. | Nicht vertraulich |
https://www.googleapis.com/auth/gmail.send |
Nur Nachrichten senden. Keine Lese- oder Änderungsberechtigungen für das Postfach. | Sensibel |
https://www.googleapis.com/auth/gmail.readonly |
Alle Ressourcen und ihre 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 Threads und Nachrichten, ohne den Papierkorb zu verwenden. | Eingeschränkt |
https://www.googleapis.com/auth/gmail.metadata |
Ressourcenmetadaten lesen, einschließlich Labels, Verlaufseinträgen und E-Mail-Nachrichtenheadern, aber nicht den Nachrichtentext oder 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 |
Verwalten Sie Einstellungen für vertrauliche E-Mails, einschließlich Weiterleitungsregeln und Aliassen.
Hinweis:Vorgänge, die durch diesen Umfang geschützt sind, sind nur für den administrativen Gebrauch zulässig. Sie sind nur für Google Workspace-Kunden verfügbar, die ein Dienstkonto mit domainweiter Delegierung verwenden. |
Eingeschränkt |
https://mail.google.com/ |
Vollständiger Zugriff auf die Postfächer des Kontos, einschließlich endgültiges Löschen von Threads und Nachrichten. Dieser Umfang sollte nur angefordert werden, wenn Ihre Anwendung Threads und Nachrichten sofort und endgültig löschen muss, ohne den Papierkorb zu verwenden. Alle anderen Aktionen können mit weniger umfassenden Zugriffsrechten ausgeführt werden. | Eingeschränkt |
In der Spalte „Nutzung“ in der Tabelle oben wird die Sensibilität der einzelnen Bereiche gemäß den folgenden Definitionen angegeben:
Nicht sensibel: Diese Bereiche bieten den geringsten Autorisierungszugriff und erfordern nur eine grundlegende App-Bestätigung. Informationen zu dieser Anforderung finden Sie unter Vorbereitung auf die Bestätigung.
Vertraulich: Diese Bereiche gewähren Zugriff auf Google-Nutzerdaten und erfordern eine Überprüfung. Weitere Informationen zu dieser Anforderung finden Sie in der Nutzerdatenrichtlinie für Google API-Dienste. Für diese Bereiche ist keine Sicherheitsprüfung erforderlich.
Eingeschränkt: Diese Bereiche gewähren umfassenden Zugriff auf Nutzerdaten von Google. Sie müssen eine Überprüfung 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.
Weitere Informationen zur Verwendung und zum Zugriff auf Gmail APIs, wenn Sie den Zugriff auf Nutzerdaten anfordern, finden Sie in der Richtlinie zu Nutzerdaten und Entwicklerrichtlinie für Gmail API-Dienste.
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 unter Mit OAuth 2.0 auf Google APIs zugreifen.
OAuth-Überprüfung
Wenn Sie bestimmte vertrauliche OAuth-Bereiche verwenden, muss Ihre App möglicherweise den OAuth-Bestätigungsprozess von Google durchlaufen. In den häufig gestellten Fragen zur OAuth-Bestätigung erfahren Sie, wann Ihre App überprüft werden sollte und welche Art der Überprüfung erforderlich ist. Weitere Informationen finden Sie in der Nutzerdatenrichtlinie für Google API-Dienste.