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,
  "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

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

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

object (MembershipCount)

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

object (AccessSettings)

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

string

פלט בלבד. ה-URI של המשתמש כדי לגשת למרחב המשותף.
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 יכול לכלול אפליקציות צ'אט.
GROUP_CHAT שיחות קבוצתיות עם 3 אנשים או יותר. GROUP_CHAT יכול לכלול אפליקציות של 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

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

פורמט: audiences/{audience}

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

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

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

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

AccessState

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

טיפוסים בני מנייה (enum)
ACCESS_STATE_UNSPECIFIED מצב הגישה לא ידוע או שהוא לא נתמך ב-API הזה.
PRIVATE רק משתמשים וקבוצות ב-Google שנוספו או הוזמנו על ידי משתמשים אחרים או אדמינים ב-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

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

שיטות

completeImport

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

create

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

delete

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

findDirectMessage

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

get

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

list

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

patch

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

setup

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