REST Resource: spaces

リソース: Space

Google Chat のスペース。スペースとは、2 人以上のユーザー間の会話、またはユーザーと Chat アプリ間の 1 対 1 のメッセージです。

JSON 表現 
{
  "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,
  "adminInstalled": boolean
}
フィールド
name

string

スペースのリソース名。

形式: spaces/{space}
type
(deprecated)

enum (Type)

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

enum (SpaceType)

スペースのタイプ。スペースを作成するとき、またはスペースのタイプを更新するときに必要です。出力は他の用途にのみ使用します。
singleUserBotDm

boolean

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

boolean

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

string

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

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

128 文字まで使用できます。
externalUserAllowed

boolean

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

  • 認証済みのユーザーが Google アカウントを使用している。デフォルトでは、そのスペースではすべての Google Chat ユーザーが参加できます。

  • このスペースは、Google Chat にデータをインポートするために使用されます。インポート モードのスペースでは、同じ Google Workspace 組織のメンバーのみを許可する必要があります。

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

enum (SpaceThreadingState)

出力のみ。Chat スペースのスレッド状態。
spaceDetails

object (SpaceDetails)

説明やルールなど、スペースに関する詳細。
spaceHistoryState

enum (HistoryState)

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

boolean

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

string (Timestamp format)

（省略可）Chat で作成されたスペースの場合は、スペースが作成された時刻。インポートされたスペースで使用されている場合を除き、このフィールドは出力専用です。

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

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

boolean

出力のみ。Chat アプリが Google Workspace 管理者によってインストールされたかどうか。管理者は、ドメイン、組織部門、またはユーザー グループに Chat アプリをインストールできます。

管理者は、ユーザーとアプリ間のダイレクト メッセージ用にのみ Chat アプリをインストールできます。管理者によるインストールをサポートするには、アプリにダイレクト メッセージ機能が搭載されている必要があります。

タイプ

非推奨: 代わりに SpaceType を使用してください。

列挙型
TYPE_UNSPECIFIED
ROOM 2 人以上の人間の会話。
DM 人間と Chat アプリ間の 1 対 1 のダイレクト メッセージ。すべてのメッセージはフラットです。なお、2 人の人間間のダイレクト メッセージは含まれません。

スペースの種類

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

列挙型
SPACE_TYPE_UNSPECIFIED 予約済み。
SPACE メッセージの送信、ファイルの共有、共同編集が可能な場所です。SPACE には Chat アプリを含めることができます。
GROUP_CHAT 3 人以上のグループで会話できます。GROUP_CHAT には Chat アプリを含めることができます。
DIRECT_MESSAGE 2 人の人間による 1 対 1 のメッセージ、または人間と Chat アプリの 1 対 1 のメッセージ。

SpaceThreadingState

Chat スペースのスレッド状態の種類を指定します。

列挙型
SPACE_THREADING_STATE_UNSPECIFIED 予約済み。
THREADED_MESSAGES メッセージ スレッドに対応した名前付きスペース。ユーザーはメッセージに返信する際にスレッド内で返信できます。これにより、元のメッセージのコンテキストに沿って返信できます。
GROUPED_MESSAGES 会話がトピック別に整理されている名前付きスペース。トピックとその返信はグループ化されます。
UNTHREADED_MESSAGES 2 人のユーザー間のダイレクト メッセージ（DM）と 3 人以上のユーザー間のグループ会話。

SpaceDetails

説明やルールなど、スペースに関する詳細。

JSON 表現 
{
  "description": string,
  "guidelines": string
}
フィールド
description

string

（省略可）スペースの説明。たとえば、スペースのディスカッション トピック、機能の目的、参加者について説明します。

150 文字まで使用できます。
guidelines

string

（省略可）スペースのルール、期待、マナー。

5,000 文字まで使用できます。

履歴の状態

メッセージとスペースの履歴状態。メッセージと会話スレッドが作成後に保持される期間を指定します。

列挙型
HISTORY_STATE_UNSPECIFIED デフォルト値。使用しないでください。
HISTORY_OFF 履歴はオフ。メッセージとスレッドは 24 時間保持されます。
HISTORY_ON 履歴がオンになっています。メッセージとスレッドの保持期間は、組織の Vault の保持ルールで指定されます。

Methods

completeImport

 指定したスペースのインポート プロセスを完了し、ユーザーに表示します。

create

 名前付きスペースを作成します。

delete

 名前付きスペースを削除します。

findDirectMessage

 指定したユーザーを含む既存のダイレクト メッセージを返します。

get

 スペースの詳細を返します。

list

 発信者がメンバーとなっているスペースを一覧表示します。

patch

 スペースを更新します。

setup

 スペースを作成し、指定したユーザーを追加します。