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,

  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
}
שדות
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 ממקור הלקוח של SDK לאדמינים. אפליקציות פרטיות יכולות גם להשתמש בכינוי customers/my_customer כדי ליצור את המרחב באותו ארגון Google Workspace שבו נמצאת האפליקציה.

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

enum (PredefinedPermissionSettings)

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

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

object (PermissionSettings)

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

אפשר לקרוא ולעדכן את הגדרות ההרשאות:
סוף השדות הבלעדיים.

סוג

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

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

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

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

אפשר להזין עד 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,
  "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 Groups שמשתמשים אחרים או אדמינים ב-Google Workspace הוסיפו או הזמינו באופן פרטני יכולים לראות את המרחב ולגשת אליו.
DISCOVERABLE

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

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

AccessPermissionSettings

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

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

object (AccessPermissionSetting)

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

object (AccessPermissionSetting)

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

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)
  }
}
שדות
manageMembersAndGroups

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

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

object (PermissionSetting)

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

PermissionSetting

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

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

boolean

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

boolean

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

boolean

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

Methods

completeImport

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

create

 יצירת מרחב.

delete

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

findDirectMessage

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

findGroupChats

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

get

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

list

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

patch

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

setup

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