डायरेक्ट्री एपीआई के groups.list
तरीके की मदद से, कुछ एट्रिब्यूट से मेल खाने वाले ग्रुप खोजे जा सकते हैं. यह तरीका query
पैरामीटर को स्वीकार करता है. यह एक ऐसी सर्च क्वेरी है जो एक या उससे ज़्यादा सर्च क्लॉज़ को मिलाकर बनाई जाती है. हर सर्च क्लॉज़ तीन हिस्सों में
होता है:
- फ़ील्ड
- खोजी गई समूह विशेषता. उदाहरण के लिए,
name
. - ऑपरेटर
- मिलता-जुलता टेस्ट, डेटा पर किया जाता है. उदाहरण के लिए,
=
ऑपरेटर यह जांच करता है कि कोई टेक्स्ट एट्रिब्यूट, वैल्यू से मेल खाता है या नहीं. - वैल्यू
- एट्रिब्यूट का वह कॉन्टेंट जिसकी जांच की जाती है. उदाहरण के लिए,
groupName
.
एक से ज़्यादा क्लॉज़ को खाली सफ़ेद जगह से अलग किया जाता है और AND
ऑपरेटर की मदद से, उन्हें गलत तरीके से जोड़ा जाता है.
फ़ील्ड
फ़ील्ड | वैल्यू टाइप | ऑपरेटर | ब्यौरा |
---|---|---|---|
email |
स्ट्रिंग | = , :{PREFIX}* |
ग्रुप का ईमेल पता. ध्यान दें: इसी क्वेरी में, memberKey पैरामीटर के साथ इसका इस्तेमाल नहीं किया जा सकता. |
name |
स्ट्रिंग | = , :{PREFIX}* |
ग्रुप का डिसप्ले नेम. ध्यान दें: इसी क्वेरी में, memberKey पैरामीटर के साथ इसका इस्तेमाल नहीं किया जा सकता. |
memberKey |
स्ट्रिंग | = , |
memberKey क्वेरी पैरामीटर से, उन सभी ग्रुप की जानकारी मिलती है जिनके लिए किसी उपयोगकर्ता या ग्रुप की सदस्यता है. यह वैल्यू, उपयोगकर्ता के मुख्य या उपनाम वाले ईमेल पते, ग्रुप के मुख्य या उपनाम वाले ईमेल पते या उपयोगकर्ता का यूनीक आईडी हो सकती है. ध्यान दें: इसका इस्तेमाल एक ही क्वेरी में email या name पैरामीटर के साथ नहीं किया जा सकता. |
वैल्यू के टाइप
वैल्यू टाइप | ज़रूरी जानकारी |
---|---|
स्ट्रिंग | अगर क्वेरी में खाली सफ़ेद जगह है, तो उसे सिंगल कोट ' में रखें. \' की मदद से क्वेरी में सिंगल कोट को एस्केप करें, जैसे कि 'Valentine\'s Day' . |
ऑपरेटर
ऑपरेटर | इस्तेमाल किए जा सकने वाले वैल्यू टाइप | ज़रूरी जानकारी |
---|---|---|
= |
string, boolean, number, date | फ़ील्ड और वैल्यू पूरी तरह से मेल खाती हैं. उदाहरण के लिए, 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*