Method: spaces.setup

スペースを作成し、指定したユーザーを追加します。呼び出し元のユーザーは自動的にスペースに追加されるので、リクエストでメンバーシップとして指定しないでください。例については、スペースを設定するをご覧ください。

追加する人間のメンバーを指定するには、SetUpSpaceRequest に適切な member.name を使用してメンバーシップを追加します。人間のユーザーを追加するには、users/{user} を使用します。{user} は、ユーザーのメールアドレスです。同じ Workspace 組織のユーザーの場合、{user} を People API のユーザーの id に、Directory API のユーザーの id にすることもできます。たとえば、user@example.com の People API Person プロファイル ID が 123456789 の場合、membership.member.nameusers/user@example.com または users/123456789 に設定することで、ユーザーをスペースに追加できます。

スペースまたはグループ チャットの場合、発信者がブロックまたは一部のメンバーによってブロックされている場合、それらのメンバーは作成済みのスペースに追加されません。

呼び出し元のユーザーと別の人間のユーザーの間にダイレクト メッセージ(DM)を作成するには、人間のユーザーを表すメンバーシップを 1 つだけ指定します。一方のユーザーがもう一方のユーザーをブロックした場合、リクエストは失敗し、DM は作成されません。

呼び出し元のユーザーと呼び出し元アプリの間の DM を作成するには、Space.singleUserBotDmtrue に設定し、メンバーシップは指定しないでください。このメソッドを使用できるのは、呼び出し元アプリとの DM の設定のみです。呼び出し元アプリをスペースのメンバーまたは 2 人のユーザー間の既存の DM として追加するには、メンバーシップを作成するをご覧ください。

2 人のユーザーの間にすでに DM が存在している場合、リクエスト時に一方のユーザーがもう一方のユーザーをブロックしても、既存の DM が返されます。

スレッド返信のスペースはサポートされていません。スペースの設定時にエラー メッセージ「ALREADY_EXISTS」が表示された場合は、別の displayName をお試しください。この表示名は、Google Workspace 組織内の既存のスペースですでに使用されている可能性があります。

ユーザー認証が必要です。

HTTP リクエスト

POST https://chat.googleapis.com/v1/spaces:setup

この URL は gRPC Transcoding 構文を使用します。

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現
{
  "space": {
    object (Space)
  },
  "requestId": string,
  "memberships": [
    {
      object (Membership)
    }
  ]
}
フィールド
space

object (Space)

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

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

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

人間による 1 対 1 の会話を作成するには、Space.spaceTypeDIRECT_MESSAGE に、Space.singleUserBotDmfalse に設定します。Space.displayName または Space.spaceDetails は設定しないでください。

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

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

requestId

string

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

memberships[]

object (Membership)

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

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

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

Space.spaceTypeSPACE に設定する場合は省略可能です。

Space.spaceTypeGROUP_CHAT に設定する場合は必須。2 つ以上のメンバーシップが必要です。

人間のユーザーとともに Space.spaceTypeDIRECT_MESSAGE に設定する場合は必須。メンバーシップは 1 つのみ。

人間と呼び出し元の Chat アプリの 1 対 1 の会話を作成する場合は(Space.spaceTypeDIRECT_MESSAGE に、Space.singleUserBotDmtrue に設定する場合)、空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には Space のインスタンスが含まれます。

承認スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/chat.spaces
  • https://www.googleapis.com/auth/chat.spaces.create

詳しくは、承認ガイドをご覧ください。