REST Resource: groups

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

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

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

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

जेएसओएन के काेड में दिखाना 
{
  "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

संसाधन का ईटैग.
aliases[]

string

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

string

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

तरीके

delete

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

get

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

insert

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

list

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

patch

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

update

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