useAdminAccess
לערך true
.
בקשת HTTP
GET https://chat.googleapis.com/v1/spaces:search
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של שאילתה
פרמטרים | |
---|---|
useAdminAccess |
ב- המשתמש שמתקשר צריך להיות אדמין ב-Google Workspace עם הרשאה לניהול צ'אט ושיחות במרחבים המשותפים. נדרש בשלב זה השיטה הזו תומכת רק בהרשאת אדמין, ולכן רק |
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
למידע נוסף, עיינו במדריך ההרשאות.