הצגת רשימת המשתתפים במרחבים משותפים. לדוגמה, אפשר להיעזר ברשימת המשתמשים והאפליקציות של 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 עם הרשאה לניהול צ'אט ושיחות במרחבים המשותפים. נדרש כשמשתמשים בהרשאת אדמין, אי אפשר לפרסם חברים של אפליקציות במרחב המשותף. |
גוף הבקשה
גוף הבקשה חייב להיות ריק.
גוף התשובה
תשובה לרשימת המשתמשים במרחב המשותף.
אם הפעולה בוצעה ללא שגיאות, גוף התשובה מכיל נתונים במבנה הבא:
ייצוג 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
למידע נוסף, עיינו במדריך ההרשאות.