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,
  "customer": 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

ID。Space のリソース名。

形式: 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 に作成されたかどうか。スペースのインポート中は、インポートが完了するまでユーザーには表示されません。

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。

string

省略可。変更不可。スペースのドメインのお客様 ID。アプリ認証でスペースを作成し、SpaceType が SPACE の場合にのみ必要です。それ以外の場合は設定しないでください。

customers/{customer} 形式で指定します。ここで、customer は [Admin SDK の顧客リソース]( https://developers.google.com/admin-sdk/directory/reference/rest/v1/customers)の id です。限定公開アプリは、customers/my_customer エイリアスを使用して、アプリと同じ Google Workspace 組織にスペースを作成することもできます。

DM の場合、このフィールドは入力されません。

enum (PredefinedPermissionSettings)

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

object (PermissionSettings)

省略可。既存のスペースのスペース権限の設定。スペースの権限設定を正確に更新するための入力。既存の権限設定が置き換えられます。出力には、現在の権限設定が一覧表示されます。