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)

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

נתיבי השדות שנתמכים כרגע:

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

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

  • spaceDetails

  • spaceHistoryState (יש תמיכה בהפעלה או השבתה של ההיסטוריה במרחב המשותף אם הארגון מאפשר למשתמשים לשנות את הגדרת ההיסטוריה שלהם. אזהרה: הצעה בלעדית לכל הנתיבים האחרים בשדות). אין תמיכה ב-spaceHistoryState עם הרשאת אדמין.

  • תצוגה מקדימה למפתחים: accessSettings.audience (תמיכה בשינוי הגדרת הגישה של מרחב משותף. אם לא מציינים קהל בהגדרת הגישה, הגדרת הגישה של המרחב המשותף מתעדכנת ל'מוגבלת'. אזהרה: הצעה בלעדית לכל הנתיבים האחרים בשדות). אין תמיכה ב-accessSettings.audience עם הרשאת אדמין.

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

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