Method: domains.getComplianceStatus

מאחזר את סטטוס התאימות של דומיין נתון. הפונקציה מחזירה PERMISSION_DENIED אם אין לכם הרשאה לגשת לסטטוס התאימות של הדומיין.

בקשת HTTP

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

כתובת ה-URL כתובה בתחביר של gRPC Transcoding.

פרמטרים של נתיב

פרמטרים
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), and if compliance data is available for that specific subdomain.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של 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 אם הכותרת 'מאת:' תואמת ל-DKIM או ל-SPF
MESSAGE_FORMATTING האם ההודעות מעוצבות בצורה נכונה בהתאם ל-RFC 5322.
DNS_RECORDS האם לדומיין יש רשומות DNS להעברה ורשומות DNS הפוכות.
ENCRYPTION האם ההודעות מוצפנות באמצעות TLS.
USER_REPORTED_SPAM_RATE אם שיעור הספאם שדווח על ידי המשתמשים נמוך מהסף.
ONE_CLICK_UNSUBSCRIBE האם השולח תומך בביטול הרשמה בלחיצה אחת באופן מספק. שימו לב שהדרישה שמוצגת למשתמשים היא "ביטול הרשמה בלחיצה אחת", אבל אנחנו דורשים עמידה בכמה כללים של "תמיכה בביטול הרשמה".
HONOR_UNSUBSCRIBE האם השולח מכבד בקשות לביטול הרשמה שהמשתמשים יזמו.

ComplianceStatus

הסטטוס של דרישת תאימות לשולח.

ייצוג ב-JSON 
{
  "status": enum (State)
}
שדות
status

enum (State)

פלט בלבד. סטטוס התאימות.

מדינה (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 השולח לא מכבד בקשות להסרה מרשימת התפוצה, וכדאי לצמצם את מספר הקמפיינים הרלוונטיים.