Method: domains.getComplianceStatus

यह फ़ंक्शन, किसी डोमेन के लिए नीति के मुताबिक होने की स्थिति को वापस लाता है. अगर आपके पास डोमेन के लिए, अनुपालन की स्थिति को ऐक्सेस करने की अनुमति नहीं है, तो यह PERMISSION_DENIED दिखाता है.

एचटीटीपी अनुरोध

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

यह यूआरएल, 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

अनुपालन से जुड़ी ज़रूरी शर्तें.

Enums
COMPLIANCE_REQUIREMENT_UNSPECIFIED नहीं बताया गया है
SPF भेजने वाले ने एसपीएफ़ को सही तरीके से कॉन्फ़िगर किया है या नहीं.
DKIM ईमेल भेजने वाले ने डीकेआईएम को सही तरीके से कॉन्फ़िगर किया है या नहीं.
SPF_AND_DKIM ईमेल भेजने वाले व्यक्ति या कंपनी ने एसपीएफ़ और डीकेआईएम, दोनों को सही तरीके से कॉन्फ़िगर किया है या नहीं.
DMARC_POLICY ईमेल भेजने वाले व्यक्ति या कंपनी ने DMARC नीति कॉन्फ़िगर की है या नहीं.
DMARC_ALIGNMENT 'इन्होंने भेजा:' हेडर, डीकेआईएम या एसपीएफ़ के साथ अलाइन है या नहीं
MESSAGE_FORMATTING ईमेल को आरएफ़सी 5322 के मुताबिक सही तरीके से फ़ॉर्मैट किया गया है या नहीं.
DNS_RECORDS डोमेन में फ़ॉरवर्ड और रिवर्स डीएनएस रिकॉर्ड हैं या नहीं.
ENCRYPTION इससे पता चलता है कि ईमेल को टीएलएस की मदद से एन्क्रिप्ट (सुरक्षित) किया गया है या नहीं.
USER_REPORTED_SPAM_RATE क्या ईमेल भेजने वाले व्यक्ति या कंपनी का स्पैम रेट, थ्रेशोल्ड से कम है.
ONE_CLICK_UNSUBSCRIBE ईमेल भेजने वाले व्यक्ति या कंपनी ने, एक क्लिक में सदस्यता छोड़ने की सुविधा दी है या नहीं. ध्यान दें कि उपयोगकर्ताओं के लिए, "एक क्लिक में सदस्यता छोड़ें" सुविधा उपलब्ध होना ज़रूरी है. हालांकि, हमें "सदस्यता छोड़ने से जुड़ी सहायता" के कई नियमों का पालन करना होता है.
HONOR_UNSUBSCRIBE क्या ईमेल भेजने वाला व्यक्ति, सदस्यता छोड़ने के लिए उपयोगकर्ता के अनुरोधों का पालन करता है.

ComplianceStatus

ईमेल भेजने वाले व्यक्ति या कंपनी के लिए, अनुपालन से जुड़ी ज़रूरी शर्तों का स्टेटस.

JSON के काेड में दिखाना 
{
  "status": enum (State)
}
फ़ील्ड
status

enum (State)

सिर्फ़ आउटपुट के लिए. अनुपालन की स्थिति.

राज्य

ईमेल भेजने वाले किसी व्यक्ति या कंपनी के लिए, अनुपालन से जुड़ी किसी खास ज़रूरी शर्त के स्टेटस टाइप.

Enums
STATE_UNSPECIFIED नहीं बताया गया है
COMPLIANT अनुपालन से जुड़ी ज़रूरी शर्तें पूरी की गई हैं और ईमेल भेजने वाले को अनुपालन करने वाला माना जाता है.
NEEDS_WORK नीति के मुताबिक काम करने की ज़रूरी शर्त पूरी नहीं की गई है. इसलिए, ईमेल भेजने वाले को नीति के मुताबिक काम करने के लिए ज़रूरी कार्रवाई करनी होगी.

OneClickUnsubscribeVerdict

यह जानकारी, ईमेल भेजने वाले व्यक्ति या कंपनी के लिए यह तय करती है कि वह एक क्लिक में सदस्यता छोड़ने की सुविधा देने से जुड़ी ज़रूरी शर्तों का पालन करती है या नहीं.

JSON के काेड में दिखाना 
{
  "status": {
    object (ComplianceStatus)
  },
  "reason": enum (Reason)
}
फ़ील्ड
status

object (ComplianceStatus)

अनुपालन की स्थिति.
reason

enum (Reason)

नीति के उल्लंघन से जुड़ी समस्या ठीक होने के बारे में फ़ैसले की वजह. अगर स्थिति 'नीति का पालन किया गया' है, तो यह खाली होना चाहिए.

कारण

एक क्लिक में सदस्यता छोड़ने की सुविधा से जुड़े नतीजे के "ज़रूरी शर्तें पूरी नहीं कीं" स्टेटस की वजह.

Enums
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)

नीति के उल्लंघन से जुड़ी समस्या ठीक होने के बारे में फ़ैसले की वजह. अगर स्थिति 'नीति का पालन किया गया' है, तो यह खाली होना चाहिए.

कारण

अनसब्सक्राइब करने के अनुरोध को पूरा करने के फ़ैसले के "नीति का उल्लंघन करने वाला" स्टेटस होने की वजह.

Enums
REASON_UNSPECIFIED नहीं बताया गया है
NOT_HONORING भेजने वाला व्यक्ति या कंपनी, सदस्यता छोड़ने के अनुरोधों को पूरा नहीं करती.
NOT_HONORING_TOO_FEW_CAMPAIGNS भेजने वाला व्यक्ति, ईमेल पाने की सुविधा से ऑप्ट आउट करने के अनुरोधों का पालन नहीं करता. साथ ही, वह काम के कैंपेन की संख्या बढ़ाने पर विचार करता है.
NOT_HONORING_TOO_MANY_CAMPAIGNS भेजने वाला व्यक्ति, सदस्यता छोड़ने के अनुरोधों का पालन नहीं करता. साथ ही, उसे काम के कैंपेन की संख्या कम करनी चाहिए.