Bevor Sie die Mail Admin Quarantine API aufrufen, müssen Sie die Schritte auf dieser Seite ausführen, um die API zu aktivieren, die für jede Anfrage erforderlichen Kennungen zu finden und die erforderlichen Administratorberechtigungen in Ihrem Google Workspace-Konto zu gewähren.
Vorbereitung
- Ein Google Workspace-Konto mit der Funktion „Admin-Quarantäne“. Weitere Informationen finden Sie unter E-Mail-Quarantänen einrichten und verwalten.
- Ein Google Cloud-Projekt. Informationen zum Erstellen eines Projekts finden Sie unter Projekt erstellen.
- Mitgliedschaft im Google Workspace Entwicklervorschauprogramm. Ihr Cloud-Projekt muss im Programm registriert sein, bevor es die Admin Quarantine API aufrufen kann.
- Zugriff auf die Admin-Konsole als Super Admin, um Administratorberechtigungen zu gewähren und die domainweite Delegierung zu autorisieren.
API aktivieren
Aktivieren Sie mailadminquarantine.googleapis.com in dem Cloud-Projekt, in dem Ihre Integration gehostet wird.
Console
Aktivieren Sie in der Google Cloud Console die Mail Admin Quarantine API.
gcloud
Führen Sie den folgenden Befehl aus und ersetzen Sie dabei PROJECT_ID durch Ihre Cloud-Projekt-ID:
gcloud services enable mailadminquarantine.googleapis.com \
--project=PROJECT_ID
Kundennummer suchen
Bei jeder Anfrage an die Admin Quarantine API wird Ihr Google Workspace-Konto mit dem Ressourcennamen customers/CUSTOMER_ID identifiziert.
So finden Sie Ihre Kundennummer:
- Melden Sie sich als Administrator in der Admin-Konsole an.
- Gehen Sie zu Konto > Kontoeinstellungen > Profil.
- Kopieren Sie die Kundennummer.
Wenn die Kundennummer mit einem C beginnt, entfernen Sie das C und verwenden Sie den verbleibenden alphanumerischen Wert im Ressourcennamen, z. B. customers/01abc23de.
Verwenden Sie nicht Ihren Domainnamen als Kundennummer.
Weitere Informationen finden Sie unter Kundennummer ermitteln.
Erforderliche Administratorberechtigungen gewähren
Die Admin Quarantine API erzwingt dieselben Prüfungen der Administratorberechtigungen wie die Administratorquarantäne in der Admin-Konsole. Jede Anfrage wird im Namen eines Google Workspace-Administrators ausgeführt. Dieser Administrator muss eine der folgenden Gmail-Berechtigungen haben:
| Privilege Individuell zusammengestellte Tour | Was ist möglich? |
|---|---|
| Administratorquarantäne aufrufen | Nachrichten in allen Quarantänen, einschließlich der Standardquarantäne, aufrufen und verwalten. |
| Zugriff auf eingeschränkte Quarantänen | Nachrichten nur in Quarantänen aufrufen und verwalten, die mit Gruppen verknüpft sind, zu denen der Administrator gehört. |
Super Admins haben diese Berechtigungen automatisch. Weisen Sie anderen Administratoren eine Rolle zu, die die Berechtigung enthält:
- Melden Sie sich als Super Admin in der Admin-Konsole an.
- Gehen Sie zu Konto > Administratorrollen.
- Wählen Sie eine vorhandene Rolle aus oder klicken Sie auf Neue Rolle erstellen.
- Gehen Sie auf dem Tab Berechtigungen zu Dienste > Gmail und wählen Sie Administratorquarantäne aufrufen oder Zugriff auf eingeschränkte Quarantänen aus.
- Weisen Sie die Rolle dem Administratorkonto zu, das Ihre Integration beim Aufrufen der API verwendet.
Weitere Informationen zu delegierten Administratorrollen finden Sie unter Administratorberechtigungen in Gmail delegieren und Administratorberechtigungen.
Wenn der Administrator, dessen Identität übernommen wurde, nicht die erforderliche Berechtigung hat, gibt die API den Fehler 403 PERMISSION_DENIED zurück.