شما میتوانید با استفاده از متد groups.list از Directory API، گروههایی را که با ویژگیهای خاصی مطابقت دارند، جستجو کنید. این متد پارامتر query را میپذیرد که یک query جستجو است که یک یا چند عبارت جستجو را ترکیب میکند. هر عبارت جستجو از سه بخش تشکیل شده است:
- میدان
- ویژگی گروهی که جستجو میشود. برای مثال،
name. - اپراتور
- آزمایشی که روی دادهها انجام میشود تا تطابقی پیدا کند. برای مثال، عملگر
=بررسی میکند که آیا یک ویژگی متنی با مقداری مطابقت دارد یا خیر. - ارزش
- محتوای ویژگی مورد آزمایش. برای مثال،
groupName.
چندین عبارت با فاصله از هم جدا میشوند و به طور ضمنی توسط عملگر AND به هم متصل میشوند.
فیلدها
| میدان | نوع مقدار | اپراتورها | توضیحات |
|---|---|---|---|
email | رشته | = , :{PREFIX}* | آدرس ایمیل گروه. توجه: این آدرس را نمیتوان با پارامتر memberKey در یک پرسوجو استفاده کرد. |
name | رشته | = , :{PREFIX}* | نام نمایشی گروه. توجه: این نام را نمیتوان با پارامتر memberKey در یک کوئری استفاده کرد. |
memberKey | رشته | = ، | پارامتر query memberKey تمام گروههایی را که یک کاربر یا گروه در آنها عضویت دارد، برمیگرداند. این مقدار میتواند هر یک از آدرسهای ایمیل اصلی یا مستعار کاربر، آدرسهای ایمیل اصلی یا مستعار گروه یا شناسه منحصر به فرد کاربر باشد. توجه: این پارامتر را نمیتوان همراه با پارامترهای email یا name در یک query استفاده کرد. |
انواع مقادیر
| نوع مقدار | یادداشتها |
|---|---|
| رشته | اگر عبارت جستجو شامل فضای خالی است، آن را با علامت نقل قول تکی ' احاطه کنید. در عبارات جستجو شده با علامت نقل قول تکی \' ، مثلاً 'Valentine\'s Day' از علامت نقل قول تکی 'Escape' استفاده کنید. |
اپراتورها
| اپراتور | انواع مقادیر پشتیبانی شده | یادداشتها |
|---|---|---|
= | رشته، بولی، عدد، تاریخ | فیلد و مقدار دقیقاً مطابقت دارند. برای مثال، 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* به صورت query=email%3Asupport* کدگذاری میشود. تمام مثالهای این صفحه پارامترهای query کدگذاری نشده را نشان میدهند. کتابخانههای کلاینت به طور خودکار این کدگذاری URL را مدیریت میکنند.
جستجوی گروه بر اساس نام نمایشی
name='contact'
جستجوی گروههایی که با پیشوند ایمیل مطابقت دارند
email:admin*
جستجوی تمام گروههای یک کاربر
memberKey=user@company.com
جستجوی گروههایی که نام و ایمیل آنها با مخاطب شروع میشود
name:contact* email:contact*