言語: 日本語 - JP
詳細 ›
地域: Jp flag. v192207005 日本

2019/09/09 - PA-API v5移行ガイド

PA-API v5移行ガイド

Product Advertising API(PA-API) 5.0 (PA-API v5) は現行のPA-API 4.0を完全にリニューアルしたバージョンです。以前よりもシステムへの組み込みがしやすく、軽量、シンプルかつ高速に動作します。 また出品情報に関するAmazonサイトの最新のユーザ体験に沿った情報もご提供します。

本移行ガイドはPA-API 4.0を組み込んだ既存システムをPA-API v5に移行するための手順を解説します。
なお、本移行ガイド以外のPA-API v5に関連するドキュメントは全て英語でのご提供となります。


PA-API v5の新機能


SDKのご提供 : PA-API v5を簡単に導入できるよう、主要なプログラミング言語ごとのSDKをご用意しました。 SDKを利用することにより、リクエストを暗号化する際の複雑な手続きやリクエストデータの生成、レスポンスの解析などを大変シンプルに利用できるようになりました。

軽量・シンプル・高速 : PA-API v5は、応答時間を短縮するためにゼロから再構築をしており、これまでの ResponseGroups 単位ではなく、 Resource 単位によるデータ取得を採用しています。PA-API v5は、以前にサポートされていたXMLよりも軽量でシンプルなJSON形式をサポートしています。

カスタマーエクスペリエンスの改善 : PA-API v5はAmazonサイトでご利用可能な言語選択機能や、Amazonプライム対応情報、主要なブラウズノードごとの売上ランキングなども提供します。

(注)PA-API 4.0とPA-API v5の詳細な違いについては、 What's New in PA-API 5.0 Guide をご確認ください(英語版のみ)。
(注)PA-API 4.0とPA-API v5のAPI対応表は、 PA-API 4.0 to 5.0 Mappings をご確認ください(英語版のみ)。


移行プロセス

PA-API 4.0から PA-API v5への移行の大まかなフローを示します。

それぞれのステップごとの詳細を下記に示します。


ステップ1. 新しいアクセスキーの取得

過去にAWSで発行したAWS認証キー(AWSアクセスキー、AWSシークレットキー)をご利用の場合、PA-API v5ではご利用いただけません。 新たに アソシエイト・セントラルのPA-APIページ にて、認証キー(アクセスキー、シークレットアクセスキー)を取得してご利用ください。 アクセスキーを取得するには、アカウントのメインユーザーである必要がありますのでご注意ください。

より詳しい解説は Migrating your PA-API Account from your AWS Account をご確認ください(英語版のみ)。

なお、現在すでにアソシエイト・セントラルにて発行したPA-API認証キーをご利用の場合( PA-APIページ にアクセスした際に表示されるアクセスキーを利用している場合)は対応は必要ありません。

[エラー例]

現在AWSで発行した認証キー(アクセスキー、シークレットアクセスキー)をご利用の方で、PA-API v5をコールして下記のようなエラーが表示される場合は、アソシエイト・セントラルのPA-APIページにて新しい認証キーを取得する必要があります。(なお、下記画面はScratchPad で PA-API v5をコールしたものです)


ステップ2. PA-API v5を試してみる

PA-API v5への移行を始める前にAPIテスト実行ツールである、 PA-API v5 Scratchpad をお試しください(英語版のみ)。PA-API v5 Scratchpadツールは、GUIツール上でリクエストを作成・送信し、レスポンスを取得することができるテスト実行ツールです。


アソシエイトID、アクセスキー、シークレットアクセスキーがあれば、ご利用いただくことができます。 Scratchpadは実行した処理に関する、複数のプログラミング言語ごとのサンプルコードを生成します。 リクエストとレスポンスの関連性が理解しやすくなりますので、是非お試しください。 より詳しい解説は Using Scratchpad Guide をご確認ください(英語版のみ)。


ステップ3. 必要な情報を収集する

PA-API v5はPA-API 4.0で利用をしていたHTTP(s)-GET/REST,SOAPよりも安全な、HTTPS-POST/JSON-RPCを採用しています。PA-API v5は以前のXMLではなくJSON形式をサポートします。こういった情報について、移行を始める前に事前に確認をしておくことを推奨します。


最適な資料は、 What's new in PA-API 5.0 Guide です(英語版のみ)。PA-API v5でリニューアルされたAPIの一覧、新旧APIの対応表、新旧APIのリクエスト形式とレスポンス形式の違いについて詳しく解説しています。


PA-API v5でサポートされる新しいAPIとResourcesというレスポンス単位、APIの構文を理解するように努めてください。 詳しくは API Reference をご確認ください(英語版のみ)。 また、PA-API 4.0とPA-API v5のレスポンスグループの対応表については PA-API 4.0 → PA-API 5.0 Mappings Guide をご確認ください(英語版のみ)。


ステップ4. PA-API v5を導入する

PA-API v5はシステムへの導入を簡単にするため、主要なプログラミング言語のSDKを用意しています。SDKを利用することにより、リクエストに必要なSignatureを入れる処理や、APIリクエストをSerializeしたり、レスポンスを解析する処理を簡単に実装することができるようになります。

現在サポートしているプログラミング言語ごとのSDKは こちら 。 別の選択肢として、 SDKを使わない実装 をすることもできます。 移行にあたって、PA-APIの現在の組み込み方法によっては、PA-APIをコールする部分とレスポンスを変換する部分のみ変更するだけで良い場合があります。

リクエスト: SDKをご利用になる場合、SDKがリクエストのSignature作成、リクエストのSerialization、レスポンスの解析を全て処理します。ご自分で実装される場合は、 こちらのガイド PA-API v5 Scratchpad で生成されるサンプルコードを参考にして下さい。エラーハンドリングをよりシステムに適合するように組み込みたい場合は こちら をご確認ください。

レスポンス: レスポンスのフォーマットがこれまでのXMLからJSONに変わりますので対応が必要です。 API Reference にて構文やデータ項目をご確認ください。

ご意見をお寄せください。

アソシエイト・セントラルについてのご提案やご意見は こちら