समूह प्रबंधित करें

इस पेज पर, Directory API की मदद से 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

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

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

यहां दिए गए उदाहरण में, यूनीक आईडी groupKey nnn है. साथ ही, ग्रुप का नाम APAC Sales Group है: 

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, दोनों आर्ग्युमेंट का इस्तेमाल करने पर: Directory API, domain के लिए सभी ग्रुप दिखाता है.
  • domain और customer आर्ग्युमेंट का इस्तेमाल न करना: Directory API, my_customer से जुड़े खाते के सभी ग्रुप दिखाता है. यह अनुरोध करने वाले एडमिन का customerId खाता है.
  • customer और userKey, दोनों आर्ग्युमेंट का इस्तेमाल करने पर: Directory API, गड़बड़ी का मैसेज दिखाता है. आपको इन तर्कों के साथ दो अलग-अलग अनुरोध करने होंगे.

इस उदाहरण में, खाता एडमिन 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, उपयोगकर्ता का मुख्य ईमेल पता, उपयोगकर्ता का दूसरा ईमेल पता, ग्रुप का मुख्य ईमेल पता, ग्रुप का दूसरा ईमेल पता या उपयोगकर्ता का यूनीक userKey हो सकता है. इसे उपयोगकर्ता के लिए किए गए ऑपरेशन की जानकारी वापस पाएं का इस्तेमाल करके ढूंढा जा सकता है.id
  • userKey में बताया गया उपयोगकर्ता या ग्रुप, आपके डोमेन से जुड़ा होना चाहिए.
  • अगर जवाब में कई ग्रुप शामिल हैं, तो pageToken क्वेरी स्ट्रिंग का इस्तेमाल करें. पेज नंबर के हिसाब से नतीजे दिखाने के मामले में, रिस्पॉन्स में nextPageToken प्रॉपर्टी दिखती है. इससे, जवाब के नतीजों के अगले पेज का टोकन मिलता है. आपका अगला अनुरोध, इस टोकन का इस्तेमाल pageToken क्वेरी स्ट्रिंग वैल्यू के तौर पर करता है.
  • customer और userKey, दोनों आर्ग्युमेंट का इस्तेमाल करने पर: Directory API, गड़बड़ी का मैसेज दिखाता है. आपको इन तर्कों के साथ दो अलग-अलग अनुरोध करने होंगे.

अनुरोध और रिस्पॉन्स की प्रॉपर्टी के लिए, 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"
     }
  ],
   "nextPageToken": "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 स्टेटस कोड मिलता है.

किसी ग्रुप को मिटाने पर, ये कार्रवाइयां होती हैं:

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