Method: accounts.list

पुष्टि किए गए उपयोगकर्ता के सभी खातों की सूची बनाता है. इसमें उपयोगकर्ता के मालिकाना हक वाले सभी खाते शामिल हैं. साथ ही, इसमें वे सभी खाते भी शामिल हैं जिनके मैनेजमेंट के अधिकार उपयोगकर्ता के पास हैं.

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

GET https://mybusinessaccountmanagement.googleapis.com/v1/accounts

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

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

पैरामीटर
parentAccount

string

ज़रूरी नहीं. उस खाते का संसाधन नाम जिसके लिए सीधे ऐक्सेस किए जा सकने वाले खातों की सूची को वापस लाना है. यह सिर्फ़ संगठनों और उपयोगकर्ताओं के ग्रुप के लिए काम का है. अगर यह वैल्यू खाली है, तो पुष्टि किए गए उपयोगकर्ता के लिए accounts.list दिखेगा. accounts/{account_id}.
pageSize

integer

ज़रूरी नहीं. हर पेज पर कितने खाते फ़ेच करने हैं. डिफ़ॉल्ट वैल्यू और ज़्यादा से ज़्यादा 20 वैल्यू हो सकती हैं.
pageToken

string

ज़रूरी नहीं. तय किए जाने पर, खातों का अगला पेज फिर से मिलेगा. जब accounts.list को किए जाने वाले कॉल, अनुरोध किए गए पेज साइज़ के हिसाब से ज़्यादा नतीजे दिखाते हैं, तो pageToken दिखता है.
filter

string

ज़रूरी नहीं. एक फ़िल्टर, जो खातों को लौटाने के लिए सीमित करता है. इस जवाब में सिर्फ़ फ़िल्टर से मेल खाने वाली एंट्री शामिल होती हैं. अगर filter खाली है, तो कोई पाबंदी लागू नहीं होती. साथ ही, अनुरोध किए गए खाते से सभी खातों (पेजों में बांटा गया) को वापस लाया जाता है.

जैसे, type=USER_GROUP फ़िल्टर वाला अनुरोध सिर्फ़ उपयोगकर्ता ग्रुप दिखाएगा.

सिर्फ़ type फ़ील्ड का इस्तेमाल किया जा सकता है.

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

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

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

accounts.ListAccounts के लिए रिस्पॉन्स मैसेज.

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

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

object (Account)

उन खातों का कलेक्शन, जिनका ऐक्सेस उपयोगकर्ता के पास है. क्वेरी करने वाले उपयोगकर्ता का निजी खाता हमेशा नतीजे का पहला आइटम रहेगा, जब तक कि इसे फ़िल्टर नहीं कर दिया जाता.
nextPageToken

string

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

अनुमति के दायरे

नीचे दिए गए OAuth के लिंक की ज़रूरत हाेती है:

  • https://www.googleapis.com/auth/business.manage

ज़्यादा जानकारी के लिए, OAuth 2.0 की खास जानकारी देखें.