REST Resource: groups

संसाधन: ग्रुप

Google Groups, आपके उपयोगकर्ताओं को ग्रुप के ईमेल पते का इस्तेमाल करके, लोगों के ग्रुप को मैसेज भेजने की सुविधा देता है. सामान्य टास्क के बारे में ज़्यादा जानकारी के लिए, डेवलपर की गाइड देखें.

अन्य तरह के ग्रुप के बारे में जानकारी पाने के लिए, Cloud Identity Groups API से जुड़ा दस्तावेज़ देखें.

ध्यान दें: एपीआई को कॉल करने वाले उपयोगकर्ता (या किसी सेवा खाते के ज़रिए झूठी पहचान बताने) के पास, वह भूमिका होनी चाहिए जिसमें एडमिन एपीआई ग्रुप की अनुमतियां शामिल हों, जैसे कि सुपर एडमिन या ग्रुप एडमिन.

JSON के काेड में दिखाना
{
  "id": string,
  "email": string,
  "name": string,
  "description": string,
  "adminCreated": boolean,
  "directMembersCount": string,
  "kind": string,
  "etag": string,
  "aliases": [
    string
  ],
  "nonEditableAliases": [
    string
  ]
}
फ़ील्ड
id

string

सिर्फ़ पढ़ने के लिए. किसी ग्रुप का यूनीक आईडी. ग्रुप id का इस्तेमाल, ग्रुप अनुरोध यूआरआई की groupKey के तौर पर किया जा सकता है.

email

string

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

name

string

ग्रुप का डिसप्ले नेम.

description

string

लोगों को ग्रुप बनाने का मकसद तय करने में मदद करने के लिए, ज़्यादा जानकारी देना. उदाहरण के लिए, इसमें यह जानकारी शामिल की जा सकती है कि ग्रुप में किसे शामिल होना चाहिए, ग्रुप को किस तरह के मैसेज भेजने हैं, ग्रुप के बारे में अक्सर पूछे जाने वाले सवालों के लिंक या ग्रुप से जुड़े अन्य ग्रुप. ज़्यादा से ज़्यादा 4,096 वर्ण इस्तेमाल किए जा सकते हैं.

adminCreated

boolean

सिर्फ़ पढ़ने के लिए. अगर इस ग्रुप को उपयोगकर्ता के बजाय एडमिन ने बनाया है, तो वैल्यू true है.

directMembersCount

string (int64 format)

ऐसे उपयोगकर्ताओं की संख्या जो ग्रुप में सीधे तौर पर शामिल हैं. अगर कोई ग्रुप इस ग्रुप (पैरंट) का सदस्य (बच्चा) है, तो पैरंट ग्रुप की directMembersCount प्रॉपर्टी में उस चाइल्ड ग्रुप के सदस्यों को नहीं गिना जाता.

kind

string

एपीआई रिसॉर्स का टाइप. Groups के संसाधनों के लिए, वैल्यू admin#directory#group है.

etag

string

संसाधन का ETag.

aliases[]

string

सिर्फ़ पढ़ने के लिए. किसी ग्रुप के उपनाम वाले ईमेल पतों की सूची. किसी ग्रुप के उपनाम जोड़ने, अपडेट करने या हटाने के लिए, groups.aliases तरीके का इस्तेमाल करें. अगर किसी ग्रुप के पीओएसटी या PUT अनुरोध में बदलाव किया जाता है, तो उस बदलाव को अनदेखा कर दिया जाता है.

nonEditableAliases[]

string

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

तरीके

delete

ग्रुप को मिटाता है.

get

किसी ग्रुप की प्रॉपर्टी हासिल करता है.

insert

ग्रुप बनाता है.

list

किसी डोमेन के या किसी userKey (पेज पर नंबर) वाले उपयोगकर्ता के सभी समूहों को वापस लाता है.

patch

ग्रुप की प्रॉपर्टी अपडेट करता है.

update

ग्रुप की प्रॉपर्टी अपडेट करता है.