يمكنك البحث عن مجموعات تطابق سمات معيّنة باستخدام طريقة 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"، ولكن ليس مع المجموعات التي تتضمّن السمة name بالقيمة "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*