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 तरीकों का इस्तेमाल करें. अगर किसी ग्रुप के POST या PUT अनुरोध में बदलाव किया जाता है, तो उस बदलाव को अनदेखा कर दिया जाता है.
nonEditableAliases[]

string

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

तरीके

delete

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

get

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

insert

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

list

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

patch

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

update

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