重要なリソース
現在利用可能な項目
| Spaces のルックアップ | 単一の Spaces ID でルックアップ 複数の Spaces ID でルックアップ 作成者 ID でルックアップ チケット購入ユーザー一覧を取得 |
| Spaces を検索 | キーワードで Spaces を検索 |
Spaces
はじめに
このページでは、X API に含まれる Spaces の endpoint について説明します。Spaces の概要については、help.x.com をご覧ください。
Spaces は、ライブ音声での会話を通じて表現と交流を可能にします。Spaces の endpoint は、Spaces を活用した新機能を実装するためのツールを提供します。これらの endpoint を使用すると、ライブ中または予定済みの Spaces を照会したり、ユーザーが関心を持ちそうな Spaces を見つけられるディスカバリー体験を構築できます。
創造力を活かして、私たちの提供範囲を超えて Spaces を拡張することをぜひご検討ください。これらの endpoint を使えば、タイトルに含まれるキーワードに基づいてリスナーに Spaces を提案する体験や、ユーザーがフォローしているアカウントのうち、ライブまたは今後の Spaces を主催しているアカウントを可視化する体験を構築できます。また、Host が自分の Spaces のパフォーマンスをより的確に把握し、オーディエンスに関するインサイトを得ることにも役立ちます。
以下のリソースは、はじめての方が Spaces の endpoint と連携を開始する際に役立ちます。
X Developer Platform の他のリソースとは異なり、Spaces には定められたライフサイクルがあります。Spaces は開始予定日の最大14日前までスケジュールでき、終了後は利用できなくなります。ホストは開始前であれば、事前にスケジュールした Space をいつでもキャンセルできます。
Spaces はライブ中はアクセス可能です。終了後は、Spaces の endpoint を使用して取得できなくなり、その状態を示すエラーメッセージが返されます。
App で Spaces の data を扱う場合は、最新の情報を返し、プラットフォーム上で利用できなくなった data を削除する責任があります。Spaces lookup endpoint は、ユーザーの期待と意図を尊重できているかを確認するのに役立ちます。
これらの endpoint は、X App における Spaces の挙動を反映しています。Spaces では、X のユーザーは、Space への関与の仕方や Space 内でのやり取りに応じて、定義された役割を持つことができます。
プライマリホストは、Spaces を作成したユーザーであり、その Spaces の所有者です。現在、Spaces にはホストを 1 人しか設定できないため、プライマリホストが唯一のホストとなります。Spaces data dictionary では、プライマリホストの情報は creator_id フィールドに格納されており、ユーザーオブジェクトに展開できます。
主要ホストは、1人以上のユーザーを共同ホストに指定できます。Spaces のデータ辞書では、これらのホストは host_ids として示され、ユーザーオブジェクトのリストに展開できます。ホスト指定は Space の開催中に変更される可能性があり、これらの endpoint から返される metadata はリクエスト時点の状態を反映します。
App は、creator_id の値を確認することで主要ホストを、host_ids の値を確認することで共同ホストを判別できます。
スピーカーは、Space 内で発言する権限を持つユーザーです。任意の時点でスピーカーは0人以上存在でき、Space には最大10人（ホストを含む）まで参加できます。Space のデータディクショナリでは、スピーカーは speaker_ids リストで返され、これを展開してユーザーオブジェクトのリストにできます。
Listener は Space を視聴し、用意されたリアクションで随時反応でき、スピーカーへの昇格をリクエストできます（Host が Space の設定で許可している場合）。Listener の情報は、participant_count フィールドで参加者（Host を含む）の合計数としてのみ返されます。
⌘I