Method: domains.getComplianceStatus

지정된 도메인의 규정 준수 상태를 가져옵니다. 도메인의 규정 준수 상태에 액세스할 권한이 없는 경우 PERMISSION_DENIED를 반환합니다.

HTTP 요청

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

URL은 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 발신자가 원클릭 수신 거부를 충분히 지원하는지 여부입니다. 사용자 대상 요구사항은 '원클릭 수신 거부'이지만 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 발신자가 수신 거부 요청을 준수하지 않으므로 관련 캠페인 수를 줄이는 것이 좋습니다.