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