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/admin-sdk/directory/v1/guides/search-groups
sortOrder

enum (SortOrder)

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

string

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

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

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

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

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

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

string

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

string

संसाधन का ईटैग.
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 अवरोही क्रम.