Method: spaces.list

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

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

  • אימות אפליקציה עם היקף ההרשאה:

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

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

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

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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

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