Method: domains.getComplianceStatus

指定されたドメインのコンプライアンス ステータスを取得します。ドメインのコンプライアンス ステータスにアクセスする権限がない場合は、PERMISSION_DENIED を返します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
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 From: ヘッダーが DKIM または SPF に適合しているかどうか
MESSAGE_FORMATTING メールが RFC 5322 に準拠する形式で正しく作成されているかどうか。
DNS_RECORDS ドメインに正引き DNS レコードと逆引き DNS レコードがあるかどうか。
ENCRYPTION メッセージが TLS で暗号化されているかどうか。
USER_REPORTED_SPAM_RATE 送信者のユーザーが報告した迷惑メール率がしきい値を下回っているかどうか。
ONE_CLICK_UNSUBSCRIBE 送信者がワンクリックでの登録解除を十分にサポートしているかどうか。ユーザー向けの要件は「ワンクリックでの登録解除」ですが、Google では複数の「登録解除サポート」ルールを満たす必要があります。
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 送信者が登録解除リクエストを尊重していない場合は、関連するキャンペーンの数を減らすことを検討してください。