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