| X API v2 の新機能 | X API v2 向けに新たに提供されたエンドポイントや機能について確認できます。 |
|---|---|
| 移行の準備はできていますか？ | 一連のガイドと手順に沿って、移行を開始しましょう。 |
| データ形式移行ガイド | これまで standard v1.1 や enterprise のデータ形式に対応していたデータパーサーを、どのように移行・再設計するかを学びます。 |
| X API エンドポイント対応表 | standard v1.1 および enterprise のエンドポイントが、新しい X API v2 のエンドポイントにどのように対応づけられるかを確認します。 |
X API v2 とは？
なぜ移行するのか？
V2 endpoints
- 人々が X Spaces をより活用できるようにし、開発者が音声会話の未来を形作ることに貢献できるようにするための Spaces endpoints。
- 不適切で攻撃的な返信や、注意をそらしたり誤解を招いたりする返信の影響を、大規模に抑制するツールを構築できるようにする Hide replies。
- リストをピン留めおよびピン留め解除する、あるいは特定ユーザーのピン留めされたリストを取得できる、新しい Lists endpoints。
- 保存しているユーザーおよびツイートデータがポリシーに準拠していることを確認できる、新しい batch compliance endpoints。
新機能
- エンドポイント間で一貫した設計
- レスポンスペイロードで返されるフィールドやオブジェクトを指定する機能
- 新しい、より詳細なデータオブジェクト
- ツイートアノテーションを活用した新しいコンテキスト情報でデータを受信・フィルタリングする機能
- 新しいメトリクスへのアクセス
- 返信スレッドに属する会話を簡単に特定およびフィルタリング
- 学術研究者向けの高度な機能と、学術研究用データへのアクセス拡大
- ストリーミングエンドポイント向けのリカバリーおよび冗長化機能
- クエリに一致するツイート数を簡単に取得
- ツイート編集機能 (Edit Tweets) への対応
- 高精度なスパムフィルタリング
- 短縮 URL を完全に展開し、より効果的なフィルタリングと分析を実現
- 廃止予定フィールドの削除とラベルの最新化による JSON レスポンスオブジェクトの簡素化
- 検索クエリに一致する公開かつ利用可能なツイートを 100% 返却
- 接続を切断することなく変更を行えるストリーミング用の「ルール」
- ツイート検索、ツイート数カウント、フィルタ済みストリーム向けの、より表現力の高いクエリ言語
- 新しいライブラリの構築と変更のより透明な追跡を可能にする OpenAPI 仕様
新規および更新されたレスポンスオブジェクトを確認する
| Object | Description |
|---|---|
| Tweet | ツイートオブジェクトには、id、text、created_at などのルートレベルのフィールドが多数含まれます。ツイートオブジェクトは、user、media、poll、place など複数の子オブジェクトの親オブジェクトでもあります。 |
| User | user オブジェクトには、参照されているユーザーを記述する X ユーザーアカウントのメタデータが含まれます。 |
| Spaces | Space オブジェクトは、state、host_id、is_ticketed、lang などのフィールドで構成されます。 |
| Lists | List オブジェクトには、description、member_count、owner_id など、要求されたリストに関する基本情報が含まれます。 |
| Media | ツイートにメディア (画像など) が含まれている場合、media.fields パラメータを使用して media オブジェクトをリクエストでき、その中には media_key、type、url、preview_image_url などのフィールドが含まれます。 |
| Poll | ツイートに含まれる投票は、いずれのエンドポイントにおいてもプライマリオブジェクトではありませんが、ツイートオブジェクト内で取得して展開できます。 |
| Place | place オブジェクトは、place_id、geo オブジェクト、country_code などのフィールドで構成されます。この情報は、ツイートを特定したり、位置情報に基づいてツイートを分析したりするために使用できます。 |
受信するオブジェクトとフィールドを柔軟に選択する
id と text フィールドを返します。
リクエストで追加のフィールドを取得したい場合は、fields パラメータと expansions パラメータを使用する必要があります。expansions パラメータを使用すると、ユーザーのピン留めされた Tweet やメディアオブジェクトなどの関連データオブジェクトを取得できます。一方、fields 系のパラメータを使用すると、デフォルトに加えて、返されるオブジェクト内の特定のフィールドだけを指定してリクエストできます。
以下は、X API v2 の各エンドポイントで指定できる expansions の一覧です。
| Object / Resource | Available 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 |
ツイート、ユーザー、スペース、メディアオブジェクトで利用できる新しいメトリクス
| Object | Available Metrics | Public Metrics | Private Metrics | Organic Metrics | Promoted Metrics |
|---|---|---|---|---|---|
| ツイート | retweet_count | ✔️ | ✔️ | ✔️ | |
| quote_count | ✔️ | ||||
| like_count | ✔️ | ✔️ | ✔️ | ||
| reply_count | ✔️ | ✔️ | ✔️ | ||
| impression_count | ✔️ | ✔️ | ✔️ | ||
| url_profile_clicks | ✔️ | ✔️ | ✔️ | ||
| url_link_clicks | ✔️ | ✔️ | ✔️ | ||
| ユーザー | follower_count | ✔️ | |||
| ユーザー | following_count | ✔️ | |||
| メディア | view_count | ✔️ | |||
| メディア | playback_0_count | ✔️ | |||
| スペース | participant_count | ✔️ |
ツイートを編集する
- 作成時点でそのツイートが編集対象だったかどうか。一部のツイート (投票付きツイートや予約投稿されたツイートなど) は編集できません。
- ツイートは 30 分間編集可能で、最大 5 回まで編集できます。編集可能なツイートについては、残りの編集可能時間と、あと何回編集できるかを確認できます。
- 表示しているツイートが編集済みバージョンかどうか (ほとんどの場合、API はツイートの最新バージョンを返しますが、ツイート ID を指定して特定の過去バージョンが要求された場合はその限りではありません) 。
- ツイートの編集履歴全体。
- ツイートの各バージョンに紐づくエンゲージメント。
スレッド形式の会話を追跡する
移行の準備ができたら
認証
OAuth 2.0 ベアラートークンは、開発者の App に代わってリクエストを行う場合に必要です。
ツールとコード
- Postman クライアントを使って個々のエンドポイントに対してリクエストを送信し、接続できる Twitter の Postman コレクション を提供しています。これは認証をテストし、エンドポイントを試すための手軽な方法です。
- また、Twitter がサポートするものとサードパーティ製のものの両方を含む、Ruby、Python、Node、Java などのライブラリの一覧も提供しています。さらに詳しい情報は、ツールとライブラリのページ を参照してください。
更新されたエンドポイントへの移行
- ツイート
- ツイートのルックアップ
- ツイートの管理
- タイムライン
- ツイート検索
- ツイート数
- フィルタ済みストリーム
- サンプルストリーム
- リツイート
- いいね
- 返信を非表示にする
- ユーザー
- リスト
新しいデータフォーマットへの移行
- ネイティブ形式から X API v2 へ (standard v1.1)
- Native Enriched から X API v2 へ (enterprise)
- Activity Streams から X API v2 へ (enterprise)