X API v2 の公開にあわせて、新しいバージョニング戦略を導入しました。これにより、開発者は X の公開 API に変更が入る見込みや、新しいバージョンへ移行すべきタイミングをより正確に把握できるようになります。
非推奨化、提供終了、変更、追加については、開発者が開発計画に適切に反映できるよう、当社のコミュニケーション チャネルを通じて通知します。API に対するすべての変更は、変更履歴に記載されます。
現在、X API には 3 つのバージョンがあります。ユースケースに必要な機能がまだ v2 で提供されていない場合を除き、連携の計画時には X API v2 の利用を強く推奨します。
各バージョンの詳細は、次のページをご覧ください。
バージョニング戦略
X APIのバージョニングは、エンドポイントのルートパスで宣言されるバージョン番号で表します。
https://api.x.com/2/tweets
X APIのメジャーバージョンは必要に応じてリリースしますが、12か月より短い間隔では行いません。APIに破壊的変更を導入する場合にメジャーバージョンをリリースします。新しいメジャーバージョンを公開する際には、開発者が移行できるようマイグレーションガイドを提供します。
破壊的変更とは、アプリの既存機能を維持するために開発者がコードを変更しなければならない変更を指します。非破壊的な変更は追加的なもので、準備が整い次第、最新バージョンにロールアウトされます。新機能を利用したい場合を除き、開発者側での対応は不要です。
セキュリティまたはプライバシー上の理由でサイクル途中に破壊的変更をロールアウトする必要がある場合は、その変更を最新バージョンに適用します。
破壊的変更
これらの変更により、開発者はアプリケーションの既存機能を維持するためにコードを修正する必要があります。
- 新たな必須パラメータの追加
- 既存エンドポイントの削除
- レスポンス内のフィールドの削除（必須・任意を問わず）
- クエリパラメータの削除
- 入出力フォーマットの再構成（例：トップレベルのフィールドをサブフィールドにする、または errors の位置をインラインに変更する）
- 既存の入力パラメータまたは出力値の名称またはデータ型の変更
- フィールド名の変更
- リソース名の変更
- レスポンスコードの変更
- エラータイプの変更
- 既存の認可スコープの変更
互換性を損なわない変更
- 新規エンドポイントの追加
- 新規オプションパラメータの追加
- 新規レスポンスフィールドの追加
- エラーメッセージの文言変更
- 新しいスコープの提供
- fields の「ヌル化」（完全に削除する代わりに、プライバシー／セキュリティ上の理由で値を null に変更すること）
非推奨と提供終了
まず、X API における「非推奨」と「提供終了」の定義を示します。
- 非推奨: 当該機能はチームのサポート対象外となります。その機能に関する新機能の追加は行われず、製品にバグや問題が発生しても、修正に対応する可能性は極めて低くなります。
- 提供終了: 当該機能には今後アクセスできなくなります。
多くの場合、新しいバージョンがリリースされると同時に、直前のバージョンは非推奨となります。バージョンは一定期間、非推奨の状態のままとなり、その後に提供終了となります。
今後の非推奨および提供終了に関する詳細は、最新情報をご確認ください。