Method: spaces.list

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

נדרש אימות. תומך באימות אפליקציות ובאימות משתמשים.

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

בקשת HTTP

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

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

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

פרמטרים
pageSize

integer

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

אם לא צוין אחרת, מוחזרים 100 רווחים לכל היותר.

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

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

pageToken

string

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

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

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)

רשימת המרחבים המשותפים בדף המבוקש (או הראשון).

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

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