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。スペースのリソース名。

形式: 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: スペースの説明とガイドラインを更新します。更新リクエストでは、説明とガイドラインの両方を SpaceDetails として渡す必要があります。フィールドの 1 つだけを更新する場合は、他のフィールドの既存の値を渡します。

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

省略可。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

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