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,
  "sessionState": enum (SpaceSessionState),
  "sessionEnableTime": string,
  "importModeExpireTime": string,
  "customer": string,

  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
}
שדות
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

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

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

object (MembershipCount)

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

object (AccessSettings)

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

string

פלט בלבד. ה-URI שדרכו המשתמשים יכולים לגשת למרחב.
sessionState

enum (SpaceSessionState)

פלט בלבד. מצב הסשן של המרחב המשותף.
sessionEnableTime

string (Timestamp format)

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

string (Timestamp format)

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

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

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

string

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

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

השדה הזה לא מאוכלס בצ'אטים ישירים או כשמשתמשים שאין להם חשבון Google Workspace יוצרים את המרחב המשותף.
מייצג את הגדרות ההרשאות של מרחב. השדה הזה מאוכלס רק כשהערך של space_type הוא SPACE. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
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

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

  • צ'אט מתמשך לפגישה שבו השרשורים מושבתים בכוונה.
  • שיחות קבוצתיות שנוצרו לפני 2022.

SpaceDetails

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

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

string

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

אפשר להזין עד 4,096 תווים.
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,
  "accessPermissionSettings": {
    object (AccessPermissionSettings)
  }
}
שדות
accessState

enum (AccessState)

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

string

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

פורמט: audiences/{audience}

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

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

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

כדי להגדיר את קהל היעד, נדרש אימות משתמש.
accessPermissionSettings

object (AccessPermissionSettings)

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

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

AccessState

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

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

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

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

AccessPermissionSettings

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

ייצוג ב-JSON 
{
  "discoverSpaceSetting": {
    object (AccessPermissionSetting)
  },
  "joinSpaceSetting": {
    object (AccessPermissionSetting)
  },
  "viewSpaceMembershipSetting": {
    object (AccessPermissionSetting)
  }
}
שדות
discoverSpaceSetting

object (AccessPermissionSetting)

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

object (AccessPermissionSetting)

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

object (AccessPermissionSetting)

אופציונלי. הגדרת הרשאת גישה לצפייה בחברים במרחב. כשמעדכנים מי יכול לראות את רשימת המשתתפים במרחב, צריך לציין את השדה הזה יחד עם PermissionSettings.view_space_membership במסכת העדכון ובגוף הבקשה. כשמעניקים גישת צפייה לקהל יעד, צריך גם להעניק PermissionSettings.view_space_membership לכל החברים באותה בקשה. כדי להסיר קהל יעד קיים (לדוגמה, כדי להגביל את גישת הצפייה למנהלים או לעוזרי מנהלים של המרחב המשותף בלבד), צריך לציין AccessPermissionSetting ריק (בלי principals).

AccessPermissionSetting

הגדרה של הרשאת גישה.

ייצוג ב-JSON 
{
  "principals": [
    {
      object (Principal)
    }
  ]
}
שדות
principals[]

object (Principal)

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

חשבון משתמש

חשבון משתמש שמייצג ישות שקיבלה גישה.

ייצוג ב-JSON 
{

  "audience": {
    object (Audience)
  }
}
שדות
סוג חשבון המשתמש. ברשימה הבאה מופיעים שדות שמוציאים זה את זה. בתשובה יוגדר לכל היותר אחד מהשדות הבאים:
audience

object (Audience)

קהל.
סוף השדות שמוציאים זה את זה.

קהל

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

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

ייצוג ב-JSON 
{
  "name": string
}
שדות
name

string

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

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

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)
  },
  "viewSpaceMembership": {
    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)

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

object (PermissionSetting)

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

PermissionSetting

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

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

boolean

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

boolean

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

boolean

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

SpaceSessionState

מצב הסשן של המרחב המשותף.

טיפוסים בני מנייה (enum)
SPACE_SESSION_STATE_UNSPECIFIED לא צוין. אל תשתמשו בהם.
NOT_SUPPORTED אין תמיכה בסשנים במרחב המשותף.
THREAD המרחב המשותף תומך בסשן שמבוסס על שרשורים.

Methods

completeImport

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

create

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

delete

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

findDirectMessage

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

findGroupChats

 הפונקציה מחזירה את כל המרחבים המשותפים עם spaceType == GROUP_CHAT, שבהם החברים האנושיים הם בדיוק המשתמש שביצע את הקריאה והמשתמשים שצוינו ב-FindGroupChatsRequest.users.

get

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

list

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

patch

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

setup

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