このガイドでは、Merchant API でのバージョニング、リリース、さまざまなバージョンのライフサイクルの処理方法について説明します。
バージョニング体系
Merchant API では、サブ API レベルでバージョニング方式が採用されています。つまり、Merchant API 内のプロダクトなど、各 Merchant API には独自のバージョン ライフサイクルがあります。
バージョニングの形式と表示
安定版のサブ API バージョン: サブ API が安定版の場合、そのすべてのメソッドが安定版になります。安定版のサブ API バージョンは vX （v1、v2 など）で表されます。これらはプロダクション レディなメジャー バージョンです。
アルファ版のサブ API バージョン: サブ API がアルファ版の場合、そのすべてのメソッドがアルファ版になります。アルファ版のサブ API バージョンは vXalpha（v1alpha、v2alphaなど）で表されます。これには、テストと迅速な反復処理を目的とした試験運用版の早期アクセス機能が含まれています。アルファ版には安定性の保証はなく、有効期間は定義されていません。30 日間の通知期間をもって変更または廃止される可能性があります。
バージョンの変更
- メジャー バージョンのインクリメント （v1 から v2 など）: 下位互換性のない変更と破壊的な変更を示します。デベロッパーによる対応が必要です。安定版のサブ API の破壊的な変更のみに新しいバージョン番号が付けられます。たとえば、v1 から v2 などです。
- マイナーな変更: 下位互換性のある追加や修正は、既存のメジャー バージョンの変更として表示されます。このような変更については、そのメジャー バージョンのリリースノートで詳しく説明します。サブ API への破壊的でない追加は、最新の安定版のアルファ版チャンネルまたは最新の安定版に直接リリースされます。
サポート終了ポリシー
古い Merchant サブ API バージョンのサポートは定期的に終了します。公式のサポート終了のお知らせから 12 か月間の非推奨期間を設けることをお約束します。
たとえば、2026 年 1 月 15 日に Products サブ API の v1 のサポートを終了した場合、2027 年 1 月 15 日以降に廃止されます。この日以降、以前のバージョンのサブ API は使用できなくなります。
サブ API のバージョンとライフサイクルのステータス
次の表に、Merchant API の各サブ API の最新バージョンを示します。
| サブ API | バージョン | ステータス |
|---|---|---|
| アカウント | v1 v1alpha v1beta |
アクティブ アクティブ 2026 年 2 月 28 日に廃止 |
| コンバージョン | v1 v1beta |
アクティブ 2026 年 2 月 28 日に廃止 |
| データソース | v1 v1beta |
アクティブ 2026 年 2 月 28 日に廃止 |
| インベントリ | v1 v1beta |
アクティブ 2026 年 2 月 28 日に廃止 |
| 問題の解決 | v1 v1beta |
アクティブ 2026 年 2 月 28 日に廃止 |
| ローカル フィード パートナーシップ | v1 v1beta |
アクティブ 2026 年 2 月 28 日に廃止 |
| 通知 | v1 v1beta |
アクティブ 2026 年 2 月 28 日に廃止 |
| 注文の追跡 | v1 v1beta |
アクティブ 2026 年 2 月 28 日に廃止 |
| プロダクト | v1 v1beta |
アクティブ 2026 年 2 月 28 日に廃止 |
| Product Studio | v1alpha | アクティブ |
| プロモーション | v1 v1beta |
アクティブ 2026 年 2 月 28 日に廃止 |
| 割り当て | v1 v1beta |
アクティブ 2026 年 2 月 28 日に廃止 |
| レポート | v1 v1beta |
アクティブ 2026 年 2 月 28 日に廃止 |
| クチコミ | v1alpha v1beta |
アクティブ 2026 年 2 月 28 日に廃止 |
ベスト プラクティス
- リリースノートと最新の更新情報 を定期的に確認して、新しいバージョン、メジャー アップデート、改善点、 サブ API のリリースと廃止に関するお知らせを確認してください。
- サブ API に安定版が 2 つ以上ある場合は、常に最新バージョンを使用することをおすすめします。
- ネットワークの問題、レート制限、新しいサブ API バージョンで導入される可能性のある新しいエラーコードやメッセージなど、さまざまなサブ API エラーを適切に処理するようにアプリケーションを設計してください。
- サブ API バージョンのサポート終了が近づいてからアップグレードの計画を立てるのではなく、 新しいバージョンが利用可能になったらすぐに評価とテストを開始してください。
- 機能リクエストやサブ API ロードマップに関するご不明な点やご意見がございましたら、お問い合わせください。Merchant API チームにテクニカル サポートを依頼する方法については、Merchant API に関するサポートを受けるをご覧ください。