אפשר לחפש קבוצות שתואמות למאפיינים מסוימים באמצעות השיטה groups.list של Directory API. השיטה הזו מקבלת את הפרמטר query, שהוא שאילתה לחיפוש שמשלבת תנאי חיפוש אחד או יותר. כל תנאי חיפוש מורכב משלושה חלקים:
- שדה
- מאפיין הקבוצה שעבורו מתבצע החיפוש. לדוגמה,
name. - מפעיל
- בדיקה שמתבצעת על הנתונים כדי לספק התאמה. לדוגמה, האופרטור
=בודק אם מאפיין טקסט תואם לערך. - ערך
- התוכן של המאפיין שנבדק. לדוגמה,
groupName.
תנאים מרובים מופרדים באמצעות רווחים ומקושרים באופן משתמע באמצעות אופרטור AND.
שדות
| שדה | סוג הערך | אופרטורים | תיאור |
|---|---|---|---|
email |
מחרוזת | =, :{PREFIX}* |
כתובת האימייל של הקבוצה. הערה: לא ניתן להשתמש בפרמטר הזה עם הפרמטר memberKey באותה שאילתה. |
name |
מחרוזת | =, :{PREFIX}* |
השם המוצג של הקבוצה. הערה: לא ניתן להשתמש בפרמטר הזה עם הפרמטר memberKey באותה שאילתה. |
memberKey |
מחרוזת | =, |
פרמטר השאילתה memberKey מחזיר את כל הקבוצות שהמשתמש או הקבוצה חברים בהן. הערך הזה יכול להיות כל אחת מכתובות האימייל הראשיות או החלופיות של המשתמש, כתובת האימייל הראשית או החלופית של הקבוצה או המזהה הייחודי של המשתמש. הערה: לא ניתן להשתמש בפרמטר הזה יחד עם הפרמטרים email או name באותה שאילתה. |
סוגי ערכים
| סוג הערך | הערות |
|---|---|
| מחרוזת | אם השאילתה מכילה רווחים, צריך להקיף אותה במירכאות בודדות '. כדי להשתמש בגרש כדי לברוח ממירכאות בודדות בשאילתות, מזינים \', לדוגמה 'Valentine\'s Day'. |
אופרטורים
| מפעיל | סוגי הערכים הנתמכים | הערות |
|---|---|---|
= |
string, boolean, number, date | השדה והערך תואמים בדיוק. לדוגמה, name=contact תואם לכל הקבוצות עם המאפיין name "contact", אבל לא "contactgroup". נתמכת ברוב שדות המחרוזות (ראו למעלה). |
:{PREFIX}* |
מחרוזת | השדה מתחיל בערך. לדוגמה, שאילתה עם email:support* תואמת לקבוצות עם ערכי email של "supportgroup@" ו-"support@", אבל לא של "contactsupport". יש תמיכה רק בקבוצה מוגבלת של שדות מחרוזת (ראו למעלה). |
דוגמאות
כל השאילתות משתמשות ב-method 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
חיפוש קבוצות עם שם וכתובת אימייל שמתחילים ב-contact
name:contact* email:contact*