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

ข้อกำหนดด้านการปฏิบัติตามข้อกำหนด

Enum
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 แบบส่งต่อและย้อนกลับหรือไม่
ENCRYPTION ไม่ว่าข้อความจะมีการเข้ารหัส TLS หรือไม่
USER_REPORTED_SPAM_RATE ผู้ส่งมีอัตราจดหมายขยะที่ผู้ใช้รายงานต่ำกว่าเกณฑ์หรือไม่
ONE_CLICK_UNSUBSCRIBE ผู้ส่งรองรับการยกเลิกการสมัครรับอีเมลในคลิกเดียวอย่างเพียงพอหรือไม่ โปรดทราบว่าข้อกำหนดที่ผู้ใช้เห็นคือ "ยกเลิกการสมัครรับอีเมลได้ในคลิกเดียว" แต่เรากำหนดให้ต้องปฏิบัติตามกฎ "การสนับสนุนการยกเลิกการสมัครรับอีเมล" หลายข้อ
HONOR_UNSUBSCRIBE ผู้ส่งปฏิบัติตามคำขอเลิกติดตามที่ผู้ใช้เป็นผู้เริ่มหรือไม่

ComplianceStatus

สถานะของข้อกำหนดในการปฏิบัติตามข้อกำหนดของผู้ส่ง

การแสดง JSON 
{
  "status": enum (State)
}
ช่อง
status

enum (State)

เอาต์พุตเท่านั้น สถานะการปฏิบัติตามข้อกำหนด

รัฐ

ประเภทสถานะสำหรับข้อกำหนดในการปฏิบัติตามข้อกำหนดของผู้ส่งที่เฉพาะเจาะจง

Enum
STATE_UNSPECIFIED ไม่ระบุ
COMPLIANT เป็นไปตามข้อกำหนดด้านการปฏิบัติตามข้อกำหนด และถือว่าผู้ส่งปฏิบัติตามข้อกำหนด
NEEDS_WORK ไม่เป็นไปตามข้อกำหนดด้านการปฏิบัติตามข้อกำหนด และผู้ส่งต้องดำเนินการเพื่อให้เป็นไปตามข้อกำหนด

OneClickUnsubscribeVerdict

ผลการตัดสินการปฏิบัติตามข้อกำหนดว่าผู้ส่งเป็นไปตามข้อกำหนดในการปฏิบัติตามข้อกำหนดการยกเลิกการสมัครรับอีเมลในคลิกเดียวหรือไม่

การแสดง JSON 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
ช่อง
status

object (ComplianceStatus)

สถานะการปฏิบัติตามข้อกำหนด
reason

enum (Reason)

เหตุผลที่เฉพาะเจาะจงสำหรับผลการตัดสินด้านการปฏิบัติตามข้อกำหนด ต้องเว้นว่างไว้หากสถานะเป็นไปตามข้อกำหนด

เหตุผล

เหตุผลที่เฉพาะเจาะจงที่ทำให้คำตัดสินการยกเลิกการสมัครรับอีเมลในคลิกเดียวมีสถานะ "ไม่เป็นไปตามข้อกำหนด"

Enum
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)

เหตุผลที่เฉพาะเจาะจงสำหรับผลการตัดสินด้านการปฏิบัติตามข้อกำหนด ต้องเว้นว่างไว้หากสถานะเป็นไปตามข้อกำหนด

เหตุผล

เหตุผลที่เฉพาะเจาะจงที่ทำให้คำตัดสินการยกเลิกการติดตามมีสถานะ "ไม่เป็นไปตามข้อกำหนด"

Enum
REASON_UNSPECIFIED ไม่ระบุ
NOT_HONORING ผู้ส่งไม่ยอมรับคำขอยกเลิกการติดตาม
NOT_HONORING_TOO_FEW_CAMPAIGNS ผู้ส่งไม่ดำเนินการตามคำขอยกเลิกการสมัครรับอีเมลและพิจารณาเพิ่มจำนวนแคมเปญที่เกี่ยวข้อง
NOT_HONORING_TOO_MANY_CAMPAIGNS ผู้ส่งไม่ปฏิบัติตามคำขอยกเลิกการสมัครรับอีเมลและพิจารณาลดจำนวนแคมเปญที่เกี่ยวข้อง