Method: spaces.patch

更新聊天室。如需範例，請參閱「更新聊天室」。

如果要更新 displayName 欄位時收到錯誤訊息 ALREADY_EXISTS，請改用其他顯示名稱。Google Workspace 機構內的現有聊天室可能已使用這個顯示名稱。

支援以下類型的驗證：

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
space.name

string

ID。聊天室的資源名稱。

格式：spaces/{space}

其中 {space} 代表系統指派給空間的 ID。如要取得聊天室 ID，您可以呼叫 spaces.list() 方法或聊天室網址。舉例來說，如果聊天室網址為 https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA，則聊天室 ID 為 AAAAAAAAA。

查詢參數

參數
updateMask

string (FieldMask format)

必要欄位。更新後的欄位路徑，如果有多個欄位，請以半形逗號分隔。

你可以更新聊天室的下列欄位：

spaceDetails：更新聊天室的說明。最多支援 150 個半形字元。

displayName：僅支援針對 spaceType 欄位為 SPACE 的聊天室更新顯示名稱。如果收到錯誤訊息 ALREADY_EXISTS，請嘗試使用其他值。Google Workspace 機構內的現有聊天室可能已使用這個顯示名稱。

spaceType：僅支援將 GROUP_CHAT 空間類型變更為 SPACE。在更新遮罩中將 displayName 和 spaceType 一起加入，並確認指定的空間具有非空白的顯示名稱和 SPACE 空間類型。如果現有空間已具有 SPACE 類型，則在更新顯示名稱時，不一定要在指定空間中加入 spaceType 遮罩和 SPACE 類型。嘗試透過其他方式更新聊天室類型會導致引數無效錯誤。useAdminAccess 不支援 spaceType。

spaceHistoryState：開啟或關閉聊天室的記錄功能，更新聊天室記錄設定。只有在 Google Workspace 機構啟用記錄設定時，才支援這項功能。如要更新聊天室歷程狀態，您必須在要求中省略所有其他欄位遮罩。useAdminAccess 不支援 spaceHistoryState。

accessSettings.audience：更新存取權設定，決定哪些使用者可以探索聊天室、加入聊天室，以及在 spaceType 欄位為 SPACE 的命名聊天室中預覽訊息。如果現有的聊天室已有目標對象，您可以略過這個欄位遮罩的值，移除目標對象並限制空間存取權。如要更新聊天室的存取權設定，驗證使用者必須是聊天室管理員，且請在要求中省略所有其他欄位遮罩。如果聊天室處於匯入模式，您就無法更新這個欄位。詳情請參閱「讓特定使用者可自由加入聊天室」。「useAdminAccess」不支援「accessSettings.audience」。

permissionSettings：支援變更聊天室的權限設定。更新權限設定時，您只能指定 permissionSettings 欄位遮罩，無法同時更新其他欄位遮罩。「useAdminAccess」不支援「permissionSettings」。支援的欄位遮蓋包括：

  • 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

詳情請參閱授權指南。