Method: groups.list

यह फ़ंक्शन, किसी डोमेन या उपयोगकर्ता के सभी ग्रुप को उपयोगकर्ता कुंजी (पेज के हिसाब से बंटा हुआ) के हिसाब से वापस लाता है.

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

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

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

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

पैरामीटर
customer

string

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

string

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

integer

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

enum (OrderBy)

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

string

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

string

क्वेरी स्ट्रिंग के हिसाब से खोज करना. इसमें एक या उससे ज़्यादा खोज क्लॉज़ होते हैं. हर क्लॉज़ में एक फ़ील्ड, ऑपरेटर, और वैल्यू होती है. पूरे दस्तावेज़ के लिए, ग्रुप खोजना पर जाएं.
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 घटते क्रम में.