Method: spaces.members.list

הצגת רשימת המשתתפים במרחבים משותפים. לדוגמה, אפשר להיעזר ברשימת המשתמשים והאפליקציות של Google Chat במרחבים משותפים. בדף האפליקציה עם אימות אפליקציות רשומים משתמשים במרחבים משותפים שלאפליקציית Chat יש גישה אליהם, אבל לא כולל מינויים באפליקציית Chat, כולל מינויים כאלה. חברויות בדף עם אימות משתמשים מציגות חברויות במרחבים המשותפים שלמשתמש המאומת יש גישה אליהם.

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

בקשת HTTP

GET https://chat.googleapis.com/v1/{parent=spaces/*}/members

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

פרמטרים של נתיב

פרמטרים
parent

string

חובה. שם המשאב של המרחב המשותף שעבורו רוצים לאחזר רשימת חברים.

פורמט: רווחים/{space}

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

פרמטרים
pageSize

integer

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

אם לא צוין אחרת, יוחזרו עד 100 חברויות במועדון.

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

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

string

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

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

string

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

אתם יכולים לסנן את חברי המועדון לפי התפקיד שלהם (role) והסוג שלהם (member.type).

כדי לסנן לפי תפקיד, צריך להגדיר את role בתור ROLE_MEMBER או ROLE_MANAGER.

כדי לסנן לפי סוג, צריך להגדיר את member.type לערך HUMAN או BOT.

כדי לסנן לפי תפקיד וסוג, משתמשים באופרטור AND. כדי לסנן לפי תפקיד או סוג, משתמשים באופרטור OR.

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

role = "ROLE_MANAGER" OR role = "ROLE_MEMBER"
member.type = "HUMAN" AND role = "ROLE_MANAGER"

השאילתות הבאות לא חוקיות:

member.type = "HUMAN" AND member.type = "BOT"
role = "ROLE_MANAGER" AND role = "ROLE_MEMBER"

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

boolean

זה שינוי אופציונלי. כאשר true, מחזירה גם חברויות המשויכות ל-Google Group, בנוסף לסוגים אחרים של חברויות במועדון. אם מגדירים filter, לא יוחזרו מינויים של Google Group שלא עומדים בקריטריונים של המסנן.
showInvited

boolean

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

נדרש כרגע אימות משתמש.

גוף הבקשה

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

גוף התשובה

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

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

object (Membership)

רשימה לא ממוינת. רשימת החברויות בדף המבוקש (או הראשון).
nextPageToken

string

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

היקפי הרשאות

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

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

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