Method: domains.getComplianceStatus

Mengambil status kepatuhan untuk domain tertentu. Menampilkan PERMISSION_DENIED jika Anda tidak memiliki izin untuk mengakses status kepatuhan untuk domain.

Permintaan HTTP

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

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
name

string

Wajib. Nama resource status kepatuhan domain yang akan diambil. Format: domains/{domainId}/complianceStatus.

Isi permintaan

Isi permintaan harus kosong.

Isi respons

Status kepatuhan untuk domain.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "name": string,
  "complianceData": {
    object (DomainComplianceData)
  },
  "subdomainComplianceData": {
    object (DomainComplianceData)
  }
}
Kolom
name

string

ID. Nama resource status kepatuhan domain. Format: domains/{domainId}/complianceStatus.
complianceData

object (DomainComplianceData)

Data kepatuhan untuk bagian domain yang dapat didaftarkan dari domain di name. Misalnya, jika name adalah domains/example.com/complianceStatus, kolom ini berisi data kepatuhan untuk example.com.
subdomainComplianceData

object (DomainComplianceData)

Data kepatuhan yang dihitung khusus untuk subdomain di name. Kolom ini hanya diisi jika domain di name adalah subdomain yang berbeda dari domain yang dapat didaftarkan (misalnya, sub.example.com), dan jika data kepatuhan tersedia untuk subdomain tertentu tersebut.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/postmaster
  • https://www.googleapis.com/auth/postmaster.traffic.readonly

Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.

DomainComplianceData

Data kepatuhan untuk domain tertentu.

Representasi JSON 
{
  "domainId": string,
  "rowData": [
    {
      object (ComplianceRowData)
    }
  ],
  "oneClickUnsubscribeVerdict": {
    object (OneClickUnsubscribeVerdict)
  },
  "honorUnsubscribeVerdict": {
    object (HonorUnsubscribeVerdict)
  }
}
Kolom
domainId

string

Domain yang datanya ini ditujukan untuk.
rowData[]

object (ComplianceRowData)

Data untuk setiap baris tabel. Setiap pesan berisi semua data yang mendukung satu baris.
oneClickUnsubscribeVerdict

object (OneClickUnsubscribeVerdict)

Putusan kepatuhan berhenti berlangganan sekali klik.
honorUnsubscribeVerdict

object (HonorUnsubscribeVerdict)

Berhenti berlangganan dengan mematuhi verdict kepatuhan.

ComplianceRowData

Data untuk satu baris tabel status kepatuhan.

Representasi JSON 
{
  "requirement": enum (ComplianceRequirement),
  "status": {
    object (ComplianceStatus)
  }
}
Kolom
requirement

enum (ComplianceRequirement)

Persyaratan kepatuhan.
status

object (ComplianceStatus)

Status kepatuhan untuk persyaratan.

ComplianceRequirement

Persyaratan kepatuhan.

Enum
COMPLIANCE_REQUIREMENT_UNSPECIFIED Tidak ditentukan.
SPF Apakah pengirim telah mengonfigurasi SPF dengan benar.
DKIM Apakah pengirim telah mengonfigurasi DKIM dengan benar.
SPF_AND_DKIM Apakah pengirim telah mengonfigurasi SPF dan DKIM dengan benar.
DMARC_POLICY Apakah pengirim telah mengonfigurasi kebijakan DMARC.
DMARC_ALIGNMENT Apakah header From: sesuai dengan DKIM atau SPF
MESSAGE_FORMATTING Apakah pesan diformat dengan benar sesuai dengan RFC 5322.
DNS_RECORDS Apakah domain memiliki data DNS penerusan dan balik.
ENCRYPTION Apakah pesan memiliki enkripsi TLS.
USER_REPORTED_SPAM_RATE Apakah pengirim berada di bawah batas untuk rasio spam yang dilaporkan pengguna.
ONE_CLICK_UNSUBSCRIBE Apakah pengirim mendukung fitur berhenti berlangganan sekali klik secara memadai. Perhatikan bahwa persyaratan yang ditampilkan kepada pengguna adalah "berhenti berlangganan sekali klik", tetapi kami mewajibkan pemenuhan beberapa aturan "dukungan berhenti berlangganan".
HONOR_UNSUBSCRIBE Apakah pengirim mematuhi permintaan berhenti berlangganan yang dimulai pengguna.

ComplianceStatus

Status persyaratan kepatuhan pengirim.

Representasi JSON 
{
  "status": enum (State)
}
Kolom
status

enum (State)

Hanya output. Status kepatuhan.

Negara Bagian

Jenis status untuk persyaratan kepatuhan pengirim tertentu.

Enum
STATE_UNSPECIFIED Tidak ditentukan.
COMPLIANT Persyaratan kepatuhan terpenuhi, dan pengirim dianggap mematuhi.
NEEDS_WORK Persyaratan kepatuhan tidak terpenuhi, dan pengirim perlu melakukan tindakan untuk mencapai kepatuhan.

OneClickUnsubscribeVerdict

Putusan kepatuhan untuk mengetahui apakah pengirim memenuhi persyaratan kepatuhan berhenti berlangganan dengan sekali klik.

Representasi JSON 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
Kolom
status

object (ComplianceStatus)

Status kepatuhan.
reason

enum (Reason)

Alasan spesifik untuk putusan kepatuhan. Harus kosong jika statusnya mematuhi.

Alasan

Alasan spesifik mengapa verdict berhenti berlangganan sekali klik memiliki status "tidak mematuhi".

Enum
REASON_UNSPECIFIED Tidak ditentukan.
NO_UNSUB_GENERAL Pengirim tidak mendukung opsi berhenti berlangganan dengan sekali klik untuk sebagian besar pesannya.
NO_UNSUB_SPAM_REPORTS Pengirim tidak mendukung opsi berhenti berlangganan sekali klik untuk sebagian besar pesan yang dilaporkan sebagai spam secara manual.
NO_UNSUB_PROMO_SPAM_REPORTS Pengirim tidak mendukung opsi berhenti berlangganan sekali klik untuk sebagian besar pesan promosi yang dilaporkan sebagai spam secara manual. Klasifikasi pesan ini adalah subkumpulan dari pesan yang tercakup dalam NO_UNSUB_SPAM_REPORTS.

HonorUnsubscribeVerdict

Putusan kepatuhan untuk mengetahui apakah pengirim memenuhi persyaratan kepatuhan terkait penghormatan permintaan berhenti berlangganan.

Representasi JSON 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
Kolom
status

object (ComplianceStatus)

Status kepatuhan.
reason

enum (Reason)

Alasan spesifik untuk putusan kepatuhan. Harus kosong jika statusnya mematuhi.

Alasan

Alasan spesifik mengapa verdict kepatuhan terhadap permintaan berhenti berlangganan memiliki status "tidak patuh".

Enum
REASON_UNSPECIFIED Tidak ditentukan.
NOT_HONORING Pengirim tidak mematuhi permintaan berhenti berlangganan.
NOT_HONORING_TOO_FEW_CAMPAIGNS Pengirim tidak mematuhi permintaan berhenti berlangganan dan mempertimbangkan untuk meningkatkan jumlah kampanye yang relevan.
NOT_HONORING_TOO_MANY_CAMPAIGNS Pengirim tidak mematuhi permintaan berhenti berlangganan dan sebaiknya kurangi jumlah kampanye yang relevan.