| X API v2 の新機能 | X API v2 に追加された新しいエンドポイントと機能をご紹介します。 |
|---|---|
| 移行の準備はできていますか？ | 一連のガイドと手順に従って、移行を開始してください。 |
| データ形式の移行ガイド | これまで標準の v1.1 およびエンタープライズのデータ形式で動作していたデータパーサーの移行方法を解説します。 |
| X API エンドポイントマップ | 標準の v1.1 およびエンタープライズの各エンドポイントが新しい X API v2 のエンドポイントにどのように対応するかを示します。 |
X API v2 とは？
なぜ移行するのか
v2 エンドポイント
- Spaces エンドポイント：ユーザーが X Spaces をより活用できるようにし、開発者が音声による会話の未来づくりに貢献できるようにします。
- 返信を非表示：攻撃的・注意散漫・誤解を招く返信の影響を大規模に抑えるツールを構築できます。
- 新しい Lists エンドポイント：Lists のピン留め・ピン留め解除 や、ユーザーのピン留め済み Lists の参照が可能です。
- 新しい バッチコンプライアンスエンドポイント：保管しているユーザーおよび Tweet の data がコンプライアンス要件に準拠していることを担保できます。
新機能
- エンドポイント間で一貫した設計
- レスポンスのペイロードで返す fields とオブジェクトを指定できる機能
- 新しく、より詳細な data オブジェクト
- Tweet 注釈によって強化された新たなコンテキスト情報で data を受信・フィルタリング
- 新しいメトリクスへのアクセス
- 返信スレッドに属する会話の容易な特定・フィルタリング
- 学術研究者向けの高度な機能と data へのアクセス拡大
- ストリーミングエンドポイント向けのリカバリおよび冗長化機能
- クエリに一致する Tweet の件数を簡単に取得
- Edit Tweets のサポート
- 高精度なスパムフィルタリング
- 短縮 URL を完全に展開し、より効果的なフィルタリングと分析を実現
- 非推奨 fields の削除とラベルの刷新による JSON レスポンスオブジェクトの簡素化
- 検索クエリで一致する公開かつ利用可能な Tweet を 100% 返す
- 接続を切らずに変更できるストリーミングの「rules」
- 検索 Tweet、Tweet 件数、フィルタ済みストリーム向けの、より表現力の高いクエリ言語
- 新しいライブラリの構築と変更の透明な追跡に役立つ OpenAPI 仕様
新規および更新されたレスポンスオブジェクトを確認する
| Object | 説明 |
|---|---|
| Tweet | Tweetオブジェクトには、id、text、created_atなどのルートレベルのfieldsが多数あります。Tweetオブジェクトは、user、media、poll、placeなど複数の子オブジェクトの親オブジェクトでもあります。 |
| User | userオブジェクトには、参照されるユーザーを記述するXユーザーアカウントのメタデータが含まれます。 |
| Spaces | Spaceオブジェクトは、state、host_id、is_ticketed、langといったfieldsで構成されます。 |
| Lists | Listオブジェクトには、description、member_count、owner_idなど、要求されたリストに関する基本情報が含まれます。 |
| Media | Tweetにメディア（画像など）が含まれる場合、media.fieldsパラメータを使用してmediaオブジェクトを取得でき、media_key、type、url、preview_image_urlなどのfieldsを含みます。 |
| Poll | Tweetに含まれるpollは、いずれのエンドポイントにおいても主要オブジェクトではありませんが、Tweetオブジェクト内で検出して展開できます。 |
| Place | placeオブジェクトは、place_id、geoオブジェクト、country_codeなどのfieldsで構成されます。これらの情報は、場所でTweetを特定し、Tweetを位置情報ごとに分析する際に利用できます。 |
受け取るオブジェクトとfieldsを選べる柔軟性
idとtextのfieldsを返します。
追加のfieldsを取得する場合は、fields と expansions パラメータを使用します。expansionsパラメータは、ユーザーの固定表示されたTweetやメディアオブジェクトなど、関連するdataオブジェクトを取得でき、fieldsパラメータでは、デフォルト以外に返されるオブジェクト内の特定のfieldsを指定してリクエストできます。
以下は、X API v2の各エンドポイントでリクエスト可能なexpansionsの一覧です。
| オブジェクト / リソース | 利用可能なExpansions |
|---|---|
| Tweets | author_id, edit_history_tweet_ids, entities.mentions.username, in_reply_to_user_id, referenced_tweets.id, referenced_tweets.id.author_id, attachments.poll_ids, attachments.media_keys, geo.place_id |
| Users | pinned_tweet_id |
| Spaces | invited_user_ids, speaker_ids, creator_id, host_ids, topic_ids |
ツイート、ユーザー、スペース、メディアオブジェクトで利用可能な新しいメトリクス
| オブジェクト | 利用可能なメトリクス | 公開メトリクス | 非公開メトリクス | オーガニックメトリクス | プロモーションメトリクス |
|---|---|---|---|---|---|
| tweets | retweet_count | ✔️ | ✔️ | ✔️ | |
| quote_count | ✔️ | ||||
| like_count | ✔️ | ✔️ | ✔️ | ||
| reply_count | ✔️ | ✔️ | ✔️ | ||
| impression_count | ✔️ | ✔️ | ✔️ | ||
| url_profile_clicks | ✔️ | ✔️ | ✔️ | ||
| url_link_clicks | ✔️ | ✔️ | ✔️ | ||
| user | follower_count | ✔️ | |||
| user | following_count | ✔️ | |||
| media | view_count | ✔️ | |||
| media | playback_0_count | ✔️ | |||
| space | participant_count | ✔️ |
ツイートの編集
- 作成時点でそのツイートが編集対象だったかどうか。投票付きや予約投稿など、一部のツイートは編集できません。
- ツイートは 30 分間編集可能で、最大 5 回まで編集できます。編集可能なツイートについては、残りの編集可能時間や残り編集回数を確認できます。
- 編集済みのツイートを表示しているかどうか（多くの場合、API はツイートの最新バージョンを返します。特定の過去バージョンが Tweet ID で要求された場合を除きます）。
- ツイートの全編集履歴。
- ツイートの各バージョンに紐づくエンゲージメント。
スレッド化された会話を追跡する
移行の準備
認証
ツールとコード
- Postman クライアントを使って各エンドポイントへリクエストし、接続できる、X の Postman collectionがあります。認証のテストやエンドポイントの検証をスムーズに行う方法です。
- Ruby、Python、Node、Java などに対応した、X がサポートするものとサードパーティ製の両方のライブラリ一覧も提供しています。詳細はツールとライブラリのページをご覧ください。
更新エンドポイントへの移行
- Tweets
- Tweet のルックアップ
- Tweet の管理
- タイムライン
- Tweet の検索
- Tweet 件数
- フィルタ済みストリーム
- サンプリングストリーム
- リツイート
- いいね
- 返信を非表示
- Users
- Lists
新しいデータ形式への移行
- ネイティブ形式から X API v2 へ（standard v1.1）
- Native Enriched から X API v2 へ（エンタープライズ）
- Activity Streams から X API v2 へ（エンタープライズ）