يمكنك البحث عن المجموعات التي تتطابق مع سمات معيّنة باستخدام أسلوب
groups.list في واجهة برمجة التطبيقات
Directory API. تقبل هذه الطريقة المَعلمة 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
التي تتضمّن طلب 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*