Method: spaces.members.list

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

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

בקשת HTTP

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

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

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

פרמטרים
parent

string

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

פורמט: spaces/{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.

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

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

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 הוא 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

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