Method: spaces.patch

עדכון של מרחב. דוגמה מופיעה במאמר בנושא עדכון מרחב.

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

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

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

    • 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

יש כמה מגבלות באימות אפליקציות:

  • כדי לעדכן את space.predefined_permission_settings או את space.permission_settings, האפליקציה צריכה להיות יוצרת המרחב.
  • אי אפשר לעדכן את space.access_settings.audience לצורך אימות אפליקציות.

בקשת HTTP

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

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

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

פרמטרים
space.name

string

מזהה. שם המשאב של המרחב.

פורמט: spaces/{space}

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

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

פרמטרים
updateMask

string (FieldMask format)

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

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

spaceDetails: עדכון התיאור וההנחיות של המרחב. בבקשת העדכון צריך להעביר גם את התיאור וגם את ההנחיות כ-SpaceDetails. אם רוצים לעדכן רק אחד מהשדות, צריך להעביר את הערך הקיים של השדה השני.

‫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, השיטה מופעלת באמצעות הרשאות האדמין של המשתמש ב-Google Workspace.

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

נדרש chat.admin.spaces היקף ההרשאות של OAuth 2.0.

חלק מהערכים של 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

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