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