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: Legen Sie fest, welche Informationen Nutzern und App-Prüfern angezeigt werden, und 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 zugegriffen wird, 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 engstmö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.
Verwenden Sie nach Möglichkeit nicht sensible Bereiche, um den Zugriff auf die für eine App erforderlichen Funktionen zu beschränken.
Nicht vertrauliche Bereiche
Die folgenden Gmail API-Bereiche werden für die meisten Anwendungsfälle empfohlen:
| Umfangscode | Beschreibung |
|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
Entwürfe verwalten und E‑Mails senden, wenn mit dem Add‑on interagiert wird. |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
E-Mails abrufen, wenn mit dem Add-on interagiert wird. |
https://www.googleapis.com/auth/gmail.labels |
E-Mail-Labels aufrufen und bearbeiten |
Sensible Bereiche
| Umfangscode | Beschreibung |
|---|---|
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
Metadaten der E‑Mail-Nachricht abrufen, wenn das Add‑on ausgeführt wird. |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
E-Mails abrufen, wenn das Add-on ausgeführt wird. |
https://www.googleapis.com/auth/gmail.send |
E-Mails in Ihrem Namen senden. |
Eingeschränkte Bereiche
| Umfangscode | Beschreibung |
|---|---|
https://mail.google.com/ |
Gmail-E‑Mails lesen, schreiben, senden und endgültig löschen
Hinweis:Fordern Sie diesen Bereich nur an, wenn Ihre Anwendung Threads und Nachrichten sofort und dauerhaft löschen muss, ohne den Papierkorb zu durchlaufen. Alle anderen Aktionen können mit weniger restriktiven Bereichen ausgeführt werden. |
https://www.googleapis.com/auth/gmail.readonly |
E-Mails und Einstellungen abrufen |
https://www.googleapis.com/auth/gmail.compose |
Entwürfe verwalten und E‑Mails senden |
https://www.googleapis.com/auth/gmail.insert |
E‑Mails Ihrem Gmail-Postfach hinzufügen |
https://www.googleapis.com/auth/gmail.modify |
E-Mails über Ihr Gmail-Konto abrufen, verfassen und senden Mit diesem Bereich können Threads und Nachrichten nicht sofort endgültig gelöscht werden, ohne dass sie in den Papierkorb verschoben werden. |
https://www.googleapis.com/auth/gmail.metadata |
Metadaten der E‑Mail-Nachricht abrufen, z. B. Labels und Header, aber nicht den E‑Mail-Text. |
https://www.googleapis.com/auth/gmail.settings.basic |
E-Mail-Einstellungen und Filter in Gmail aufrufen, bearbeiten, erstellen oder ändern |
https://www.googleapis.com/auth/gmail.settings.sharing |
Vertrauliche E‑Mail-Einstellungen, einschließlich Einstellungen für die Vergabe von Berechtigungen zum Verwalten Ihrer E‑Mails, verwalten
Hinweis:Vorgänge, die durch diesen Bereich geschützt sind, sind nur für die administrative Nutzung vorgesehen. Sie sind nur für Google Workspace-Kunden verfügbar, die ein Dienstkonto mit domainweiter Delegierung verwenden. |
Die Bereiche in den vorherigen Tabellen geben ihre Sensibilität gemäß den folgenden Definitionen an:
Nicht vertraulich: Diese Bereiche bieten den kleinsten Autorisierungsbereich und erfordern nur eine einfache OAuth-App-Überprüfung. Weitere Informationen finden Sie unter Voraussetzungen für die Bestätigung.
Vertraulich: Diese Bereiche bieten Zugriff auf bestimmte Google-Nutzerdaten, die Nutzer für Ihre App autorisieren. Sie erfordern eine zusätzliche OAuth-App-Überprüfung. Weitere Informationen finden Sie unter Anforderungen für vertrauliche und eingeschränkte Bereiche.
Eingeschränkt: Diese Bereiche bieten umfassenden Zugriff auf Google-Nutzerdaten und erfordern die OAuth-App-Überprüfung für eingeschränkte Bereiche. Weitere Informationen 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 Sicherheitsüberprüfung durchlaufen.
Zusätzliche Informationen zur Nutzung und zum Zugriff auf Gmail-APIs, wenn Sie Zugriff auf Nutzerdaten anfordern, finden Sie in der Richtlinie zu Nutzerdaten und Entwicklern für Google Workspace-APIs.
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.
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 vertraulicher OAuth-Bereiche muss Ihre App möglicherweise das OAuth-Bestätigungsverfahren von Google durchlaufen. In den FAQs zur OAuth-App-Überprüfung erfahren Sie, ob dies erforderlich ist und welche Art von Überprüfung benötigt wird.