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

​
v2 Account Activity API 移行ガイド

このガイドは、旧来の Enterprise Account Activity API から v2 Account Activity API への移行を支援します。中核機能は変わりませんが、X API v2 との整合性を図るため、endpoint の構成と認証方式が更新されています。

​
変更の概要

  • API 形式: エンドポイントは /1.1/account_activity/ ではなく /2/account_activity/ のベースパスを使用します。
  • Webhook 管理: webhook の作成、一覧、検証（CRC）、削除は V2 Webhooks API によって行われます。
  • 認証: V2 のエンドポイントには次のいずれかが必要です:
    • OAuthUser（3-legged OAuth）：ユーザーごとのアクション（例: ユーザーの購読登録）。
    • OAuth2 App Only（Bearer Token）：アプリレベルのアクション（例: 購読の一覧/削除）。
    • V1.1 では要件が混在しており、しばしば OAuth 1.0a が使用されていました。
  • エンドポイント対応表:
V1.1 EndpointV2 の同等機能 / アクション備考
POST /1.1/account_activity/webhooks.json?url=<URL>POST /2/webhooksDocs。OAuth2AppOnly が必要。
GET /1.1/account_activity/webhooks.jsonGET /2/webhooksDocs。OAuth2AppOnly が必要。
PUT /1.1/account_activity/webhooks/:webhook_id.jsonPUT /2/webhooks/:webhook_idCRC をトリガーします。Docs。OAuth2AppOnly が必要。
DELETE /1.1/account_activity/webhooks/:webhook_id.jsonDELETE /2/webhooks/:webhook_idDocs。OAuth2AppOnly が必要。
POST /1.1/account_activity/webhooks/:webhook_id/subscriptions/all.jsonPOST /2/account_activity/webhooks/:webhook_id/subscriptions/allOAuthUser が必要。
GET /1.1/account_activity/subscriptions/count.jsonGET /2/account_activity/subscriptions/countOAuth2AppOnly が必要。
GET /1.1/account_activity/webhooks/:webhook_id/subscriptions/all.jsonGET /2/account_activity/webhooks/:webhook_id/subscriptions/allOAuthUser が必要。
GET /1.1/account_activity/webhooks/:webhook_id/subscriptions/all/list.jsonGET /2/account_activity/webhooks/:webhook_id/subscriptions/all/listOAuth2AppOnly が必要。
DELETE /1.1/account_activity/webhooks/:webhook_id/subscriptions/:user_id/allDELETE /2/account_activity/webhooks/:webhook_id/subscriptions/:user_id/allOAuth2AppOnly が必要。
DELETE /1.1/account_activity/webhooks/:webhook_id/subscriptions/all非推奨 / 直接の同等機能なし個別の delete を使用するか、DELETE /2/webhooks/:webhook_id で webhook を削除してください。
  • レスポンス形式: 成功およびエラーレスポンスの構造は AAAPI ドキュメントを確認してください。
移行時は、新しいベースパスの使用、認証フローの見直し、そして V2 Webhooks API を用いた webhook 管理に合わせてコードを更新してください。

​
移行方法

  • パッケージを決める:
    • Account Activity API にアクセスするため、Enterprise または Pro のパッケージを選択し、次を考慮してください:
      • 必要な webhook の数
      • 現在/将来のサブスクリプション数または認可済みユーザー数
      • X クライアントアプリケーションの数
      • 希望するサポートレベル（フォーラム対応か、マネージド Enterprise の 1:1 サポートか）
      • 価格の詳細（Enterprise は営業へお問い合わせください）
  • 認可方式を OAuth 2.0 に更新する:
    • X App に「Read, Write, and Access Direct Messages」の権限が付与されていることを確認します。
    • v2 endpoint に対して OAuth 2.0 を使用するよう更新します。scope を変更した場合はユーザーの再認可が必要です。
    • developer portal を使用して次を管理します:
      • OAuth 2.0 Access Token
      • Client ID と Client Secret
  • webhook を検証または再設定する:
    • 既存の webhook URL を使用するか、新しいものを設定します（例: https://your_domain.com/webhook/twitter）。
    • v2 Webhooks API ドキュメントに従って webhook を登録・管理します。
  • サンプル App:
    • Simple webhook server
      • CRC チェックへの応答と POST イベントの受信方法を示す、単一ファイルの Python スクリプト。
    • Account Activity API sample dashboard
      • bun.sh で実装された Web アプリで、webhook とサブスクリプションの管理、およびアプリ内でのライブイベント受信が可能です。
⌘I