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,
  "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.
}
フィールド
name

string

スペースのリソース名。

形式: spaces/{space}

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

type
(deprecated)

enum (Type)

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

spaceType

enum (SpaceType)

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

singleUserBotDm

boolean

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

threaded
(deprecated)

boolean

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

displayName

string

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

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

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

externalUserAllowed

boolean

変更不可。このスペースで、すべての 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 の場合にのみ出力に設定されます。

lastActiveTime

string (Timestamp format)

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

adminInstalled

boolean

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

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

membershipCount

object (MembershipCount)

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

accessSettings

object (AccessSettings)

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

spaceUri

string

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

共用体フィールド space_permission_settings。スペースの権限の設定を表します。space_typeSPACE の場合にのみ入力されます。space_permission_settings は次のいずれかになります。
predefinedPermissionSettings

enum (PredefinedPermissionSettings)

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

permissionSettings

object (PermissionSettings)

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

タイプ

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

列挙型
TYPE_UNSPECIFIED 予約済み。
ROOM 人間同士の会話。
DM 人間と Chat アプリ間の 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 の保持ルールで指定されています。

MembershipCount

スペースのメンバーシップ数をカテゴリ別にグループ化して表します。

JSON 表現
{
  "joinedDirectHumanUserCount": integer,
  "joinedGroupCount": integer
}
フィールド
joinedDirectHumanUserCount

integer

スペースに直接参加した人間のユーザーの数。参加グループのメンバーであるユーザーの数はカウントされません。

joinedGroupCount

integer

スペースに直接参加したすべてのグループの数。

AccessSettings

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

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

enum (AccessState)

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

audience

string

省略可。スペースの検索、スペースへの参加、スペース内のメッセージのプレビューが可能な対象グループのリソース名。未設定のままにした場合、個別に招待されたユーザーまたはスペースに追加されたユーザーまたは Google グループのみがスペースにアクセスできます。詳しくは、対象グループがスペースを検索可能にするをご覧ください。

形式: audiences/{audience}

Google Workspace 組織のデフォルトの対象グループを使用するには、audiences/default に設定します。

AccessState

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

列挙型
ACCESS_STATE_UNSPECIFIED アクセス状態が不明であるか、この API ではサポートされていません。
PRIVATE 他のユーザーまたは Google Workspace 管理者が個別に追加または招待したユーザーまたは Google グループのみが、スペースを見つけてアクセスできます。
DISCOVERABLE スペースの管理者が、対象グループにスペースへのアクセス権を付与しました。個別にスペースに追加または招待されたユーザーまたは Google グループも、スペースを見つけてアクセスできます。詳しくは、特定のユーザーがスペースを検索可能にするをご覧ください。

PredefinedPermissionSettings

名前付きスペースの作成時に指定できるスペースの権限の設定。今後、その他の設定が追加される可能性があります。名前付きスペースの権限の設定について詳しくは、スペースの詳細をご覧ください。

列挙型
PREDEFINED_PERMISSION_SETTINGS_UNSPECIFIED 指定なし。使用しないでください。
COLLABORATION_SPACE このスペースを、すべてのメンバーがメッセージを投稿できるコラボレーション スペースとして設定します。
ANNOUNCEMENT_SPACE このスペースをお知らせ用スペースにし、スペースの管理者のみがメッセージを投稿できるようにする設定。

PermissionSettings

名前付きスペースの権限の設定。スペースの作成時に権限を設定するには、リクエストの PredefinedPermissionSettings フィールドを指定します。

JSON 表現
{
  "manageMembersAndGroups": {
    object (PermissionSetting)
  },
  "modifySpaceDetails": {
    object (PermissionSetting)
  },
  "toggleHistory": {
    object (PermissionSetting)
  },
  "useAtMentionAll": {
    object (PermissionSetting)
  },
  "manageApps": {
    object (PermissionSetting)
  },
  "manageWebhooks": {
    object (PermissionSetting)
  },
  "postMessages": {
    object (PermissionSetting)
  },
  "replyMessages": {
    object (PermissionSetting)
  }
}
フィールド
manageMembersAndGroups

object (PermissionSetting)

スペースのメンバーとグループを管理するための設定。

modifySpaceDetails

object (PermissionSetting)

スペースの名前、アバター、説明、ガイドラインを更新するための設定です。

toggleHistory

object (PermissionSetting)

スペースの履歴のオンとオフを切り替えるための設定です。

useAtMentionAll

object (PermissionSetting)

スペースで @all を使用するための設定。

manageApps

object (PermissionSetting)

スペース内のアプリを管理するための設定です。

manageWebhooks

object (PermissionSetting)

スペースで Webhook を管理するための設定です。

postMessages

object (PermissionSetting)

出力専用。スペースにメッセージを投稿するための設定です。

replyMessages

object (PermissionSetting)

スペース内のメッセージに返信するための設定です。

PermissionSetting

スペースの権限の設定を表します。

JSON 表現
{
  "managersAllowed": boolean,
  "membersAllowed": boolean
}
フィールド
managersAllowed

boolean

スペースの管理者がこの権限を持っているかどうか。

membersAllowed

boolean

マネージャー以外のメンバーにこの権限が付与されているかどうか。

メソッド

completeImport

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

create

メンバーのいないスペースを作成します。

delete

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

findDirectMessage

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

get

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

list

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

patch

スペースを更新します。

setup

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