במדריך הזה נסביר איך להשתמש ב-method setUp()
במשאב Space
של Google Chat API כדי ליצור מרחב משותף ב-Chat ולהוסיף אליו משתתפים.
המשאבים מסוג Space
מייצגים מקום שבו אנשים ואפליקציות Chat יכולים לשלוח הודעות, לשתף קבצים ולשתף פעולה. יש כמה סוגים של מרחבים משותפים:
- צ'אטים אישיים (DM) הם שיחות בין שני משתמשים או בין משתמש לאפליקציית Chat.
- שיחות קבוצתיות הן שיחות בין שלושה משתמשים או יותר באפליקציות Chat.
- מרחבים משותפים עם שם הם מקומות קבועים שבהם אנשים שולחים הודעות, משתפים קבצים ועובדים יחד.
אפשר להשתמש בשיטה setUp()
כדי לבצע כל אחת מהפעולות הבאות:
- יוצרים מרחב משותף עם שם ומוסיפים לו חברים ראשוניים.
- ליצור צ'אט אישי בין שני אנשים.
- ליצור צ'אט קבוצתי עם כמה אנשים.
כשאתם מגדירים מרחב משותף, כדאי לקחת בחשבון את הדברים הבאים:
- המשתמש הקורא (המאומת) מתווסף למרחב המשותף באופן אוטומטי, כך שאין צורך לציין את החברות של המשתמש בבקשה.
- כשיוצרים צ'אט אישי (DM), אם כבר קיים צ'אט אישי בין שני משתמשים, הוא מוחזר. אחרת, תיווצר שיחה פרטית.
- כשיוצרים שיחה קבוצתית, אם אף אחד מהחברים בקבוצה שצוינו בבקשה לא נוסף לשיחה הקבוצתית (למשל, בעיה בהרשאות), יכול להיות שתיווצר שיחה קבוצתית ריקה (שכוללת רק את המשתמש שהתחיל את השיחה).
- אי אפשר להגדיר מרחבים משותפים עם תגובות בשרשור או לצרף אנשים שלא משתמשים ב-Google Workspace.
- חברויות כפולות (כולל המשתמש הקורא) שצוינו בבקשה מסוננות במקום לגרום לשגיאה בבקשה.
דרישות מוקדמות
Node.js
- חשבון Google Workspace בתוכנית Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- מתקינים את ספריית הלקוח של Cloud ל-Node.js.
-
יצירת פרטי כניסה של מזהה לקוח OAuth לאפליקציה למחשב. כדי להריץ את הדוגמה במדריך הזה, שומרים את פרטי הכניסה כקובץ JSON בשם
client_secrets.json
בספרייה המקומית.
- בחירת היקף הרשאה שתומך באימות משתמשים.
Python
- חשבון Google Workspace בתוכנית Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- מתקינים את ספריית הלקוח של Cloud ב-Python.
-
יצירת פרטי כניסה של מזהה לקוח OAuth לאפליקציה למחשב. כדי להריץ את הדוגמה במדריך הזה, שומרים את פרטי הכניסה כקובץ JSON בשם
client_secrets.json
בספרייה המקומית.
- בחירת היקף הרשאה שתומך באימות משתמשים.
Java
- חשבון Google Workspace בתוכנית Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- מתקינים את ספריית הלקוח של Cloud עבור Java.
-
יצירת פרטי כניסה של מזהה לקוח OAuth לאפליקציה למחשב. כדי להריץ את הדוגמה במדריך הזה, שומרים את פרטי הכניסה כקובץ JSON בשם
client_secrets.json
בספרייה המקומית.
- בחירת היקף הרשאה שתומך באימות משתמשים.
Apps Script
- חשבון Google Workspace בתוכנית Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- מגדירים את מסך ההסכמה של OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- יוצרים פרויקט נפרד של Apps Script ומפעילים את שירות הצ'אט המתקדם.
- בחירת היקף הרשאה שתומך באימות משתמשים.
הגדרת מרחב משותף
כדי להגדיר מרחבים משותפים, צריך להעביר את הפרטים הבאים בבקשה:
- מציינים את היקף ההרשאה
chat.spaces.create
אוchat.spaces
. - קוראים ל-method
SetUpSpace()
. - מעבירים את
space
כמכונה שלSpace
עם כל השדות הנדרשים, כמוdisplayName
אוspaceType
. - מעבירים את
memberships
כמערך של מכונותMembership
. לכל מכונה:- מציינים את
users/{user}
כדי להוסיף משתמש אנושי כחבר במרחב המשותף, כאשר{user}
הוא{person_id}
שלperson
מ-People API, או המזהה שלuser
ב-Directory API. לדוגמה, אם המשתמש ב-People APIresourceName
הואpeople/123456789
, אפשר להוסיף אותו למרחב המשותף על ידי הוספת חברות עםusers/123456789
כ-member.name
. - מציינים את הערך
groups/{group}
כדי להוסיף קבוצה כחברה במרחב המשותף, כאשר{group}
הוא מזהה הקבוצה שאליה רוצים ליצור חברות. אפשר לאחזר את המזהה של הקבוצה באמצעות Cloud Identity API. לדוגמה, אם Cloud Identity API מחזיר קבוצה בשםgroups/123456789
, צריך להגדיר אתmembership.groupMember.name
לערךgroups/123456789
. אי אפשר להוסיף קבוצות מ-Google Groups לצ'אט קבוצתי או לצ'אט אישי, אלא רק למרחב משותף בעל שם.
- מציינים את
כדי ליצור צ'אט אישי בין המשתמש מבצע הקריאה לבין משתמש אנושי אחר, צריך לציין את החברות של המשתמש האנושי בבקשה.
כדי ליצור שיחה פרטית בין המשתמש הקורא לאפליקציה הקוראת, מגדירים את הערך של space.singleUserBotDm
כ-true
ולא מציינים חברויות. אפשר להשתמש בשיטה הזו רק כדי להגדיר צ'אט ישיר עם אפליקציית השיחה. כדי להוסיף את אפליקציית השיחה כחברה במרחב משותף או בצ'אט ישיר קיים בין שני משתמשים אנושיים, אפשר לעיין במאמר יצירת חברות.
בדוגמה הבאה נוצר מרחב עבודה בשם ומשתמשים שניים (המשתמש המאומת ומשתמש נוסף) מצטרפים למרחב העבודה.
Node.js
Python
Java
Apps Script
כדי להריץ את הדוגמה, מחליפים את הפרטים הבאים:
DISPLAY_NAME
: השם המוצג של המרחב החדש.USER_NAME
: המזהה של המשתמש השני שרוצים לכלול את המינוי שלו.
כדי לעבור למרחב המשותף, משתמשים במזהה המשאב של המרחב המשותף כדי ליצור את כתובת ה-URL שלו.
אפשר לקבל את מזהה המשאב מהמרחב המשותף name
בגוף התשובה ב-Google Chat. לדוגמה, אם הערך של name
במרחב המשותף הוא spaces/1234567
, תוכלו להיכנס למרחב המשותף באמצעות כתובת ה-URL הבאה: https://mail.google.com/chat/u/0/#chat/space/1234567
.
נושאים קשורים
- יוצרים מרחב משותף.
- לקבלת פרטים על מרחב משותף
- רשימת המרחבים המשותפים.
- לעדכן מרחב משותף.
- למחוק את המרחב המשותף.
- מחפשים מרחב משותף בצ'אט אישי.
- להגדיר מרחב משותף כגלוי למשתמשים ספציפיים.