リソース: Space
Google Chat のスペース。スペースとは、複数のユーザー間の会話、またはユーザーと Chat アプリの 1 対 1 のメッセージです。
JSON 表現 |
---|
{ "name": string, "type": enum ( |
フィールド | |
---|---|
name |
スペースのリソース名。 形式: |
type |
出力専用。非推奨: 代わりに |
spaceType |
スペースのタイプ。スペースを作成するとき、またはスペースのタイプを更新するときに必要です。出力は他の用途にのみ使用されます。 |
singleUserBotDm |
省略可。スペースが Chat アプリと人間 1 人の DM であるかどうか。 |
threaded |
出力専用。非推奨: 代わりに |
displayName |
スペースの表示名。スペースを作成する場合に必要です。スペースの作成時または ダイレクト メッセージの場合、このフィールドは空になることがあります。 128 文字まで使用できます。 |
externalUserAllowed |
変更不可。このスペースで Google Chat ユーザーがメンバーとして許可されるかどうか。Google Workspace の組織でスペースを作成するときに入力します。次の条件でスペースを作成する場合は、このフィールドを省略します。
既存のスペースの場合、このフィールドは出力専用です。 |
spaceThreadingState |
出力専用。Chat スペースのスレッド状態。 |
spaceDetails |
説明やルールなど、スペースに関する詳細。 |
spaceHistoryState |
このスペース内のメッセージとスレッドのメッセージ履歴状態。 |
importMode |
省略可。このスペースを Google Workspace へのデータ移行の一環として |
createTime |
省略可。変更不可。Chat で作成されたスペースの場合は、スペースが作成された時刻。このフィールドは、インポート モードのスペースで使用されている場合を除き、出力のみとなります。 インポート モードのスペースの場合、元の作成時間を保持するために、このフィールドに、ソースでスペースが作成された時点の過去のタイムスタンプを設定します。
|
adminInstalled |
出力専用。Chat アプリを備えたダイレクト メッセージ(DM)スペースの場合、そのスペースが Google Workspace 管理者によって作成されたかどうか。管理者は、組織内のユーザーに代わって Chat 用アプリをインストールしてダイレクト メッセージを設定できます。 管理者によるインストールをサポートするには、Chat アプリにダイレクト メッセージ機能を実装する必要があります。 |
accessSettings |
省略可。スペースのアクセス設定を指定します。 |
spaceUri |
出力専用。スペースの 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 |
省略可。スペースの説明。たとえば、スペースのディスカッション トピック、機能上の目的、参加者についての説明などを記述します。 150 文字まで使用できます。 |
guidelines |
省略可。空間のルール、期待、マナー。 5,000 文字まで使用できます。 |
HistoryState
メッセージとスペースの履歴状態。メッセージと会話スレッドを作成後に保持する期間を指定します。
列挙型 | |
---|---|
HISTORY_STATE_UNSPECIFIED |
デフォルト値。使用しないでください。 |
HISTORY_OFF |
履歴はオフです。メッセージとスレッドは 24 時間保持されます。 |
HISTORY_ON |
履歴: オン。メッセージとスレッドの保持期間は、組織の Vault の保持ルールで指定されます。 |
AccessSettings
スペースのアクセス設定を表します。
JSON 表現 |
---|
{
"accessState": enum ( |
フィールド | |
---|---|
accessState |
出力専用。スペースのアクセス状態を示します。 |
audience |
省略可。スペースにアクセスできる対象グループのリソース名。このフィールドに有効な対象グループ ID を設定してスペースを検出可能にするか、 |
AccessState
Space のアクセス状態を表します。
列挙型 | |
---|---|
ACCESS_STATE_UNSPECIFIED |
アクセス状態が不明であるか、この API ではサポートされていません。 |
PRIVATE |
追加または招待されたメンバーまたはグループがスペースを検索できます。 |
DISCOVERABLE |
選択した対象グループだけでなく、追加または招待されたメンバーやグループもスペースを見つけることができます。 |
メソッド |
|
---|---|
|
指定したスペースのインポート プロセスを完了し、ユーザーに表示します。 |
|
名前付きスペースを作成します。 |
|
名前付きスペースを削除します。 |
|
指定したユーザーの既存のダイレクト メッセージを返します。 |
|
スペースの詳細を返します。 |
|
呼び出し元がメンバーになっているスペースを一覧表示します。 |
|
スペースを更新します。 |
|
スペースを作成し、指定したユーザーを追加します。 |