Method: spaces.setup

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

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

כדי לציין את קבוצות Google שרוצים להוסיף, מוסיפים חברויות באמצעות membership.group_member.name המתאים. כדי להוסיף או להזמין קבוצת Google, משתמשים ב-groups/{group}, כאשר {group} הוא id של הקבוצה מ-Cloud Identity Groups API. לדוגמה, אפשר להשתמש ב-Cloud Identity Groups lookup API כדי לאחזר את המזהה 123456789 של כתובת האימייל של הקבוצה group@example.com. אחר כך אפשר להוסיף את הקבוצה למרחב המשותף על ידי הגדרת membership.group_member.name לערך groups/123456789. אי אפשר לשלוח אימיילים לקבוצות, ואפשר להוסיף קבוצות Google רק כחברים במרחבים משותפים עם שם.

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

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

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

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

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

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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}.

כדי להוסיף חברות בקבוצות Google, השדה Membership.group_member צריך להכיל group עם name מאוכלס (בפורמט groups/{group}). אפשר להוסיף קבוצות Google רק כשמגדירים את Space.spaceType לערך SPACE.

אופציונלי כשמגדירים את 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

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