profile.update.bio、post.create、post.delete など関心のあるイベントをサブスクライブし、イベントを取得したいユーザーの User ID でフィルタリングできます。その User ID に一致するイベントは、1 秒未満のレイテンシーでアプリに配信されます。
配信方法
X Activity API は現在、アプリへのイベント配信について次の方法をサポートしています:- 永続的な HTTP ストリーム
- Webhook
サポートされているイベントタイプ
現在、X Activity API はカテゴリ別に整理された次のイベントタイプをサポートしています。各タイプのサンプル JSON については、イベントペイロードを参照してください。Post イベント
Post イベントは、ユーザーが Post を作成または削除したときにトリガーされます。XAA 経由の Post イベント vs Filtered Stream: X Activity API は
post.create および post.delete イベントをサポートしています。user_id でサブスクライブすることで、ユーザーが Post を作成または削除した際にリアルタイムで通知を受け取れます。ターゲットを絞ったキーワードフィルタリング、ブール論理、ジオターゲティング、言語フィルター、または Filtered Stream がサポートするその他の演算子が必要な場合は、代わりに Filtered Stream エンドポイントをご利用ください。Like イベント
Like イベントは、ユーザーが Post にいいねをしたとき、またはそのユーザー自身の Post にいいねがついたときにトリガーされます。Direction フィルター:
like.create イベントは、outbound または inbound に設定できるオプションの direction フィルターをサポートしています。ユーザー自身が行ったいいねには outbound を、ユーザーの Post が受け取ったいいねには inbound を指定します。direction を指定しない場合、inbound と outbound の両方の like イベントが配信されます。プライベートイベント: like.create はプライベートイベントであり、ユーザーコンテキスト (OAuth 2.0) 認証が必要です。以下のイベントのプライバシーと認証を参照してください。Follow イベント
Follow イベントは、フィルター対象のユーザーが他のユーザーをフォローしたとき、または他のユーザーからフォローされたときにトリガーされます。Profile イベント
Profile イベントは、ユーザーがプロフィール情報に変更を加えたときにトリガーされます。Chat イベント
Chat イベントは、新しい暗号化メッセージングスタック、つまり XChat に関連するものです。レガシー DM イベント
レガシー DM イベントは、従来の暗号化されていない DM システムに関連するものです。News イベント
News イベントは、Grok によってキュレーションされたトレンドトピックや見出しの更新情報を提供します。エンタープライズ限定:
news.new イベントは現時点で、Enterprise および Partner ティアのアカウントでのみ利用可能です。Spaces イベント
Spaces イベントは、ユーザーが Space を開始または終了したときにトリガーされます。Mute イベント
Mute イベントは、フィルター対象のユーザーが他のユーザーをミュートまたはミュート解除したときにトリガーされます。プライベートイベント: Mute イベントはプライベートであり、
mute.read スコープを持つユーザーコンテキスト (OAuth 2.0) 認証が必要です。user_id フィルターは、ミュートまたはミュート解除を実行するユーザーに一致します。ユーザーが ミュートされる ことに関する通知を購読することはできません。以下のイベントのプライバシーと認証を参照してください。Block イベント
Block イベントは、フィルター対象のユーザーが他のユーザーをブロックまたはブロック解除したときにトリガーされます。プライベートイベント: Block イベントはプライベートであり、
block.read スコープを持つユーザーコンテキスト (OAuth 2.0) 認証が必要です。user_id フィルターは、ブロックまたはブロック解除を実行するユーザーに一致します。ユーザーが ブロックされる ことに関する通知を購読することはできません。以下のイベントのプライバシーと認証を参照してください。イベントのプライバシーと認証
X Activity API は、X アプリと同等の取り扱いとして、パブリックイベントとプライベートイベントを以下のように区別しています。パブリックイベント
パブリックイベントは、公開ユーザーアカウントが公に行うアクティビティであり、すべての X ユーザーから閲覧可能なものです。これらのイベントは X プラットフォーム上のすべてのユーザーに表示され、閲覧にあたってユーザーからの OAuth 認証を必要としません。 現在のパブリックイベント:- プロフィールの更新 (自己紹介、画像、バナー、所在地、URL、ユーザー名の変更)
- Post の作成 (
post.create) と削除 (post.delete)
プライベートイベント
プライベートイベントは、OAuth 認証を通じてユーザーの明示的な同意が必要なアクティビティです。ユーザーは X 経由で認証を行い、これらのイベントへのアクセスを開発者アプリに対して明示的に許可する必要があります。 現在のプライベートイベント:- いいね (
like.create) - 暗号化チャットの受信 (
chat.received) - 暗号化チャットの送信 (
chat.sent) - DM の受信 (
dm.received) - DM の送信 (
dm.sent) - DM の既読 (
dm.read) - DM の入力中インジケーター (
dm.indicate_typing) - Post でのメンション (
post.mention.create) - ミュート (
mute.mute,mute.unmute) —mute.readスコープが必要です - ブロック (
block.block,block.unblock) —block.readスコープが必要です
- ユーザーは OAuth 2.0 を介してアプリケーションを認証する必要があります
- アプリケーションは適切な OAuth スコープを取得する必要があります
- ユーザーは、これらのイベントへのアクセスをアプリに対して明示的に許可する必要があります
- プライベートイベントのサブスクリプションは、アプリケーションを承認したユーザーに対してのみ作成できます
サブスクリプションの上限
X Activity API には、アカウントティアに応じて異なるサブスクリプションの上限があります:エンドポイント
アカウントのセットアップこれらのエンドポイントにアクセスするには、以下が必要です:X API v2 エンドポイントへのアクセス取得について詳しくは、Getting started ガイドをご覧ください。