يمكنك البحث عن مجموعات تطابق سمات معيّنة باستخدام طريقة groups.list في Directory API. تقبل هذه الطريقة المعلمة query، وهي طلب بحث
يجمع بين عبارة بحث واحدة أو أكثر. وتتكون كل عبارة بحث من
ثلاثة أجزاء:
- الحقل
- سمة المجموعة التي يتم البحث فيها مثلاً:
name - مُشغِّل
- اختبار يتم إجراؤه على البيانات للتأكّد من تطابقها على سبيل المثال، يختبر عامل التشغيل
=ما إذا كانت السمة النصية تتطابق مع قيمة. - القيمة
- محتوى السمة التي يتم اختبارها. مثلاً:
groupName
يتم فصل الجمل المتعددة بمسافة بيضاء ويتم دمجها ضمنيًا باستخدام
عامل التشغيل AND.
الحقول
| الحقل | نوع القيمة | عوامل التشغيل | الوصف |
|---|---|---|---|
email |
سلسلة | =، :{PREFIX}* |
عنوان البريد الإلكتروني للمجموعة. ملاحظة: لا يمكن استخدام هذه السمة مع المَعلمة memberKey في طلب البحث نفسه. |
name |
سلسلة | =، :{PREFIX}* |
هو الاسم المعروض للمجموعة. ملاحظة: لا يمكن استخدام هذه المَعلمة مع مَعلمة memberKey في طلب البحث نفسه. |
memberKey |
سلسلة | =, |
تعرض مَعلمة طلب البحث memberKey جميع المجموعات التي ينتمي إليها مستخدم أو مجموعة. يمكن أن تكون هذه القيمة أي عنوان من عناوين البريد الإلكتروني الرئيسية أو البديلة للمستخدم، أو عنوان البريد الإلكتروني الرئيسي أو البديل للمجموعة، أو المعرّف الفريد للمستخدم. ملاحظة: لا يمكن استخدام هذه السمة مع المَعلمتَين email أو name في طلب البحث نفسه. |
أنواع القيم
| نوع القيمة | Notes |
|---|---|
| سلسلة | إحاطة بعلامة اقتباس مفردة ' إذا كان طلب البحث يحتوي على مسافة بيضاء. يمكنك تجاهل علامات الاقتباس المفردة في طلبات البحث باستخدام \'، على سبيل المثال 'Valentine\'s Day'. |
عوامل التشغيل
| مُشغِّل | أنواع القيم المسموح بها | Notes |
|---|---|---|
= |
string, boolean, number, date | يتطابق الحقل والقيمة تمامًا. على سبيل المثال، تتطابق السمة name=contact مع جميع المجموعات التي تتضمّن السمة name "contact"، وليس "contactgroup". مدعومة في معظم حقول السلسلة (انظر أعلاه). |
:{PREFIX}* |
سلسلة | يبدأ الحقل بالقيمة. على سبيل المثال، يتطابق طلب البحث الذي يتضمن email:support* مع المجموعات التي تحتوي على قيم email لـ "supportgroup@" و"support@" ولكن ليس "contactsupport". غير متاحة إلا مع مجموعة محدودة من حقول السلسلة (انظر أعلاه). |
أمثلة
تستخدم جميع طلبات البحث الطريقة groups.list، التي تتضمّن طلب HTTP مشابهًا لما يلي (يتم تضمين فواصل الأسطر لسهولة القراءة):
GET https://admin.googleapis.com/admin/directory/v1/groups ?domain=primary domain &query=query parameters
يجب أن تكون المَعلمة query بترميز عنوان URL. على سبيل المثال، طلب البحث query=email:support* هو عنوان URL تم ترميزه بالصيغة query=email%3Asupport*.
تعرض جميع الأمثلة في هذه الصفحة مَعلمات query غير مرمّزة.
تتعامل مكتبات العملاء مع ترميز عناوين URL هذا تلقائيًا.
البحث عن مجموعة حسب الاسم المعروض
name='contact'
البحث عن المجموعات التي تتطابق مع بادئة البريد الإلكتروني
email:admin*
البحث عن جميع المجموعات التابعة لمستخدم
memberKey=user@company.com
البحث عن مجموعات بالاسم وعنوان البريد الإلكتروني بدءًا من جهة الاتصال
name:contact* email:contact*