Method: spaces.patch

スペースを更新します。例については、スペースを更新するをご覧ください。

displayName フィールドを更新しているときにエラー メッセージ ALREADY_EXISTS が表示された場合は、別の表示名を試してください。Google Workspace 組織内の既存のスペースで、この表示名がすでに使用されている可能性があります。

次のタイプの認証をサポートしています。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
space.name

string

ID。Space のリソース名。

形式: spaces/{space}

ここで、{space} はスペースにシステムによって割り当てられた ID を表します。スペース ID は、spaces.list() メソッドを呼び出すか、スペースの URL から取得できます。たとえば、スペースの URL が 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 に変更することのみをサポートします。更新マスクに spaceType とともに displayName を含め、指定されたスペースに空でない表示名と 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 管理者権限を使用して実行されます。

呼び出し元のユーザーは、Chat とスペースの会話の管理権限を持つ 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

詳しくは、認可ガイドをご覧ください。