メインコンテンツへスキップ

​
概要

filtered stream エンドポイントグループを使用すると、開発者は公開ポストのストリームをフィルタリングできます。このエンドポイントグループには、ルールの作成と管理を行い、それらのルールを適用して、条件に一致する公開ポストのみを返すストリームをフィルタリングできる複数のエンドポイントが含まれます。このエンドポイントグループを使うことで、特定のトピックやイベントを監視したり、競合相手に関する会話をモニタリングしたり、トレンドがどのように形成されるかを把握したり、その他さまざまなことが可能になります。 開発者は REST の rules エンドポイント を使用して、定義した条件に一致するポストをフィルタリングするためのルールを追加・削除できます。これらの rules は、ポスト本文のキーワード、ハッシュタグ、URL などのポスト属性にマッチするオペレーターを使って作成できます。オペレーターやルール句は、ブールロジックやかっこと組み合わせることで、フィルターのマッチング動作をより細かく調整できます。  ルールのセットを追加したら、X が JSON 形式で ポストオブジェクト を配信し始める webhook を登録できます。webhook には、設定したルールに一致するコンテンツのみが送信されます。 このエンドポイントは編集済みポストをサポートします。webhook には、1 つ以上のフィルターに一致する編集済みポストが、その編集履歴とともに配信されます。編集履歴には、ポストの id の配列が含まれます。編集履歴のないポストでは、この配列には単一の id が入ります。編集済みポストでは、この配列には複数の id が、編集の順序を反映した昇順で格納され、配列の最後の要素が最新バージョンになります。ポスト編集の仕組みについて詳しくは、ポスト編集の基本 のページを参照してください。  注意: このエンドポイントグループは、ルールの設定方法という点では v2 filtered stream エンドポイント と類似しています。唯一の違いは、ルールに一致したポストの配信メカニズムです。
  • v2 filtered stream エンドポイントの場合は、永続的な接続を確立し、ルールに一致するポストを受信し続ける必要があります。
  • この filtered stream webhook エンドポイントの場合は、webhook を登録すると、X がルールに一致するポストを webhook に配信します。
これにより、クライアント側の切断や、サービスの通常の再起動に伴うサーバー側の切断を処理する必要がなくなります。1 秒あたり数百件のイベントを配信する可能性が高いため、webhook サーバーはこれらの同時接続試行を処理できる必要があります。 このエンドポイントは現在 Enterprise 開発者向けに提供されており、次の構成をサポートします。
  • プロジェクトごとに 25,000 件以上のルール
  • ルール作成時にすべてのオペレーターを利用可能
  • 最大 2048 文字までのルールを作成可能
  • Enterprise アクセスの申請は こちら
filtered stream から返される投稿は、月次の Post cap の対象になります。
アカウントのセットアップこれらのエンドポイントにアクセスするには、次が必要です。X API v2 エンドポイントへのアクセスの詳細については、はじめに ガイドを参照してください。