Method: spaces.members.list

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

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

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

    • https://www.googleapis.com/auth/chat.bot
    • https://www.googleapis.com/auth/chat.app.memberships (נדרש אישור אדמין)

  • אימות משתמש עם אחת מהרשאות הגישה הבאות:

    • https://www.googleapis.com/auth/chat.memberships.readonly
    • https://www.googleapis.com/auth/chat.memberships
    • ‫https://www.googleapis.com/auth/chat.import (רווחים במצב ייבוא בלבד)
    • אימות משתמשים מעניק הרשאות אדמין כשחשבון אדמין מאומת, useAdminAccess הוא true, ואחד מהיקפי ההרשאות הבאים נמצא בשימוש:
      • https://www.googleapis.com/auth/chat.admin.memberships.readonly
      • https://www.googleapis.com/auth/chat.admin.memberships

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של gRPC Transcoding.

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

פרמטרים
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.

אם הערך של 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.app.memberships
  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.memberships
  • https://www.googleapis.com/auth/chat.memberships.readonly

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