Dieses Dokument enthält Informationen zur Autorisierung und Authentifizierung der Gmail API. Bevor Sie dieses Dokument lesen, sollten Sie die allgemeinen Informationen zur Authentifizierung und Autorisierung von Google Workspace unter Informationen zur Authentifizierung und Autorisierung lesen.
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 Anwendungsprüfern angezeigt werden. Registrieren Sie Ihre Anwendung, damit Sie sie später veröffentlichen können.
Bereiche der Gmail API
Zum Definieren der Zugriffsebene für Ihre Anwendung müssen Sie Autorisierungsbereiche identifizieren und deklarieren. Ein Autorisierungsbereich ist ein OAuth 2.0-URI-String, der den Namen der Google Workspace-Anwendung, die Art von Daten, auf die zugegriffen wird, und die Zugriffsebene enthält. Bereiche sind die Anfragen Ihrer Anwendung zur Arbeit mit Google Workspace-Daten, einschließlich der Google-Kontodaten von Nutzern.
Wenn Ihre Anwendung installiert ist, wird ein Nutzer aufgefordert, die von der Anwendung verwendeten Bereiche zu validieren. Im Allgemeinen sollten Sie den engsten Fokusbereich auswählen und vermeiden, Bereiche anzufordern, die Ihre Anwendung nicht benötigt. Nutzer gewähren leichter Zugriff auf eingeschränkte, klar beschriebene Bereiche.
Die Gmail API unterstützt die folgenden Bereiche:
| Bereichscode | Beschreibung | Nutzung |
|---|---|---|
https://www.googleapis.com/auth/gmail.addons.current.action.compose |
Sie können Entwürfe verwalten und E-Mails senden, wenn Sie mit dem Add-on interagieren. | Nicht vertraulich |
https://www.googleapis.com/auth/gmail.addons.current.message.action |
Ihre E-Mails abrufen, wenn Sie mit dem Add-on interagieren. | Nicht vertraulich |
https://www.googleapis.com/auth/gmail.addons.current.message.metadata |
Metadaten der E-Mail-Nachrichten aufrufen, wenn das Add-on ausgeführt wird | Sensibel |
https://www.googleapis.com/auth/gmail.addons.current.message.readonly |
Sehen Sie sich Ihre E-Mails an, 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 deren Metadaten lesen – keine Schreibvorgänge. | Eingeschränkt |
https://www.googleapis.com/auth/gmail.compose |
Entwürfe erstellen, lesen, aktualisieren und löschen. Senden Sie Nachrichten und Entwürfe. | 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 Threads und Nachrichten unter Umgehung des Papierkorbs. | Eingeschränkt |
https://www.googleapis.com/auth/gmail.metadata |
Metadaten von Ressourcen lesen, einschließlich Labels, Verlaufseinträge und E-Mail-Nachrichtenheadern, aber nicht aus dem Nachrichtentext oder den Anhängen. | 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 vertrauliche E-Mail-Einstellungen, einschließlich Weiterleitungsregeln und Aliassen.
Hinweis:Vorgänge, die durch diesen Bereich geschützt sind, sind auf administrative Zwecke beschränkt. 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 dauerhaftem Löschen von Threads und Nachrichten. Dieser Bereich sollte nur angefordert werden, wenn Ihre Anwendung Threads und Nachrichten sofort und endgültig unter Umgehung des Papierkorbs löschen muss. Alle anderen Aktionen können mit weniger moderaten Bereichen ausgeführt werden. | Eingeschränkt |
Die Spalte „Nutzung“ in der obigen Tabelle gibt die Vertraulichkeit der einzelnen Bereiche nach den folgenden Definitionen an:
Nicht vertraulich – Diese Bereiche bieten den kleinsten Autorisierungszugriff und erfordern nur eine grundlegende Anwendungsüberprüfung. Informationen zu dieser Anforderung finden Sie unter Schritte zur Vorbereitung auf die Überprüfung.
Vertraulich: Diese Bereiche ermöglichen den Zugriff auf Google-Nutzerdaten und erfordern eine Prüfung auf vertrauliche Bereiche. Informationen zu dieser Anforderung finden Sie unter Nutzerdatenrichtlinie der Google API-Dienste. Für diese Bereiche ist keine Sicherheitsprüfung erforderlich.
Eingeschränkt – Diese Bereiche bieten umfassenden Zugriff auf Google-Nutzerdaten und erfordern eine Überprüfung des eingeschränkten Bereichs. Informationen zu dieser Anforderung finden Sie unter Nutzerdatenrichtlinie der Google API-Dienste und Zusätzliche Anforderungen für bestimmte API-Bereiche. Wenn Sie Daten in einem eingeschränkten Bereich auf Servern speichern oder übertragen, müssen Sie eine Sicherheitsprüfung durchlaufen.
Weitere Informationen, die Ihre Nutzung und den Zugriff auf Gmail APIs regeln, wenn Sie den Zugriff auf Nutzerdaten anfordern, finden Sie in den Nutzerdaten und Entwicklerrichtlinien für Gmail API-Dienste.
Wenn Ihre Anwendung Zugriff auf andere Google APIs benötigt, können Sie diese Bereiche ebenfalls hinzufügen. Weitere Informationen zu Google API-Bereichen finden Sie unter OAuth 2.0 für den Zugriff auf Google APIs verwenden.
OAuth-Überprüfung
Bei Verwendung bestimmter vertraulicher OAuth-Bereiche muss Ihre Anwendung möglicherweise den OAuth-Überprüfungsprozess von Google durchlaufen. In den FAQs zur OAuth-Überprüfung erfahren Sie, wann Ihre Anwendung verifiziert werden soll und welche Art von Überprüfung erforderlich ist. Weitere Informationen finden Sie unter Nutzerdatenrichtlinie der Google API-Dienste.