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

इस पेज पर, डायरेक्ट्री एपीआई की मदद से 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 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, दोनों आर्ग्युमेंट का इस्तेमाल करना: डायरेक्ट्री एपीआई, 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, उपयोगकर्ता का मुख्य ईमेल पता, उपयोगकर्ता का दूसरा ईमेल पता, ग्रुप का मुख्य ईमेल पता, ग्रुप का दूसरा ईमेल पता या उपयोगकर्ता का यूनीक id हो सकता है. 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"
     }
  ],
   "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 स्टेटस कोड दिखता है.

ग्रुप मिटाने पर, ये चीज़ें होती हैं:

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