ग्रुप मैनेज करें

एक समूह बनाएं

ग्रुप बनाने के लिए, इस 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 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 वैल्यू. खाते के तौर पर व्यवस्थापक है, तो अपने खाते केmy_customer customerId. अगर आप रीसेलर हैं और रीसेलर से खरीदने वाले किसी ग्राहक के खाते को ऐक्सेस कर रहे हैं, तो रीसेलर से खरीदने वाले खाते का 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 https://admin.googleapis.com/admin/directory/v1/groups/groupKey/aliases

सही जवाब मिलने पर एचटीटीपी 201 स्टेटस कोड और ग्रुप के उपनामों की सूची दिखेगी.

ग्रुप का दूसरा ईमेल पता मिटाना

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 https://admin.googleapis.com/admin/directory/v1/group/nnnn

सही जवाब मिलने पर एचटीटीपी 200 स्टेटस कोड.

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

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