メインコンテンツへスキップ
X Activity API (XAA) のエンドポイントグループを使用すると、開発者は X プラットフォーム上で発生するアクティビティイベントにアクセスできます。 開発者は、ProfileBioUpdateProfilePictureUpdate など関心のあるイベントを購読し、対象ユーザーの User ID でフィルタリングできます。該当するイベントは、その User ID に対してサブ秒レイテンシでアプリに配信されます。
X Activity API はオープンベータとして提供されています。オープンベータ期間中は、不具合、破壊的変更、未完成の機能が含まれる可能性があります。皆さまからのフィードバックは非常に貴重です。問題は developer community forums でご報告ください。

配信メカニズム

X Activity API は現在、イベントをアプリに送信するために、次の配信メカニズムをサポートしています。
  • 永続的な HTTP ストリーミング
  • Webhook

サポートされているイベントタイプ

現在、X Activity API は以下のプロフィール更新イベントをサポートしています。
カテゴリイベント名説明
プロフィールProfileBioUpdateユーザーがプロフィールの自己紹介を更新したときにトリガーされます
プロフィールProfilePictureUpdateユーザーがプロフィール画像を更新したときにトリガーされます
プロフィールProfileBannerUpdateユーザーがプロフィールバナーを更新したときにトリガーされます
プロフィールProfileGeoUpdateユーザーがプロフィールの位置情報を更新したときにトリガーされます
プロフィールProfileUrlUpdateユーザーがプロフィールのウェブサイト URL を更新したときにトリガーされます
プロフィールProfileScreennameUpdateユーザーが表示名を更新したときにトリガーされます
プロフィールProfileVerifiedBadgeUpdateユーザーが認証バッジを更新したときにトリガーされます
今後のリリースでは、XAA はソーシャル上のやり取り、コンテンツのエンゲージメント、収益化機能など、追加のイベントタイプへの対応を拡大していきます。新しいイベントタイプが利用可能になり次第、ドキュメントを更新します。
注: XAA はポストを配信しません。リアルタイムのポスト配信については、開発者がリアルタイムでポストをフィルタリングおよびストリーミングできる Filtered Stream エンドポイントをご確認ください。

イベントのプライバシーと認証

X Activity API は、以下で説明するように X アプリと同等の扱いで、公開イベント非公開イベントを区別します。

公開イベント

公開イベントは、一般公開のユーザーアカウントが公開で行い、すべてのXユーザーに表示されるアクティビティです。これらのイベントはXプラットフォーム上の全ユーザーに可視で、閲覧にユーザーのOAuth認証は不要です。 現在の公開イベント:
  • プロフィール更新(自己紹介、画像、バナー、所在地、URL、ユーザー名の変更)
これらの公開イベントについては、フィルターでユーザーIDを指定してサブスクリプションを作成し、XAA経由で受信できます。

プライベートイベント

プライベートイベントは、OAuth 認証を通じてユーザーの明示的な同意が必要となるアクティビティです。ユーザーは X で認証を行い、これらのイベントへアクセスできるよう Developer App に対して明示的な許可を付与する必要があります。 プライベートイベントの認証要件:
  • ユーザーは OAuth 2.0 を用いてあなたのアプリケーションで認証を行う必要があります
  • あなたのアプリケーションは適切な OAuth スコープを取得する必要があります
  • ユーザーはあなたのアプリによるこれらのイベントへのアクセスを明示的に許可する必要があります
  • プライベートイベントのサブスクリプションは、あなたのアプリケーションを承認したユーザーに対してのみ作成できます

サブスクリプション上限

X Activity API では、アカウントのティアに応じてサブスクリプションの上限が異なります:
パッケージのティア最大サブスクリプション数
Free利用不可
Basic50
Pro2,500
Enterprise20,000
Partner100,000
アカウントの設定これらのエンドポイントにアクセスするには、以下が必要です。X API v2 エンドポイントへのアクセス方法の詳細は、導入ガイドをご覧ください。