スペースを作成し、指定したユーザーを追加します。呼び出し元のユーザーはスペースに自動的に追加されるため、リクエストでメンバーシップとして指定しないでください。例については、初期メンバーを含むスペースを設定するをご覧ください。
追加する人間のメンバーを指定するには、適切な membership.member.name
を持つメンバーシップを追加します。人間のユーザーを追加するには、users/{user}
を使用します。ここで、{user}
はユーザーのメールアドレスです。同じ Workspace 組織内のユーザーの場合、{user}
には People API のユーザーの id
や、Directory API のユーザーの id
を指定できます。たとえば、user@example.com
の People API の個人プロファイル ID が 123456789
の場合、membership.member.name
を users/user@example.com
または users/123456789
に設定することで、ユーザーを Space に追加できます。
追加する Google グループを指定するには、適切な membership.group_member.name
を使用してメンバーシップを追加します。Google グループを追加または招待するには、groups/{group}
を使用します。ここで、{group}
は Cloud Identity Groups API のグループの id
です。たとえば、Cloud Identity Groups Lookup API を使用して、グループメール group@example.com
の ID 123456789
を取得し、membership.group_member.name
を groups/123456789
に設定することで、グループをスペースに追加できます。グループのメールアドレスはサポートされていません。Google グループは名前付きスペースのメンバーとしてのみ追加できます。
名前付きスペースまたはグループ チャットの場合、呼び出し元が一部のメンバーをブロックしている、または一部のメンバーからブロックされている、または一部のメンバーを追加する権限がない場合は、それらのメンバーは作成されたスペースに追加されません。
呼び出し元のユーザーと別の人間のユーザー間のダイレクト メッセージ(DM)を作成するには、人間のユーザーを表すメンバーシップを 1 つだけ指定します。一方のユーザーが他方をブロックすると、リクエストは失敗し、DM は作成されません。
通話ユーザーと通話アプリの間の DM を作成するには、Space.singleUserBotDm
を true
に設定し、メンバーシップは指定しません。このメソッドは、呼び出し元アプリで 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 |
必須。 スペースを作成するには、 グループ チャットを作成するには、 人間との 1 対 1 の会話を作成するには、 人間と呼び出し元の Chat アプリの 1 対 1 の会話を作成するには、
|
request |
省略可。このリクエストの一意の識別子。ランダムな UUID を使用することをおすすめします。既存のリクエスト ID を指定すると、新しいスペースが作成されるのではなく、その ID で作成されたスペースが返されます。同じ Chat アプリの既存のリクエスト ID を指定して、認証済みのユーザーが異なると、エラーが返されます。 |
memberships[] |
省略可。スペースに参加するよう招待する Google Chat ユーザーまたはグループ。呼び出し元のユーザーは自動的に追加されるため、省略します。 現在、このセットでは(呼び出し元を除き)最大 20 個のメンバーシップが許可されています。 人間のメンバーシップの場合、 Google グループのメンバーシップの場合、
2 つ以上のメンバーシップとともに 人間のユーザーで 人間と呼び出し元の Chat アプリとの 1 対 1 の会話を作成する場合は空にする必要があります( |
レスポンスの本文
成功した場合、レスポンスの本文には Space
のインスタンスが含まれます。
認可スコープ
次の OAuth スコープのいずれかが必要です。
https://www.googleapis.com/auth/chat.spaces
https://www.googleapis.com/auth/chat.spaces.create
詳細については、承認ガイドをご覧ください。