Method: spaces.patch

string

ID。スペースのリソース名。

形式: spaces/{space}

ここで、{space} はスペースにシステムによって割り当てられた ID を表します。スペース ID は、spaces.list() メソッドを呼び出すか、スペースの URL から取得できます。たとえば、スペースの URL が https://mail.google.com/mail/u/0/#chat/space/AAAAAAAAA の場合、スペース ID は AAAAAAAAA です。

string (FieldMask format)

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

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

spaceDetails: スペースの説明を更新します。150 文字までサポートされます。

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 ではサポートされていません。

permissionSettings: スペースの権限設定の変更をサポートします。権限設定を更新する場合は、permissionSettings フィールド マスクのみを指定できます。他のフィールド マスクを同時に更新することはできません。permissionSettings は useAdminAccess ではサポートされていません。サポートされているフィールド マスクは次のとおりです。

• permissionSettings.manageMembersAndGroups
• permissionSettings.modifySpaceDetails
• permissionSettings.toggleHistory
• permissionSettings.useAtMentionAll
• permissionSettings.manageApps
• permissionSettings.manageWebhooks
• permissionSettings.replyMessages

boolean

省略可。true の場合、メソッドはユーザーの Google Workspace 管理者権限を使用して実行されます。

呼び出し元のユーザーは、Chat とスペースの会話の管理権限を持つ Google Workspace 管理者である必要があります。

chat.admin.spaces OAuth 2.0 スコープが必要です。

一部の FieldMask 値は、管理者権限を使用してサポートされません。詳しくは、updateMask の説明をご覧ください。