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

この 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

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