במדריך הזה נסביר איך להשתמש ב-method 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 בשם
client_secrets.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 בשם
client_secrets.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 בשם
client_secrets.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, יוצרים פרטי כניסה לחשבון שירות. במאמר אימות ואישור בתור אפליקציית Google Chat מוסבר איך עושים זאת.
- בוחרים את היקף ההרשאה בהתאם למצב האימות כמשתמש או כאפליקציית 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
של המרחב המשותף. אפשר לקבל את המזהה על ידי קריאה ל-method ListSpaces()
או מכתובת ה-URL של המרחב המשותף.
Google Chat API מחזיר רשימה של חברי קבוצות Google, אנשים ואפליקציות מהמרחב המשותף שצוין.
הצגת רשימת המשתתפים במרחב משותף עם אימות באמצעות אפליקציה
כדי לקבל רשימה של משתמשים ואפליקציית Chat במרחב משותף שיש לאפליקציה המאומתת גישה אליו, צריך להעביר את הפרטים הבאים בבקשה:
- באמצעות אימות אפליקציות, מציינים את היקף ההרשאה
chat.bot
. - קוראים ל-method
ListMemberships()
. - כדי להציג רשימה של קבוצות Google, מגדירים את פרמטר השאילתה
showGroups
לערךtrue
.
בדוגמה הבאה מפורטים משתתפים אנושיים במרחב המשותף (לא מנהלי המרחב) שגלויים לאפליקציית Chat:
Node.js
Python
Java
Apps Script
כדי להריץ את הדוגמה הזו, מחליפים את SPACE_NAME
במזהה שמופיע בשדה name
של המרחב המשותף. כדי לאתר אותו, אפשר לשלוח קריאה ל-method ListSpaces()
או לכתובת ה-URL של המרחב המשותף.
Google Chat API מחזיר רשימת משתתפים אנושיים במרחב המשותף (לא כולל מנהלי המרחב המשותף) מהמרחב שצוין.
הצגת רשימת החברים כאדמינים ב-Google Workspace
אדמינים ב-Google Workspace יכולים להפעיל את השיטה ListMemberships()
כדי לקבל רשימה של החברים בכל מרחב משותף בארגון שלהם ב-Google Workspace. Chat API מחזיר רק חברויות של משתמשים – פנימיים וחיצוניים – או של קבוצות Google מהארגון שלכם, ולכן לא מחזיר חברויות באפליקציות של Chat.
כדי להפעיל את השיטה הזו כאדמינים ב-Google Workspace:
- קוראים לשיטה באמצעות אימות משתמש, ומציינים היקף הרשאה שתומך בקריאה לשיטה באמצעות הרשאות אדמין.
- בבקשה, מציינים את הפרמטרים הבאים של השאילתה:
- מגדירים את
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
: אסימון דף, שהתקבל מקריאה קודמת במרחב משותף. צריך לספק את האסימון הזה כדי לאחזר את הדף הבא. כשמחלקים לדפים, ערך המסנן צריך להתאים לקריאה שסיפקה את אסימון הדף. העברת ערך שונה עשויה להוביל לתוצאות בלתי צפויות.filter
: מסנן שאילתות. נדרש אימות משתמש. פרטים על שאילתות נתמכות זמינים במסמך העזרה שלListMembershipsRequest
.
נושאים קשורים
- איך מקבלים פרטים על המינוי של משתמש או של אפליקציית Chat
- להזמין או להוסיף משתמש או אפליקציית Chat למרחב משותף.
- איך מעדכנים את פרטי החברות של משתמשים במרחב משותף ב-Google Chat
- להסיר משתמש או את אפליקציית Chat ממרחב משותף.