スペース
はじめに
このページでは、X API に含まれる Spaces エンドポイントについて説明します。Spaces の概要については、help.x.com を参照してください。
Spaces は、ライブ音声での会話を通じた表現と交流を可能にします。Spaces エンドポイントは、Spaces に関連する新機能を構築するためのツールを提供します。これらのエンドポイントを使用すると、ライブ中またはスケジュール済みの Spaces を照会したり、ユーザーが興味のありそうな Spaces を見つけられるようなディスカバリー体験を実装したりできます。
X では、皆さまの創意工夫によって Spaces を私たちの実装の枠を超えて拡張していただくことを奨励しています。これらのエンドポイントを使えば、タイトルに含まれるキーワードに基づいてリスナーに Spaces を提案する体験や、ユーザーがフォローしているアカウントのうちライブ配信中または開催予定の Spaces をホストしているアカウントを浮き上がらせる体験を構築できます。また、ホストが自分の Spaces のパフォーマンスをより深く把握し、オーディエンスに関する洞察を得られるよう支援することも可能です。
以下のリソースは、はじめの一歩や Spaces エンドポイントとの連携に役立ちます。
X Developer Platform の他のリソースと異なり、Spaces には定められたライフサイクルがあります。Spaces は開始予定日の最大 14 日前までにスケジュールでき、終了後は利用できなくなります。ホストは開始前であれば、事前にスケジュールした Space をいつでもキャンセルできます。
Spaces はライブ配信中のみアクセス可能です。終了すると、Spaces エンドポイントで取得できなくなり、その状態を示すエラーメッセージが返されます。
アプリで Spaces の data を扱う場合、最新の情報を返すこと、およびプラットフォーム上で利用できなくなったデータを削除する責任があります。Spaces lookup endpoint を使うことで、ユーザーの期待や意図に沿う運用を確実に行えます。
これらのエンドポイントは、X アプリにおける Spaces の動作を反映しています。Spaces では、ユーザーは、Space での参加方法や振る舞いに応じて、特定の役割が割り当てられます。
プライマリホストは、Space を作成したユーザーであり、その Space 自体の所有者です。現在、Space にはホストを 1 人しか設定できないため、プライマリホストが唯一のホストとなります。Spaces data dictionary では、プライマリホストの情報は creator_id フィールドにあり、user object に展開できます。
プライマリホストは、1人以上のユーザーを共同ホストに指定できます。Spaces のデータディクショナリでは、これらのホストは host_ids として表示され、ユーザーオブジェクトのリストに展開できます。ホストの指定は Space の開催中に変更される場合があり、これらのエンドポイントが返すメタデータは、リクエスト時点の状態を反映します。
アプリは、creator_id の値を確認することでプライマリホストを、host_ids の値を確認することで共同ホストを特定できます。
スピーカーは、Space で話す権限を持つユーザーです。任意の時点で 0 人以上のスピーカーが存在でき、Space には最大 10 人（ホストを含む）までスピーカーが参加できます。Space のデータ辞書では、スピーカーは speaker_ids リストで返され、これを展開してユーザーオブジェクトのリストにできます。
リスナーは Space を聴取し、用意されたリアクションでいつでも反応でき、（ホストが Space の設定で許可している場合）スピーカーへの参加をリクエストできます。リスナーに関する情報は、participant_count フィールドで参加者（ホストを含む）の合計数としてのみ返されます。