डायरेक्ट्री एपीआई के groups.list तरीके का इस्तेमाल करके, कुछ एट्रिब्यूट से मैच होने वाले ग्रुप खोजे जा सकते हैं. यह तरीका query पैरामीटर को स्वीकार करता है. यह एक या उससे ज़्यादा खोज क्लॉज़ को मिलाकर बनाई गई खोज क्वेरी होती है. खोज के लिए इस्तेमाल होने वाला हर क्लॉज़, तीन हिस्सों से बना होता है:
- फ़ील्ड
- खोजा गया ग्रुप एट्रिब्यूट. उदाहरण के लिए,
name. - ऑपरेटर
- मैच करने के लिए, डेटा पर की जाने वाली जांच. उदाहरण के लिए,
=ऑपरेटर यह जांच करता है कि कोई टेक्स्ट एट्रिब्यूट किसी वैल्यू से मैच करता है या नहीं. - मान
- जिस एट्रिब्यूट की जांच की जा रही है उसका कॉन्टेंट. उदाहरण के लिए,
groupName.
एक से ज़्यादा क्लॉज़ को स्पेस से अलग किया जाता है और उन्हें AND ऑपरेटर से जोड़ा जाता है.
फ़ील्ड
| फ़ील्ड | वैल्यू टाइप | ऑपरेटर | ब्यौरा |
|---|---|---|---|
email |
स्ट्रिंग | =, :{PREFIX}* |
ग्रुप का ईमेल पता. ध्यान दें: एक ही क्वेरी में, memberKey पैरामीटर के साथ इसका इस्तेमाल नहीं किया जा सकता. |
name |
स्ट्रिंग | =, :{PREFIX}* |
ग्रुप का डिसप्ले नेम. ध्यान दें: एक ही क्वेरी में, इसका इस्तेमाल memberKey पैरामीटर के साथ नहीं किया जा सकता. |
memberKey |
स्ट्रिंग | =, |
memberKey क्वेरी पैरामीटर, उन सभी ग्रुप को दिखाता है जिनकी सदस्यता किसी उपयोगकर्ता या ग्रुप के पास है. यह वैल्यू, उपयोगकर्ता का कोई भी प्राइमरी या अन्य ईमेल पता, ग्रुप का कोई भी प्राइमरी या अन्य ईमेल पता या उपयोगकर्ता का यूनीक आईडी हो सकता है. ध्यान दें: एक ही क्वेरी में, email या name पैरामीटर के साथ इसका इस्तेमाल नहीं किया जा सकता. |
वैल्यू टाइप
| वैल्यू टाइप | नोट |
|---|---|
| स्ट्रिंग | अगर क्वेरी में स्पेस है, तो उसे सिंगल कोट ' के अंदर रखें. \' का इस्तेमाल करके, क्वेरी में सिंगल कोटेशन को एस्केप करें. उदाहरण के लिए, 'Valentine\'s Day'. |
ऑपरेटर
| ऑपरेटर | इस्तेमाल की जा सकने वाली वैल्यू के टाइप | नोट |
|---|---|---|
= |
स्ट्रिंग, बूलियन, संख्या, तारीख | फ़ील्ड और वैल्यू पूरी तरह से मेल खाती हैं. उदाहरण के लिए, name=contact, name एट्रिब्यूट "contact" वाले सभी ग्रुप से मैच करता है, लेकिन "contactgroup" से नहीं. ज़्यादातर स्ट्रिंग फ़ील्ड पर काम करता है (ऊपर देखें). |
:{PREFIX}* |
स्ट्रिंग | फ़ील्ड, वैल्यू से शुरू होता है. उदाहरण के लिए, email:support* वाली क्वेरी, "supportgroup@" और "support@" की email वैल्यू वाले ग्रुप से मैच करती है, लेकिन "contactsupport" से नहीं. यह सिर्फ़ स्ट्रिंग फ़ील्ड के सीमित सेट पर काम करता है (ऊपर देखें). |
उदाहरण
सभी क्वेरी, groups.list
विधि का इस्तेमाल करती हैं. इसमें एचटीटीपी अनुरोध, नीचे दिए गए अनुरोध जैसा होता है. इसे आसानी से पढ़ने के लिए, लाइन ब्रेक शामिल किए गए हैं:
GET https://admin.googleapis.com/admin/directory/v1/groups ?domain=primary domain &query=query parameters
query पैरामीटर को कोड में बदलना ज़रूरी है. उदाहरण के लिए, क्वेरी query=email:support* को यूआरएल कोड में बदलकर query=email%3Asupport* किया गया है.
इस पेज पर दिए गए सभी उदाहरणों में, कोड में बदले बिना दिखाए गए query पैरामीटर हैं.
क्लाइंट लाइब्रेरी, यूआरएल कोड को अपने-आप बदल देती हैं.
डिसप्ले नेम से कोई ग्रुप खोजना
name='contact'
ईमेल प्रीफ़िक्स से मैच होने वाले ग्रुप खोजना
email:admin*
किसी उपयोगकर्ता के सभी ग्रुप खोजना
memberKey=user@company.com
ऐसे ग्रुप खोजें जिनके नाम और ईमेल पते में संपर्क से मिलता-जुलता शब्द हो
name:contact* email:contact*