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. תצוגה מקדימה למפתחים: אפשר לסנן לפי member.type גם באמצעות האופרטור !=.

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

אם המדיניות useAdminAccess מוגדרת כ-True, צריך להזין member.type = "HUMAN" או member.type != "BOT". מסננים אחרים של סוגי חברים יידחו.

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

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

member.type != "BOT"

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

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 שלא עומדים בקריטריונים של המסנן.

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

boolean

כשהערך הוא true, השיטה תפעל עם הרשאות האדמין של המשתמש ב-Google Workspace.

המשתמשים לביצוע שיחות צריכים להיות אדמינים ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים המשותפים.

נדרש היקף OAuth 2.0, chat.admin.memberships.readonly או chat.admin.memberships.

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

גוף הבקשה

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

גוף התשובה

תשובה לרשימת המשתתפים במרחב המשותף.

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

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

object (Membership)

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

string

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

היקפי ההרשאות

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

  • https://www.googleapis.com/auth/chat.admin.memberships
  • https://www.googleapis.com/auth/chat.admin.memberships.readonly
  • 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

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