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 发件人未遵从退订请求，请考虑减少相关广告系列的数量。