Domain zur Zulassungsliste hinzufügen

Auf dieser Seite wird erklärt, wie Sie mit der Allowlisted Domains API eine Domain zur Zulassungsliste hinzufügen.

Hinweis

Wichtige Überlegungen

  • Unveränderliches Design: Da Domainnamen nicht geändert werden können, müssen Aktualisierungen durch Löschen des vorhandenen Eintrags und Erstellen eines neuen Eintrags vorgenommen werden.
  • Durchsatz: Das System unterstützt ein Kontingent von etwa einer Abfrage pro Sekunde (Query Per Second, QPS), das für alle Domains für ein beliebiges eindeutiges Kundenkonto gilt.
  • Kapazität: Administratoren können für ein einzelnes Kundenkonto maximal 5.000 Domains hinzufügen.

Domain zur Zulassungsliste hinzufügen

Verwenden Sie die Methode create, um einen neuen Eintrag hinzuzufügen. Diese Mutation ist asynchron und gibt einen Vorgang mit langer Ausführungszeit zurück.

Python

def create_allowlisted_domain(service, domain_name):
  """Creates an allowlisted domain."""
  try:
    payload = {'domain': domain_name}
    response = service.allowlistedDomains().create(body=payload).execute()
    return response
  except Exception as e:
    print(f'An error occurred during create: {e}')
    return None

Fehlerbehandlung

Fehlerbedingung RPC-Statuscode Fehlermeldung Fehlerbehebung / Begründung
Keine Berechtigung für die Ressource PERMISSION_DENIED (403) "Permission denied for allowlisted domain resource." • Prüfen Sie, ob dem Nutzer der entsprechende Bereich gewährt wurde.
• Prüfen Sie, ob der Nutzer die erforderliche Berechtigung hat.
• Wenden Sie sich an die Kontakt-E-Mail-Adresse, um zu prüfen, ob das Projekt/der Nutzer auf der Zulassungsliste steht.
Kundennummer für den Nutzer nicht gefunden NOT_FOUND (404) "Customer ID not found for user." Der angemeldete Nutzer ist nicht mit einer gültigen Domain verknüpft.
Eine Aktualisierung der Zulassungsliste läuft bereits. FAILED_PRECONDITION (400) "An allowlist update is already in progress. Please wait for it to complete before making another request." Warten Sie, bis die vorherigen Mutationen abgeschlossen sind.
Das Domainlimit in der Zulassungsliste wurde erreicht. FAILED_PRECONDITION (400) "Allowlisted domain limit has been reached." Die maximale Kapazität von 5.000 Domains für das Kundenkonto wurde erreicht. Es können keine weiteren Domains hinzugefügt werden.
Domainname leer INVALID_ARGUMENT (400) "Domain name cannot be empty." Prüfen Sie die Domain, die an die Erstellungsanfrage übergeben wurde. Sie darf nicht leer sein.
Domainname ungültig INVALID_ARGUMENT (400) "Invalid domain name: <domain>." Der in der Anfrage angegebene Domainname ist fehlerhaft oder ungültig. Dieser Fehler tritt in der Regel in einem der folgenden Szenarien auf:
Syntaktische Ungültigkeit: Der Domainname entspricht nicht den erforderlichen Formatierungsstandards.
Eingeschränkte Domains: Die folgenden Domains sind eingeschränkt und können nicht zur Zulassungsliste hinzugefügt werden:
aol.com
gmail.com
hotmail.com
mail.ru
outlook.com
web.de
yahoo.com
yandex.com
yandex.ru

Audit-Logs

Bei Erstellungen mit der Allowlisted Domains API werden Audit-Log-Ereignisse generiert, die von Administratoren überprüft werden können. Weitere Informationen finden Sie unter Audit-Logs ansehen.