このガイドでは、Merchant API でのバージョニング、リリース、さまざまなバージョンのライフサイクルの処理方法について説明します。
バージョニング体系
Merchant API では、サブ API レベルでバージョニング戦略が採用されています。つまり、Merchant API 内の Products など、各 API には独自のバージョン ライフサイクルがあります。
バージョン管理の形式とプレゼンテーション
安定版のサブ API バージョン: サブ API が安定版の場合、そのすべてのメソッドは安定版です。安定版のサブ API バージョンは vX(v1、v2 など)として表されます。これらは本番環境で使用できるメジャー バージョンです。
アルファ版のサブ API バージョン: サブ API がアルファ版の場合、そのすべてのメソッドはアルファ版です。アルファ版のサブ API バージョンは vXalpha(v1alpha、v2alpha など)として表されます。これらには、テストと迅速な反復を目的とした試験運用版の早期アクセス機能が含まれています。アルファ版には安定性の保証がなく、ライフサイクルも定義されていません。30 日間の通知期間で変更または廃止される可能性があります。
バージョンの変更
メジャー バージョンの増加(v1 から v2 など): 下位互換性のない互換性を破る変更を示します。デベロッパーの対応が必要です。安定版サブ API の互換性のない変更のみに新しいバージョン番号が付けられます。たとえば、v1 から v2 などです。
マイナー変更: 下位互換性のある追加や修正は、既存のメジャー バージョンへの変更として提示されます。このような変更については、そのメジャー バージョンのリリースノートで詳しく説明します。サブ API への非破壊的な追加は、最新の安定版のアルファ チャンネルにリリースされるか、最新の安定版に直接リリースされます。
廃止ポリシー
古い Merchant サブ API バージョンは定期的にサポートが終了します。安定版のメジャー バージョン(vX)については、正式な非推奨の発表から 12 か月間の非推奨期間を設けることをお約束します。
たとえば、2026 年 1 月 15 日に Products サブ API の v1 を非推奨にした場合、2027 年 1 月 15 日以降に廃止されます。この日を過ぎると、以前のバージョンのサブ API は使用できなくなります。
サブ API のバージョンとライフサイクル ステータス
次の表に、Merchant API の各サブ API の最新バージョンを示します。
Sub-API | バージョン | ステータス |
---|---|---|
アカウント | 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 日に廃止予定 |
プロダクト | 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 に関するサポートを受けるをご覧ください。