Method: domains.getComplianceStatus

وضعیت انطباق برای یک دامنه‌ی مشخص را بازیابی می‌کند. اگر مجوز دسترسی به وضعیت انطباق برای دامنه را نداشته باشید، مقدار PERMISSION_DENIED را برمی‌گرداند.

درخواست HTTP

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

این URL از سینتکس Transcoding در 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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

داده‌های انطباق دامنه

داده‌های انطباق برای یک دامنه مشخص.

نمایش JSON 
{
  "domainId": string,
  "rowData": [
    {
      object (ComplianceRowData)
    }
  ],
  "oneClickUnsubscribeVerdict": {
    object (OneClickUnsubscribeVerdict)
  },
  "honorUnsubscribeVerdict": {
    object (HonorUnsubscribeVerdict)
  }
}
فیلدها
domainId

string

دامنه‌ای که این داده‌ها برای آن است.

rowData[]

object ( ComplianceRowData )

داده‌های مربوط به هر یک از ردیف‌های جدول. هر پیام شامل تمام داده‌هایی است که از یک ردیف واحد پشتیبانی می‌کنند.

oneClickUnsubscribeVerdict

object ( OneClickUnsubscribeVerdict )

حکم انطباق با لغو اشتراک با یک کلیک.

honorUnsubscribeVerdict

object ( HonorUnsubscribeVerdict )

لغو اشتراک به احترام حکم انطباق.

داده‌های ردیف انطباق

داده‌های مربوط به یک ردیف از جدول وضعیت انطباق.

نمایش JSON 
{
  "requirement": enum (ComplianceRequirement),
  "status": {
    object (ComplianceStatus)
  }
}
فیلدها
requirement

enum ( ComplianceRequirement )

الزام انطباق.

status

object ( ComplianceStatus )

وضعیت انطباق با الزام.

الزامات انطباق

الزام انطباق.

انوم‌ها
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 اینکه آیا فرستنده درخواست‌های لغو اشتراک از سوی کاربر را می‌پذیرد یا خیر.

وضعیت انطباق

وضعیت الزامات انطباق فرستنده.

نمایش JSON 
{
  "status": enum (State)
}
فیلدها
status

enum ( State )

فقط خروجی. وضعیت انطباق.

ایالت

انواع وضعیت برای یک الزام انطباق فرستنده خاص.

انوم‌ها
STATE_UNSPECIFIED نامشخص.
COMPLIANT الزام انطباق برآورده شده است و فرستنده مطابق با الزامات تلقی می‌شود.
NEEDS_WORK الزام انطباق برآورده نشده است و فرستنده باید برای دستیابی به انطباق تلاش کند.

حکم لغو اشتراک با یک کلیک

حکم انطباق برای اینکه آیا فرستنده الزام انطباق با لغو اشتراک با یک کلیک را برآورده می‌کند یا خیر.

نمایش 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 قرار می‌گیرند.

افتخارلغو اشتراکحکم

حکم انطباق برای اینکه آیا فرستنده، الزام انطباق با لغو اشتراک را رعایت می‌کند یا خیر.

نمایش 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 فرستنده به درخواست‌های لغو اشتراک توجهی نمی‌کند و کاهش تعداد کمپین‌های مرتبط را در نظر می‌گیرد.