Method: spaces.setup

יצירת מרחב משותף והוספה של משתמשים ספציפיים אליו. המשתמש שהתקשרתם אליו יצורף אוטומטית למרחב המשותף, ואתם לא רוצים לציין שהוא חבר בבקשה. לדוגמה, תוכלו לקרוא את המאמר הגדרת מרחב משותף עם המשתתפים הראשונים.

כדי לציין את המשתמשים האנושיים להוספה, צריך להוסיף חברויות באמצעות member.name המתאים בSetUpSpaceRequest. כדי להוסיף משתמש אנושי, צריך להשתמש ב-users/{user}. הכתובת {user} יכולה לשמש ככתובת האימייל של המשתמש. עבור משתמשים באותו ארגון Workspace, {user} יכול להיות גם id עבור המשתמש מ-People API, או id של המשתמש ב-Directory API. לדוגמה, אם מזהה פרופיל האנשים של user@example.com ב-People API הוא 123456789, אפשר להוסיף את המשתמש למרחב המשותף על ידי הגדרת הערך של membership.member.name בתור users/user@example.com או users/123456789.

במרחב משותף או בצ'אט קבוצתי, אם מי שמתקשר נחסם או נחסם על ידי חלק מהמשתתפים, הם לא מצורפים למרחב המשותף שנוצר.

כדי ליצור צ'אט אישי (DM) בין המשתמש שמתקשר לבין משתמש אנושי אחר, צריך לציין בדיוק מינוי אחד שייצג את המשתמש. אם משתמש אחד חוסם את המשתמש האחר, הבקשה תיכשל והצ'אט לא ייווצר.

כדי ליצור צ'אט אישי בין המשתמש שמתקשר לבין האפליקציה לשיחות, צריך להגדיר בשדה Space.singleUserBotDm את הערך true בלי לציין חברויות. אפשר להשתמש בשיטה הזו רק כדי ליצור צ'אטים אישיים מאפליקציית השיחות. במאמר הזמנה או הוספה של משתמשים או אפליקציות למרחב משותף מוסבר איך מוסיפים את אפליקציית השיחות כמשתתפים במרחב משותף או כצ'אט קיים בין שני משתמשים.

אם כבר יש צ'אט אישי בין שני משתמשים, גם כשמשתמש אחד חוסם את המשתמש השני בזמן שליחת הבקשה, הצ'אט האישי הקיים מוחזר.

אי אפשר להשתמש במרחבים משותפים עם תשובות בשרשור. אם מופיעה הודעת השגיאה ALREADY_EXISTS במהלך הגדרת המרחב המשותף, אפשר לנסות להשתמש במכשיר displayName אחר. יכול להיות שהשם המוצג הזה כבר קיים במרחב משותף קיים ב-Google Workspace.

נדרש אימות משתמש.

בקשת HTTP

POST https://chat.googleapis.com/v1/spaces:setup

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "space": {
    object (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
שדות
space

object (Space)

חובה. השדה Space.spaceType הוא חובה.

כדי ליצור מרחב משותף, צריך להגדיר את Space.spaceType לערך SPACE ולהגדיר את Space.displayName. אם מופיעה הודעת השגיאה ALREADY_EXISTS במהלך הגדרת המרחב המשותף, אפשר לנסות להשתמש במכשיר displayName אחר. יכול להיות שהשם המוצג הזה כבר קיים במרחב משותף קיים ב-Google Workspace.

כדי ליצור צ'אט קבוצתי, צריך לשנות את הערך של Space.spaceType לערך GROUP_CHAT. אין להגדיר את Space.displayName.

כדי לדבר עם אנשים בצ'אט אישי, צריך להגדיר את Space.spaceType למצב DIRECT_MESSAGE ולהגדיר את Space.singleUserBotDm ל-false. אין להגדיר Space.displayName או Space.spaceDetails.

כדי ליצור שיחה אישית בין אדם לבין אפליקציית Chat, מגדירים את Space.spaceType ל-DIRECT_MESSAGE ואת Space.singleUserBotDm ל-true. אין להגדיר Space.displayName או Space.spaceDetails.

אם כבר קיים מרחב משותף מסוג DIRECT_MESSAGE, המרחב המשותף הזה יוחזר במקום ליצור מרחב משותף חדש.
requestId

string

זה שינוי אופציונלי. מזהה ייחודי לבקשה הזו. מומלץ להשתמש במזהה ייחודי אוניברסלי (UUID) אקראי. אם מציינים מזהה בקשה קיים, המערכת מחזירה את המרחב המשותף שנוצר עם המזהה הזה במקום ליצור מרחב משותף חדש. אם מציינים מזהה בקשה קיים מאותה אפליקציית Chat עם משתמש מאומת אחר, מופיעה הודעת שגיאה.
memberships[]

object (Membership)

זה שינוי אופציונלי. משתמשי Google Chat שרוצים להזמין למרחב המשותף. השמט את המשתמש המתקשר כי הוא יתווסף באופן אוטומטי.

בשלב הזה, ההגדרה מאפשרת עד 20 חברויות (בנוסף למבצע הקריאה החוזרת).

השדה Membership.member חייב להכיל user עם name מאוכלס (בפורמט users/{user}) ו-type מוגדר ל-User.Type.HUMAN. אפשר להוסיף משתמשים אנושיים רק כשמגדירים מרחב משותף (אפשר להוסיף אפליקציות ל-Chat רק כדי להגדיר צ'אטים אישיים באפליקציה לשיחות). אפשר גם להוסיף חברים באמצעות כתובת האימייל של המשתמש ככינוי של {user}. למשל, user.name יכול להיות users/example@gmail.com. כדי להזמין משתמשי Gmail או משתמשים מדומיינים חיצוניים ב-Google Workspace, צריך להזין את כתובת האימייל של המשתמש עבור {user}.

אופציונלי כשמגדירים את Space.spaceType לערך 'SPACE'.

חובה כשמגדירים את Space.spaceType לערך 'GROUP_CHAT', עם שני מינויים לפחות.

חובה כשמגדירים את Space.spaceType לערך 'DIRECT_MESSAGE' עם משתמש אנושי, וגם עם מינוי אחד בלבד.

השדה הזה צריך להיות ריק כשיוצרים שיחה אישית בין אדם לבין אפליקציית Chat (כשמגדירים את הערך של Space.spaceType לערך DIRECT_MESSAGE ואת הערך Space.singleUserBotDm כ-true).

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה מכיל מופע של Space.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

למידע נוסף, עיינו במדריך ההרשאות.