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 वैल्यू (अगर कोई हो).

अनुरोध का मुख्य हिस्सा

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

जवाब का मुख्य हिस्सा

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

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

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

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