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

פלט בלבד. במרחבים משותפים של צ'אט אישי (DM) באפליקציית 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 צ'אטים אישיים (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 שנוספו או הוזמנו על ידי משתמשים אחרים או אדמינים ב-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

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