Method: domains.getComplianceStatus

Ruft den Compliance-Status für eine bestimmte Domain ab. Gibt PERMISSION_DENIED zurück, wenn Sie nicht berechtigt sind, auf den Compliance-Status der Domain zuzugreifen.

HTTP-Anfrage

GET https://gmailpostmastertools.googleapis.com/v2/{name=domains/*/complianceStatus}

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
name

string

Erforderlich. Der Ressourcenname des abzurufenden Compliance-Status der Domain. Format: domains/{domainId}/complianceStatus.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Compliance-Status für eine Domain.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "name": string,
  "complianceData": {
    object (DomainComplianceData)
  },
  "subdomainComplianceData": {
    object (DomainComplianceData)
  }
}
Felder
name

string

ID. Der Ressourcenname des Compliance-Status der Domain. Format: domains/{domainId}/complianceStatus.
complianceData

object (DomainComplianceData)

Compliance-Daten für den registrierbaren Domainteil der Domain in name. Wenn name beispielsweise domains/example.com/complianceStatus ist, enthält dieses Feld Compliance-Daten für example.com.
subdomainComplianceData

object (DomainComplianceData)

Compliance-Daten, die speziell für die Subdomain in name berechnet wurden. Dieses Feld wird nur ausgefüllt, wenn die Domain in name eine Subdomain ist, die sich von der registrierbaren Domain unterscheidet (z.B. sub.example.com) und ob für diese spezielle Subdomain Compliance-Daten verfügbar sind.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/postmaster
  • https://www.googleapis.com/auth/postmaster.traffic.readonly

Weitere Informationen finden Sie im Autorisierungsleitfaden.

DomainComplianceData

Compliance-Daten für eine bestimmte Domain.

JSON-Darstellung 
{
  "domainId": string,
  "rowData": [
    {
      object (ComplianceRowData)
    }
  ],
  "oneClickUnsubscribeVerdict": {
    object (OneClickUnsubscribeVerdict)
  },
  "honorUnsubscribeVerdict": {
    object (HonorUnsubscribeVerdict)
  }
}
Felder
domainId

string

Die Domain, für die diese Daten bestimmt sind.
rowData[]

object (ComplianceRowData)

Daten für jede Zeile der Tabelle. Jede Nachricht enthält alle Daten, die einer einzelnen Zeile zugrunde liegen.
oneClickUnsubscribeVerdict

object (OneClickUnsubscribeVerdict)

Compliance-Urteil zur Abmeldung mit nur einem Klick.
honorUnsubscribeVerdict

object (HonorUnsubscribeVerdict)

Compliance-Einstufung für die Berücksichtigung von Abmeldungen.

ComplianceRowData

Daten für eine einzelne Zeile der Tabelle mit dem Compliance-Status.

JSON-Darstellung 
{
  "requirement": enum (ComplianceRequirement),
  "status": {
    object (ComplianceStatus)
  }
}
Felder
requirement

enum (ComplianceRequirement)

Die Compliance-Anforderung.
status

object (ComplianceStatus)

Der Compliancestatus für die Anforderung.

ComplianceRequirement

Die Compliance-Anforderung.

Enums
COMPLIANCE_REQUIREMENT_UNSPECIFIED Nicht angegeben
SPF Ob der Absender SPF richtig konfiguriert hat.
DKIM Ob der Absender DKIM richtig konfiguriert hat.
SPF_AND_DKIM Ob der Absender sowohl SPF als auch DKIM richtig konfiguriert hat.
DMARC_POLICY Gibt an, ob der Absender eine DMARC-Richtlinie konfiguriert hat.
DMARC_ALIGNMENT Ob der „Von:“-Header mit DKIM oder SPF übereinstimmt
MESSAGE_FORMATTING Ob Nachrichten gemäß RFC 5322 richtig formatiert sind.
DNS_RECORDS Ob die Domain über Forward- und Reverse-DNS-Einträge verfügt.
ENCRYPTION Ob Nachrichten TLS-verschlüsselt sind.
USER_REPORTED_SPAM_RATE Gibt an, ob die Rate der von Nutzern als Spam gemeldeten Nachrichten für den Absender unter einem bestimmten Grenzwert liegt.
ONE_CLICK_UNSUBSCRIBE Ob der Absender das Abmelden mit nur einem Klick ausreichend unterstützt. Die für Nutzer geltende Anforderung lautet „Abmeldung mit einem Klick“. Wir verlangen jedoch die Einhaltung mehrerer Regeln zur Unterstützung der Abmeldung.
HONOR_UNSUBSCRIBE Gibt an, ob der Absender von Nutzern initiierte Abmeldeanfragen berücksichtigt.

ComplianceStatus

Der Status einer Anforderung zur Absender-Compliance.

JSON-Darstellung 
{
  "status": enum (State)
}
Felder
status

enum (State)

Nur Ausgabe. Der Compliancestatus.

Bundesland

Die Statustypen für eine bestimmte Anforderung zur Absender-Compliance.

Enums
STATE_UNSPECIFIED Nicht angegeben
COMPLIANT Die Compliance-Anforderung wird erfüllt und der Absender gilt als konform.
NEEDS_WORK Die Compliance-Anforderung ist nicht erfüllt und der Absender muss Maßnahmen ergreifen, um die Compliance zu erreichen.

OneClickUnsubscribeVerdict

Konformitätsurteil dazu, ob ein Absender die Konformitätsanforderung für das Abmelden mit nur einem Klick erfüllt.

JSON-Darstellung 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
Felder
status

object (ComplianceStatus)

Der Compliancestatus.
reason

enum (Reason)

Der konkrete Grund für das Compliance-Ergebnis. Muss leer sein, wenn der Status „compliant“ ist.

Grund

Der genaue Grund, warum das Ergebnis für die Ein-Klick-Abmeldung den Status „Nicht konform“ hat.

Enums
REASON_UNSPECIFIED Nicht angegeben
NO_UNSUB_GENERAL Der Absender unterstützt das Abbestellen mit nur einem Klick für die meisten seiner Nachrichten nicht.
NO_UNSUB_SPAM_REPORTS Der Absender unterstützt das Abmelden mit nur einem Klick für die meisten Nachrichten, die manuell als Spam gemeldet werden, nicht.
NO_UNSUB_PROMO_SPAM_REPORTS Der Absender unterstützt das Abmelden mit nur einem Klick für die meisten Werbenachrichten nicht, die manuell als Spam gemeldet werden. Diese Klassifizierung von Nachrichten ist eine Teilmenge der von NO_UNSUB_SPAM_REPORTS abgedeckten Nachrichten.

HonorUnsubscribeVerdict

Compliance-Urteil dazu, ob ein Absender die Compliance-Anforderung zur Berücksichtigung von Abmeldungen erfüllt.

JSON-Darstellung 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
Felder
status

object (ComplianceStatus)

Der Compliancestatus.
reason

enum (Reason)

Der konkrete Grund für das Compliance-Ergebnis. Muss leer sein, wenn der Status „compliant“ ist.

Grund

Der genaue Grund, warum das Ergebnis für die Berücksichtigung von Abmeldungen den Status „Nicht konform“ hat.

Enums
REASON_UNSPECIFIED Nicht angegeben
NOT_HONORING Der Absender berücksichtigt keine Abmeldeanfragen.
NOT_HONORING_TOO_FEW_CAMPAIGNS Der Absender berücksichtigt keine Abmeldeanfragen und erwägt, die Anzahl der relevanten Kampagnen zu erhöhen.
NOT_HONORING_TOO_MANY_CAMPAIGNS Der Absender berücksichtigt keine Abmeldeanfragen. Er sollte die Anzahl der relevanten Kampagnen reduzieren.