Method: domains.getComplianceStatus

Recupera el estado de cumplimiento de un dominio determinado. Devuelve PERMISSION_DENIED si no tienes permiso para acceder al estado de cumplimiento del dominio.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta

Parámetros
name

string

Obligatorio. Es el nombre del recurso del estado de cumplimiento del dominio que se recuperará. Formato: domains/{domainId}/complianceStatus.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Es el estado de cumplimiento de un dominio.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "name": string,
  "complianceData": {
    object (DomainComplianceData)
  },
  "subdomainComplianceData": {
    object (DomainComplianceData)
  }
}
Campos
name

string

Es el identificador. Es el nombre del recurso del estado de cumplimiento del dominio. Formato: domains/{domainId}/complianceStatus.
complianceData

object (DomainComplianceData)

Son los datos de cumplimiento de la parte registrable del dominio en name. Por ejemplo, si name es domains/example.com/complianceStatus, este campo contiene datos de cumplimiento para example.com.
subdomainComplianceData

object (DomainComplianceData)

Son los datos de cumplimiento calculados específicamente para el subdominio en name. Este campo solo se propaga si el dominio en name es un subdominio que difiere de su dominio registrable (p.ej., sub.example.com) y si hay datos de cumplimiento disponibles para ese subdominio específico.

Permisos de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta la Guía de autorización.

DomainComplianceData

Son los datos de cumplimiento para un dominio determinado.

Representación JSON 
{
  "domainId": string,
  "rowData": [
    {
      object (ComplianceRowData)
    }
  ],
  "oneClickUnsubscribeVerdict": {
    object (OneClickUnsubscribeVerdict)
  },
  "honorUnsubscribeVerdict": {
    object (HonorUnsubscribeVerdict)
  }
}
Campos
domainId

string

Es el dominio para el que se proporcionan estos datos.
rowData[]

object (ComplianceRowData)

Son los datos de cada una de las filas de la tabla. Cada mensaje contiene todos los datos que respaldan una sola fila.
oneClickUnsubscribeVerdict

object (OneClickUnsubscribeVerdict)

Es el veredicto de cumplimiento de la anulación de suscripción con un clic.
honorUnsubscribeVerdict

object (HonorUnsubscribeVerdict)

Es el veredicto de cumplimiento que indica que se respetó la anulación de la suscripción.

ComplianceRowData

Son los datos de una sola fila de la tabla de estado de cumplimiento.

Representación JSON 
{
  "requirement": enum (ComplianceRequirement),
  "status": {
    object (ComplianceStatus)
  }
}
Campos
requirement

enum (ComplianceRequirement)

Es el requisito de cumplimiento.
status

object (ComplianceStatus)

Es el estado de cumplimiento del requisito.

ComplianceRequirement

Es el requisito de cumplimiento.

Enums
COMPLIANCE_REQUIREMENT_UNSPECIFIED Sin especificar.
SPF Indica si el remitente configuró correctamente el SPF.
DKIM Indica si el remitente configuró correctamente DKIM.
SPF_AND_DKIM Indica si el remitente configuró correctamente SPF y DKIM.
DMARC_POLICY Indica si el remitente configuró la política de DMARC.
DMARC_ALIGNMENT Si el encabezado De: está alineado con DKIM o SPF
MESSAGE_FORMATTING Indica si los mensajes tienen el formato correcto según la RFC 5322.
DNS_RECORDS Indica si el dominio tiene registros DNS inversos y de reenvío.
ENCRYPTION Indica si los mensajes tienen encriptación TLS.
USER_REPORTED_SPAM_RATE Indica si el remitente está por debajo de un umbral para el porcentaje de spam denunciado por los usuarios.
ONE_CLICK_UNSUBSCRIBE Indica si el remitente admite la anulación de la suscripción con un clic de forma suficiente. Ten en cuenta que el requisito para los usuarios es "cancelación de suscripción con un solo clic", pero exigimos el cumplimiento de varias reglas de "compatibilidad con la cancelación de suscripción".
HONOR_UNSUBSCRIBE Indica si el remitente acepta las solicitudes de cancelación de suscripción iniciadas por el usuario.

ComplianceStatus

Es el estado de un requisito de cumplimiento del remitente.

Representación JSON 
{
  "status": enum (State)
}
Campos
status

enum (State)

Solo salida. Es el estado de cumplimiento.

Estado

Son los tipos de estado para un requisito de cumplimiento específico del remitente.

Enums
STATE_UNSPECIFIED Sin especificar.
COMPLIANT Se cumple con el requisito de cumplimiento y se considera que el remitente cumple con las normas.
NEEDS_WORK No se cumple el requisito de cumplimiento, y el remitente debe realizar tareas para lograr el cumplimiento.

OneClickUnsubscribeVerdict

Es el veredicto de cumplimiento que indica si un remitente satisface el requisito de cumplimiento de anulación de suscripción con un clic.

Representación JSON 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
Campos
status

object (ComplianceStatus)

Es el estado de cumplimiento.
reason

enum (Reason)

Es el motivo específico del veredicto de cumplimiento. Debe estar vacío si el estado es de cumplimiento.

Motivo

Es el motivo específico por el que el veredicto de cancelación con un solo clic tiene el estado "No conforme".

Enums
REASON_UNSPECIFIED Sin especificar.
NO_UNSUB_GENERAL El remitente no admite la anulación de la suscripción con un clic en la mayoría de sus mensajes.
NO_UNSUB_SPAM_REPORTS El remitente no admite la anulación de la suscripción con un clic para la mayoría de los mensajes que se denuncian manualmente como spam.
NO_UNSUB_PROMO_SPAM_REPORTS El remitente no admite la anulación de la suscripción con un clic para la mayoría de los mensajes promocionales que se denuncian manualmente como spam. Esta clasificación de mensajes es un subconjunto de los que abarca NO_UNSUB_SPAM_REPORTS.

HonorUnsubscribeVerdict

Es el veredicto de cumplimiento que indica si un remitente cumple con el requisito de cumplimiento de respeto de las cancelaciones de suscripción.

Representación JSON 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
Campos
status

object (ComplianceStatus)

Es el estado de cumplimiento.
reason

enum (Reason)

Es el motivo específico del veredicto de cumplimiento. Debe estar vacío si el estado es de cumplimiento.

Motivo

Es el motivo específico por el que un veredicto de cumplimiento de la cancelación de la suscripción tiene el estado "incumplimiento".

Enums
REASON_UNSPECIFIED Sin especificar.
NOT_HONORING El remitente no respeta las solicitudes de cancelación de suscripción.
NOT_HONORING_TOO_FEW_CAMPAIGNS El remitente no respeta las solicitudes de cancelación de suscripción y considera aumentar la cantidad de campañas pertinentes.
NOT_HONORING_TOO_MANY_CAMPAIGNS El remitente no respeta las solicitudes de cancelación de suscripción y considera reducir la cantidad de campañas pertinentes.