Method: domains.getComplianceStatus

检索给定网域的合规状态。如果您没有访问网域合规状态的权限，则返回 PERMISSION_DENIED。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
name

string

必需。要检索的网域合规状态的资源名称。格式：domains/{domainId}/complianceStatus。

请求正文

请求正文必须为空。

响应正文

网域的合规状态。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "name": string,
  "complianceData": {
    object (DomainComplianceData)
  },
  "subdomainComplianceData": {
    object (DomainComplianceData)
  }
}
字段
name

string

标识符。网域合规状态的资源名称。格式：domains/{domainId}/complianceStatus。
complianceData

object (DomainComplianceData)

name 中网域的可注册网域部分的合规数据。例如，如果 name 为 domains/example.com/complianceStatus，则此字段包含 example.com 的合规数据。
subdomainComplianceData

object (DomainComplianceData)

专门为 name 中的子网域计算的合规数据。只有当 name 中的网域是不同于其可注册网域（例如 sub.example.com）的子网域，并且该特定子网域有合规数据时，系统才会填充此字段。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅授权指南。

DomainComplianceData

给定网域的合规数据。

JSON 表示法 
{
  "domainId": string,
  "rowData": [
    {
      object (ComplianceRowData)
    }
  ],
  "oneClickUnsubscribeVerdict": {
    object (OneClickUnsubscribeVerdict)
  },
  "honorUnsubscribeVerdict": {
    object (HonorUnsubscribeVerdict)
  }
}
字段
domainId

string

此数据所适用的网域。
rowData[]

object (ComplianceRowData)

表中每一行的数据。每条消息都包含支持单行的所有数据。
oneClickUnsubscribeVerdict

object (OneClickUnsubscribeVerdict)

一键退订合规性判定。
honorUnsubscribeVerdict

object (HonorUnsubscribeVerdict)

退订履行合规性判定。

ComplianceRowData

合规状态表中单行的数据。

JSON 表示法 
{
  "requirement": enum (ComplianceRequirement),
  "status": {
    object (ComplianceStatus)
  }
}
字段
requirement

enum (ComplianceRequirement)

合规要求。
status

object (ComplianceStatus)

该要求的合规状态。

ComplianceRequirement

合规要求。

枚举
COMPLIANCE_REQUIREMENT_UNSPECIFIED 未指定。
SPF 发件人是否已正确配置 SPF。
DKIM 发件人是否已正确配置 DKIM。
SPF_AND_DKIM 发件人是否已正确配置 SPF 和 DKIM。
DMARC_POLICY 发件人是否已配置 DMARC 政策。
DMARC_ALIGNMENT “发件人”标头是否与 DKIM 或 SPF 一致
MESSAGE_FORMATTING 邮件是否已根据 RFC 5322 正确设置格式。
DNS_RECORDS 网域是否有正向和反向 DNS 记录。
ENCRYPTION 邮件是否有 TLS 加密。
USER_REPORTED_SPAM_RATE 发件人被用户举报为垃圾邮件的比例是否低于阈值。
ONE_CLICK_UNSUBSCRIBE 发件人是否充分支持一键退订。请注意，面向用户的要求是“一键退订”，但我们需要满足多项“退订支持”规则。
HONOR_UNSUBSCRIBE 发件人是否履行用户发起的退订请求。

ComplianceStatus

发件人合规要求的状态。

JSON 表示法 
{
  "status": enum (State)
}
字段
status

enum (State)

仅限输出。合规状态。

状态

特定发件人合规要求的状态类型。

枚举
STATE_UNSPECIFIED 未指定。
COMPLIANT 满足合规要求，发件人被视为合规。
NEEDS_WORK 不满足合规要求，发件人需要采取措施才能实现合规。

OneClickUnsubscribeVerdict

发件人是否满足一键退订合规要求的合规性判定。

JSON 表示法 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
字段
status

object (ComplianceStatus)

合规状态。
reason

enum (Reason)

合规性判定的具体原因。如果状态为“合规”，则必须为空。

原因

一键退订判定状态为“不合规”的具体原因。

枚举
REASON_UNSPECIFIED 未指定。
NO_UNSUB_GENERAL 发件人不支持针对其大多数邮件的一键退订。
NO_UNSUB_SPAM_REPORTS 发件人不支持针对大多数手动举报为垃圾邮件的邮件的一键退订。
NO_UNSUB_PROMO_SPAM_REPORTS 发件人不支持针对大多数手动举报为垃圾邮件的促销邮件的一键退订。此类邮件是 NO_UNSUB_SPAM_REPORTS 所涵盖邮件的子集。

HonorUnsubscribeVerdict

发件人是否满足退订履行合规要求的合规性判定。

JSON 表示法 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
字段
status

object (ComplianceStatus)

合规状态。
reason

enum (Reason)

合规性判定的具体原因。如果状态为“合规”，则必须为空。

原因

退订履行判定状态为“不合规”的具体原因。

枚举
REASON_UNSPECIFIED 未指定。
NOT_HONORING 发件人不履行退订请求。
NOT_HONORING_TOO_FEW_CAMPAIGNS 发件人不履行退订请求，并考虑增加相关广告系列的数量。
NOT_HONORING_TOO_MANY_CAMPAIGNS 发件人不履行退订请求，并考虑减少相关广告系列的数量。