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 फ़ील्ड के साथ इस्तेमाल किया जा सकता है.

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

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

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

Account.ListAccounts के लिए जवाब का मैसेज.

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

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

object (Account)

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

string

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

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

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

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

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