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} מייצג את המזהה שהמערכת הקצה למרחב המשותף. אפשר לקבל את מזהה המרחב באמצעות קריאה ל-method‏ 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

פלט בלבד. במרחבים משותפים של צ'אט אישי (DM) באפליקציית 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]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers). אפליקציות פרטיות יכולות גם להשתמש בכתובת החלופית 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)

זה שינוי אופציונלי. ההגדרה של השימוש ב-'הכול' במרחב משותף.
manageApps

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

פלט בלבד. ההגדרה הזו קובעת אם אפשר לפרסם הודעות במרחב המשותף.
replyMessages

object (PermissionSetting)

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

PermissionSetting

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

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

boolean

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

boolean

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

Methods

completeImport

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

create

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

delete

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

findDirectMessage

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

get

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

list

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

patch

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

setup

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