במדריך הזה מוסבר איך משתמשים ב-method list()
במשאב Space
ב-Google Chat API כדי להציג מרחבים. הצגת רשימה של המרחבים המשותפים מחזירה רשימה של המרחבים המשותפים עם חלוקה לדפים וניתן לסנן אותה.
המשאבים מסוג Space
מייצגים מקום שבו אנשים ואפליקציות של Chat יכולים לשלוח הודעות, לשתף קבצים ולשתף פעולה. יש כמה סוגים של מרחבים משותפים:
- צ'אטים ישירים הם שיחות בין שני משתמשים או משתמש ואפליקציית Chat.
- שיחות קבוצתיות הן שיחות בין שלושה משתמשים או יותר באפליקציות Chat.
- מרחבים משותפים עם שם הם מקומות קבועים שבהם אנשים שולחים הודעות, משתפים קבצים ועובדים יחד.
כשמציגים מרחבים משותפים באמצעות אימות באפליקציה, מוצגים מרחבים משותפים שיש לאפליקציית 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.
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.
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.
Apps Script
- חשבון Google Workspace בתוכנית Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור של אפליקציית Chat.
- יוצרים פרויקט נפרד של Apps Script ומפעילים את שירות הצ'אט המתקדם.
- במדריך הזה, צריך להשתמש באימות משתמשים או אימות אפליקציות. כדי לבצע אימות כאפליקציית Chat, צריך ליצור פרטי כניסה לחשבון שירות. במאמר אימות והרשאה כאפליקציה של Google Chat מוסבר איך לעשות זאת.
- בוחרים היקף הרשאה בהתאם לכך אם רוצים לבצע אימות כמשתמש או כאפליקציית Chat.
הצגת רשימה של מרחבים משותפים עם אימות משתמשים
כדי לקבל רשימה של המרחבים המשותפים ב-Google Chat, צריך להעביר את הפרמטרים הבאים בבקשה:
- באימות משתמש, מציינים את היקף ההרשאה
chat.spaces.readonly
אוchat.spaces
. - קוראים ל-method
ListSpaces()
.
בדוגמה הבאה מקבלים רשימה של מרחבים עם שמות (אבל לא צ'אטים קבוצתיים וצ'אטים ישירים, שמסוננים החוצה) שגלויים למשתמש המאומת:
Node.js
Python
Java
Apps Script
Chat API מחזיר רשימת מרחבים משותפים שמחולקת לדפים.
הצגת רשימה של מרחבים משותפים עם אימות באמצעות אפליקציה
כדי לקבל רשימה של המרחבים המשותפים ב-Google Chat, צריך להעביר את הפרמטרים הבאים בבקשה:
- באימות אפליקציה, מציינים את היקף ההרשאה
chat.bot
. - קוראים ל-method
ListSpaces()
.
בדוגמה הבאה מפורטים מרחבים משותפים עם שם (אבל לא צ'אטים קבוצתיים וצ'אטים אישיים) שגלויים לאפליקציית Chat:
Node.js
Python
Java
Apps Script
Chat API מחזיר רשימת מרחבים משותפים שמחולקת לדפים.
התאמה אישית של חלוקת הדפים או סינון הרשימה
כדי להציג רשימה של מרחבים משותפים ב-Google Chat, מעבירים את הפרמטרים האופציונליים הבאים של השאילתה כדי להתאים אישית את החלוקה לדפים של המרחבים המשותפים או לסנן את המרחבים שמופיעים ברשימה:
pageSize
: מספר המרחבים המשותפים המקסימלי שאפשר להחזיר. יכול להיות שהשירות יחזיר פחות מהערך הזה. אם לא צוין, המערכת תחזיר עד 100 מקומות פנויים. הערך המקסימלי הוא 1,000. ערכים גבוהים מ-1,000 משתנים באופן אוטומטי ל-1,000.pageToken
: אסימון דף, שהתקבל מבקשת list spaces קודמת. צריך לספק את האסימון הזה כדי לאחזר את הדף הבא. כשמחלקים לדפים, ערך המסנן צריך להתאים לקריאה שסיפקה את אסימון הדף. העברת ערך שונה עשויה להוביל לתוצאות בלתי צפויות.filter
: מסנן שאילתות. פרטים על שאילתות נתמכות זמינים במסמך העזרה שלListSpacesRequest
.
נושאים קשורים
- יוצרים מרחב משותף.
- איך מגדירים מרחב משותף.
- לקבלת פרטים על מרחב משותף
- לעדכן מרחב משותף.
- למחוק את המרחב המשותף.
- מחפשים מרחב משותף בצ'אט אישי.