Method: domains.getComplianceStatus

Recupera o status de compliance de um determinado domínio. Retorna PERMISSION_DENIED se você não tiver permissão para acessar o status de compliance do domínio.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
name

string

Obrigatório. O nome do recurso do status de compliance do domínio a ser recuperado. Formato: domains/{domainId}/complianceStatus.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Status de compliance de um domínio.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "name": string,
  "complianceData": {
    object (DomainComplianceData)
  },
  "subdomainComplianceData": {
    object (DomainComplianceData)
  }
}
Campos
name

string

Identificador. O nome do recurso do status de compliance do domínio. Formato: domains/{domainId}/complianceStatus.
complianceData

object (DomainComplianceData)

Dados de compliance da parte do domínio que pode ser registrada em name. Por exemplo, se name for domains/example.com/complianceStatus, esse campo vai conter dados de compliance para example.com.
subdomainComplianceData

object (DomainComplianceData)

Dados de compliance calculados especificamente para o subdomínio em name. Esse campo só será preenchido se o domínio em name for um subdomínio diferente do domínio registrável (por exemplo, sub.example.com) e se os dados de compliance estão disponíveis para esse subdomínio específico.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte o guia de autorização.

DomainComplianceData

Dados de compliance para um determinado domínio.

Representação JSON 
{
  "domainId": string,
  "rowData": [
    {
      object (ComplianceRowData)
    }
  ],
  "oneClickUnsubscribeVerdict": {
    object (OneClickUnsubscribeVerdict)
  },
  "honorUnsubscribeVerdict": {
    object (HonorUnsubscribeVerdict)
  }
}
Campos
domainId

string

Domínio a que esses dados se referem.
rowData[]

object (ComplianceRowData)

Dados de cada uma das linhas da tabela. Cada mensagem contém todos os dados que sustentam uma única linha.
oneClickUnsubscribeVerdict

object (OneClickUnsubscribeVerdict)

Veredicto de conformidade do cancelamento da inscrição com um clique.
honorUnsubscribeVerdict

object (HonorUnsubscribeVerdict)

Veredito de conformidade de cancelamento de inscrição.

ComplianceRowData

Dados de uma única linha da tabela de status de compliance.

Representação JSON 
{
  "requirement": enum (ComplianceRequirement),
  "status": {
    object (ComplianceStatus)
  }
}
Campos
requirement

enum (ComplianceRequirement)

O requisito de compliance.
status

object (ComplianceStatus)

O status de compliance do requisito.

ComplianceRequirement

O requisito de compliance.

Tipos enumerados
COMPLIANCE_REQUIREMENT_UNSPECIFIED Não especificado.
SPF Se o remetente configurou o SPF corretamente.
DKIM Se o remetente configurou o DKIM corretamente.
SPF_AND_DKIM Se o remetente configurou corretamente o SPF e o DKIM.
DMARC_POLICY Se o remetente configurou a política do DMARC.
DMARC_ALIGNMENT Se o cabeçalho "De:" está alinhado com o DKIM ou o SPF
MESSAGE_FORMATTING Se as mensagens estão formatadas corretamente de acordo com o RFC 5322.
DNS_RECORDS Se o domínio tem registros DNS de encaminhamento e reversos.
ENCRYPTION Se as mensagens têm criptografia TLS.
USER_REPORTED_SPAM_RATE Se o remetente está abaixo de um limite para a taxa de spams denunciados por usuários.
ONE_CLICK_UNSUBSCRIBE Se o remetente oferece suporte suficiente ao cancelamento da inscrição com um clique. O requisito para o usuário é "cancelamento da inscrição com um clique", mas exigimos o cumprimento de várias regras de "suporte ao cancelamento da inscrição".
HONOR_UNSUBSCRIBE Indica se o remetente atende aos pedidos de cancelamento de inscrição iniciados pelo usuário.

ComplianceStatus

O status de um requisito de compliance do remetente.

Representação JSON 
{
  "status": enum (State)
}
Campos
status

enum (State)

Apenas saída. O status de compliance.

Estado

Os tipos de status para um requisito de compliance de remetente específico.

Tipos enumerados
STATE_UNSPECIFIED Não especificado.
COMPLIANT O requisito de compliance é atendido, e o remetente é considerado em conformidade.
NEEDS_WORK O requisito de compliance não foi atendido, e o remetente precisa trabalhar para alcançar a conformidade.

OneClickUnsubscribeVerdict

Verificação de conformidade para saber se um remetente atende ao requisito de conformidade de cancelamento da inscrição com um clique.

Representação JSON 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
Campos
status

object (ComplianceStatus)

O status de compliance.
reason

enum (Reason)

O motivo específico do veredicto de compliance. Precisa estar vazio se o status for "em conformidade".

Motivo

O motivo específico pelo qual um veredito de cancelamento com um clique tem o status "em não conformidade".

Tipos enumerados
REASON_UNSPECIFIED Não especificado.
NO_UNSUB_GENERAL O remetente não oferece cancelamento da inscrição com um clique na maioria das mensagens.
NO_UNSUB_SPAM_REPORTS O remetente não oferece suporte ao cancelamento da inscrição com um clique para a maioria das mensagens denunciadas manualmente como spam.
NO_UNSUB_PROMO_SPAM_REPORTS O remetente não oferece suporte ao cancelamento da inscrição com um clique para a maioria das mensagens promocionais denunciadas manualmente como spam. Essa classificação de mensagens é um subconjunto daquelas abrangidas por NO_UNSUB_SPAM_REPORTS.

HonorUnsubscribeVerdict

Verificação de conformidade para saber se um remetente atende ao requisito de conformidade de cancelamento de inscrição.

Representação JSON 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
Campos
status

object (ComplianceStatus)

O status de compliance.
reason

enum (Reason)

O motivo específico do veredicto de compliance. Precisa estar vazio se o status for "em conformidade".

Motivo

O motivo específico pelo qual um veredito de respeito ao cancelamento de inscrição tem o status "em não conformidade".

Tipos enumerados
REASON_UNSPECIFIED Não especificado.
NOT_HONORING O remetente não aceita pedidos de cancelamento de inscrição.
NOT_HONORING_TOO_FEW_CAMPAIGNS O remetente não atende às solicitações de cancelamento de inscrição e considera aumentar o número de campanhas relevantes.
NOT_HONORING_TOO_MANY_CAMPAIGNS O remetente não atende aos pedidos de cancelamento de inscrição. Considere reduzir o número de campanhas relevantes.