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

​
概要

Filtered stream の endpoint グループは、開発者が公開されている Posts の stream をフィルタリングできるようにします。この endpoint グループには、ルールの作成と管理を行う複数の endpoint が含まれており、これらのルールを適用して一致する公開 Posts を返す stream を絞り込めます。この endpoint グループにより、ユーザーは特定のトピックやイベントをリッスンし、競技に関する会話を監視し、トレンドの形成を把握するなど、さまざまな用途に活用できます。 開発者は REST の rules endpoint を使用して、定義した条件に一致する Posts をフィルタリングするためのルールを追加・削除できます。これらの rules は、メッセージのキーワード、ハッシュタグ、URL などの Post 属性にマッチする演算子で作成できます。演算子やルール句は、ブールロジックや括弧と組み合わせることで、フィルターのマッチング挙動をより精緻に調整できます。  ルールを一式追加したら、webhook を登録できます。X は Post objects を JSON 形式で配信し始めます。webhook には、ルールに一致するコンテンツのみが届きます。 この endpoint は編集済みの Posts をサポートします。webhook には、1 つ以上のフィルターに一致する編集済み Posts が、Post ID の配列を含む編集履歴とともに届きます。編集履歴がない Posts の場合、この配列には単一の ID が含まれます。編集された Posts の場合、この配列には複数の ID が含まれ、編集の順序を反映して昇順に並び、配列の最後に最新バージョンが入ります。Post の編集の仕組みについては、Posts edits fundamentals を参照してください。  注: この endpoint グループは、ルールの設定方法については v2 filtered stream endpoint と類似しています。唯一の違いは、ルールに一致した Posts の配信メカニズムです。
  • v2 filtered stream endpoint の場合は、永続的な接続を確立し、ルールに一致する Posts をリッスンする必要があります。
  • 本 filtered stream webhook endpoint の場合は、webhook を登録すると、X がルールに一致する Posts を webhook に配信します。
これにより、クライアント側の切断や、サービスの通常の再起動に伴うサーバー側の切断を処理する必要がなくなります。毎秒数百件のイベントを配信する可能性が高いため、同時接続試行を処理できるように webhook サーバーを準備する必要があります。 この endpoint は現在、Enterprise の開発者が利用可能で、以下の構成をサポートしています:
  • プロジェクトあたり 25,000 件超のルール
  • ルール作成時にすべての演算子を使用可能
  • 最大 2048 文字までのルールを作成可能
  • Enterprise アクセスの申請はこちら
Filtered stream から返される Posts は、月次の Post上限 に算入されます。
アカウントのセットアップこれらの endpoint にアクセスするには、次が必要です:X API v2 endpoint へのアクセス方法の詳細は、入門ガイドをご覧ください。
⌘I