REST Resource: spaces

{
  "name": string,
  "type": enum (Type),
  "spaceType": enum (SpaceType),
  "singleUserBotDm": boolean,
  "threaded": boolean,
  "displayName": string,
  "externalUserAllowed": boolean,
  "spaceThreadingState": enum (SpaceThreadingState),
  "spaceDetails": {
    object (SpaceDetails)
  },
  "spaceHistoryState": enum (HistoryState),
  "importMode": boolean,
  "createTime": string,
  "lastActiveTime": string,
  "adminInstalled": boolean,
  "membershipCount": {
    object (MembershipCount)
  },
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string,

  // Union field space_permission_settings can be only one of the following:
  "predefinedPermissionSettings": enum (PredefinedPermissionSettings),
  "permissionSettings": {
    object (PermissionSettings)
  }
  // End of list of possible types for union field space_permission_settings.
}

string

スペースのリソース名。

形式: spaces/{space}

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

enum (Type)

出力専用。非推奨: 代わりに spaceType を使用してください。スペースのタイプ。

enum (SpaceType)

スペースのタイプ。スペースを作成する場合やスペースのタイプを更新する場合に必須です。他の用途の場合のみ出力。

boolean

省略可。スペースが Chat アプリと 1 人の人間間の DM であるかどうか。

boolean

出力専用。非推奨: 代わりに spaceThreadingState を使用してください。このスペースでメッセージがスレッド形式になっているかどうか。

string

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

ダイレクト メッセージの場合、このフィールドは空になることがあります。

最大 128 文字をサポートします。

boolean

変更不可。このスペースで、すべての Google Chat ユーザーをメンバーとして許可するかどうかを指定します。Google Workspace 組織でスペースを作成するときに入力します。次の条件でスペースを作成する場合は、このフィールドを省略します。

• 認証済みのユーザーが一般ユーザー向けアカウント（管理対象外のユーザー アカウント）を使用している。デフォルトでは、一般ユーザー向けアカウントで作成されたスペースでは、すべての Google Chat ユーザーが許可されます。

既存のスペースの場合、このフィールドは出力専用です。

enum (SpaceThreadingState)

出力専用。Chat スペースのスレッド状態。

object (SpaceDetails)

説明やルールなど、スペースの詳細。

enum (HistoryState)

このスペース内のメッセージとスレッドのメッセージ履歴の状態。

boolean

省略可。Google Workspace へのデータ移行の一環として Import Mode にこのスペースが作成されたかどうか。スペースのインポート中は、インポートが完了するまでユーザーには表示されません。

string (Timestamp format)

省略可。変更不可。Chat で作成されたスペースの場合、スペースの作成時刻。このフィールドは出力専用です。ただし、インポート モードのスペースで使用する場合は除きます。

インポート モードのスペースの場合、元の作成時間を保持するため、このフィールドを、ソースでスペースが作成された時点の過去のタイムスタンプに設定します。

spaceType が GROUP_CHAT または SPACE の場合にのみ出力に設定されます。

string (Timestamp format)

出力専用。スペース内の最後のメッセージのタイムスタンプ。

boolean

出力専用。Chat 用アプリを含むダイレクト メッセージ（DM）スペースの場合、そのスペースの作成者が Google Workspace 管理者かどうか。管理者は、組織内のユーザーに代わって Chat 用アプリを使用したダイレクト メッセージをインストールして設定できます。

管理者によるインストールに対応するには、Chat アプリにダイレクト メッセージ機能を実装する必要があります。

object (MembershipCount)

出力専用。メンバータイプ別にグループ化された参加メンバーシップの数。spaceType が SPACE、DIRECT_MESSAGE、または GROUP_CHAT の場合に入力されます。

object (AccessSettings)

省略可。スペースのアクセス設定を指定します。spaceType が SPACE の場合にのみ入力されます。

string

出力専用。ユーザーがスペースにアクセスするための URI。

enum (PredefinedPermissionSettings)

省略可。入力のみのスペースの権限の設定。スペースを作成するための入力。このフィールドが設定されていない場合は、コラボレーション スペースが作成されます。スペースを作成すると、PermissionSettings フィールドに設定が入力されます。

object (PermissionSettings)

省略可。スペースを更新するために設定できる正確な権限の設定。スペースを更新するための入力です。それ以外の場合は、出力のみ。スペースの作成には、代わりに predefinedPermissionSettings を使用してください。