Skip to main content
このガイドでは、X Activity API エンドポイントを使用してイベントをサブスクライブし受信する方法を説明します。一般的に 3 つのステップがあります:
  1. イベントをフィルタリングしたいユーザーの User ID を特定する
  2. そのユーザーに対してフィルタリングしたいイベントタイプのサブスクリプションを作成する
  3. Webhook または永続的な HTTP ストリーム接続を使ってイベントを受信する
前提条件始める前に、次のものが必要です:

ユーザー ID の取得

サブスクリプションを作成する前に、フィルタリングしたいアカウントのユーザー ID を知る必要があります。この例では、XDevelopers ハンドルを使用します。ユーザー ID は、以下を含むいくつかの方法でルックアップできます: ユーザー名でユーザー ID をルックアップ:
自分自身のユーザー ID を取得:
どちらのエンドポイントも、サブスクリプションフィルターで使用できる id フィールドを含むユーザー情報を返します。JSON レスポンスの例は以下のとおりです:

サブスクリプションの作成

次のステップはサブスクリプションを作成することです。この例では、XDevelopers の bio 更新をサブスクライブします。そのためには、user_idevent_type を JSON ボディで渡します。この場合、event_typeprofile.update.bio です。 X Developer のユーザー ID: 2244994945 と、オプションのタグを渡します:
認可には (developer portal からの) bearer token を使用します。app-only bearer token は、このような公開イベントに対して機能します。一部のイベントは非公開で、代わりに user-context (OAuth 2.0) 認証が必要です — 詳しくはイベントのプライバシーと認証を参照してください。
リクエストが成功すると、サブスクリプションが作成されます:
profile.update.bio

イベントの取得

サブスクリプションを作成したら、Webhook または永続的な HTTP ストリーム経由でイベントを受信できます。この例では、永続的な HTTP ストリームを開きます:
Xdevelopers アカウントがプロフィール bio を更新すると、イベントがストリーム経由で配信されます:
profile.update.bio

サブスクリプション管理

X Activity API は、標準的な CRUD 操作を通じてサブスクリプションを管理するエンドポイントを提供します。

サブスクリプションの作成

イベントを受信するための新しいサブスクリプションを作成します:
  • tag フィールドはオプションです。配信時にイベントを識別するのに役立ちます。
  • webhook_id フィールドもオプションです。Webhook をセットアップする方法は webhook ドキュメントを参照してください。webhook_id が指定されている場合、イベントは提供された Webhook に配信され、ストリームが開いている場合はストリームにも配信されます。
レスポンス:
profile.update.bio

サブスクリプションの一覧表示

アプリケーションのすべてのアクティブなサブスクリプションを取得します:
レスポンス:
profile.update.bio

サブスクリプションの削除

サブスクリプションを削除します:
レスポンス:
total_subscriptions は、削除操作後にアプリに関連付けられている残りのサブスクリプション数を示します。

サブスクリプションの更新

PUT エンドポイントを使用すると、サブスクリプションの配信方法やタグを更新できます。 filter または event_type の更新には、既存のサブスクリプションを削除して新しいものを追加する必要があります。
レスポンス:
profile.update.bio

次のステップ

イベントペイロード

各アクティビティイベントタイプのサンプル JSON

API リファレンス

完全なエンドポイントドキュメント

Webhooks

Webhook 配信をセットアップ