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 של הקבוצה מה-API של הקבוצות ב-Cloud Identity. לדוגמה, אפשר להשתמש ב-Cloud Identity Groups lookup API כדי לאחזר את המזהה 123456789 של כתובת האימייל של הקבוצה group@example.com. אחר כך אפשר להוסיף את הקבוצה למרחב המשותף על ידי הגדרת הערך groups/123456789 ב-membership.group_member.name. אי אפשר לשלוח אימיילים לקבוצות, ואפשר להוסיף קבוצות 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

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