メインコンテンツへスキップ
X API v2 の最新バージョンは大きなアップデートです。そこで、この移行セクションは以下のパートに分割しています。
X API v2 の新機能X API v2 で新たに提供された endpoint と機能について解説します。
移行の準備はできていますか？ガイドと手順に沿って、移行を開始しましょう。
データ形式の移行ガイドこれまで Standard v1.1 および Enterprise のデータ形式で動作していたデータパーサーの移行方法を解説します。
X API endpoint マップStandard v1.1 および Enterprise の endpoint が新しい X API v2 の endpoint にどのように対応するかを確認できます。

​
X API v2 とは何ですか？

X API v2 は現在の主要な X API であり、プロダクトへの投資とイノベーションの重点領域です。私たちは開発者と連携して、多様な開発者コミュニティにより良く貢献できる次世代の X API を構築しました。開発者からのフィードバックに基づき、より幅広いニーズに応えるために API を再設計し、新機能や endpoint を導入し、開発者体験を向上させました。 X API v2 は現在の主要な X API であり、プロダクトへの投資とイノベーションの重点領域です。ここ数年にわたり、私たちは開発者と連携して API を再構築し、より幅広いニーズに対応し、新機能や endpoint を導入し、開発者体験を改善してきました。私たちはオープンな開発者プラットフォームを継続的に構築していくことを約束しており、皆さまが X API v2 で何を構築されるのかを楽しみにしています。

​
なぜ移行するのか?

X API v2 は、最新かつより持続可能な基盤の上に構築されており、Standard v1.1 や Enterprise 製品に対する改良版の endpoint を備えるとともに、まったく新しい機能も提供します。レガシー API（v1.1 および Enterprise）をご利用のお客様には、最終的にこれらを非推奨とする予定のため、v2 への移行を強く推奨します。X API を使用して公開の会話を収集・分析し、X 上の人々と関わり、イノベーションを推進してください。 このセクションでは、endpoint と機能について説明します。

​
v2 の endpoint

以下のガイドで、v2 の endpoint の全一覧と、v2 以前の同等の endpoint を確認できます:
X API v2 の endpoint の多くは既存機能の置き換えですが、いくつかの新規 endpoint も導入しました。以下は v2 で公開した新規 endpoint の例です:
  • Spaces endpoints: ユーザーが X Spaces をより活用できるようにし、開発者が音声会話の未来の形成に寄与できるようにします。
  • Hide replies: 乱用的、注意をそらす、または誤解を招く返信の影響を大規模に抑制するためのツールを構築できます。
  • 新しい Lists endpoints: Lists をピン留め/ピン留め解除したり、特定ユーザーのピン留め済み Lists を照会できます。
  • 新しい batch compliance endpoints: 保存しているユーザーおよび Tweet のデータが規約や法令に準拠していることを担保できます。

​
新機能

X API v2 には、X API の価値をさらに高める新機能が含まれています。多くの新要素は皆さまからのフィードバックに基づいており、従来は Enterprise 顧客向けだった機能も含まれます。 API の改善点には以下が含まれます:

​
新規および更新されたレスポンスオブジェクトの紹介

以下の6つの data オブジェクトが v2 の endpoint で利用可能です:
ObjectDescription
TweetTweet オブジェクトには、id、text、created_at など、ルートレベルの fields が多数含まれます。Tweet オブジェクトは、user、media、poll、place など複数の子オブジェクトの親オブジェクトでもあります。
Userユーザーオブジェクトには、参照されるユーザーを記述する X のユーザーアカウントの metadata が含まれます。
SpacesSpace オブジェクトは、state、host_id、is_ticketed、lang などの fields で構成されます。
ListsList オブジェクトには、要求された List の基本情報が含まれ、description、member_count、owner_id などがあります。
MediaTweet にメディア（画像など）が含まれる場合、media.fields パラメータを使用して media オブジェクトをリクエストでき、media_key、type、url、preview_image_url などの fields を取得できます。
PollTweet に含まれる投票は、いずれの endpoint においてもプライマリオブジェクトではありませんが、Tweet オブジェクト内で検出し、展開できます。
Placeplace オブジェクトは、place_id、geo オブジェクト、country_code などの fields で構成されます。この情報は、場所に基づいて Tweet を特定し、分析するために使用できます。
fields と expansions の使い方について詳しくは、こちらをご覧ください。

​
受信するオブジェクトと fields を選べる柔軟性

GET endpoint にリクエストを送信すると、その endpoint に関連する主要な data オブジェクトが返され、既定の fields セットが含まれます。たとえば、Tweet オブジェクトは既定で id と text fields を返します。 追加の fields を取得したい場合は、fields と expansions パラメータを使用します。expansions パラメータでは、ユーザーの固定表示された Tweet やメディアオブジェクトなどの関連データオブジェクトを取得でき、fields パラメータでは既定項目に加えて返されるオブジェクト内の特定の fields を指定して要求できます。 以下は、各種 X API v2 endpoint で要求可能な expansions の一覧です。
Object / ResourceAvailable Expansions
Tweetsauthor_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
Userspinned_tweet_id
Spacesinvited_user_ids, speaker_ids, creator_id, host_ids, topic_ids
fields と expansions の使い方の詳細をご覧ください。

​
tweets、ユーザー、Spaces、メディアオブジェクトで利用可能な新しいmetrics

Tweet、ユーザー、Spaces、List、メディアオブジェクトで参照できるmetricsが増えました。これらのmetricsには公開・非公開があり、一部はTweet広告向けにオーガニックとプロモーションのcontextに分解して提供されます。 利用可能なmetricsについて詳しく見る。
ObjectAvailable MetricsPublic MetricsPrivate MetricsOrganic MetricsPromoted Metrics
tweetsretweet_count✔️✔️✔️
quote_count✔️
like_count✔️✔️✔️
reply_count✔️✔️✔️
impression_count✔️✔️✔️
url_profile_clicks✔️✔️✔️
url_link_clicks✔️✔️✔️
userfollower_count✔️
userfollowing_count✔️
mediaview_count✔️
mediaplayback_0_count✔️
spaceparticipant_count✔️

​
ツイートの編集

X API v2 の endpoint は、編集済みの Tweet に関する metadata を提供します。Edit Tweet 機能は 2022 年 9 月 1 日、X 従業員を対象としたテストとして初めて導入されました。この日以降、対象の Tweet は 30 分間に最大 5 回まで編集できます。Edit Tweets の詳細をご確認ください。 X API v2 を使用すると、開発者は次の点を把握できます。
  • 作成時にその Tweet が編集対象だったかどうか。投票付きや予約投稿された Tweet など、一部の Tweet は編集できません。
  • Tweet は 30 分間編集可能で、最大 5 回まで編集できます。編集可能な Tweet については、残りの編集可能時間と残り編集回数を確認できます。
  • 編集済みの Tweet のバージョンを表示しているかどうか（多くの場合、API は Tweet の最新バージョンを返しますが、Tweet ID で特定の過去バージョンが要求された場合はその限りではありません）。
  • その Tweet の編集履歴全体。
  • Tweet の各バージョンに紐づくエンゲージメント。

​
スレッド化された会話を追跡する

新たに追加された Tweet フィールドにより、指定の Tweet が属する会話スレッドを判別できます。conversation ID は、その会話を開始した Tweet の Tweet ID です。詳しくは conversation tracking をご覧ください。

​
移行の準備ができたら

v2 endpoint を使用するには、次のものが必要です。 Project 内の App のキーおよびトークンを使用することが重要です。Project 外の App のキーおよびトークンを使用している場合、v2 endpoint へのリクエストは行えません。 デベロッパーアカウントを取得したら、上記のすべてを developer portal で設定できます。

​
認証

新しい Twitter API では、異なる endpoint にアクセスするために、2 種類の認証パターンである OAuth 1.0a ユーザーコンテキスト と OAuth 2.0 Bearer Token を使用します。各方式は endpoint へのリクエスト時に異なる目的を持ちます。 OAuth 1.0a ユーザーコンテキスト は、Twitter ユーザーの代わりにリクエストを行う場合に必要です OAuth 2.0 Bearer Token は、開発者用 App の代わりにリクエストを行う場合に必要です

​
ツールとコード

新しいendpointや機能に慣れ、作業を始めるにあたってすぐに利用できるいくつかの選択肢をご用意しています。
  • Postmanクライアントで個々のendpointにリクエストを送信し、接続できるTwitterのPostman collectionをご用意しています。認証の検証やendpointの試行を手軽に行える方法です。
  • また、Ruby、Python、Node、Java などに対応したTwitter公式およびサードパーティ製ライブラリの一覧も提供しています。詳細はツールとライブラリをご覧ください。

​
更新済みendpointへの移行

新しいTwitter v2 endpointの利用開始にあたり、旧バージョンと比較して各更新済みendpointの機能差を把握できるよう、詳細な移行ガイドを用意しています。

​
新しいデータ形式への移行

v1.1 または Enterprise から v2 に移行する際は、data の提供形式が大きく変わっている点を理解しておくことが重要です。新たな fields の追加、fields の順序の変更、場合によっては要素の完全な削除が行われています。 これらの変更点を理解いただくため、pre-v2 のデータ形式における fields を新しい fields にマッピングし、新しい fields のリクエスト方法を説明する一連のガイドを作成しています。 この移行ハブ内の data formats migration セクション、または以下の各データ形式ガイドをご覧ください。

​
次は？

このプラットフォームを長くご利用の方は、多くの新しいendpointが既存のStandard v1.1やEnterpriseのendpointと整合していることにお気づきでしょう。実際、将来的にはこれらが3つのバージョンすべてを置き換える予定です。 X APIのendpointマップが、従来の各バージョンにどのように対応しているかを理解できるよう、表を用意しました。 今後の計画については、product roadmapをご覧ください。 また、既にリリース済みの内容を確認できるchangelogも用意しています。

​
次に何を構築すべきでしょうか？

X API v2 の機能拡充にあたり、皆さまからのご意見を継続して伺いたいと考えています。皆さまからのフィードバックを歓迎し、積極的にお寄せいただけるようお願いいたします。 すでに投稿されているアイデアをご確認のうえ、ご自身のニーズに合致するものに支持を示し、あわせてフィードバックもお寄せください。
⌘I