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