Dieses Dokument enthält Gmail API-spezifische Autorisierungs- und Authentifizierungsinformationen. Bevor Sie dieses Dokument lesen, sollten Sie sich die allgemeinen Informationen zur Authentifizierung und Autorisierung in Google Workspace unter Authentifizierung und Autorisierung ansehen.
OAuth 2.0 für die Autorisierung konfigurieren
OAuth-Zustimmungsbildschirm konfigurieren und Bereiche auswählen: Damit legen Sie fest, welche Informationen Nutzern und App-Prüfern angezeigt werden. Außerdem registrieren Sie Ihre App, damit Sie sie später veröffentlichen können.
Gmail API-Bereiche
Um den Zugriff zu definieren, der Ihrer App gewährt wird, 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 von Nutzern.
Wenn Ihre App installiert wird, werden Nutzer aufgefordert, die von der App verwendeten Bereiche zu bestätigen. 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 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 ausgeführt 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, dauerhaften Löschens von Unterhaltungen und Nachrichten, wobei der Papierkorb umgangen wird. | Eingeschränkt |
https://www.googleapis.com/auth/gmail.metadata |
Metadaten von Ressourcen lesen, einschließlich Labels, Verlaufsdatensätzen und E‑Mail-Headern, 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 |
Vertrauliche E‑Mail-Einstellungen, einschließlich Weiterleitungsregeln und Aliasse, verwalten
Hinweis:Vorgänge, die durch diesen Bereich geschützt sind, sind nur für die administrative Verwendung vorgesehen. 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 des endgültigen Löschens von Unterhaltungen und Nachrichten. Dieser Bereich sollte nur angefordert werden, wenn Ihre Anwendung Unterhaltungen und Nachrichten sofort und endgültig löschen muss, ohne den Papierkorb zu verwenden. Alle anderen Aktionen können mit weniger restriktiven Bereichen ausgeführt werden. | Eingeschränkt |
In der Spalte „Verwendung“ in der Tabelle oben wird die Sensibilität der einzelnen Bereiche gemäß den folgenden Definitionen angegeben:
Nicht vertraulich: Diese Bereiche bieten den geringsten Autorisierungszugriff und erfordern nur eine grundlegende App-Überprüfung. Weitere Informationen zu dieser Anforderung finden Sie unter Bestätigung vorbereiten.
Vertraulich: Diese Bereiche gewähren Zugriff auf Google-Nutzerdaten und erfordern eine Überprüfung vertraulicher Bereiche. Weitere Informationen zu dieser Anforderung finden Sie in der Nutzerdatenrichtlinie für Google API-Dienste. Für diese Bereiche ist keine Sicherheitsüberprüfung erforderlich.
Eingeschränkt: Diese Bereiche bieten umfassenden Zugriff auf Google-Nutzerdaten und erfordern einen Überprüfungsprozess für eingeschränkte Bereiche. Weitere Informationen zu dieser Anforderung finden Sie in der Nutzerdatenrichtlinie für Google API-Dienste und den zusätzlichen Anforderungen für bestimmte API-Bereiche. Wenn Sie Daten mit eingeschränkten Bereichen auf Servern speichern oder übertragen, müssen Sie eine Sicherheitsprüfung durchlaufen.
Weitere Informationen zu Ihrer Nutzung und Ihrem Zugriff auf Gmail APIs, wenn Sie Zugriff auf Nutzerdaten anfordern, finden Sie in der Richtlinie zu Nutzerdaten und Entwicklern für Google API-Dienste.
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 Mit OAuth 2.0 auf Google APIs zugreifen.
OAuth-Überprüfung
Für die Verwendung bestimmter vertraulicher OAuth-Bereiche muss Ihre App möglicherweise die OAuth-Überprüfung von Google durchlaufen. Lesen Sie die Häufig gestellten Fragen zur OAuth-Überprüfung, um zu erfahren, wann Ihre App überprüft werden muss und welche Art der Überprüfung erforderlich ist. Weitere Informationen finden Sie in der Nutzerdatenrichtlinie für Google API-Dienste.