Method: spaces.create

スペースを作成します。Import mode で名前付きスペースまたはグループ チャットを作成するために使用できます。例については、スペースを作成するをご覧ください。

次のタイプの認証をサポートしています。

  • 管理者による承認と次のいずれかの認可スコープによるアプリ認証:

    • https://www.googleapis.com/auth/chat.app.spaces.create
    • https://www.googleapis.com/auth/chat.app.spaces
  • 次のいずれかの認可スコープを使用したユーザー認証:

    • https://www.googleapis.com/auth/chat.spaces.create
    • https://www.googleapis.com/auth/chat.spaces
    • https://www.googleapis.com/auth/chat.import(インポート モードのスペースのみ)

アプリとして認証する場合は、リクエストで space.customer フィールドを設定する必要があります。

アプリとして認証すると、Chat 用アプリがスペースのメンバーとして追加されます。ただし、ユーザー認証とは異なり、Chat 用アプリはスペース管理者として追加されません。デフォルトでは、スペースのすべてのメンバーが Chat 用アプリをスペースから削除できます。スペース管理者のみがスペースからアプリを削除できるようにするには、space.permission_settings.manage_appsmanagersAllowed に設定します。

作成時のスペース メンバーシップは、スペースが Import mode で作成されたかどうかによって異なります。

  • インポート モード: メンバーは作成されません。
  • その他のすべてのモード: 通話ユーザーがメンバーとして追加されます。これは次のようになります。
    • アプリ認証を使用している場合はアプリ自体。
    • ユーザー認証を使用する場合のユーザー。

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

HTTP リクエスト

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

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

クエリ パラメータ

パラメータ
requestId

string

省略可。このリクエストの一意の ID。ランダムな UUID をおすすめします。リクエスト ID を指定すると、リクエストがべき等になり、同じリクエスト ID を持つ複数の同一リクエストが送信されても、スペースが 1 つだけ作成されます。リクエスト ID が同じ後続のリクエストでは、リクエストされた詳細が現在の状態と異なる場合でも、既存のスペースが返され、スペースは更新されません。

このフィールドを効果的に使用するには:

  • 後続のリクエストが元のリクエストと同じ認証情報を使用していることを確認します。
  • 指定されたリクエスト ID でスペースがすでに作成されている場合、リクエストはそのスペースを返します。返されるスペースは完全に設定されていない場合があります。API は、リクエスト内のスペースを、システム割り当てのリソース名が設定された状態でエコーします。スペースの最新のメタデータを取得するには、spaces.get を呼び出します。
  • 別の認証済みユーザーで既存のリクエスト ID を再利用すると、エラーが発生します。

リクエストの本文

リクエストの本文には Space のインスタンスが含まれます。

レスポンスの本文

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

認可スコープ

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

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

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