Method: spaces.patch

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

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

יש תמיכה בסוגי אימות הבאים:

  • אימות אפליקציה עם אישור אדמין ב-גרסת Developer Preview ואחד מהיקפי ההרשאה הבאים:

    • https://www.googleapis.com/auth/chat.app.spaces
  • אימות משתמשים עם אחד מההיקפים הבאים של הרשאות:

    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import (רווחים במצב ייבוא בלבד)
    • אימות משתמש מעניק הרשאות אדמין כשחשבון אדמין מבצע אימות, הערך של useAdminAccess הוא true ונעשה שימוש בהיקפי ההרשאה הבאים:
      • https://www.googleapis.com/auth/chat.admin.spaces

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

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

פרמטרים
space.name

string

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

פורמט: spaces/{space}

כאשר {space} מייצג את המזהה שהמערכת הקצה למרחב המשותף. אפשר לקבל את מזהה המרחב המשותף על ידי קריאה ל-method‏ spaces.list() או מכתובת ה-URL של המרחב המשותף. לדוגמה, אם כתובת ה-URL של המרחב המשותף היא https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA, המזהה של המרחב המשותף הוא AAAAAAAAA.

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

פרמטרים
updateMask

string (FieldMask format)

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

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

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

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

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

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

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

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

  • permissionSettings.manageMembersAndGroups
  • permissionSettings.modifySpaceDetails
  • permissionSettings.toggleHistory
  • permissionSettings.useAtMentionAll
  • permissionSettings.manageApps
  • permissionSettings.manageWebhooks
  • permissionSettings.replyMessages
useAdminAccess

boolean

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

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

נדרשת הרשאת OAuth 2.0 chat.admin.spaces.

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

גוף הבקשה

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

גוף התשובה

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

היקפי הרשאה

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

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

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