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

ID。網域法規遵循狀態的資源名稱。格式：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 寄件者未遵守取消訂閱要求，請考慮減少相關廣告活動的數量。