אפשר לחפש קבוצות שתואמות לתכונות מסוימות באמצעות השיטה 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*