REST Resource: spaces

משאב: מרחב

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

ייצוג JSON 
{
  "name": string,
  "type": enum (Type),
  "spaceType": enum (SpaceType),
  "singleUserBotDm": boolean,
  "threaded": boolean,
  "displayName": string,
  "externalUserAllowed": boolean,
  "spaceThreadingState": enum (SpaceThreadingState),
  "spaceDetails": {
    object (SpaceDetails)
  },
  "spaceHistoryState": enum (HistoryState),
  "importMode": boolean,
  "createTime": string,
  "lastActiveTime": string,
  "adminInstalled": boolean,
  "membershipCount": {
    object (MembershipCount)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string,

  // Union field space_permission_settings can be only one of the following:
  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
  // End of list of possible types for union field space_permission_settings.
}
שדות
name

string

שם המשאב של המרחב המשותף.

פורמט: spaces/{space}
type
(deprecated)

enum (Type)

פלט בלבד. הוצא משימוש: במקומו צריך להשתמש ברכיב spaceType. סוג המרחב המשותף.
spaceType

enum (SpaceType)

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

boolean

זה שינוי אופציונלי. האם המרחב המשותף הוא צ'אט בין אפליקציית Chat לבין אדם אחד?
threaded
(deprecated)

boolean

פלט בלבד. הוצא משימוש: במקומו צריך להשתמש ברכיב spaceThreadingState. האם ההודעות יקובצו במרחב המשותף הזה.
displayName

string

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

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

אפשר להזין עד 128 תווים.
externalUserAllowed

boolean

בלתי ניתן לשינוי. האם המרחב המשותף הזה מאפשר לכל משתמש ב-Google Chat להצטרף אליו. צריך להזין כאן את הפרטים כשיוצרים מרחב משותף ב-Google Workspace. יש להשמיט את השדה הזה כשיוצרים רווחים בתנאים הבאים:

  • המשתמש המאומת משתמש בחשבון פרטי (חשבון משתמש לא מנוהל). כברירת מחדל, במרחבים משותפים שנוצרו על ידי חשבון פרטי אפשר להשתמש ב-Google Chat.

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

במרחבים משותפים קיימים, השדה הזה משמש רק כפלט.
spaceThreadingState

enum (SpaceThreadingState)

פלט בלבד. מצב השרשור במרחב ב-Chat.
spaceDetails

object (SpaceDetails)

פרטים על המרחב המשותף, כולל תיאור וכללים.
spaceHistoryState

enum (HistoryState)

המצב של היסטוריית ההודעות של ההודעות והשרשורים במרחב המשותף.
importMode

boolean

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

string (Timestamp format)

זה שינוי אופציונלי. בלתי ניתן לשינוי. מידע על מרחבים משותפים שנוצרו ב-Chat: השדה הזה הוא פלט בלבד, חוץ מבמקרים שבהם נעשה בו שימוש במרחבים משותפים של מצב ייבוא.

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

השדה הזה מאוכלס רק בפלט כשהערך של spaceType הוא GROUP_CHAT או SPACE.
lastActiveTime

string (Timestamp format)

פלט בלבד. חותמת הזמן של ההודעה האחרונה במרחב המשותף.

adminInstalled

boolean

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

כדי לתמוך בהתקנה של אדמין, אפליקציית Chat צריכה לכלול צ'אט אישי.
membershipCount

object (MembershipCount)

פלט בלבד. מספר החברויות במועדון שהצטרפו לפי סוג החבר. מאוכלס כשהערך בשדה spaceType הוא SPACE, DIRECT_MESSAGE או GROUP_CHAT.

accessSettings

object (AccessSettings)

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

spaceUri

string

פלט בלבד. ה-URI של המרחב.

שדה איחוד space_permission_settings. השדה הזה מייצג את הגדרות ההרשאות של המרחב המשותף. השדה הזה מאוכלס רק כשהערך של space_type הוא SPACE. space_permission_settings יכול להיות רק אחת מהאפשרויות הבאות:
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

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

permissionSettings

object (PermissionSettings)

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

סוג

הוצא משימוש: במקומו צריך להשתמש ברכיב SpaceType.

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

SpaceType

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

טיפוסים בני מנייה (enum)
SPACE_TYPE_UNSPECIFIED שמור.
SPACE מקום שבו אנשים שולחים הודעות, משתפים קבצים ועובדים יחד. SPACE יכול לכלול אפליקציות צ'אט.
GROUP_CHAT שיחות קבוצתיות עם 3 אנשים או יותר. GROUP_CHAT יכול לכלול אפליקציות צ'אט.
DIRECT_MESSAGE צ'אטים אישיים בין שני אנשים או בין שני אנשים לבין אפליקציית Chat.

SpaceThreadingState

ההגדרה קובעת את סוג השרשור במרחב ב-Chat.

טיפוסים בני מנייה (enum)
SPACE_THREADING_STATE_UNSPECIFIED שמור.
THREADED_MESSAGES מרחבים משותפים עם שם שתומכים בשרשורי הודעות. כשמשתמשים מגיבים להודעה, הם יכולים להשיב בשרשור, והתשובה שלהם נשארת בהקשר של ההודעה המקורית.
GROUPED_MESSAGES במרחבים משותפים עם שמות שבהם השיחות מחולקות לפי נושאים. הנושאים והתשובות שלהם מקובצים יחד.
UNTHREADED_MESSAGES צ'אטים אישיים בין שני אנשים ושיחות קבוצתיות בין 3 אנשים או יותר.

SpaceDetails

פרטים על המרחב המשותף, כולל תיאור וכללים.

ייצוג JSON 
{
  "description": string,
  "guidelines": string
}
שדות
description

string

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

אפשר להזין עד 150 תווים.
guidelines

string

זה שינוי אופציונלי. הכללים, הציפיות והנימוסים של המרחב.

אפשר להזין עד 5,000 תווים.

HistoryState

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

טיפוסים בני מנייה (enum)
HISTORY_STATE_UNSPECIFIED ערך ברירת המחדל. אין להשתמש בו.
HISTORY_OFF ההיסטוריה מושבתת. ההודעות והשרשורים נשמרים למשך 24 שעות.
HISTORY_ON ההיסטוריה מופעלת. כללי השמירה ב-Vault של הארגון מגדירים את משך הזמן לשמירת הודעות ושרשורים.

MembershipCount

מייצג את מספר החברים במרחב המשותף, בקיבוץ לפי קטגוריות.

ייצוג JSON 
{
  "joinedDirectHumanUserCount": integer,
  "joinedGroupCount": integer
}
שדות
joinedDirectHumanUserCount

integer

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

integer

מספר הקבוצות שהצטרפו ישירות למרחב המשותף.

AccessSettings

הגדרת הגישה של המרחב המשותף.

ייצוג JSON 
{
  "accessState": enum (AccessState),
  "audience": string
}
שדות
accessState

enum (AccessState)

פלט בלבד. מצב הגישה של המרחב המשותף.
audience

string

זה שינוי אופציונלי. שם המשאב של קהל היעד שיש לו הרשאת גישה למרחב המשותף. צריך להגדיר את השדה הזה למזהה חוקי של קהל יעד כדי שהמרחב יהיה גלוי או להשתמש בכינוי audiences/default כדי להגדיר את המרחב עם הגדרת ברירת המחדל לגישה במסוף Admin. מידע נוסף מופיע במאמר הגדרת מרחב שגלוי לקהל יעד. אם רוצים שהמרחב המשותף יהיה מוגבל, צריך לבטל את ההגדרה שלו. השדה הזה מאוכלס רק כשהמרחב המשותף גלוי. פורמט: audiences/{audience}, audiences/default יכול לשמש ככינוי ברירת המחדל של הגדרת שיתוף הצ'אט.

AccessState

מצב הגישה של המרחב.

טיפוסים בני מנייה (enum)
ACCESS_STATE_UNSPECIFIED מצב הגישה לא ידוע או שהוא לא נתמך ב-API הזה.
PRIVATE שאר חברי הקבוצה או חברי המרחב המשותף יוכלו לראות אותם.
DISCOVERABLE קהל היעד שנבחר יוכל לראות את המרחב המשותף, וגם את החברים או הקבוצות שנוספו או הוזמנו אליו.

PredefinedPermissionSettings

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

טיפוסים בני מנייה (enum)
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED לא צוין. אין להשתמש בו.
COLLABORATION_SPACE הגדרת המרחב המשותף הזה כמרחב לשיתוף פעולה שבו כל המשתתפים יכולים לפרסם הודעות.
ANNOUNCEMENT_SPACE הגדרת המרחב המשותף הזה כמרחב הודעות שבו רק מנהלי המרחב המשותף יכולים לפרסם הודעות.

PermissionSettings

הגדרות ההרשאות למרחב משותף עם שם. כדי לקבוע את ההגדרות של ההרשאות כשיוצרים מרחב משותף, צריך לציין את השדה PredefinedPermissionSettings בבקשה.

ייצוג JSON 
{
  "manageMembersAndGroups": {
    object (PermissionSetting)
  },
  "modifySpaceDetails": {
    object (PermissionSetting)
  },
  "toggleHistory": {
    object (PermissionSetting)
  },
  "useAtMentionAll": {
    object (PermissionSetting)
  },
  "manageApps": {
    object (PermissionSetting)
  },
  "manageWebhooks": {
    object (PermissionSetting)
  },
  "postMessages": {
    object (PermissionSetting)
  },
  "replyMessages": {
    object (PermissionSetting)
  }
}
שדות
manageMembersAndGroups

object (PermissionSetting)

הגדרה לניהול רשימת המשתתפים והקבוצות במרחב המשותף.
modifySpaceDetails

object (PermissionSetting)

הגדרה לעדכון השם, הדמות, התיאור וההנחיות של המרחב המשותף.
toggleHistory

object (PermissionSetting)

הגדרה להפעלה ולהשבתה של ההיסטוריה של המרחב המשותף.
useAtMentionAll

object (PermissionSetting)

הגדרה לשימוש בתיוג @כולם במרחב המשותף.
manageApps

object (PermissionSetting)

הגדרה לניהול האפליקציות במרחב המשותף.
manageWebhooks

object (PermissionSetting)

הגדרה לניהול ה-webhooks במרחבים משותפים.
postMessages

object (PermissionSetting)

פלט בלבד. הגדרה לפרסום הודעות במרחב.
replyMessages

object (PermissionSetting)

הגדרה של מענה להודעות במרחב המשותף.

PermissionSetting

מייצג הגדרה של הרשאה למרחב.

ייצוג JSON 
{
  "managersAllowed": boolean,
  "membersAllowed": boolean
}
שדות
managersAllowed

boolean

אם למנהלים של המרחבים המשותפים יש את ההרשאה הזו.
membersAllowed

boolean

האם למשתמשים שהם לא בעלי חשבון ניהול יש את ההרשאה הזו.

שיטות

completeImport

 משלים את תהליך הייבוא של המרחב שצוין והופך אותו לגלוי למשתמשים.

create

 יצירת מרחב משותף עם שם.

delete

 מחיקה של מרחב משותף עם שם.

findDirectMessage

 הפונקציה מחזירה את הצ'אט האישי הקיים עם המשתמש שצוין.

get

 הפונקציה מחזירה פרטים על מרחב משותף.

list

 בתיבת הדו-שיח הזו מפורטים המרחבים המשותפים שאליהם המשתמש משתתף.

patch

 לעדכן את המרחב המשותף.

setup

 יצירת מרחב משותף והוספה של משתמשים ספציפיים אליו.