Method: domains.list

यह फ़ंक्शन, आपके रजिस्टर किए गए सभी डोमेन की सूची और उनसे जुड़े मेटाडेटा को वापस लाता है. जवाब में डोमेन का क्रम तय नहीं होता और यह अनुमान नहीं लगाया जा सकता कि किस क्रम में डोमेन दिखेंगे. ज़रूरी नहीं कि नए रजिस्टर किए गए डोमेन, इस सूची के आखिर में जोड़े जाएं.

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

GET https://gmailpostmastertools.googleapis.com/v2beta/domains

यह यूआरएल, gRPC ट्रांसकोडिंग सिंटैक्स का इस्तेमाल करता है.

क्वेरी पैरामीटर

पैरामीटर
pageSize

integer

ज़रूरी नहीं. अनुरोध किया गया पेज साइज़. सर्वर, अनुरोध किए गए डोमेन से कम डोमेन दिखा सकता है. अगर कोई वैल्यू तय नहीं की गई है, तो इस फ़ील्ड के लिए डिफ़ॉल्ट वैल्यू 10 होती है. इस फ़ील्ड के लिए ज़्यादा से ज़्यादा 200 वैल्यू डाली जा सकती हैं.
pageToken

string

ज़रूरी नहीं. अगर कोई पिछली सूची का अनुरोध किया गया है, तो उससे मिला nextPageToken वैल्यू.

अनुरोध का मुख्य भाग

अनुरोध का मुख्य हिस्सा खाली होना चाहिए.

जवाब का मुख्य भाग

domains.list के लिए जवाब का मैसेज.

अगर एपीआई सही से जुड़ जाता है, ताे जवाब के मुख्य भाग में नीचे दिए गए स्ट्रक्चर शामिल होता है.

JSON के काेड में दिखाना 
{
  "domains": [
    {
      object (Domain)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
domains[]

object (Domain)

वे डोमेन जिन्हें उपयोगकर्ता ने रजिस्टर किया है.
nextPageToken

string

नतीजों का अगला पेज पाने के लिए टोकन. अगर सूची में और नतीजे नहीं हैं, तो यह खाली होता है.

अनुमति पाने के लिंक

इसके लिए, इनमें से किसी एक OAuth स्कोप की ज़रूरत होती है:

  • https://www.googleapis.com/auth/postmaster
  • https://www.googleapis.com/auth/postmaster.domain

ज़्यादा जानकारी के लिए, अनुमति देने से जुड़ी गाइड देखें.