במדריך הזה מוסבר איך להשתמש בשיטה
list()
במשאב Membership
של Google Chat API כדי ליצור רשימה של חברים במרחב. הרשימה מחולקת לדפים, ואפשר לסנן אותה לפי חברות במרחב.
- הצגת חברות עם אימות אפליקציה מציגה חברות במרחבים שאפליקציית Chat יכולה לגשת אליהם, אבל לא כוללת חברות באפליקציית Chat, כולל חברות משלה.
- רשימת חברויות עם אימות משתמשים מציגה חברויות במרחבים שלמשתמש המאומת יש גישה אליהם.
- אדמינים ב-Google Workspace יכולים להשתמש בהרשאות אדמין כדי להציג רשימה של כל החברים בכל המרחבים בארגון Google Workspace שלהם.
המשאב
Membership
מייצג אם משתמש אנושי או אפליקציית Google Chat הוזמנו למרחב, הם חלק ממנו או שהם לא נמצאים בו.
דרישות מוקדמות
Node.js
- חשבון Google Workspace במהדורת Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- הגדרת מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- מתקינים את ספריית הלקוח של Cloud ל-Node.js.
- יוצרים פרטי גישה בהתאם לאופן שבו רוצים לבצע אימות בבקשה של Google Chat API:
- כדי לבצע אימות כמשתמש ב-Chat, יוצרים פרטי כניסה של מזהה לקוח OAuth ושומרים אותם כקובץ JSON בשם
credentials.json
בספרייה המקומית. - כדי לבצע אימות כאפליקציית Chat, יוצרים פרטי כניסה לחשבון שירות ושומרים אותם כקובץ JSON בשם
credentials.json
.
- כדי לבצע אימות כמשתמש ב-Chat, יוצרים פרטי כניסה של מזהה לקוח OAuth ושומרים אותם כקובץ JSON בשם
- בוחרים היקף הרשאה בהתאם לאופן שבו רוצים לבצע אימות – כמשתמש או כאפליקציית Chat.
- מרחב ב-Google Chat שמשתמש מאומת או אפליקציית Chat שמתקשרת חברים בו. כדי לאמת את עצמכם כאפליקציית Chat, צריך להוסיף את אפליקציית Chat למרחב.
Python
- חשבון Google Workspace במהדורת Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- הגדרת מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- מתקינים את ספריית הלקוח של Cloud לשימוש ב-Python.
- יוצרים פרטי גישה בהתאם לאופן שבו רוצים לבצע אימות בבקשה של Google Chat API:
- כדי לבצע אימות כמשתמש ב-Chat, יוצרים פרטי כניסה של מזהה לקוח OAuth ושומרים אותם כקובץ JSON בשם
credentials.json
בספרייה המקומית. - כדי לבצע אימות כאפליקציית Chat, יוצרים פרטי כניסה לחשבון שירות ושומרים אותם כקובץ JSON בשם
credentials.json
.
- כדי לבצע אימות כמשתמש ב-Chat, יוצרים פרטי כניסה של מזהה לקוח OAuth ושומרים אותם כקובץ JSON בשם
- בוחרים היקף הרשאה בהתאם לאופן שבו רוצים לבצע אימות – כמשתמש או כאפליקציית Chat.
- מרחב ב-Google Chat שמשתמש מאומת או אפליקציית Chat שמתקשרת חברים בו. כדי לאמת את עצמכם כאפליקציית Chat, צריך להוסיף את אפליקציית Chat למרחב.
Java
- חשבון Google Workspace במהדורת Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- הגדרת מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- מתקינים את ספריית הלקוח של Cloud ל-Java.
- יוצרים פרטי גישה בהתאם לאופן שבו רוצים לבצע אימות בבקשה של Google Chat API:
- כדי לבצע אימות כמשתמש ב-Chat, יוצרים פרטי כניסה של מזהה לקוח OAuth ושומרים אותם כקובץ JSON בשם
credentials.json
בספרייה המקומית. - כדי לבצע אימות כאפליקציית Chat, יוצרים פרטי כניסה לחשבון שירות ושומרים אותם כקובץ JSON בשם
credentials.json
.
- כדי לבצע אימות כמשתמש ב-Chat, יוצרים פרטי כניסה של מזהה לקוח OAuth ושומרים אותם כקובץ JSON בשם
- בוחרים היקף הרשאה בהתאם לאופן שבו רוצים לבצע אימות – כמשתמש או כאפליקציית Chat.
- מרחב ב-Google Chat שמשתמש מאומת או אפליקציית Chat שמתקשרת חברים בו. כדי לאמת את עצמכם כאפליקציית Chat, צריך להוסיף את אפליקציית Chat למרחב.
Apps Script
- חשבון Google Workspace במהדורת Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- הגדרת מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- יוצרים פרויקט עצמאי של Apps Script ומפעילים את שירות Chat מתקדם.
- במדריך הזה, חובה להשתמש באימות משתמשים או באפליקציות. כדי לבצע אימות כאפליקציית Chat, צריך ליצור פרטי כניסה לחשבון שירות. במאמר אימות והרשאה של אפליקציות צ'אט ובקשות מ-Google Chat API מוסבר איך לעשות זאת.
- בוחרים היקף הרשאה בהתאם לאופן שבו רוצים לבצע אימות – כמשתמש או כאפליקציית Chat.
- מרחב ב-Google Chat שמשתמש מאומת או אפליקציית Chat שמתקשרת חברים בו. כדי לאמת את עצמכם כאפליקציית Chat, צריך להוסיף את אפליקציית Chat למרחב.
הצגת רשימת המשתתפים במרחב עם אימות משתמשים
כדי להציג רשימה של משתמשים, קבוצות Google ואפליקציית Chat במרחב שלמשתמש המאומת יש גישה אליו, צריך להעביר את הפרטים הבאים בבקשה:
- באימות משתמש, מציינים את היקף ההרשאות של
chat.memberships.readonly
אוchat.memberships
. - מבצעים קריאה ל-method
ListMemberships()
. - כדי להציג רשימה של קבוצות Google, מגדירים את פרמטר השאילתה
showGroups
לערךtrue
.
בדוגמה הבאה מפורטים חברים בקבוצת Google, משתמשים ואפליקציות שגלויים למשתמש המאומת.
Node.js
Python
Java
Apps Script
כדי להריץ את הדוגמה הזו, מחליפים את SPACE_NAME
במזהה מהשדה name
של המרחב. אפשר לקבל את המזהה על ידי הפעלת השיטה ListSpaces()
או מכתובת ה-URL של המרחב.
Google Chat API מחזיר רשימה של חברים בקבוצות Google, משתמשים ואפליקציות מהמרחב שצוין.
הצגת רשימת המשתתפים במרחב עם אימות אפליקציה
כדי להציג רשימה של משתמשים ואפליקציית Chat במרחב שלאפליקציה המאומתת יש גישה אליו, צריך להעביר את הפרטים הבאים בבקשה:
- באימות אפליקציות, מציינים את היקף ההרשאה
chat.bot
. - מבצעים קריאה ל-method
ListMemberships()
. - כדי להציג רשימה של קבוצות Google, מגדירים את פרמטר השאילתה
showGroups
לערךtrue
.
בדוגמה הבאה מפורטים משתתפים במרחב (לא מנהלי המרחב) שאפליקציית Chat יכולה לראות:
Node.js
Python
Java
Apps Script
כדי להריץ את הדוגמה הזו, מחליפים את SPACE_NAME
במזהה מהשדה name
של המרחב. אפשר לקבל את המזהה על ידי הפעלת השיטה ListSpaces()
או מכתובת ה-URL של המרחב.
Google Chat API מחזיר רשימה של משתתפים אנושיים במרחב (לא כולל מנהלי המרחב) מהמרחב שצוין.
הצגת רשימת חברים כאדמין ב-Google Workspace
אדמינים ב-Google Workspace יכולים להתקשר לשיטה ListMemberships()
כדי להציג רשימה של חברים בכל מרחב בארגון שלהם ב-Google Workspace. Chat API מחזיר רק חברויות של משתמשים – פנימיים וחיצוניים – או של קבוצות Google מהארגון שלכם, ולכן הוא לא כולל חברויות של אפליקציות ל-Chat.
כדי להפעיל את ה-method הזה כאדמינים ב-Google Workspace, צריך לבצע את הפעולות הבאות:
- קוראים ל-method באמצעות אימות משתמש, ומציינים היקף הרשאות שתומך בקריאה ל-method באמצעות הרשאות אדמין.
- בבקשה, מציינים את הפרמטרים הבאים של השאילתה:
- מגדירים את
useAdminAccess
להיותtrue
. - כדי להחזיר רק משתמשים, מגדירים את
filter
שלmember.type
כך שיהיה שווה ל-HUMAN
. - כדי להחזיר משתמשים וקבוצות, מגדירים את
filter
עבורmember.type
לא שווה ל-BOT
AND
showGroups
שווה ל-true
.
- מגדירים את
מידע נוסף ודוגמאות זמינים במאמר ניהול מרחבים ב-Google Chat כאדמינים ב-Google Workspace.
התאמה אישית של המספור או סינון הרשימה
כדי להציג את רשימת החברויות, מעבירים את פרמטרי השאילתה הבאים כדי להתאים אישית את המספור של הדפים או לסנן את רשימת החברויות:
-
pageSize
: המספר המקסימלי של חברויות שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא מציינים מספר, המערכת מחזירה עד 100 מרחבים. הערך המקסימלי הוא 1,000. ערכים שגדולים מ-1,000 משתנים אוטומטית ל-1,000. -
pageToken
: טוקן דף שהתקבל מקריאה קודמת של list spaces. צריך להזין את האסימון הזה כדי לאחזר את הדף הבא. כשמבצעים חלוקה לעמודים, ערך המסנן צריך להיות זהה לקריאה שסיפקה את אסימון הדף. העברת ערך שונה עלולה להוביל לתוצאות לא צפויות. -
filter
: מסנן של שאילתה. נדרש אימות משתמש. פרטים על שאילתות נתמכות זמינים במפרט של השיטה ב-ListMembershipsRequest
.
נושאים קשורים
- קבלת פרטים על החברות של משתמש או של אפליקציה ל-Chat
- איך מזמינים או מוסיפים משתמש או אפליקציית Chat למרחב
- עדכון החברות של משתמש במרחב ב-Google Chat.
- הסרת משתמש או אפליקציה ל-Chat ממרחב