הצגת רשימה של מרחבים משותפים (original) (raw)

במדריך הזה מוסבר איך להשתמש בשיטה 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 בשם credentials.json בספרייה המקומית.
    * כדי לבצע אימות כאפליקציית Chat, יוצרים פרטי כניסה לחשבון שירות ושומרים אותם כקובץ JSON בשם credentials.json.
• בוחרים היקף הרשאה בהתאם לאופן שבו רוצים לבצע אימות – כמשתמש או כאפליקציית 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.

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.

Apps Script

• חשבון Google Workspace במהדורת Business או Enterprise עם גישה ל-Google Chat.
• מגדירים את הסביבה:
  • יוצרים פרויקט ב-Google Cloud.
  • הגדרת מסך ההסכמה ל-OAuth.
  • מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
  • יוצרים פרויקט עצמאי של Apps Script ומפעילים את שירות Chat המתקדם.
  • במדריך הזה, אתם צריכים להשתמש באימות משתמשים או באפליקציות. כדי לבצע אימות כאפליקציית 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.
• איך יוצרים מרחבים
• איך יוצרים מרחבים
• איך מקבלים פרטים על מרחב
• עדכון מרחב.
• מחיקת מרחב
• איך מחפשים מרחבים לצ'אטים ישירים