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/*}

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

路徑參數

參數
space.name

string

ID。聊天室的資源名稱。

格式：spaces/{space}

其中 {space} 代表系統指派的空間 ID。您可以呼叫 spaces.list() 方法或從聊天室網址取得聊天室 ID。舉例來說，如果空間網址為 https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA，空間 ID 就是 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」。

accessSettings.access_permission_settings：更新可探索及加入 spaceType 欄位為 SPACE 的聊天室的存取權設定。允許加入聊天室的主體也必須能探索聊天室。如要更新聊天室的存取權設定，驗證使用者必須是聊天室管理員或助理管理員，且要求中不得包含任何其他欄位遮罩。如果空間處於匯入模式，就無法更新這個欄位。詳情請參閱「允許特定使用者探索聊天室」。「accessSettings.access_permission_settings」不支援「useAdminAccess」，支援的欄位遮蓋包括：

  • accessSettings.access_permission_settings.discoverSpaceSetting
  • accessSettings.access_permission_settings.joinSpaceSetting

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

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

boolean

(選用步驟) 時，方法會使用使用者的 Google Workspace 管理員權限執行。true

通話使用者必須是具備「管理即時通訊和聊天室對話」權限的 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

詳情請參閱授權指南。