Skip to main content

概要

Filtered stream エンドポイントグループを使用すると、開発者は公開 Post のストリームをフィルタリングできます。このエンドポイントグループの機能には、ルールの作成と管理、およびそれらのルールを適用して該当する公開 Post を返す Post ストリームのフィルタリングを可能にする複数のエンドポイントが含まれます。このエンドポイントグループを使用すると、特定のトピックやイベントをリッスンしたり、コンペティションを取り巻く会話を監視したり、トレンドがどのように発展するかを理解したりできます。 開発者は REST の rules エンドポイントを使用して、定義した条件に一致する Post をフィルタリングするためのルールを追加および削除できます。これらのルールは、メッセージのキーワード、ハッシュタグ、URL などの Post 属性に一致するオペレーターで作成できます。オペレーターとルール節はブール論理と括弧で組み合わせて、フィルタのマッチング動作を細かく設定できます。 一連のルールを追加すると、Webhook を登録して、X が Post オブジェクトを JSON 形式で配信し始めます。Webhook に配信されるのは、ルールに一致するコンテンツのみです。 このエンドポイントは編集済み Post をサポートします。Webhook は、フィルターに 1 つ以上一致する編集済み Post を、その編集履歴(Post ID の配列を含む)とともに受け取ります。編集履歴のない Post の場合、この配列には 1 つの ID のみが含まれます。編集された Post の場合、この配列には複数の ID が含まれ、編集順を反映して昇順に並べられ、最新バージョンが配列の最後の位置になります。Post の編集の仕組みについて詳しくは、Post 編集の基礎ページを参照してください。 注意: このエンドポイントグループは、ルールを設定する点で v2 filtered stream エンドポイントと似ています。唯一の違いは、ルールに一致する Post の配信メカニズムです。
  • v2 filtered stream エンドポイントの場合、永続的な接続を確立し、ルールに一致する Post をリッスンする必要があります。
  • この filtered stream webhook エンドポイントの場合、Webhook を登録すると、X がルールに一致する Post を Webhook に配信します。
これにより、クライアント側のドロップやサーバー側の通常の再起動によるドロップに起因する切断を処理する必要がなくなります。1 秒あたり数百のイベントを配信する可能性があるため、Webhook サーバーがこれらの同時接続を処理できる必要があります。 このエンドポイントは現在 Enterprise 開発者向けに提供されており、次の構成をサポートします:
  • プロジェクトあたり 25,000 以上のルール
  • ルール作成時にすべてのオペレーターを使用可能
  • 最大 2048 文字のルールを作成可能
  • Enterprise アクセスの申請はこちら
Filtered stream から返される Post は、月間の Post cap にカウントされます。
アカウントのセットアップこれらのエンドポイントにアクセスするには、次のものが必要です:X API v2 エンドポイントへのアクセスの取得について詳しくは、はじめにガイドをご覧ください。