הפונקציה מחזירה רשימה של מרחבים משותפים בארגון ב-Google Workspace על סמך חיפוש של אדמין.
נדרשת אימות משתמש עם הרשאות אדמין. בבקשה, צריך להגדיר את useAdminAccess
לערך true
.
בקשת HTTP
GET https://chat.googleapis.com/v1/spaces:search
כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.
פרמטרים של שאילתה
פרמטרים | |
---|---|
use |
כשהערך הוא המשתמש הקורא חייב להיות אדמין ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים משותפים. נדרש היקף OAuth 2.0, השיטה הזו תומכת כרגע רק בהרשאת אדמין, ולכן אפשר להשתמש רק ב- |
page |
המספר המקסימלי של מרחבים שצריך להחזיר. ייתכן שהשירות יחזיר פחות מהערך הזה. אם לא צוין, המערכת תחזיר עד 100 מקומות פנויים. הערך המקסימלי הוא 1,000. אם משתמשים בערך גבוה מ-1,000, הוא ישתנה באופן אוטומטי ל-1,000. |
page |
טוקן, שהתקבל מהקריאה הקודמת למרחבים משותפים לחיפוש. מציינים את הפרמטר הזה כדי לאחזר את הדף הבא. במהלך החלוקה לדפים, כל הפרמטרים האחרים שצוינו צריכים להתאים לקריאה שסיפקה את אסימון הדף. העברה של ערכים שונים לפרמטרים האחרים עלולה להוביל לתוצאות בלתי צפויות. |
query |
חובה. שאילתת חיפוש. אפשר לחפש לפי הפרמטרים הבאים:
השדה
השדה בשדות השונים, יש תמיכה רק באופרטורים באותו שדה, השאילתות לדוגמה הבאות תקינות:
|
order |
זה שינוי אופציונלי. סדר הרשימה של המרחבים המשותפים. המאפיינים הנתמכים להזמנה הם:
הערכים החוקיים של פעולת ההזמנה הם:
אלה תחבירי ה-JSON הנתמכים:
|
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
תשובה עם רשימה של מרחבים משותפים שתואמים לבקשת המרחבים המשותפים בחיפוש.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
ייצוג ב-JSON |
---|
{
"spaces": [
{
object ( |
שדות | |
---|---|
spaces[] |
דף עם המרחבים המשותפים המבוקשים. |
next |
אסימון שאפשר להשתמש בו כדי לאחזר את הדף הבא. אם השדה הזה ריק, אין דפים נוספים. |
total |
המספר הכולל של הרווחים שתואמים לשאילתה, בכל הדפים. אם התוצאה היא יותר מ-10,000 מקומות חנייה, הערך הזה הוא אומדן. |
היקפי הרשאה
נדרש אחד מהיקפי ההרשאות הבאים של OAuth:
https://www.googleapis.com/auth/chat.admin.spaces
https://www.googleapis.com/auth/chat.admin.spaces.readonly
מידע נוסף זמין במדריך להרשאות.