Method: domains.getComplianceStatus

Truy xuất trạng thái tuân thủ của một miền nhất định. Trả về PERMISSION_DENIED nếu bạn không có quyền truy cập vào trạng thái tuân thủ của miền.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Tham số
name

string

Bắt buộc. Tên tài nguyên của trạng thái tuân thủ của miền cần truy xuất. Định dạng: domains/{domainId}/complianceStatus.

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Trạng thái tuân thủ của một miền.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "complianceData": {
    object (DomainComplianceData)
  },
  "subdomainComplianceData": {
    object (DomainComplianceData)
  }
}
Trường
name

string

Giá trị nhận dạng. Tên tài nguyên của trạng thái tuân thủ của miền. Định dạng: domains/{domainId}/complianceStatus.
complianceData

object (DomainComplianceData)

Dữ liệu tuân thủ cho phần miền có thể đăng ký của miền trong name. Ví dụ: nếu name là domains/example.com/complianceStatus, thì trường này chứa dữ liệu tuân thủ cho example.com.
subdomainComplianceData

object (DomainComplianceData)

Dữ liệu tuân thủ được tính toán riêng cho miền con trong name. Trường này chỉ được điền sẵn nếu miền trong name là một miền con khác với miền có thể đăng ký của miền đó (ví dụ: sub.example.com) và nếu có dữ liệu tuân thủ cho miền con cụ thể đó.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.

DomainComplianceData

Dữ liệu tuân thủ cho một miền cụ thể.

Biểu diễn dưới dạng JSON 
{
  "domainId": string,
  "rowData": [
    {
      object (ComplianceRowData)
    }
  ],
  "oneClickUnsubscribeVerdict": {
    object (OneClickUnsubscribeVerdict)
  },
  "honorUnsubscribeVerdict": {
    object (HonorUnsubscribeVerdict)
  }
}
Trường
domainId

string

Miền mà dữ liệu này dành cho.
rowData[]

object (ComplianceRowData)

Dữ liệu cho từng hàng trong bảng. Mỗi thông báo chứa tất cả dữ liệu hỗ trợ một hàng duy nhất.
oneClickUnsubscribeVerdict

object (OneClickUnsubscribeVerdict)

Kết quả tuân thủ tính năng nhấp một lần để huỷ đăng ký.
honorUnsubscribeVerdict

object (HonorUnsubscribeVerdict)

Tuân thủ kết quả về việc huỷ đăng ký.

ComplianceRowData

Dữ liệu cho một hàng duy nhất trong bảng trạng thái tuân thủ.

Biểu diễn dưới dạng JSON 
{
  "requirement": enum (ComplianceRequirement),
  "status": {
    object (ComplianceStatus)
  }
}
Trường
requirement

enum (ComplianceRequirement)

Yêu cầu tuân thủ.
status

object (ComplianceStatus)

Trạng thái tuân thủ của yêu cầu.

ComplianceRequirement

Yêu cầu tuân thủ.

Enum
COMPLIANCE_REQUIREMENT_UNSPECIFIED Không xác định.
SPF Người gửi đã định cấu hình SPF đúng cách hay chưa.
DKIM Người gửi đã định cấu hình DKIM đúng cách hay chưa.
SPF_AND_DKIM Người gửi đã định cấu hình đúng cả SPF và DKIM hay chưa.
DMARC_POLICY Người gửi đã định cấu hình chính sách DMARC hay chưa.
DMARC_ALIGNMENT Phần đầu thư Từ: có khớp với DKIM hoặc SPF hay không
MESSAGE_FORMATTING Thư có được định dạng đúng cách theo RFC 5322 hay không.
DNS_RECORDS Miền có bản ghi DNS chuyển tiếp và bản ghi DNS ngược hay không.
ENCRYPTION Thư có được mã hoá bằng TLS hay không.
USER_REPORTED_SPAM_RATE Người gửi có tỷ lệ thư rác do người dùng báo cáo thấp hơn ngưỡng hay không.
ONE_CLICK_UNSUBSCRIBE Liệu người gửi có hỗ trợ đầy đủ tính năng huỷ đăng ký bằng một lần nhấp hay không. Xin lưu ý rằng yêu cầu đối với người dùng là "huỷ đăng ký bằng một lần nhấp", nhưng chúng tôi yêu cầu bạn phải đáp ứng nhiều quy tắc "hỗ trợ huỷ đăng ký".
HONOR_UNSUBSCRIBE Liệu người gửi có tuân thủ các yêu cầu huỷ đăng ký do người dùng thực hiện hay không.

ComplianceStatus

Trạng thái của một yêu cầu tuân thủ dành cho người gửi email.

Biểu diễn dưới dạng JSON 
{
  "status": enum (State)
}
Trường
status

enum (State)

Chỉ có đầu ra. Trạng thái tuân thủ.

Tiểu bang

Các loại trạng thái cho một yêu cầu tuân thủ cụ thể của người gửi.

Enum
STATE_UNSPECIFIED Không xác định.
COMPLIANT Yêu cầu tuân thủ đã được đáp ứng và người gửi email được coi là tuân thủ.
NEEDS_WORK Người gửi chưa đáp ứng yêu cầu tuân thủ và cần phải thực hiện các bước để đạt được trạng thái tuân thủ.

OneClickUnsubscribeVerdict

Kết quả tuân thủ cho biết liệu người gửi có đáp ứng yêu cầu tuân thủ về chức năng huỷ đăng ký bằng một lần nhấp hay không.

Biểu diễn dưới dạng JSON 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
Trường
status

object (ComplianceStatus)

Trạng thái tuân thủ.
reason

enum (Reason)

Lý do cụ thể dẫn đến kết quả tuân thủ. Phải trống nếu trạng thái là tuân thủ.

Lý do

Lý do cụ thể khiến kết quả nhấp một lần để huỷ đăng ký có trạng thái "không tuân thủ".

Enum
REASON_UNSPECIFIED Không xác định.
NO_UNSUB_GENERAL Người gửi không hỗ trợ tính năng huỷ đăng ký bằng một lần nhấp cho phần lớn thư của họ.
NO_UNSUB_SPAM_REPORTS Người gửi không hỗ trợ chức năng huỷ đăng ký bằng một lần nhấp cho hầu hết những thư bị báo cáo là thư rác theo cách thủ công.
NO_UNSUB_PROMO_SPAM_REPORTS Người gửi không hỗ trợ chức năng huỷ đăng ký bằng một lần nhấp cho hầu hết các thư quảng cáo bị báo cáo là thư rác theo cách thủ công. Việc phân loại thư này là một phần nhỏ trong số những thư thuộc phạm vi NO_UNSUB_SPAM_REPORTS.

HonorUnsubscribeVerdict

Kết quả tuân thủ cho biết liệu người gửi email có đáp ứng yêu cầu tuân thủ việc tôn trọng lựa chọn không nhận email hay không.

Biểu diễn dưới dạng JSON 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
Trường
status

object (ComplianceStatus)

Trạng thái tuân thủ.
reason

enum (Reason)

Lý do cụ thể dẫn đến kết quả tuân thủ. Phải trống nếu trạng thái là tuân thủ.

Lý do

Lý do cụ thể khiến kết quả tuân thủ yêu cầu không nhận email có trạng thái "không tuân thủ".

Enum
REASON_UNSPECIFIED Không xác định.
NOT_HONORING Người gửi không thực hiện các yêu cầu huỷ đăng ký.
NOT_HONORING_TOO_FEW_CAMPAIGNS Người gửi không xử lý yêu cầu huỷ đăng ký và cân nhắc việc tăng số lượng chiến dịch có liên quan.
NOT_HONORING_TOO_MANY_CAMPAIGNS Người gửi không xử lý yêu cầu huỷ đăng ký và cân nhắc giảm số lượng chiến dịch có liên quan.