משאב: מרחב
מרחב משותף ב-Google Chat. מרחבים הם בעצם שיחות בין שני משתמשים או יותר, או צ'אטים אישיים בין משתמש לבין אפליקציית Chat.
ייצוג JSON |
---|
{ "name": string, "type": enum ( |
שדות | |
---|---|
name |
שם המשאב של המרחב המשותף. פורמט:
|
type |
פלט בלבד. הוצא משימוש: במקומו צריך להשתמש ברכיב |
spaceType |
סוג המרחב. חובה כשיוצרים מרחב משותף או כשמשנים את הסוג של המרחב המשותף. פלט עבור שימוש אחר בלבד. |
singleUserBotDm |
זה שינוי אופציונלי. האם המרחב המשותף הוא צ'אט בין אפליקציית Chat לבין אדם אחד? |
threaded |
פלט בלבד. הוצא משימוש: במקומו צריך להשתמש ברכיב |
displayName |
השם המוצג של המרחב המשותף. חובה כשיוצרים מרחב עם אם מדובר בצ'אטים אישיים, יכול להיות שהשדה הזה יהיה ריק. אפשר להזין עד 128 תווים. |
externalUserAllowed |
בלתי ניתן לשינוי. האם המרחב המשותף הזה מאפשר לכל משתמש ב-Google Chat להצטרף אליו. צריך להזין כאן את הפרטים כשיוצרים מרחב משותף ב-Google Workspace. יש להשמיט את השדה הזה כשיוצרים רווחים בתנאים הבאים:
במרחבים משותפים קיימים, השדה הזה משמש רק כפלט. |
spaceThreadingState |
פלט בלבד. מצב השרשור במרחב ב-Chat. |
spaceDetails |
פרטים על המרחב המשותף, כולל תיאור וכללים. |
spaceHistoryState |
המצב של היסטוריית ההודעות של ההודעות והשרשורים במרחב המשותף. |
importMode |
זה שינוי אופציונלי. האם המרחב המשותף הזה נוצר באפליקציה |
createTime |
זה שינוי אופציונלי. בלתי ניתן לשינוי. מידע על מרחבים משותפים שנוצרו ב-Chat: השדה הזה הוא פלט בלבד, חוץ מבמקרים שבהם נעשה בו שימוש במרחבים משותפים של מצב ייבוא. במרחבים משותפים של מצב ייבוא, צריך להגדיר את השדה הזה כחותמת הזמן ההיסטורית שבה המרחב המשותף נוצר במקור כדי שזמן היצירה המקורי יישמר. השדה הזה מאוכלס רק בפלט כשהערך של |
lastActiveTime |
פלט בלבד. חותמת הזמן של ההודעה האחרונה במרחב המשותף. |
adminInstalled |
פלט בלבד. במרחבים משותפים בצ'אטים אישיים באפליקציית Chat, לא משנה אם האדמין ב-Google Workspace יצר את המרחב המשותף. אדמינים יכולים להתקין ולהגדיר צ'אט אישי עם אפליקציית Chat בשם המשתמשים בארגון שלהם. כדי לתמוך בהתקנה של אדמין, אפליקציית Chat צריכה לכלול צ'אט אישי. |
membershipCount |
פלט בלבד. מספר החברויות במועדון שהצטרפו לפי סוג החבר. מאוכלס כשהערך בשדה |
accessSettings |
זה שינוי אופציונלי. כאן קובעים את הגדרת הגישה של המרחב המשותף. השדה הזה מאוכלס רק כשהערך של |
spaceUri |
פלט בלבד. ה-URI של המשתמש לגישה למרחב המשותף. |
שדה איחוד space_permission_settings . השדה הזה מייצג את הגדרות ההרשאות של המרחב המשותף. השדה הזה מאוכלס רק כשהערך של space_type הוא SPACE . space_permission_settings יכול להיות רק אחת מהאפשרויות הבאות: |
|
predefinedPermissionSettings |
זה שינוי אופציונלי. קלט בלבד. הגדרות ההרשאות במרחב המשותף. אם השדה הזה לא מוגדר, ייווצר מרחב משותף ליצירת מרחב משותף. אחרי שיוצרים את המרחב, ההגדרות יאוכלסו בשדה |
permissionSettings |
זה שינוי אופציונלי. הגדרות ההרשאות המדויקות שאפשר להגדיר כדי לעדכן את המרחב המשותף. תיבת טקסט לעדכון המרחב המשותף. אחרת, יתבצע רק פלט. ליצירת מרחב משותף, צריך להשתמש ב- |
סוג
הוצא משימוש: במקומו צריך להשתמש ברכיב SpaceType
.
טיפוסים בני מנייה (enum) | |
---|---|
TYPE_UNSPECIFIED |
שמור. |
ROOM |
שיחות בין שני אנשים או יותר. |
DM |
צ'אט אישי בין משתמשים לבין אפליקציית Chat, שבה כל ההודעות הן שטוחות. שימו לב שהנושא הזה לא כולל צ'אטים אישיים בין שני בני אדם. |
SpaceType
סוג המרחב. חובה כשיוצרים או מעדכנים מרחב משותף. פלט עבור שימוש אחר בלבד.
טיפוסים בני מנייה (enum) | |
---|---|
SPACE_TYPE_UNSPECIFIED |
שמור. |
SPACE |
מקום שבו אנשים שולחים הודעות, משתפים קבצים ועובדים יחד. SPACE יכול לכלול אפליקציות צ'אט. |
GROUP_CHAT |
שיחות קבוצתיות עם 3 אנשים או יותר. GROUP_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 |
זה שינוי אופציונלי. תיאור של המרחב המשותף. למשל, אפשר לתאר את נושא השיחה, המטרה התפעולית או רשימת המשתתפים במרחב המשותף. אפשר להזין עד 150 תווים. |
guidelines |
זה שינוי אופציונלי. הכללים, הציפיות והנימוסים של המרחב. אפשר להזין עד 5,000 תווים. |
HistoryState
את מצב ההיסטוריה של ההודעות והמרחבים המשותפים. מציינת למשך כמה זמן ההודעות והשרשורים של השיחות יישמרו אחרי שיוצרים אותם.
טיפוסים בני מנייה (enum) | |
---|---|
HISTORY_STATE_UNSPECIFIED |
ערך ברירת המחדל. אין להשתמש בו. |
HISTORY_OFF |
ההיסטוריה מושבתת. ההודעות והשרשורים נשמרים למשך 24 שעות. |
HISTORY_ON |
ההיסטוריה מופעלת. כללי השמירה ב-Vault של הארגון מגדירים את משך הזמן לשמירת הודעות ושרשורים. |
MembershipCount
ייצוג JSON |
---|
{ "joinedDirectHumanUserCount": integer, "joinedGroupCount": integer } |
שדות | |
---|---|
joinedDirectHumanUserCount |
מספר המשתמשים האנושיים שהצטרפו ישירות למרחב המשותף, ללא ספירה של משתמשים שהצטרפו באמצעות חברות בקבוצה שהצטרפתם אליה. |
joinedGroupCount |
מספר הקבוצות שהצטרפו ישירות למרחב המשותף. |
AccessSettings
הגדרת הגישה של המרחב המשותף.
ייצוג JSON |
---|
{
"accessState": enum ( |
שדות | |
---|---|
accessState |
פלט בלבד. מצב הגישה של המרחב המשותף. |
audience |
זה שינוי אופציונלי. שם המשאב של קהל היעד, שיכול לגלות את המרחב המשותף, להצטרף אליו ולראות תצוגה מקדימה של ההודעות במרחב המשותף. אם המדיניות לא מוגדרת, רק משתמשים וקבוצות Google שהוזמנו או נוספו למרחב המשותף בנפרד יכולים לגשת אליו. מידע נוסף מופיע במאמר הגדרת מרחב משותף שגלוי לקהל יעד. פורמט: כדי להשתמש בקהל היעד שמוגדר כברירת מחדל בארגון ב-Google Workspace, צריך להגדיר את הערך |
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 ( |
שדות | |
---|---|
manageMembersAndGroups |
הגדרה לניהול רשימת המשתתפים והקבוצות במרחב המשותף. |
modifySpaceDetails |
הגדרה לעדכון השם, הדמות, התיאור וההנחיות של המרחב המשותף. |
toggleHistory |
הגדרה להפעלה ולהשבתה של ההיסטוריה של המרחב המשותף. |
useAtMentionAll |
הגדרה לשימוש בתיוג @כולם במרחב המשותף. |
manageApps |
הגדרה לניהול האפליקציות במרחב המשותף. |
manageWebhooks |
הגדרה לניהול ה-webhooks במרחבים משותפים. |
postMessages |
פלט בלבד. הגדרה לפרסום הודעות במרחב. |
replyMessages |
הגדרה של מענה להודעות במרחב המשותף. |
PermissionSetting
מייצג הגדרה של הרשאה למרחב.
ייצוג JSON |
---|
{ "managersAllowed": boolean, "membersAllowed": boolean } |
שדות | |
---|---|
managersAllowed |
אם למנהלים של המרחבים המשותפים יש את ההרשאה הזו. |
membersAllowed |
האם למשתמשים שהם לא בעלי חשבון ניהול יש את ההרשאה הזו. |
שיטות |
|
---|---|
|
משלים את תהליך הייבוא של המרחב שצוין והופך אותו לגלוי למשתמשים. |
|
יצירת מרחב משותף בלי משתתפים. |
|
מחיקה של מרחב משותף עם שם. |
|
הפונקציה מחזירה את הצ'אט האישי הקיים עם המשתמש שצוין. |
|
הפונקציה מחזירה פרטים על מרחב משותף. |
|
בתיבת הדו-שיח הזו מפורטים המרחבים המשותפים שאליהם המשתמש משתתף. |
|
לעדכן את המרחב המשותף. |
|
|
|
יצירת מרחב משותף והוספה של משתמשים ספציפיים אליו. |