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 تُستخدَم لتحديد ما إذا كان المرسِل يتيح ميزة إلغاء الاشتراك بنقرة واحدة بشكل كافٍ. يُرجى العِلم أنّ المتطلب الذي يواجهه المستخدم هو "إلغاء الاشتراك بنقرة واحدة"، ولكنّنا نشترط استيفاء قواعد متعددة بشأن "إتاحة إلغاء الاشتراك".
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 لا يستجيب المرسِل لطلبات إلغاء الاشتراك، لذا ننصحك بتقليل عدد الحملات ذات الصلة.