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,
  "importModeExpireTime": string,
  "customer": 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}

כאשר {space} מייצג את המזהה שהוקצה למרחב על ידי המערכת. אפשר לקבל את מזהה המרחב באמצעות הפעלת השיטה spaces.list() או מכתובת ה-URL של המרחב. לדוגמה, אם כתובת ה-URL של המרחב היא https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, מזהה המרחב הוא AAAAAAAAA.
type
(deprecated)

enum (Type)

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

enum (SpaceType)

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

boolean

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

boolean

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

string

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

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

אפשר להשתמש בעד 128 תווים.
externalUserAllowed

boolean

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

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

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

enum (SpaceThreadingState)

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

object (SpaceDetails)

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

enum (HistoryState)

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

boolean

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

כדי ליצור מרחב ב-Import Mode, צריך אימות משתמש.
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 שמשמש משתמשים לגישה למרחב.
importModeExpireTime

string (Timestamp format)

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

כל מרחב שנוצר במצב ייבוא צריך לצאת מהמצב הזה לפני תאריך התפוגה באמצעות spaces.completeImport.

השדה הזה מתמלא רק במרחבים שנוצרו במצב ייבוא.
customer

string

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

בפורמט customers/{customer}, כאשר customer הוא id ממשאב הלקוח של Admin SDK. אפליקציות פרטיות יכולות גם להשתמש בכינוי customers/my_customer כדי ליצור את המרחב באותו ארגון Google Workspace שבו נמצאת האפליקציה.

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

enum (PredefinedPermissionSettings)

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

הגדרת הרשאות מוגדרות מראש תומכת ב:
permissionSettings

object (PermissionSettings)

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

קריאה ועדכון של הגדרות הרשאות תומכים ב:

סוג

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

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

SpaceType

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

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

SpaceThreadingState

מציין את סוג השרשור במרחב ב-Chat.

טיפוסים בני מנייה (enum)
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

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

טיפוסים בני מנייה (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

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

פורמט: audiences/{audience}

כדי להשתמש בקהל היעד שמוגדר כברירת מחדל לארגון Google Workspace, צריך להגדיר את הערך audiences/default.

קריאת קהל היעד תומכת ב:

השדה הזה לא מאוכלס כשמשתמשים בהיקף chat.bot עם אימות אפליקציה.

כדי להגדיר את קהל היעד, צריך לאמת את המשתמש.

AccessState

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

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

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

כדי ליצור מרחבים שגלויים לכולם, צריך לאמת את המשתמשים.

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)

אופציונלי. הגדרה לשימוש בתיוג @all במרחב.
manageApps

object (PermissionSetting)

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

object (PermissionSetting)

אופציונלי. הגדרה לניהול webhooks במרחב.
postMessages

object (PermissionSetting)

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

object (PermissionSetting)

אופציונלי. הגדרה למענה להודעות במרחב.

PermissionSetting

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

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

boolean

אופציונלי. האם לבעלי המרחב (ROLE_MANAGER) יש את ההרשאה הזו.
membersAllowed

boolean

אופציונלי. האם למשתתפים במרחב (ROLE_MEMBER) יש את ההרשאה הזו.

Methods

completeImport

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

create

 יצירת מרחב.

delete

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

findDirectMessage

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

get

 מחזירה פרטים על מרחב.

list

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

patch

 עדכון של מרחב.
מחזירה רשימה של מרחבים בארגון Google Workspace על סמך חיפוש של אדמין.

setup

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