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,
  "adminInstalled": boolean,
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string
}
שדות
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.
adminInstalled

boolean

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

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

object (AccessSettings)

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

spaceUri

string

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

סוג

הוצא משימוש: יש להשתמש במקום זאת ב-SpaceType.

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

SpaceType

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

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

SpaceThreadingState

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

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

SpaceDetails

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

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

string

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

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

string

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

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

HistoryState

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

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

AccessSettings

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

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

enum (AccessState)

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

string

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

AccessState

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

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

שיטות

completeImport

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

create

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

delete

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

findDirectMessage

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

get

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

list

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

patch

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

setup

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