समूहों को खोजें

Directory API के 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* वाली क्वेरी, email की "supportgroup@" और "support@" वैल्यू वाले ग्रुप से मैच करती है, लेकिन "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*