REST Resource: spaces

リソース: Space

Google Chat のスペース。スペースとは、複数のユーザー間の会話、またはユーザーと 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,
  "accessSettings": {
    object (AccessSettings)
  },
  "spaceUri": string
}
フィールド
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 Chat ユーザーが参加できます。

  • インポート モードのスペースでは同じ Google Workspace 組織のメンバーのみを許可する必要があるため、このスペースは Google Chat へのデータのインポートに使用されます。ただし、Google Workspace デベロッパー プレビュー プログラムの一環として、インポート モードのスペースではすべての Google Chat ユーザーを許可できるため、このフィールドをインポート モードのスペースに設定できます。

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

spaceThreadingState

enum (SpaceThreadingState)

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

spaceDetails

object (SpaceDetails)

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

spaceHistoryState

enum (HistoryState)

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

importMode

boolean

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

createTime

string (Timestamp format)

省略可。変更不可。Chat で作成されたスペースの場合は、スペースが作成された時刻。このフィールドは、インポート モードのスペースで使用されている場合を除き、出力のみとなります。

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

spaceTypeGROUP_CHAT または SPACE の場合にのみ出力に入力されます。

adminInstalled

boolean

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

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

accessSettings

object (AccessSettings)

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

spaceUri

string

出力のみ。スペースの URI。

タイプ

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

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

SpaceType

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

列挙型
SPACE_TYPE_UNSPECIFIED 予約済み。
SPACE メッセージの送信、ファイルの共有、共同編集を行う場所です。SPACE には Chat アプリを含めることができます。
GROUP_CHAT 3 人以上のグループでのグループ会話。GROUP_CHAT には Chat アプリを含めることができます。
DIRECT_MESSAGE 2 人の人間、または人間と 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 文字まで使用できます。

HistoryState

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

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

AccessSettings

スペースのアクセス設定を表します。

JSON 表現
{
  "accessState": enum (AccessState),
  "audience": string
}
フィールド
accessState

enum (AccessState)

出力のみ。スペースのアクセス状態を示します。

audience

string

省略可。スペースにアクセスできる対象グループのリソース名。このフィールドに有効な対象グループ ID を設定してスペースを検出可能にするか、audiences/default エイリアスを使用して管理コンソールでデフォルトのアクセス設定でスペースを設定します。詳しくは、対象グループにスペースを検出可能にするをご覧ください。スペースを制限するには、このフィールドの設定を解除します。スペースが検出可能な場合のみ入力されます。形式: audiences/{audience}audiences/default は、チャットのデフォルトの共有設定のエイリアスとして使用できます。

AccessState

Space のアクセス状態を表します。

列挙型
ACCESS_STATE_UNSPECIFIED アクセス状態が不明であるか、この API ではサポートされていません。
PRIVATE 追加または招待されたメンバーまたはグループがスペースを検索できます。
DISCOVERABLE 選択した対象グループだけでなく、追加または招待されたメンバーやグループもスペースを見つけることができます。

Methods

completeImport

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

create

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

delete

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

findDirectMessage

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

get

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

list

呼び出し元がメンバーになっているスペースを一覧表示します。

patch

スペースを更新します。

setup

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