Method: spaces.patch

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

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

必須完成使用者驗證

HTTP 要求

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

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

路徑參數

參數
space.name

string

聊天室的資源名稱。

格式︰spaces/{space}

查詢參數

參數
updateMask

string (FieldMask format)

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

目前支援的欄位路徑:

  • displayName (僅支援將具有 SPACE 類型的聊天室顯示名稱,或是同時加入 spaceType 遮罩,將 GROUP_CHAT 聊天室類型變更為 SPACE 時。嘗試更新 GROUP_CHATDIRECT_MESSAGE 聊天室的顯示名稱會導致引數無效。如果在更新 displayName 時收到錯誤訊息 ALREADY_EXISTS,請嘗試使用其他 displayName。Google Workspace 機構中的現有聊天室可能已使用這個顯示名稱)。

  • spaceType (只支援將 GROUP_CHAT 聊天室類型變更為 SPACE。在更新遮罩中加入 displayNamespaceType,並確認指定空間的顯示名稱並非空白,且空間類型為 SPACE。如果現有聊天室已包含 SPACE 類型,則在更新顯示名稱時,不一定要在指定空間中加入 spaceType 遮罩和 SPACE 類型。如果嘗試透過其他方式更新聊天室類型,將會導致引數無效。

  • spaceDetails

  • spaceHistoryState (支援開啟或關閉聊天室記錄功能,前提是機構允許使用者變更自己的記錄設定)。警告:與其他欄位路徑互斥)。

  • 開發人員預覽版:accessSettings.audience (支援變更聊天室的存取權設定。如未在存取權設定中指定目標對象,聊天室的存取權設定會更新為受限制。警告:與其他欄位路徑互斥)。

要求主體

要求主體包含 Space 的例項。

回應主體

如果成功,回應主體會包含 Space 的執行例項。

授權範圍

需要下列其中一種 OAuth 範圍:

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

詳情請參閱授權指南