इस पेज पर, डायरेक्ट्री एपीआई की मदद से Google Groups को मैनेज करने का तरीका बताया गया है:
- समूह बनाएं
- ग्रुप अपडेट करना
- ग्रुप का उपनाम जोड़ें
- किसी ग्रुप को वापस लाना
- किसी डोमेन या खाते के लिए सभी ग्रुप फिर से पाना
- किसी सदस्य के सभी समूह फिर से पाएं
- सभी समूह उपनाम फिर से पाएं
- ग्रुप का उपनाम मिटाना
- समूह मिटाना
समूह बनाएं
ग्रुप बनाने के लिए, नीचे दिए गए POST
अनुरोध का इस्तेमाल करें और उस अनुमति को शामिल करें
जिसके बारे में
अनुमति देने के अनुरोध में बताया गया है.
आपके पास खाते से जुड़े किसी भी डोमेन के लिए ग्रुप बनाने का विकल्प होता है. क्वेरी स्ट्रिंग, अनुरोध,
और रिस्पॉन्स प्रॉपर्टी के लिए, groups.insert
तरीका देखें.
POST https://admin.googleapis.com/admin/directory/v1/groups
नीचे दिया गया JSON अनुरोध, सैंपल अनुरोध का एक मुख्य हिस्सा दिखाता है, जो ग्रुप बनाता है. ग्रुप का ईमेल पता sales_group@example.com है:
{ "email": "sales_group@example.com", "name": "Sales Group", "description": "This is the Sales group." }
सही जवाब देने पर,
एचटीटीपी 201
स्टेटस कोड
और नए ग्रुप की प्रॉपर्टी दिखती हैं.
ग्रुप अपडेट करना
किसी ग्रुप की सेटिंग अपडेट करने के लिए, नीचे दिए गए PUT
अनुरोध का इस्तेमाल करें. साथ ही,
अनुरोधों को अनुमति देने के अनुरोध में दी गई अनुमति को शामिल करें.
groupKey
, ग्रुप का ईमेल पता, ग्रुप के उपनामों का कोई ईमेल पता या
ग्रुप का यूनीक id
होता है. क्वेरी स्ट्रिंग, अनुरोध, और रिस्पॉन्स प्रॉपर्टी के लिए,
groups.update
तरीका देखें.
PUT https://admin.googleapis.com/admin/directory/v1/groups/groupKey
आम तौर पर, Google का सुझाव है कि ग्रुप के ईमेल पते को स्थायी डेटा की कुंजी के तौर पर इस्तेमाल न करें. ऐसा इसलिए, क्योंकि ईमेल पता बदला जा सकता है.
यहां दिए गए उदाहरण में, यूनीक groupKey
nnn
है और ग्रुप का
नाम एशिया पैसिफ़िक (APAC) सेल्स ग्रुप है:
PUT https://admin.googleapis.com/admin/directory/v1/groups/nnn
{ "email": "sales_group@example.com", "name": "APAC Sales Group" }
अपडेट का अनुरोध करने के लिए, आपको अपने अनुरोध में सिर्फ़ अपडेट की गई जानकारी सबमिट करनी होगी. आपको अनुरोध में, ग्रुप की सभी प्रॉपर्टी को डालने की ज़रूरत नहीं है.
सही जवाब देने पर,
एचटीटीपी 201
स्टेटस कोड
और नए ग्रुप की प्रॉपर्टी दिखती हैं:
{ "kind": "directory#groups", "id": "group's unique ID", "etag": "group's unique ETag", "email": "sales_group@example.com", "name": "APAC Sales Group", "directMembersCount": "5", "description": "This is the APAC sales group.", "adminCreated": true, "aliases": [ { "alias": "best_sales_group@example.com" } ], "nonEditableAliases: [ { "alias": "liz@test.com" } ] }
ग्रुप का उपनाम जोड़ें
ग्रुप का उपनाम जोड़ने के लिए, नीचे दिए गए POST
अनुरोध का इस्तेमाल करें और
अनुरोधों की अनुमति दें में बताया गया अनुमति शामिल करें.
groupKey
, ग्रुप का ईमेल पता, ग्रुप के उपनामों का कोई ईमेल पता या
ग्रुप का यूनीक id
होता है. क्वेरी स्ट्रिंग, अनुरोध, और रिस्पॉन्स प्रॉपर्टी के लिए, groups
रिसॉर्स देखें.
POST https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases
आम तौर पर, Google का सुझाव है कि ग्रुप के ईमेल पते को स्थायी डेटा की कुंजी के तौर पर इस्तेमाल न करें. ऐसा इसलिए, क्योंकि ईमेल पता बदला जा सकता है.
नीचे दिया गया JSON अनुरोध, ग्रुप का उपनाम बनाने के लिए एक सैंपल अनुरोध दिखाता है. groupKey
, ग्रुप का यूनीक id
है, जिसे NNNN
दिखाता है
POST https://admin.googleapis.com/admin/directory/v1/groups/NNNN/aliases
{ "alias": "best_sales_group@example.com" }
सही जवाब देने पर,
एचटीटीपी 201
स्टेटस कोड
और नए ग्रुप के उपनाम की प्रॉपर्टी दिखती हैं.
किसी ग्रुप को वापस लाना
किसी ग्रुप को वापस पाने के लिए, नीचे दिए गएGET
अनुरोध का इस्तेमाल करें. साथ ही, अनुमति देने के अनुरोध में बताई गई अनुमति को शामिल करें.
groupKey
, ग्रुप का ईमेल पता, ग्रुप के उपनामों का कोई ईमेल पता या
ग्रुप का यूनीक id
होता है. क्वेरी स्ट्रिंग, अनुरोध, और रिस्पॉन्स प्रॉपर्टी के लिए, groups.get
तरीका देखें.
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey
आम तौर पर, Google का सुझाव है कि ग्रुप के ईमेल पते को स्थायी डेटा की कुंजी के तौर पर इस्तेमाल न करें. ऐसा इसलिए, क्योंकि ईमेल पता बदला जा सकता है.
यहां दिए गए उदाहरण में, यूनीक groupKey
आईडी nnnn
है:
GET https://admin.googleapis.com/admin/directory/v1/groups/nnnn
सही जवाब देने पर,
एचटीटीपी 200
स्टेटस कोड
और ग्रुप की सेटिंग दिखती हैं:
{ "kind": "directory#groups", "id": "group's unique ID", "etag": "group's unique ETag", "email": "sales_group@example.com", "name": "APAC Sales Group", "directMembersCount": "5", "description": "This is the APAC sales group.", "adminCreated": true, "aliases": [ { "alias": "best_sales_group@example.com" } ], "nonEditableAliases: [ { "alias": "liz@test.com" } ] }
किसी डोमेन या खाते के लिए सभी ग्रुप फिर से पाना
किसी खास डोमेन या खाते के सभी ग्रुप को फिर से पाने के लिए, नीचे दिए गए GET
अनुरोध का इस्तेमाल करें और
अनुमति देने के अनुरोध में बताया गया अनुमति शामिल करें. क्वेरी स्ट्रिंग, अनुरोध, और रिस्पॉन्स प्रॉपर्टी के लिए, groups.list
तरीका देखें.
आसानी से समझ में आने के लिए, इस उदाहरण में लाइन रिटर्न का इस्तेमाल किया गया है:
GET https://admin.googleapis.com/admin/directory/v1/groups?domain=domain name &customer=my_customer or customerId&pageToken=pagination token &maxResults=max results
किसी डोमेन या खाते के लिए सभी ग्रुप की जानकारी फ़ेच करते समय, इन बातों का ध्यान रखें:
- किसी सब-डोमेन के सभी ग्रुप: डोमेन के नाम के साथ
domain
आर्ग्युमेंट का इस्तेमाल करें. - खाते के सभी ग्रुप:
customer
आर्ग्युमेंट का इस्तेमाल,my_customer
या खाते कीcustomerId
वैल्यू के साथ करें. खाते के एडमिन के तौर पर, अपने खाते काcustomerId
दिखाने के लिए,my_customer
स्ट्रिंग का इस्तेमाल करें. अगर आप रीसेलर हैं और रीसेलर से खरीदने वाले ग्राहक का खाता ऐक्सेस किया जाता है, तो उस खाते केcustomerId
का इस्तेमाल करें जिसे रीसेलर से खरीदा गया है.customerId
वैल्यू के लिए, किसी डोमेन के सभी उपयोगकर्ताओं को वापस लाने की कार्रवाई के अनुरोध में मौजूद, खाते के प्राइमरी डोमेन नेम का इस्तेमाल करें. मिलने वाले रिस्पॉन्स मेंcustomerId
वैल्यू होती है. domain
औरcustomer
, दोनों तर्कों का इस्तेमाल करना: डायरेक्ट्री एपीआई,domain
के लिए सभी ग्रुप दिखाता है.domain
औरcustomer
आर्ग्युमेंट का इस्तेमाल नहीं किया जा रहा है: डायरेक्ट्री एपीआई,my_customer
से जुड़े खाते के सभी ग्रुप दिखाता है. यह अनुरोध करने वाले एडमिन का खाताcustomerId
है.customer
औरuserKey
, दोनों तर्कों का इस्तेमाल करना: डायरेक्ट्री एपीआई गड़बड़ी दिखाता है. आपको इन तर्कों के साथ दो अलग-अलग अनुरोध करने होंगे.
यहां दिए गए उदाहरण में, खाते के सभी ग्रुप की सूची का अनुरोध करने के लिए, खाते का एडमिन my_customer
का इस्तेमाल करता है:
GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=my_customer&maxResults=2
यहां दिए गए उदाहरण में, रीसेलर के एडमिन के अनुरोध से, customerId C03az79cb
के साथ रीसेलर वाले खाते के सभी ग्रुप
लौटाए जाते हैं. हर जवाब वाले पेज से ज़्यादा से ज़्यादा दो नतीजे मिल सकते हैं.
इस जवाब में फ़ॉलो-ऑन सूची के लिए nextPageToken
है:
GET https://admin.googleapis.com/admin/directory/v1/groups?domain=sales.com&customer=C03az79cb&maxResults=2
सही जवाब देने पर,
एचटीटीपी 200
स्टेटस कोड
और ग्रुप को ग्रुप ईमेल के वर्णमाला के क्रम में दिखाया जाता है:
{ "kind": "directory#groups", "groups": [ { "kind": "directory#groups", "id": "group's unique ID", "etag": "group's unique ETag", "email": "support@sales.com", "name": "Sales support", "directMembersCount": "6", "description": "The sales support group", "adminCreated": true }, { "kind": "directory#groups", "id": "group's unique ID", "etag": "group's unique ETag", "email": "travel@sales.com", "name": "Sales travel", "directMembersCount": "2", "description": "The travel group supporting sales", "adminCreated": false, "aliases": [ { "alias": "best_sales_group@example.com" } ], "nonEditableAliases: [ { "alias": "liz@test.com" } ] }, "nextPageToken": "NNNN" }
किसी सदस्य के सभी समूह फिर से पाएं
उन सभी ग्रुप को फिर से पाने के लिए जिनके पास सदस्य की सदस्यता है, नीचे दिए गए GET
अनुरोध का इस्तेमाल करें. साथ ही,
अनुमति देने के अनुरोध में बताया गया अनुमति शामिल करें. आसानी से समझ में आने के लिए, इस उदाहरण में लाइन रिटर्न का इस्तेमाल किया गया है:
GET https://admin.googleapis.com/admin/directory/v1/groups?userKey=user key ?pageToken=pagination token &maxResults=maximum results per response page
- सदस्य, उपयोगकर्ता या ग्रुप हो सकता है.
userKey
उपयोगकर्ता का मुख्य ईमेल पता, उपयोगकर्ता का उपनाम, किसी ग्रुप का मुख्य ईमेल पता, ग्रुप का ईमेल उपनाम या उपयोगकर्ता का यूनीकid
हो सकता है. इसे उपयोगकर्ता की कार्रवाई वापस पाएं का इस्तेमाल करके ढूंढा जा सकता है.userKey
में मौजूद उपयोगकर्ता या ग्रुप आपके डोमेन से जुड़ा होना चाहिए.- बड़ी संख्या में ग्रुप वाले जवाब देने के लिए,
pageToken
क्वेरी स्ट्रिंग का इस्तेमाल करें. पेज पर नंबर डालने के मामले में, रिस्पॉन्सnextPageToken
प्रॉपर्टी दिखाता है, जो रिस्पॉन्स के नतीजों के अगले पेज के लिए एक टोकन देती है. आपका अगला अनुरोध, इस टोकन कोpageToken
क्वेरी स्ट्रिंग की वैल्यू के तौर पर इस्तेमाल करता है. customer
औरuserKey
, दोनों तर्कों का इस्तेमाल करना: डायरेक्ट्री एपीआई गड़बड़ी दिखाता है. आपको इन तर्कों के साथ दो अलग-अलग अनुरोध करने होंगे.
अनुरोध और रिस्पॉन्स प्रॉपर्टी के लिए, groups.list
तरीका देखें.
सही जवाब देने पर एक एचटीटीपी 200 स्टेटस कोड और सदस्य की जानकारी की सूची दिखती है:
- वे सभी ग्रुप दिखाए जाते हैं जिनके लिए सदस्य ने सदस्यता ली है. इनमें, उपयोगकर्ता के डोमेन से बाहर के ग्रुप भी शामिल हैं.
- ग्रुप को हर ग्रुप के ईमेल पते के वर्णमाला के क्रम में दिखाया जाता है.
- जवाब के मुख्य हिस्से में,
id
, ग्रुप का यूनीक आईडी होता है. - जवाब में, उपयोगकर्ता के डोमेन से बाहर के ग्रुप की लिस्टिंग में, संगठन से बाहर के ग्रुप के उपनाम शामिल नहीं होते.
{ "kind": "directory#groups", "groups": [ { "kind": "directory#group", "id": "group's unique ID", "etag": "group's unique ETag", "email": "sales_group@example.com", "name": "sale group", "directMembersCount": "5", "description": "Sales group" }, { "kind": "directory#group", "id": "group's unique ID", "etag": "group's unique ETag", "email": "support_group.com", "name": "support group", "directMembersCount": "5", "description": "Support group" } ], "nextPakeToken": "NNNNN" }
सभी समूह उपनाम फिर से पाएं
किसी ग्रुप के सभी उपनामों को वापस पाने के लिए, यहां दिए गएGET
अनुरोध का इस्तेमाल करें. साथ ही, उस अनुमति को शामिल करें जो अनुरोधों को अनुमति देने में बताया गया है. groupKey
, ग्रुप का मुख्य ईमेल पता, ग्रुप का यूनीक
id
या ग्रुप के उपनामों का कोई भी ईमेल पता हो सकता है. अनुरोध और रिस्पॉन्स प्रॉपर्टी के लिए, groups
संसाधन देखें.
GET https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases
सही जवाब देने पर,
एचटीटीपी 201
स्टेटस कोड
और ग्रुप के उपनामों की सूची दिखती है.
ग्रुप का उपनाम मिटाना
किसी ग्रुप का उपनाम मिटाने के लिए, यहां दिए गएDELETE
अनुरोध का इस्तेमाल करें. साथ ही, उस अनुमति को शामिल करें जो अनुरोधों को अनुमति देने में बताया गया है.
groupKey
, ग्रुप का मुख्य ईमेल पता, ग्रुप का यूनीक
id
या ग्रुप के उपनामों का कोई भी ईमेल पता हो सकता है. aliasId
वह उपनाम है जिसे
मिटाया जा रहा है. अनुरोध और रिस्पॉन्स प्रॉपर्टी के लिए, groups
संसाधन देखें:
DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases/aliasId
सही जवाब देने पर, एचटीटीपी 201
स्टेटस कोड दिखता है.
समूह मिटाना
किसी ग्रुप को मिटाने के लिए, नीचे दिए गए DELETE
अनुरोध का इस्तेमाल करें और
अनुरोधों को अनुमति दें में बताई गई अनुमति को शामिल करें.
groupKey
, ग्रुप का यूनीक id
है:
DELETE https://admin.googleapis.com/admin/directory/v1/groups/groupKey
उदाहरण के लिए, DELETE
का यह अनुरोध, उस ग्रुप को मिटा देता है जिसमें nnnn
ग्रुप id
है:
DELETE https://admin.googleapis.com/admin/directory/v1/group/nnnn
सही जवाब देने पर, एचटीटीपी 200
स्टेटस कोड दिखता है.
जब कोई ग्रुप मिटाया जाता है, तो ऐसा होता है:
- ग्रुप के सभी सदस्यों को मिटा दिया जाता है. सदस्य के उपयोगकर्ता खाते नहीं मिटाए जाते.
- समूह संग्रह हटा दिया जाता है.
- मिटाए गए ग्रुप के पते पर भेजे गए मैसेज, डिलीवर नहीं किए जाते हैं. इसके बजाय, भेजने वाले को ईमेल वापसी का मैसेज मिलता है.