הצגת רשימת המשתמשים במרחבים משותפים. ראו דוגמה במאמר הצגת רשימת המשתמשים והאפליקציות של Google Chat במרחבים משותפים. בדף אפליקציה עם אימות אפליקציות רשומים מינויים במרחבים משותפים שאליהם יש לאפליקציית Chat גישה, אבל לא כולל מינויים לאפליקציית Chat, כולל החברות שלה. בדף פרטי חברויות באימות משתמשים רשומים חברויות במרחבים משותפים שלמשתמש המאומת יש גישה אליהם.
נדרש אימות. תמיכה באימות אפליקציות ובאימות משתמש.
בקשת HTTP
GET https://chat.googleapis.com/v1/{parent=spaces/*}/members
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
פרמטרים | |
---|---|
parent |
חובה. שם המשאב של המרחב המשותף שעבורו רוצים לאחזר את רשימת החברים. פורמט: רווחים/{space} |
פרמטרים של שאילתה
פרמטרים | |
---|---|
pageSize |
זה שינוי אופציונלי. המספר המקסימלי של חברויות במועדון שאפשר להחזיר. השירות עשוי להחזיר פחות מהערך הזה. אם לא מציינים שום אפשרות, יוחזרו עד 100 חברויות במועדון של הערוץ. הערך המקסימלי הוא 1,000. אם משתמשים בערך שגבוה מ-1,000, הוא משתנה באופן אוטומטי ל-1,000. ערכים שליליים מחזירים שגיאה מסוג |
pageToken |
זה שינוי אופציונלי. אסימון דף, שהתקבל מקריאה קודמת להצגת רשימת חברויות. צריך לספק את הפרמטר הזה כדי לאחזר את הדף הבא. במהלך החלוקה לדפים, כל הפרמטרים האחרים שצוינו צריכים להתאים לקריאה שסיפקה את אסימון הדף. העברה של ערכים שונים לפרמטרים האחרים עלולה להוביל לתוצאות בלתי צפויות. |
filter |
זה שינוי אופציונלי. מסנן שאילתות. אפשר לסנן את המינויים לפי התפקיד של החבר/ה ( כדי לסנן לפי תפקיד, צריך להגדיר את כדי לסנן לפי סוג, צריך להגדיר את כדי לסנן לפי תפקיד וסוג, אפשר להשתמש באופרטור אם המדיניות לדוגמה, השאילתות הבאות תקינות:
השאילתות הבאות לא חוקיות:
שאילתות לא חוקיות נדחות על ידי השרת עם השגיאה |
showGroups |
זה שינוי אופציונלי. כאשר |
showInvited |
זה שינוי אופציונלי. כאשר כרגע נדרש אימות משתמש. |
useAdminAccess |
true , השיטה תפעל עם הרשאות האדמין של המשתמש ב-Google Workspace.המשתמשים לביצוע שיחות צריכים להיות אדמינים ב-Google Workspace עם הרשאה לניהול צ'אטים ושיחות במרחבים המשותפים. נדרש היקף OAuth 2.0, אי אפשר להציג רשימות של אפליקציות במרחבים משותפים כשמשתמשים בהרשאת אדמין. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
תשובה לרשימת המשתתפים במרחב המשותף.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
ייצוג JSON |
---|
{
"memberships": [
{
object ( |
שדות | |
---|---|
memberships[] |
רשימה לא ממוינת. רשימת החברויות בדף המבוקש (או הראשון). |
nextPageToken |
אסימון שאפשר לשלוח בתור |
היקפי ההרשאות
נדרש אחד מהיקפי ההרשאות הבאים של 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
מידע נוסף זמין במדריך להרשאות.