Method: domains.getComplianceStatus

Pobiera stan zgodności w przypadku danej domeny. Zwraca błąd PERMISSION_DENIED, jeśli nie masz uprawnień dostępu do stanu zgodności domeny.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
name

string

Wymagane. Nazwa zasobu stanu zgodności domeny do pobrania. Format: domains/{domainId}/complianceStatus.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Stan zgodności domeny.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "name": string,
  "complianceData": {
    object (DomainComplianceData)
  },
  "subdomainComplianceData": {
    object (DomainComplianceData)
  }
}
Pola
name

string

Identyfikator. Nazwa zasobu stanu zgodności domeny. Format: domains/{domainId}/complianceStatus.
complianceData

object (DomainComplianceData)

Dane dotyczące zgodności w przypadku części domeny, którą można zarejestrować, w domenie name. Jeśli np. wartość name to domains/example.com/complianceStatus, to pole zawiera dane dotyczące zgodności w przypadku example.com.
subdomainComplianceData

object (DomainComplianceData)

Dane dotyczące zgodności obliczone specjalnie dla subdomeny w name. To pole jest wypełniane tylko wtedy, gdy domena w name jest subdomeną różniącą się od domeny, którą można zarejestrować (np. sub.example.com) oraz czy dla tej konkretnej subdomeny są dostępne dane dotyczące zgodności.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

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

Więcej informacji znajdziesz w przewodniku po autoryzacji.

DomainComplianceData

Dane dotyczące zgodności w przypadku danej domeny.

Zapis JSON 
{
  "domainId": string,
  "rowData": [
    {
      object (ComplianceRowData)
    }
  ],
  "oneClickUnsubscribeVerdict": {
    object (OneClickUnsubscribeVerdict)
  },
  "honorUnsubscribeVerdict": {
    object (HonorUnsubscribeVerdict)
  }
}
Pola
domainId

string

Domena, której dotyczą te dane.
rowData[]

object (ComplianceRowData)

Dane dla każdego wiersza tabeli. Każda wiadomość zawiera wszystkie dane, które składają się na jeden wiersz.
oneClickUnsubscribeVerdict

object (OneClickUnsubscribeVerdict)

Wynik zgodności z wymaganiami dotyczącymi anulowania subskrypcji jednym kliknięciem.
honorUnsubscribeVerdict

object (HonorUnsubscribeVerdict)

Anulowanie subskrypcji zgodnie z oceną zgodności.

ComplianceRowData

Dane dotyczące jednego wiersza w tabeli stanu zgodności.

Zapis JSON 
{
  "requirement": enum (ComplianceRequirement),
  "status": {
    object (ComplianceStatus)
  }
}
Pola
requirement

enum (ComplianceRequirement)

Wymagania dotyczące zgodności.
status

object (ComplianceStatus)

Stan zgodności z wymaganiem.

ComplianceRequirement

Wymagania dotyczące zgodności.

Wartości w polu enum
COMPLIANCE_REQUIREMENT_UNSPECIFIED Nie określono.
SPF Czy nadawca prawidłowo skonfigurował SPF.
DKIM Czy nadawca prawidłowo skonfigurował DKIM.
SPF_AND_DKIM Czy nadawca prawidłowo skonfigurował SPF i DKIM.
DMARC_POLICY Czy nadawca skonfigurował zasady DMARC.
DMARC_ALIGNMENT czy nagłówek „Od:” jest zgodny z DKIM lub SPF;
MESSAGE_FORMATTING Czy wiadomości są poprawnie sformatowane zgodnie ze standardem RFC 5322.
DNS_RECORDS Czy domena ma rekordy DNS (standardowe i odwrotne).
ENCRYPTION Czy wiadomości są szyfrowane przy użyciu protokołu TLS.
USER_REPORTED_SPAM_RATE Czy nadawca ma wskaźnik spamu zgłaszanego przez użytkowników poniżej progu.
ONE_CLICK_UNSUBSCRIBE Czy nadawca w wystarczającym stopniu obsługuje anulowanie subskrypcji jednym kliknięciem. Pamiętaj, że wymaganie dotyczące użytkowników to „anulowanie subskrypcji 1 kliknięciem”, ale my wymagamy spełnienia wielu reguł „obsługi anulowania subskrypcji”.
HONOR_UNSUBSCRIBE Określa, czy nadawca uwzględnia żądania rezygnacji z subskrypcji zainicjowane przez użytkownika.

ComplianceStatus

Stan wymagania dotyczącego zgodności nadawcy.

Zapis JSON 
{
  "status": enum (State)
}
Pola
status

enum (State)

Tylko dane wyjściowe. Stan zgodności.

Stan

Typy stanu dla konkretnego wymagania dotyczącego zgodności nadawcy.

Wartości w polu enum
STATE_UNSPECIFIED Nie określono.
COMPLIANT Wymagania dotyczące zgodności są spełnione, a nadawca jest uznawany za zgodnego z zasadami.
NEEDS_WORK Wymagania dotyczące zgodności nie są spełnione i nadawca musi podjąć działania, aby je spełnić.

OneClickUnsubscribeVerdict

Wynik zgodności informujący, czy nadawca spełnia wymagania dotyczące anulowania subskrypcji 1 kliknięciem.

Zapis JSON 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
Pola
status

object (ComplianceStatus)

Stan zgodności.
reason

enum (Reason)

Konkretny powód wyniku zgodności. Jeśli stan to zgodność, to pole musi być puste.

Przyczyna

Konkretny powód, dla którego wynik rezygnacji jednym kliknięciem ma stan „niezgodny”.

Wartości w polu enum
REASON_UNSPECIFIED Nie określono.
NO_UNSUB_GENERAL Nadawca nie obsługuje anulowania subskrypcji jednym kliknięciem w przypadku większości swoich wiadomości.
NO_UNSUB_SPAM_REPORTS Nadawca nie obsługuje anulowania subskrypcji jednym kliknięciem w przypadku większości wiadomości, które są ręcznie zgłaszane jako spam.
NO_UNSUB_PROMO_SPAM_REPORTS Nadawca nie obsługuje anulowania subskrypcji jednym kliknięciem w przypadku większości wiadomości promocyjnych, które są ręcznie zgłaszane jako spam. Ta klasyfikacja wiadomości jest podzbiorem klasyfikacji objętych przez NO_UNSUB_SPAM_REPORTS.

HonorUnsubscribeVerdict

Werdykt dotyczący zgodności, który określa, czy nadawca spełnia wymagania dotyczące rezygnacji z subskrypcji.

Zapis JSON 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
Pola
status

object (ComplianceStatus)

Stan zgodności.
reason

enum (Reason)

Konkretny powód wyniku zgodności. Jeśli stan to zgodność, to pole musi być puste.

Przyczyna

Konkretny powód, dla którego wynik dotyczący respektowania rezygnacji z subskrypcji ma stan „niezgodny”.

Wartości w polu enum
REASON_UNSPECIFIED Nie określono.
NOT_HONORING Nadawca nie uwzględnia próśb o rezygnację z subskrypcji.
NOT_HONORING_TOO_FEW_CAMPAIGNS Nadawca nie uwzględnia próśb o rezygnację z subskrypcji i rozważa zwiększenie liczby odpowiednich kampanii.
NOT_HONORING_TOO_MANY_CAMPAIGNS Nadawca nie uwzględnia próśb o rezygnację z subskrypcji i powinien rozważyć zmniejszenie liczby odpowiednich kampanii.