Method: domains.getComplianceStatus

Recupera lo stato di conformità per un determinato dominio. Restituisce PERMISSION_DENIED se non hai l'autorizzazione per accedere allo stato di conformità per il dominio.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Obbligatorio. Il nome della risorsa dello stato di conformità del dominio da recuperare. Formato: domains/{domainId}/complianceStatus.

Corpo della richiesta

Il corpo della richiesta deve essere vuoto.

Corpo della risposta

Stato di conformità per un dominio.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "name": string,
  "complianceData": {
    object (DomainComplianceData)
  },
  "subdomainComplianceData": {
    object (DomainComplianceData)
  }
}
Campi
name

string

Identificatore. Il nome della risorsa dello stato di conformità del dominio. Formato: domains/{domainId}/complianceStatus.
complianceData

object (DomainComplianceData)

Dati di conformità per la parte del dominio registrabile del dominio in name. Ad esempio, se name è domains/example.com/complianceStatus, questo campo contiene i dati di conformità per example.com.
subdomainComplianceData

object (DomainComplianceData)

Dati di conformità calcolati appositamente per il sottodominio in name. Questo campo viene compilato solo se il dominio in name è un sottodominio diverso dal dominio registrabile (ad es. sub.example.com) e se i dati di conformità sono disponibili per quel sottodominio specifico.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta la Guida all'autorizzazione.

DomainComplianceData

Dati di conformità per un determinato dominio.

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

string

Il dominio a cui si riferiscono questi dati.
rowData[]

object (ComplianceRowData)

I dati per ciascuna riga della tabella. Ogni messaggio contiene tutti i dati che supportano una singola riga.
oneClickUnsubscribeVerdict

object (OneClickUnsubscribeVerdict)

Verdetto di conformità per l'annullamento dell'iscrizione con un solo clic.
honorUnsubscribeVerdict

object (HonorUnsubscribeVerdict)

Responso di conformità relativo all'annullamento dell'iscrizione.

ComplianceRowData

Dati per una singola riga della tabella dello stato di conformità.

Rappresentazione JSON 
{
  "requirement": enum (ComplianceRequirement),
  "status": {
    object (ComplianceStatus)
  }
}
Campi
requirement

enum (ComplianceRequirement)

Il requisito di conformità.
status

object (ComplianceStatus)

Lo stato di conformità per il requisito.

ComplianceRequirement

Il requisito di conformità.

Enum
COMPLIANCE_REQUIREMENT_UNSPECIFIED Non specificato.
SPF Se il mittente ha configurato correttamente SPF.
DKIM Se il mittente ha configurato correttamente DKIM.
SPF_AND_DKIM Se il mittente ha configurato correttamente sia SPF che DKIM.
DMARC_POLICY Indica se il mittente ha configurato il criterio DMARC.
DMARC_ALIGNMENT Se l'intestazione Da: è allineata con DKIM o SPF
MESSAGE_FORMATTING Se i messaggi sono formattati correttamente in base allo standard RFC 5322.
DNS_RECORDS Se il dominio dispone di record DNS di inoltro e inversi.
ENCRYPTION Indica se i messaggi sono criptati con TLS.
USER_REPORTED_SPAM_RATE Se il mittente è al di sotto di una soglia per il tasso di spam segnalato dagli utenti.
ONE_CLICK_UNSUBSCRIBE Se il mittente supporta sufficientemente l'annullamento dell'iscrizione con un solo clic. Tieni presente che il requisito rivolto agli utenti è "annullamento dell'iscrizione con un solo clic", ma richiediamo la soddisfazione di più regole di "supporto per l'annullamento dell'iscrizione".
HONOR_UNSUBSCRIBE Indica se il mittente rispetta le richieste di annullamento dell'iscrizione avviate dall'utente.

ComplianceStatus

Lo stato di un requisito di conformità del mittente.

Rappresentazione JSON 
{
  "status": enum (State)
}
Campi
status

enum (State)

Solo output. Lo stato di conformità.

Stato

I tipi di stato per un determinato requisito di conformità del mittente.

Enum
STATE_UNSPECIFIED Non specificato.
COMPLIANT Il requisito di conformità è soddisfatto e il mittente è considerato conforme.
NEEDS_WORK Il requisito di conformità non è soddisfatto e il mittente deve intervenire per raggiungere la conformità.

OneClickUnsubscribeVerdict

Verdetto di conformità che indica se un mittente soddisfa il requisito di conformità per l'annullamento dell'iscrizione con un solo clic.

Rappresentazione JSON 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
Campi
status

object (ComplianceStatus)

Lo stato di conformità.
reason

enum (Reason)

Il motivo specifico del verdetto di conformità. Deve essere vuoto se lo stato è conforme.

Motivo

Il motivo specifico per cui un esito di annullamento dell'iscrizione con un clic ha lo stato "non conforme".

Enum
REASON_UNSPECIFIED Non specificato.
NO_UNSUB_GENERAL Il mittente non supporta l'annullamento dell'iscrizione con un solo clic per la maggior parte dei suoi messaggi.
NO_UNSUB_SPAM_REPORTS Il mittente non supporta l'annullamento dell'iscrizione con un solo clic per la maggior parte dei messaggi segnalati manualmente come spam.
NO_UNSUB_PROMO_SPAM_REPORTS Il mittente non supporta l'annullamento dell'iscrizione con un solo clic per la maggior parte dei messaggi promozionali segnalati manualmente come spam. Questa classificazione dei messaggi è un sottoinsieme di quelli inclusi in NO_UNSUB_SPAM_REPORTS.

HonorUnsubscribeVerdict

Verdetto di conformità che indica se un mittente soddisfa il requisito di conformità relativo al rispetto delle richieste di annullamento dell'iscrizione.

Rappresentazione JSON 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
Campi
status

object (ComplianceStatus)

Lo stato di conformità.
reason

enum (Reason)

Il motivo specifico del verdetto di conformità. Deve essere vuoto se lo stato è conforme.

Motivo

Il motivo specifico per cui un esito di rispetto dell'annullamento dell'iscrizione ha lo stato "Non conforme".

Enum
REASON_UNSPECIFIED Non specificato.
NOT_HONORING Il mittente non accetta le richieste di annullamento dell'iscrizione.
NOT_HONORING_TOO_FEW_CAMPAIGNS Il mittente non rispetta le richieste di annullamento dell'iscrizione e valuta la possibilità di aumentare il numero di campagne pertinenti.
NOT_HONORING_TOO_MANY_CAMPAIGNS Il mittente non accetta le richieste di annullamento dell'iscrizione e valuta la possibilità di ridurre il numero di campagne pertinenti.