Method: spaces.list

רשימה של המרחבים המשותפים שבהם המשתמש שמתקשר הוא חבר. הצ'אטים הקבוצתיים והצ'אטים לא מופיעים עד ששולחים את ההודעה הראשונה. דוגמה לכך מופיעה בקטע רשימת המרחבים המשותפים.

יש תמיכה בסוגי אימות הבאים:

כדי לקבל רשימה של כל המרחבים המשותפים שנקראו לפי ארגון ב-Google Workspace, צריך להשתמש במקום זאת בשיטה spaces.search() עם הרשאות אדמין ב-Workspace.

בקשת HTTP

GET https://chat.googleapis.com/v1/spaces

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של שאילתה

פרמטרים
pageSize

integer

זה שינוי אופציונלי. המספר המקסימלי של מרחבים שצריך להחזיר. השירות עשוי להחזיר פחות מהערך הזה.

אם לא צוין, המערכת תחזיר עד 100 מקומות פנויים.

הערך המקסימלי הוא 1,000. אם משתמשים בערך גבוה מ-1,000, הוא ישתנה באופן אוטומטי ל-1,000.

ערכים שליליים מחזירים שגיאה מסוג INVALID_ARGUMENT.
pageToken

string

זה שינוי אופציונלי. אסימון דף, שהתקבל משיחה קודמת של list spaces. מציינים את הפרמטר הזה כדי לאחזר את הדף הבא.

כשמחלקים לדפים, ערך המסנן צריך להתאים לקריאה שסיפקה את אסימון הדף. העברה של ערך אחר עלולה להוביל לתוצאות בלתי צפויות.
filter

string

זה שינוי אופציונלי. מסנן שאילתות.

אפשר לסנן מרחבים לפי סוג המרחב (spaceType).

כדי לסנן לפי סוג מרחב משותף, צריך לציין ערך enum תקין, כמו SPACE או GROUP_CHAT (הערך של spaceType לא יכול להיות SPACE_TYPE_UNSPECIFIED). כדי לשלוח שאילתה לגבי כמה סוגי מרחבים משותפים, משתמשים באופרטור OR.

לדוגמה, השאילתות הבאות תקינות:

spaceType = "SPACE"
spaceType = "GROUP_CHAT" OR spaceType = "DIRECT_MESSAGE"

שאילתות לא חוקיות נדחות על ידי השרת עם השגיאה INVALID_ARGUMENT.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

התשובה לבקשה להצגת רשימת המרחבים המשותפים.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "spaces": [
    {
      object (Space)
    }
  ],
  "nextPageToken": string
}
שדות
spaces[]

object (Space)

הצגת רשימת המרחבים המשותפים בדף המבוקש (או הראשון). הערה: השדה permissionSettings לא מוחזר באובייקט המרחב המשותף לבקשות רשימה.
nextPageToken

string

אפשר לשלוח אסימון כ-pageToken כדי לאחזר את דף התוצאות הבא. אם השדה ריק, אין דפים נוספים.

היקפי הרשאה

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.readonly
  • https://www.googleapis.com/auth/chat.bot

מידע נוסף זמין במדריך להרשאות.