Groups Settings API, किसी मौजूदा Google ग्रुप की सेटिंग को अपडेट करता है और उसे वापस लाता है. एपीआई की मदद से, ये काम किए जा सकते हैं:
- ग्रुप के अंदरूनी और बाहरी ऐक्सेस के लिए, ग्रुप की सेटिंग में बदलाव करना.
- ग्रुप की सूचनाओं में बदलाव करें.
- बातचीत का डेटा संग्रहित करने और मैसेज मॉडरेट करने की सुविधा कॉन्फ़िगर करें.
- अपने खाते के उपयोगकर्ता ग्रुप को पसंद के मुताबिक बनाएं.
Google Groups का इस्तेमाल करने या दूसरे तरह के ग्रुप मैनेज करने के ज़्यादा तरीकों के बारे में जानने के लिए, Cloud Identity का दस्तावेज़ देखें.
Groups Settings API का डेटा मॉडल
Groups Settings API, Groups रिसॉर्स पर काम करता है. इससे पता चलता है कि किसी खाते के उपयोगकर्ता, दूसरे लोगों के ग्रुप के साथ कैसे बातचीत करते हैं और कैसे मिलकर काम करते हैं. हर ग्रुप की पहचान, ग्रुप के ईमेल पते से की जाती है.
एपीआई डेटा मॉडल, खाते के ग्रुप के Groups कलेक्शन पर आधारित होता है. हर ग्रुप में कॉन्फ़िगरेशन सेटिंग का एक यूनीक सेट होता है.
Groups Settings API के काम
ग्रुप सेटिंग एपीआई में ग्रुप सेटिंग के तरीकों को कॉल किया जा सकता है, जैसा कि नीचे दी गई टेबल में बताया गया है:
| कार्रवाई | ब्यौरा | REST एचटीटीपी मैपिंग |
|---|---|---|
get |
ग्राहक के खाते के लिए, ग्रुप की सेटिंग पाता है. सभी 'प्राप्त करें' ऑपरेशन के लिए, किसी ऐसे उपयोगकर्ता की अनुमति लेना ज़रूरी है जिसके पास पुष्टि हो. | GET पर मौजूद ग्रुप यूआरआई. |
update |
ग्राहक के खाते के लिए, किसी ग्रुप की सेटिंग अपडेट करता है. सभी अपडेट कार्रवाइयों के लिए पुष्टि किए गए उपयोगकर्ता को अनुमति मिलनी चाहिए. | PUT पर मौजूद ग्रुप यूआरआई. |
JSON और Atom डेटा फ़ॉर्मैट
डिफ़ॉल्ट रूप से, Groups Settings API, डेटा को JSON फ़ॉर्मैट में दिखाता है. ऐटम नोटेशन, डेटा का एक वैकल्पिक फ़ॉर्मैट है. JSON और Atom, दोनों डेटा फ़ॉर्मैट में डेटा को पढ़ने और उसमें बदलाव करने की सुविधाएं पूरी तरह से काम करती हैं.
JSON एक सामान्य इंटरनेट फ़ॉर्मैट है, जो डेटा के अलग-अलग स्ट्रक्चर को दिखाने का तरीका उपलब्ध कराता है. json.org के मुताबिक, JSON एक ऐसा टेक्स्ट फ़ॉर्मैट है जो किसी भी भाषा पर निर्भर नहीं करता. हालांकि, इसमें C, C++, C#, Java, JavaScript, Perl, और Python जैसी C फ़ैमिली की भाषाओं के प्रोग्रामर के लिए इस्तेमाल किए जाने वाले कॉन्वेंशन का इस्तेमाल किया जाता है.
एपीआई के डेटा फ़ॉर्मैट को बदलने के लिए, अपने अनुरोध के यूआरआई में alt क्वेरी स्ट्रिंग शामिल करें. उदाहरण के लिए:
JSON
GET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=json
ऐटम
GET https://www.googleapis.com/groups/v1/groups/salesgroup@example.com?alt=atom