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

概要

filtered stream エンドポイントグループは、開発者が公開 Post のストリームをフィルタリングできるようにする機能群です。このエンドポイントグループには、ルールの作成と管理を行い、それらのルールを適用して一致する公開 Post を返すストリームをフィルタリングできる複数のエンドポイントが含まれます。本エンドポイントグループにより、特定のトピックやイベントの検知、競技やキャンペーン周りの会話のモニタリング、トレンド形成の把握などが可能になります。 開発者は REST のrules エンドポイントを使用して、定義した条件に一致する Post をフィルタリングするルールの追加・削除ができます。これらのルールは、メッセージのキーワード、ハッシュタグ、URL などの Post 属性にマッチするオペレーターで作成できます。オペレーターやルール句は、ブール論理や丸括弧と組み合わせて、フィルターのマッチング動作をより精緻化できます。  ルールのセットを追加したら、Webhook を登録すると、X が JSON 形式でPost オブジェクトの配信を開始します。Webhook には、あなたのルールに一致するコンテンツのみが配信されます。 このエンドポイントは編集済みの Post をサポートします。あなたの Webhook には、1 つ以上のフィルターに一致する編集済みの Post が、その編集履歴(Post ID の配列を含む)とともに届きます。編集履歴がない Post の場合、この配列には単一の ID が入ります。編集されている場合、この配列には複数の ID が含まれ、編集順に昇順で並び、配列の最後が最新バージョンになります。Post の編集の仕組みについては、Posts edits fundamentalsをご覧ください。  注意: このエンドポイントグループは、ルールの設定方法に関してはv2 filtered stream エンドポイントと類似しています。唯一の違いは、あなたのルールに一致した Post の配信メカニズムです。
  • v2 filtered stream エンドポイントでは、永続接続を確立し、あなたのルールに一致する Post を受信し続ける必要があります。
  • 本 filtered stream Webhook エンドポイントでは、Webhook を登録すると、X があなたの Webhook にあなたのルールに一致する Post を配信します。
これにより、クライアント側の切断や、当社サービスの通常の再起動に伴うサーバー側の切断への対応が不要になります。毎秒数百件のイベントを配信する可能性が高いため、 Webhook サーバーはこれらの同時接続試行を処理できる必要があります。 このエンドポイントは現在、エンタープライズ開発者向けに提供され、次の構成をサポートします:
  • プロジェクトあたり 25,000 件超のルール
  • ルール作成時にすべてのオペレーターを使用可能
  • ルールは最大 2048 文字まで作成可能
  • エンタープライズアクセスはこちらから申請
filtered stream から返される Post は、月次のPost 上限にカウントされます。
アカウントの設定これらのエンドポイントにアクセスするには、以下が必要です:X API v2 エンドポイントへのアクセス方法については、はじめにガイドをご覧ください。