می‌توانید گروه‌هایی را که با ویژگی‌های خاص مطابقت دارند با روش 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*