概要

以下のページでは、X API に含まれる Spaces エンドポイントについて説明します。Spaces 全般の詳細については、help.x.com を参照してください。 

Spaces は、ライブ音声での会話を通じて表現とインタラクションを可能にします。Spaces エンドポイントは、Spaces を活用した新しい機能を作成するためのツールを提供します。これらのエンドポイントを使用して、ライブ中またはスケジュール済みの Spaces を取得したり、ユーザーが興味を持ちそうな Spaces を見つけられるような発見のためのエクスペリエンスを構築したりできます。

私たちは、Spaces を私たちが構築した形にとどめず、皆さんの創造性で拡張していただくことを歓迎します。これらのエンドポイントを使って、タイトルに含まれるキーワードに基づいてリスナーに Spaces を提案するエクスペリエンスを構築したり、ライブまたは今後の Spaces をホストしていて、かつユーザーにフォローされているアカウントを可視化したりできます。また、ホストが自分の Spaces のパフォーマンスをよりよく理解し、オーディエンスに関するインサイトを得られるよう支援することも可能です。

​

重要なリソース

以下のリソースは、Spaces エンドポイントの利用開始や統合に役立ちます。

• X API v2 へのアクセス権を取得する

• Spaces データ辞書

• Spaces エンドポイントへの最初のリクエストを行う

   

​

現在利用可能な機能

Spaces のルックアップ	単一の Spaces ID で取得する 複数の Spaces ID を使って取得する 作成者 ID で取得する チケット購入者のユーザー一覧を取得する
Spaces の検索	キーワードを使って Spaces を検索する

​

Spaces のライフサイクルを理解する

X Developer Platform の他のリソースとは異なり、Spaces には明確なライフサイクルがあります。Spaces は開始予定日時の最大 14 日前までスケジュールでき、終了後は利用できなくなります。ホストは、開始前であればいつでも、すでにスケジュールした Space をキャンセルすることもできます。

Space がライブ中はアクセス可能ですが、終了すると Spaces エンドポイントを使って取得することはできなくなり、この状態を示すエラーメッセージが返されます。

あなたの App が Spaces のデータを扱う場合、常に最新の情報を返すとともに、プラットフォーム上で利用できなくなったデータを削除する責任があります。Spaces lookup endpoint を利用することで、ユーザーの期待や意図を尊重した形でデータを扱えていることを確保しやすくなります。  

​

Spaces におけるロール

これらのエンドポイントは、X App における Spaces の動作を反映しています。Spaces では、X ユーザーは Space との関わり方や Space 内での振る舞いに応じて、特定のロールが割り当てられます。  

​

クリエイター (またはプライマリホスト)

プライマリホストは、Space を作成したユーザーであり、その Space 自体の所有者です。現在、Space はホストを 1 人しか持てないため、プライマリホストが唯一のホストとなります。Spaces data dictionary では、プライマリホストの情報は creator_id フィールドに含まれており、ユーザーオブジェクト に展開することができます。  

​

ホスト

プライマリホストは、1 人以上のユーザーを共同ホストとして追加できます。Spaces のデータディクショナリでは、これらのホストは host_ids として表示され、ユーザーオブジェクトのリストに展開できます。Space の開催中はホストの指定が変更される可能性があり、これらのエンドポイントから返されるメタデータは、リクエスト時点の状態を反映します。

App は、creator_id の値を確認することでプライマリホストを、host_ids の値を確認することで共同ホストを判別できます。  

​

スピーカー

スピーカーとは、スペース内で発言する権限を持つユーザーのことです。任意の時点で 0 人以上のスピーカーが存在でき、スペースにはホストを含めて最大 10 人までのスピーカーが参加できます。Space データ辞書では、スピーカーは speaker_ids リストとして返され、これを展開してユーザーオブジェクトのリストに変換できます。  

​

リスナー

リスナーはスペースを視聴し、あらかじめ定義されたリアクションをいつでも使用して反応でき、 (ホストがスペースの設定でこれを許可している場合は) スピーカーになることをリクエストすることもできます。リスナーに関する情報は、participant_count フィールドで返される参加者数 (ホストを含む) の集計値としてのみ取得できます。