Method: spaces.setup

{
  "space": {
    object (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}

object (Space)

必須。Space.spaceType 項目は必須です。

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

グループ チャットを作成するには、Space.spaceType を GROUP_CHAT に設定します。Space.displayName は設定しないでください。

人間との 1 対 1 の会話を作成するには、Space.spaceType を DIRECT_MESSAGE に設定し、Space.singleUserBotDm を false に設定します。Space.displayName または Space.spaceDetails は設定しないでください。

人間と呼び出し元の Chat アプリとの間で 1 対 1 の会話を作成するには、Space.spaceType を DIRECT_MESSAGE に、Space.singleUserBotDm を true に設定します。Space.displayName または Space.spaceDetails は設定しないでください。

DIRECT_MESSAGE のスペースがすでに存在する場合、新しいスペースを作成するのではなく、そのスペースが返されます。

string

省略可。このリクエストの一意の識別子。ランダムな UUID をおすすめします。既存のリクエスト ID を指定すると、新しいスペースを作成するのではなく、その ID で作成されたスペースが返されます。同じ Chat アプリから別の認証済みユーザーを含む既存のリクエスト ID を指定すると、エラーが返されます。

object (Membership)

省略可。スペースに招待する Google Chat のユーザーまたはグループ。呼び出し元のユーザーは自動的に追加されるため、除外します。

このセットでは現在、（呼び出し元に加えて）最大 20 のメンバーシップが許可されています。

人間のメンバーシップの場合、Membership.member フィールドには、name が入力され（形式: users/{user}）、type が User.Type.HUMAN に設定された user が含まれている必要があります。人間のユーザーを追加できるのは、スペースの設定時のみです（Chat アプリの追加は、通話アプリでのダイレクト メッセージの設定でのみサポートされています）。このユーザーのメールアドレスを {user} のエイリアスとして使用してメンバーを追加することもできます。たとえば、user.name は users/example@gmail.com です。Gmail ユーザーまたは外部の Google Workspace ドメインのユーザーを招待するには、そのユーザーのメールアドレスを {user} に使用する必要があります。

Google グループ メンバーシップの場合、Membership.group_member フィールドに group の name が入力された（形式: groups/{group}）必要があります。Google グループを追加できるのは、Space.spaceType を SPACE に設定する場合に限られます。

Space.spaceType を SPACE に設定する場合は省略可。

2 つ以上のメンバーシップとともに Space.spaceType を GROUP_CHAT に設定する場合は必須です。

メンバーシップを 1 つだけ指定し、人間のユーザーが Space.spaceType を DIRECT_MESSAGE に設定する場合は必須です。

人間と呼び出し元の Chat アプリの間で 1 対 1 の会話を作成する場合は空にする必要があります（Space.spaceType を DIRECT_MESSAGE、Space.singleUserBotDm を true に設定する場合）。