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