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 רק כחברים במרחבים משותפים עם שם.

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

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

כדי ליצור צ'אט אישי בין המשתמש המתקשר לבין אפליקציית השיחות, צריך להגדיר את 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}.

עבור חברות בקבוצה ב-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

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