Method: domains.users.list

यह उन उपयोगकर्ताओं की सूची बनाता है जिनके पास किसी डोमेन का ऐक्सेस है.

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

GET https://gmailpostmastertools.googleapis.com/v2beta/{parent=domains/*}/users

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

पाथ पैरामीटर

पैरामीटर
parent

string

ज़रूरी है. उस पैरंट संसाधन का नाम जिसके लिए उपयोगकर्ताओं की सूची बनानी है. फ़ॉर्मैट: domains/{domain}

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

पैरामीटर
pageSize

integer

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

string

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

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

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

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

उपयोगकर्ताओं की सूची के लिए जवाब का मैसेज.

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

JSON फ़ॉर्मैट में दिखाया गया है 
{
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
फ़ील्ड
users[]

object (User)

उन उपयोगकर्ताओं की सूची जिनके पास डोमेन का ऐक्सेस है.
nextPageToken

string

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

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

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

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

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