Method: domains.getComplianceStatus

Récupère l'état de conformité d'un domaine donné. Renvoie PERMISSION_DENIED si vous n'êtes pas autorisé à accéder à l'état de conformité du domaine.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Nom de ressource de l'état de conformité du domaine à récupérer. Format : domains/{domainId}/complianceStatus.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

État de conformité d'un domaine.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "name": string,
  "complianceData": {
    object (DomainComplianceData)
  },
  "subdomainComplianceData": {
    object (DomainComplianceData)
  }
}
Champs
name

string

Identifiant. Nom de ressource de l'état de conformité du domaine. Format : domains/{domainId}/complianceStatus.
complianceData

object (DomainComplianceData)

Données de conformité pour la partie domaine enregistrable du domaine dans name. Par exemple, si name est domains/example.com/complianceStatus, ce champ contient les données de conformité pour example.com.
subdomainComplianceData

object (DomainComplianceData)

Données de conformité calculées spécifiquement pour le sous-domaine dans name. Ce champ n'est renseigné que si le domaine dans name est un sous-domaine qui diffère de son domaine enregistrable (par exemple, sub.example.com) et si des données de conformité sont disponibles pour ce sous-domaine spécifique.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour en savoir plus, consultez le guide d'autorisation.

DomainComplianceData

Données de conformité pour un domaine donné.

Représentation JSON 
{
  "domainId": string,
  "rowData": [
    {
      object (ComplianceRowData)
    }
  ],
  "oneClickUnsubscribeVerdict": {
    object (OneClickUnsubscribeVerdict)
  },
  "honorUnsubscribeVerdict": {
    object (HonorUnsubscribeVerdict)
  }
}
Champs
domainId

string

Domaine auquel ces données se rapportent.
rowData[]

object (ComplianceRowData)

Données pour chacune des lignes du tableau. Chaque message contient toutes les données qui sous-tendent une seule ligne.
oneClickUnsubscribeVerdict

object (OneClickUnsubscribeVerdict)

Verdict de conformité du désabonnement en un clic.
honorUnsubscribeVerdict

object (HonorUnsubscribeVerdict)

Évaluation de conformité des demandes de désabonnement honorées.

ComplianceRowData

Données pour une seule ligne du tableau de l'état de conformité.

Représentation JSON 
{
  "requirement": enum (ComplianceRequirement),
  "status": {
    object (ComplianceStatus)
  }
}
Champs
requirement

enum (ComplianceRequirement)

Exigence de conformité.
status

object (ComplianceStatus)

État de conformité de l'exigence.

ComplianceRequirement

Exigence de conformité.

Enums
COMPLIANCE_REQUIREMENT_UNSPECIFIED Non spécifié.
SPF Si l'expéditeur a correctement configuré SPF.
DKIM Indique si l'expéditeur a correctement configuré DKIM.
SPF_AND_DKIM Indique si l'expéditeur a correctement configuré SPF et DKIM.
DMARC_POLICY Indique si l'expéditeur a configuré des règles DMARC.
DMARC_ALIGNMENT Si l'en-tête "De" correspond à DKIM ou SPF
MESSAGE_FORMATTING Indique si les messages sont correctement mis en forme conformément à la norme RFC 5322.
DNS_RECORDS Indique si le domaine dispose d'enregistrements DNS de transfert et inversés.
ENCRYPTION Indique si les messages sont chiffrés avec TLS.
USER_REPORTED_SPAM_RATE Indique si le taux de spam signalé par les utilisateurs pour l'expéditeur est inférieur à un seuil.
ONE_CLICK_UNSUBSCRIBE Indique si l'expéditeur permet de se désabonner en un clic. Notez que l'exigence visible par l'utilisateur est "se désabonner en un clic", mais nous exigeons le respect de plusieurs règles concernant la "prise en charge de la désinscription".
HONOR_UNSUBSCRIBE Indique si l'expéditeur respecte les demandes de désabonnement initiées par les utilisateurs.

ComplianceStatus

État d'une exigence de conformité pour les expéditeurs.

Représentation JSON 
{
  "status": enum (State)
}
Champs
status

enum (State)

Uniquement en sortie. État de conformité.

État

Types d'état pour une exigence de conformité d'un expéditeur spécifique.

Enums
STATE_UNSPECIFIED Non spécifié.
COMPLIANT L'exigence de conformité est respectée et l'expéditeur est considéré comme conforme.
NEEDS_WORK L'expéditeur ne respecte pas les exigences de conformité et doit effectuer des actions pour y remédier.

OneClickUnsubscribeVerdict

Verdict de conformité indiquant si un expéditeur respecte l'exigence de conformité concernant le désabonnement en un clic.

Représentation JSON 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
Champs
status

object (ComplianceStatus)

État de conformité.
reason

enum (Reason)

Motif spécifique du verdict de conformité. Ce champ doit être vide si l'état est "Conforme".

Motif

Raison spécifique pour laquelle l'état d'un verdict de désabonnement en un clic est "Non conforme".

Enums
REASON_UNSPECIFIED Non spécifié.
NO_UNSUB_GENERAL L'expéditeur ne propose pas de désabonnement en un clic pour la majorité de ses messages.
NO_UNSUB_SPAM_REPORTS L'expéditeur ne permet pas de se désabonner en un clic pour la plupart des messages signalés manuellement comme spam.
NO_UNSUB_PROMO_SPAM_REPORTS L'expéditeur n'est pas compatible avec le désabonnement en un clic pour la plupart des messages promotionnels signalés manuellement comme spam. Cette classification des messages est un sous-ensemble de ceux couverts par NO_UNSUB_SPAM_REPORTS.

HonorUnsubscribeVerdict

Verdict de conformité indiquant si un expéditeur respecte l'exigence de conformité concernant l'acceptation des demandes de désabonnement.

Représentation JSON 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
Champs
status

object (ComplianceStatus)

État de conformité.
reason

enum (Reason)

Motif spécifique du verdict de conformité. Ce champ doit être vide si l'état est "Conforme".

Motif

Motif spécifique pour lequel l'état d'une décision de respect de la désinscription est "Non conforme".

Enums
REASON_UNSPECIFIED Non spécifié.
NOT_HONORING L'expéditeur ne respecte pas les demandes de désabonnement.
NOT_HONORING_TOO_FEW_CAMPAIGNS L'expéditeur ne respecte pas les demandes de désabonnement et envisage d'augmenter le nombre de campagnes pertinentes.
NOT_HONORING_TOO_MANY_CAMPAIGNS L'expéditeur ne respecte pas les demandes de désabonnement. Pensez à réduire le nombre de campagnes pertinentes.