Product Advertising API (PA-API) 5.0は現行のProduct Advertising API 4.0を完全にリニューアルしたバージョンです。4.0よりもシステムに組み込みやすく軽量で、シンプルかつ高速に動作します。またAmazonサイトのユーザーエクスペリンスを向上する新しい機能も備わっています。

本移行ガイドでは、Product Advertising API 4.0を組み込んだ既存のアプリケーションをProduct Advertising API 5.0に移行するための手順を説明します。

PA-API 5.0の新機能

Product Advertising API 5.0 (PA-API 5.0) はハイレベルでの次の新しい機能を提供します。

• 移行が容易： 主要な言語で複雑な設定なしに使えるSDKで移行と導入が簡単。SDKを利用することにより、リクエストの署名、リクエストのシリアライゼーション、レスポンスのデシリアライゼーションがシンプルになります。
• 軽量・シンプル・高速： PA-API 5.0は、応答時間を短縮するためにゼロから構築されており、ResponseGroupsではなく、Resourcesを使用します。PA-API 5.0は、以前にサポートされていたXMLよりも軽量でシンプルなJSON形式をサポートしています。
• カスタマーエクスペリエンスの改善： PA-API 5.0は、LanguageOfPreference (希望の言語) 対応、PrimeExclusive (プライム限定) の資格、特定のBrowseNode (ブラウズノード) の複数・直感的な売上ランキングの情報など、Amazonサイトに合わせた機能を備えています。

移行プロセス

以下のフローチャートは、ハイレベルでのPA-API 4.0からPA-API 5.0への移行をチェックリストにしたものです。

上に記載されたステップごとの詳細を下記に示します。

ステップ1： 新しい認証情報を取得する

現在お持ちのAWS認証情報 (AWSアクセスキーとAWSシークレットキー) は PA-API 5.0では使えません。現在AWSの認証情報をお持ちの場合は、アカウントを移行してから新しい認証情報を作ることができます。詳細については、AWSアカウントからのPA-APIアカウントの移行 (Migrating your PA-API Account from your AWS Account) を参照してください。

古いAWS認証情報をお持ちで、PA-API 5.0を試す際に次のようなエラーが表示される場合は (エラーのスクリーンショットがPA-API 5.0 Scratchpadのものであることに注目)、お使いのAWSアカウントからPA-APIアカウントを移行しなければならないことがあります。

なお、AWSからの認証情報の移行がすでに完了済みで、新しい認証情報 (AWSのものではない) をお持ちの場合は、それ以上の対応は必要ありません。

ステップ2： PA-API 5.0を試してみる

Product Advertising API 5.0への移行を始める前に、PA-API 5.0 Scratchpadを使って試してみてください。

PA-API 5.0 Scratchpadツールは、Product Advertising APIに向けてリクエストを送信し、レスポンスを取得するのに使うことができるツールです。Scratchpadは複数の言語ごとにサンプルコードを返すため、Product Advertising APIの動作を理解し、簡単に導入するための助けとなります。

詳細については、Scratchpadの使い方 (Using Scratchpad Guide) を参照してください。

ステップ3： 必要な知識を得る

• PA-API 5.0は以前使っていたHTTP(s)-GET/REST,SOAPよりも安全なHTTPS-POST/JSON-RPCを採用しています。A-API 5.0は以前のXMLではなくJSON形式をサポートします。PA-API 5.0への移行を始める前に、こういった情報について詳しく調べておくことをお勧めします。
• Product Advertising API 5.0の新しい機能については、PA-API 5.0ガイドの新項目 (What's new in PA-API 5.0 Guide) を確認してください。
• PA-API 5.0でサポートされるAPIとResources、新しいAPIの構文を理解するように努めてください。詳細については、APIの資料 (API Reference) を参照してください。PA-API 5.0とPA-API 4.0 APIおよびResponseGroupsのマッピングについてはPA-API 4.0 → PA-API 5.0マッピングガイド (PA-API 4.0 → PA-API 5.0 Mappings Guide) を確認してください。

ステップ4： PA-API 5.0を導入する

導入を簡単にするため、Product Advertising API 5.0は主要な言語で複雑な設定なしに使えるSDKを備えています。SDKを利用することにより、リクエストのサイン、APIリクエストのシリアライゼーション、APIレスポンスのデシリアライゼーションがシンプルになります。

サポートされているSDKでPA-API 5.0を導入するか、別の方法として、SDKを使わずにバニラ実装をすることもできます。移行にあたっては、PA-APIをコールする部分とPA-APIレスポンスを変換する部分のみを、お使いのアプリケーションの使いたいフォーマットで変更するだけで良い場合があります。

• リクエスト： SDKをご利用になる場合、SDKがリクエストのサイン、シリアリゼーション、レスポンスのデシリアリゼーションを処理します。また、このガイドやPA-API 5.0 Scratchpadのコードサンプルのセクションのサイン・アルゴリズムを参考にすることもできます。また、PA-API 5.0 Errorsを使うためにお使いのアプリケーションのエラーハンドリングをアップデートしておくとよいかもしれません。
• レスポンス： 新しいJSONレスポンス構文を使うために、お使いのアプリケーションのレスポンス・トランスフォーマーまたはコンバーターのアップデートが必要な場合があります。すべての属性の構文と場所については、API資料 (API Reference) を確認してください。