במדריך הזה מוסבר איך להשתמש ב-method get()
במשאב Space
של Google Chat API כדי לראות פרטים על מרחב משותף, כמו השם המוצג, התיאור וההנחיות שלו.
אדמינים ב-Google Workspace יכולים להפעיל את השיטה get()
כדי לאחזר פרטים על כל מרחב משותף בארגון שלהם ב-Google Workspace.
המשאבים מסוג Space
מייצגים מקום שבו אנשים ואפליקציות Chat יכולים לשלוח הודעות, לשתף קבצים ולשתף פעולה. יש כמה סוגים של מרחבים משותפים:
- צ'אטים אישיים (DM) הם שיחות בין שני משתמשים או בין משתמש לאפליקציית Chat.
- שיחות קבוצתיות הן שיחות בין שלושה משתמשים או יותר באפליקציות Chat.
- מרחבים משותפים עם שם הם מקומות קבועים שבהם אנשים שולחים הודעות, משתפים קבצים ועובדים יחד.
אימות באמצעות אימות אפליקציה מאפשר לאפליקציית Chat לקבל פרטים על מרחב משותף שבו היא חברה. אימות באמצעות אימות משתמש מאפשר לכם לקבל מרחבים משותפים שיש למשתמש המאומת גישה אליהם, כחבר במרחב או כאדמין Google Workspace.
דרישות מוקדמות
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.spaces.readonly
אוchat.spaces
. - באימות אפליקציה, צריך לציין את היקף ההרשאה
chat.bot
או את ההיקףchat.app.spaces
. ההיקףchat.app.spaces
זמין ב-Developer Preview ונדרש אישור חד-פעמי של האדמין.
- באימות משתמש, מציינים את היקף ההרשאה
- קוראים ל-method
GetSpace()
ומעבירים את ה-name
של המרחב המשותף שרוצים לקבל. מוצאים את שם המרחב המשותף במשאבSpace
ב-Google Chat, או בכתובת ה-URL של המרחב המשותף.
איך משתמשים יכולים לקבל פרטים על המרחב המשותף
כך אפשר לקבל את פרטי המרחב המשותף באמצעות אימות משתמשים:
Node.js
Python
Java
Apps Script
כדי להריץ את הדוגמה הזו, מחליפים את SPACE_NAME
במזהה שמופיע בשדה name
של המרחב המשותף. אפשר לקבל את המזהה על ידי קריאה ל-method ListSpaces()
או מכתובת ה-URL של המרחב המשותף.
ממשק ה-API של Chat מחזיר מופע של Space
עם פרטי המרחב המשותף שצוין.
הצגת פרטי המרחב המשותף כאדמינים ב-Google Workspace
אדמינים ב-Google Workspace יכולים להפעיל את השיטה GetSpace
כדי לאחזר פרטים על כל מרחב משותף בארגון שלהם ב-Google Workspace.
כדי לקרוא ל-method הזה כאדמינים ב-Google Workspace:
- קוראים לשיטה באמצעות אימות משתמש, ומציינים היקף הרשאה שתומך בקריאה לשיטה באמצעות הרשאות אדמין.
- בבקשה, מציינים את פרמטר השאילתה
useAdminAccess
עדtrue
.
למידע נוסף ולדוגמאות, ראו ניהול מרחבים משותפים ב-Google Chat כאדמינים ב-Google Workspace.
הצגת פרטי המרחב כאפליקציית Chat
כך אפשר לקבל את פרטי המרחב המשותף באמצעות אימות באפליקציה:
Node.js
Python
Java
Apps Script
כדי להריץ את הדוגמה הזו, מחליפים את SPACE_NAME
במזהה שמופיע בשדה name
של המרחב המשותף. אפשר לקבל את המזהה על ידי קריאה ל-method ListSpaces()
או מכתובת ה-URL של המרחב המשותף.
ממשק ה-API של Chat מחזיר מופע של Space
עם פרטי המרחב המשותף שצוין.
נושאים קשורים
- יוצרים מרחב משותף.
- מגדירים מרחב משותף.
- רשימת המרחבים המשותפים.
- לעדכן מרחב משותף.
- למחוק מרחב משותף.
- מחפשים מרחב משותף בצ'אט אישי.