במדריך הזה מוסבר איך להשתמש בשיטה setUp() במשאב Space של Google Chat API כדי ליצור מרחב ב-Chat ולהוסיף אליו משתתפים.
Spaceמשאב
מייצג מקום שבו אנשים ואפליקציות ל-Chat יכולים לשלוח הודעות, לשתף קבצים ולשתף פעולה. יש כמה סוגים של מרחבים:
- צ'אטים ישירים הם שיחות בין שני משתמשים או בין משתמש לבין אפליקציית Chat.
- צ'אטים קבוצתיים הם שיחות בין שלושה משתמשים או יותר לבין אפליקציות של Chat.
- מרחבים משותפים עם שם הם מקומות קבועים שבהם אנשים יכולים לשלוח הודעות, לשתף קבצים ולעבוד יחד.
אתם יכולים להשתמש בשיטה setUp() כדי לבצע כל אחת מהפעולות הבאות:
- ליצור מרחב עם שם וחברים ראשוניים.
- ליצור צ'אט ישיר בין שני אנשים.
- ליצור צ'אט קבוצתי עם כמה אנשים.
כשמגדירים מרחב, כדאי לקחת בחשבון את הנקודות הבאות:
- המשתמש שביצע את הקריאה (מאומת) מצורף אוטומטית למרחב, כך שלא צריך לציין את החברות של המשתמש בבקשה.
- כשיוצרים צ'אט ישיר, אם קיים צ'אט ישיר בין שני משתמשים, הצ'אט הישיר הזה מוחזר. אחרת, נוצר צ'אט ישיר.
- כשיוצרים צ'אט קבוצתי, אם אף אחד מהמשתתפים שצוינו בבקשה לא נוסף לצ'אט הקבוצתי (לדוגמה, בגלל בעיית הרשאה), יכול להיות שייווצר צ'אט קבוצתי ריק (כולל רק המשתמש שמתקשר).
- אי אפשר להגדיר מרחבים עם שרשורים של תשובות או להוסיף אנשים שלא מהארגון שלכם ב-Google Workspace.
- חברות כפולה (כולל המשתמש שמתקשר) שצוינה בבקשה מסוננת במקום לגרום לשגיאה בבקשה.
- כשמנהל ב-Google Workspace מתקין אפליקציית Chat לכל הארגון שלו ב-Google Workspace, מערכת Google Chat יוצרת צ'אט ישיר בין אפליקציית Chat שהותקנה לכל משתמש בארגון, כך שאין צורך להגדיר צ'אטים ישירים באופן פרוגרמטי. במקום זאת, אפשר לרשום את המרחבים כדי לקבל את כל הצ'אטים הישירים או למצוא צ'אט ישיר כדי לקבל פרטים על צ'אט ישיר ספציפי.
דרישות מוקדמות
Node.js
- חשבון Google Workspace במהדורת Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- הגדרת מסך ההסכמה ל-OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- מתקינים את ספריית הלקוח של Cloud ל-Node.js.
-
יצירת פרטי כניסה של מזהה לקוח OAuth לאפליקציה למחשב. כדי להריץ את הדוגמה במדריך הזה, שומרים את פרטי הכניסה כקובץ JSON בשם
credentials.jsonבספרייה המקומית.
- בחירת היקף הרשאה שתומך באימות משתמשים.
Python
- חשבון Google Workspace במהדורת Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- הגדרת מסך ההסכמה ל-OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- מתקינים את ספריית הלקוח של Cloud לשימוש ב-Python.
-
יצירת פרטי כניסה של מזהה לקוח OAuth לאפליקציה למחשב. כדי להריץ את הדוגמה במדריך הזה, שומרים את פרטי הכניסה כקובץ JSON בשם
credentials.jsonבספרייה המקומית.
- בחירת היקף הרשאה שתומך באימות משתמשים.
Java
- חשבון Google Workspace במהדורת Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- הגדרת מסך ההסכמה ל-OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- מתקינים את ספריית הלקוח של Cloud ל-Java.
-
יצירת פרטי כניסה של מזהה לקוח OAuth לאפליקציה למחשב. כדי להריץ את הדוגמה במדריך הזה, שומרים את פרטי הכניסה כקובץ JSON בשם
credentials.jsonבספרייה המקומית.
- בחירת היקף הרשאה שתומך באימות משתמשים.
Apps Script
- חשבון Google Workspace במהדורת Business או Enterprise עם גישה ל-Google Chat.
- מגדירים את הסביבה:
- יוצרים פרויקט ב-Google Cloud.
- הגדרת מסך ההסכמה ל-OAuth.
- מפעילים ומגדירים את Google Chat API עם שם, סמל ותיאור לאפליקציית Chat.
- יוצרים פרויקט עצמאי של Apps Script ומפעילים את שירות Chat המתקדם.
- בחירת היקף הרשאה שתומך באימות משתמשים.
הגדרת מרחב
כדי להגדיר מרחב, מעבירים את הפרטים הבאים בבקשה:
- מציינים את היקף ההרשאות של
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 לצ'אטים קבוצתיים או לצ'אטים ישירים, אלא רק למרחבים עם שם.
- מציינים
כדי ליצור צ'אט ישיר בין המשתמש המתקשר לבין משתמש אנושי אחר, צריך לציין את החברות של המשתמש האנושי בבקשה.
כדי ליצור צ'אט ישיר בין המשתמש שמתקשר לבין האפליקציה שמתקשרת, מגדירים את space.singleUserBotDm ל-true ולא מציינים חברות כלשהי. אפשר להשתמש בשיטה הזו רק כדי להגדיר צ'אט עם אפליקציית שיחות. כדי להוסיף את אפליקציית שיחות כמשתתף במרחב או בצ'אט קיים בין שני משתמשים, אפשר לעיין במאמר בנושא יצירת חברות.
בדוגמה הבאה נוצר מרחב עם שם, ונוצרת חברות אחת במרחב עבור שני משתמשים (המשתמש המאומת ועוד משתמש אחד).
Node.js
Python
Java
Apps Script
כדי להריץ את הדוגמה, מחליפים את הערכים הבאים:
-
DISPLAY_NAME: השם המוצג של המרחב החדש. -
USER_NAME: המזהה של המשתמש השני שרוצים לכלול את החברות שלו.
כדי לעבור לחלל, משתמשים במזהה המשאב של החלל כדי ליצור את כתובת ה-URL של החלל.
אפשר לקבל את מזהה מקור המידע מהמרחב name בגוף התגובה של Google Chat. לדוגמה, אם המזהה של המרחב הוא name, אפשר להיכנס למרחב באמצעות כתובת ה-URL הבאה:
https://mail.google.com/chat/u/0/#chat/space/1234567.spaces/1234567
נושאים קשורים
- איך יוצרים מרחבים
- איך מקבלים פרטים על מרחב
- רשימת מרחבים.
- איך מעדכנים מרחב
- מחיקת מרחב
- איך מחפשים מרחבים עם צ'אטים ישירים
- איך יוצרים מרחב שגלוי למשתמשים ספציפיים