Method: spaces.patch

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

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

ユーザー認証が必要です。

HTTP リクエスト

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

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

パスパラメータ

パラメータ
space.name

string

スペースのリソース名。

形式: spaces/{space}

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

必須。更新されたフィールドパス。複数ある場合はカンマで区切って指定します。

スペースの次のフィールドを更新できます。

  • spaceDetails

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

  • spaceType: GROUP_CHAT スペースタイプを SPACE に変更することのみをサポートします。更新マスクに spaceType とともに displayName を含め、指定されたスペースの表示名と SPACE スペースタイプが空でないことを確認します。既存のスペースがすでに SPACE タイプである場合、表示名を更新するときに、指定されたスペースに spaceType マスクと SPACE タイプを含めるかどうかは任意です。他の方法でスペースタイプを更新しようとすると、無効な引数のエラーが発生します。spaceType は管理者権限でサポートされていません。

  • spaceHistoryState: スペースの履歴をオンまたはオフにして、スペースの履歴設定を更新します。Google Workspace の組織に対して履歴設定が有効になっている場合にのみサポートされます。スペースの履歴の状態を更新するには、リクエストで他のすべてのフィールド マスクを省略する必要があります。spaceHistoryState は管理者権限でサポートされていません。

  • accessSettings.audience: spaceType フィールドが SPACE の名前付きスペースで、スペースの検出、スペースへの参加、メッセージのプレビューを行えるユーザーのアクセス設定を更新します。既存のスペースに対象グループがある場合は、このフィールド マスクの値を省略することで、そのオーディエンスを削除し、スペースへのアクセスを制限できます。スペースのアクセス設定を更新するには、認証するユーザーがスペースの管理者である必要があります。また、リクエストで他のすべてのフィールド マスクを省略する必要があります。スペースがインポート モードの場合、このフィールドを更新できません。詳しくは、特定のユーザーがスペースを検索可能にするをご覧ください。accessSettings.audience は管理者権限でサポートされていません。

  • デベロッパー プレビュー: スペースの権限設定の変更をサポートします。サポートされているフィールド パスは、permissionSettings.manage_members_and_groups、permissionSettings.modify_space_details、permissionSettings.toggle_history、permissionSettings.use_at_mention_all、permissionSettings.manage_apps、permissionSettings.manage_webhooks、permissionSettings.reply_messages です（警告: 他のすべての権限以外の設定フィールドパスと相互に排他的）。permissionSettings は管理者権限でサポートされていません。
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.admin.spaces
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

詳細については、承認ガイドをご覧ください。