תוכלו לחפש קבוצות שתואמות למאפיינים מסוימים באמצעות השיטה groups.list של ה-Directory API. השיטה הזו מקבלת את הפרמטר query, שהוא שאילתת חיפוש שמשלבת סעיף חיפוש אחד או יותר. כל סעיף חיפוש מורכב משלושה חלקים:
- שדה
- מאפיין הקבוצה שחיפשת. לדוגמה:
name. - מפעיל
- בדיקה שמתבצעת על הנתונים כדי לספק התאמה. לדוגמה, האופרטור
=בודק אם מאפיין טקסט תואם לערך. - תמורה לכסף
- תוכן המאפיין שנבדק. לדוגמה:
groupName.
כמה סעיפים מופרדים באמצעות רווח לבן ומחוברים באופן מרומז באמצעות אופרטור AND.
שדות
| שדה | סוג הערך | אופרטורים | תיאור |
|---|---|---|---|
email |
מחרוזת | =, :{PREFIX}* |
זוהי כתובת האימייל של הקבוצה. הערה: אי אפשר להשתמש בפרמטר הזה עם הפרמטר memberKey באותה שאילתה. |
name |
מחרוזת | =, :{PREFIX}* |
השם המוצג של הקבוצה. הערה: אי אפשר להשתמש בפרמטר הזה עם הפרמטר memberKey באותה שאילתה. |
memberKey |
מחרוזת | =, |
פרמטר השאילתה memberKey מחזיר את כל הקבוצות שבהן יש למשתמש או לקבוצה חברות. הערך הזה יכול להיות כל אחת מכתובות האימייל הראשיות או החלופיות של המשתמש, מכתובת האימייל הראשית או החלופית של הקבוצה, או מזהה ייחודי של משתמש. הערה: אי אפשר להשתמש בפעולה זו יחד עם הפרמטרים email או name באותה שאילתה. |
סוגי ערכים
| סוג הערך | הערות |
|---|---|
| מחרוזת | מוקף במירכאות יחידות ' אם השאילתה מכילה רווח לבן. השתמשו בתו בריחה (escape) במירכאות יחידות בשאילתות עם המילה \', לדוגמה '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.
ספריות לקוח מטפלות בקידוד כתובת אתר זה באופן אוטומטי.
חיפוש קבוצה לפי השם המוצג
name='contact'
חיפוש קבוצות שתואמות לקידומת של כתובת אימייל
email:admin*
חיפוש כל הקבוצות של משתמש מסוים
memberKey=user@company.com
חיפוש קבוצות עם שם וכתובת אימייל שמתחילה באיש קשר
name:contact* email:contact*