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. אם משנים את השם המוצג במרחב המשותף, הוספת המסכה spaceType והסוג SPACE במקום שצוין היא אופציונלית. אם במרחב המשותף הקיים כבר יש סוג SPACE, אם תנסו לעדכן את סוג המרחב המשותף בדרכים אחרות, תתקבל שגיאת ארגומנט לא חוקית).

  • spaceDetails

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

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

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאות

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

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

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