Method: spaces.patch

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

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

נדרש אימות משתמש.

בקשת HTTP

PATCH https://chat.googleapis.com/v1/{space.name=spaces/*}

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
space.name

string

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

פורמט: spaces/{space}

פרמטרים של שאילתה

פרמטרים
updateMask

string (FieldMask format)

חובה. נתיבי השדות המעודכנים, מופרדים בפסיקים אם יש מספר שדות.

אתם יכולים לעדכן את השדות הבאים במרחב משותף:

  • spaceDetails

  • displayName: אפשר לעדכן את השם המוצג רק במרחבים שבהם השדה spaceType הוא SPACE. אם מופיעה הודעת השגיאה ALREADY_EXISTS, צריך לנסות ערך אחר. יכול להיות שבמרחב המשותף קיים בארגון ב-Google Workspace כבר נעשה שימוש בשם המוצג הזה.

  • spaceType: אפשר לשנות רק את סוג המרחב המשותף GROUP_CHAT למרחב המשותף SPACE. צריך לכלול את displayName יחד עם spaceType במסכת העדכון, ולוודא שלמרחב המשותף יש שם תצוגה שאינו ריק ואת סוג המרחב המשותף SPACE. כשמעדכנים את השם המוצג, אם במרחב הקיים כבר מוגדר סוג SPACE, לא חובה לכלול את המסכה spaceType ואת הסוג SPACE. ניסיון לעדכן את סוג המרחב המשותף בדרכים אחרות יגרום לשגיאת ארגומנט לא חוקי. אין תמיכה ב-spaceType עם הרשאת אדמין.

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

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

  • תצוגה מקדימה למפתחים: תמיכה בשינוי הגדרות ההרשאות של מרחב משותף. נתיבי השדות הנתמכים כוללים: permissionSettings.manage_members_and_groups, permissionSettings.modify_space_details, permissionSettings.toggle_history, permissionSettings.use_at_mention_all, permissionSettings.manage_apps, permissionSettings.manage_webhooks, permissionSettings.reply_messages (אזהרה: לא בלעדית לכל נתיבי השדות של הגדרות שאינן הרשאות). אין תמיכה ב-permissionSettings עם הרשאת אדמין.
useAdminAccess

boolean

כשהערך הוא true, השיטה תפעל עם הרשאות האדמין של המשתמש ב-Google Workspace.

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

נדרש היקף OAuth 2.0 chat.admin.spaces.

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

גוף הבקשה

גוף הבקשה מכיל מופע של Space.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול מופע של Space.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/chat.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

מידע נוסף זמין במדריך להרשאות.