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)

必須。更新されたフィールドのパス(複数ある場合はカンマ区切り)。

現在サポートされているフィールドパス:

  • displayNameSPACE タイプのスペースの表示名の変更、または GROUP_CHAT スペースタイプを SPACE に変更するための spaceType マスクも組み込まれた場合に限ります。GROUP_CHAT または DIRECT_MESSAGE スペースの表示名を更新しようとすると、無効な引数エラーが発生します。displayName の更新時にエラー メッセージ ALREADY_EXISTS が表示された場合は、別の displayName をお試しください。この表示名は、Google Workspace 組織内の既存のスペースですでに使用されている可能性があります)。

  • spaceTypeGROUP_CHAT のスペースタイプを SPACE に変更することのみをサポートします。更新マスクに displayNamespaceType とともに指定し、指定されたスペースが空でない表示名と SPACE スペースタイプになるようにします。既存のスペースにすでに SPACE タイプがある場合、表示名の更新時に指定されたスペースに spaceType マスクと SPACE 型を含めるかどうかは任意です。他の方法でスペースタイプを更新しようとすると、無効な引数エラーが発生します)。

  • spaceDetails

  • spaceHistoryStateユーザーが履歴設定の変更を許可している場合は、スペースの履歴を有効または無効にすることができます。警告: 他のすべてのフィールドパスと相互に排他的です)。

  • デベロッパー プレビュー: accessSettings.audience(スペースのアクセス設定を変更できます。アクセス設定で対象ユーザーが指定されていない場合、スペースのアクセス設定は制限付きに変更されます。警告: 他のすべてのフィールドパスと相互に排他的です)。

リクエスト本文

リクエストの本文には Space のインスタンスが含まれています。

レスポンスの本文

成功した場合、レスポンスの本文には Space のインスタンスが含まれます。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.spaces

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