Method: groups.list

किसी डोमेन या उपयोगकर्ता के सभी ग्रुप को वापस लाता है. इसके लिए, userKey दिया जाता है. यह पेज के हिसाब से होता है.

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

GET https://admin.googleapis.com/admin/directory/v1/groups

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

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

पैरामीटर
customer

string

ग्राहक के Google Workspace खाते का यूनीक आईडी. एक से ज़्यादा डोमेन वाले खाते के मामले में, किसी ग्राहक के सभी ग्रुप फ़ेच करने के लिए, domain के बजाय इस फ़ील्ड का इस्तेमाल करें. अपने खाते के customerId को दिखाने के लिए, my_customer उपनाम का भी इस्तेमाल किया जा सकता है. customerId को उपयोगकर्ता संसाधन के हिस्से के तौर पर भी दिखाया जाता है. आपको customer या domain पैरामीटर में से कोई एक देना होगा.
domain

string

डोमेन नेम. सिर्फ़ एक डोमेन के ग्रुप पाने के लिए, इस फ़ील्ड का इस्तेमाल करें. किसी कस्टमर खाते के सभी डोमेन दिखाने के लिए, customer क्वेरी पैरामीटर का इस्तेमाल करें.
maxResults

integer

कितने नतीजे दिखाने हैं. ज़्यादा से ज़्यादा 200 वैल्यू डाली जा सकती हैं.
orderBy

enum (OrderBy)

नतीजों को क्रम से लगाने के लिए इस्तेमाल किया जाने वाला कॉलम
pageToken

string

सूची में अगले पेज की जानकारी देने वाला टोकन
query

string

क्वेरी स्ट्रिंग खोज. यह "" फ़ॉर्मैट में होना चाहिए. पूरा दस्तावेज़ https: //developers.google.com/workspace/admin/directory/v1/guides/search-groups पर उपलब्ध है
sortOrder

enum (SortOrder)

नतीजों को बढ़ते या घटते क्रम में दिखाना है या नहीं. सिर्फ़ तब इस्तेमाल किया जाता है, जब orderBy का भी इस्तेमाल किया जाता है
userKey

string

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

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

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

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

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

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

string

यह किस तरह का संसाधन है.
etag

string

संसाधन का ETag.
groups[]

object (Group)

ग्रुप ऑब्जेक्ट की सूची.
nextPageToken

string

इस नतीजे के अगले पेज को ऐक्सेस करने के लिए इस्तेमाल किया जाने वाला टोकन.

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

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

  • https://apps-apis.google.com/a/feeds/groups/
  • https://www.googleapis.com/auth/admin.directory.group
  • https://www.googleapis.com/auth/admin.directory.group.readonly

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

OrderBy

Enums
EMAIL ग्रुप का ईमेल पता.

SortOrder

Enums
ASCENDING बढ़ते क्रम में.
DESCENDING घटते क्रम में.