「Amazon API」の使い方⑥－パラメーターの種類とか編－

前回で、リクエストURLの結果を表示させることができるようになりました。
（→ 「Amazon API」の使い方⑤－リクエスト結果（XML）の表示編－）

Amazon APIの使い方としては、ほぼほぼ終わりでもいいんですが、欲しい情報を取ってこれるように、リクエストURLに付けるパラメーターについて簡単に説明しておきます。

リクエストURLのおさらい

リクエストURLの簡単なおさらいですが、

[URL]?[パラメーター1]=値&[パラメーター2]=値&[パラメーター3]=値・・・（いくつでも）

こういうやつですね。

元となるリクエストURLがあって、それにパラメーターを付けてAmazonに情報をリクエストするわけです。

パラメーターの設定の仕方で、Amazonから受け取れるデータが変わってきます。

もうちょっと詳しくは第3回を見てください。
⇒「Amazon API」の使い方を紹介③－リクエストURL作成の概要－

今回は、そのパラメーターの種類とか設定値を説明していきます。

絶対に必要なパラメーター

パラメーターには色々な種類があります。
まずは、必ず必要になるパラメーターから見ていきましょう！

Service

何のサービスを使用するかを設定します。
とはいっても設定できる値は、「AWSECommerceService」の1つしかないみたいので、それを設定してあげましょう。

【例】
Service=AWSECommerceService

AWSAccessKeyId

アクセスキーを設定します。
第2回で取得したやつですね。
⇒「Amazon API」の使い方を紹介②－アクセスキーとシークレットキーの取得－

【例】
AWSAccessKeyId=[第2回で取得したアクセスキー（人によって異なる）]

AssociateTag

アソシエイトIDを指定するパラメーターです。

「AssociateTag」の取得方法については第1回を参考に！
⇒「Amazon API」の使い方を紹介①－アソシエイトID（タグ）登録編－

【例】
AssociateTag=[第1回で取得したアソシエイトタグ]

Operation

Amazonには色々な機能（カートに追加とか、商品検索とか）がありますよね。
どの機能（操作）をさせるかを設定できます。

基本的に使うのは、商品検索だと思います。
商品検索の値は、「ItemSearch」です。

【例】
Operation=ItemSearch

その他の「Operation」の値については、以下のサイトを参考に！

API Version 2009-07-01の場合

パラメータ値	実行内容
BrowseNodeLookup	BrowseNodeの情報。ブラウズノードとは商品が分類されているグループの階層構造
CartAdd	カートに商品追加
CartClear	カートをクリア
CartCreate	カートを作成
CartGet	カートを取得
CartModify	カート内の情報変更
CustomerContentLookup	顧客をID検索
CustomerContentSearch	顧客を検索
Help	HELPを表示
ItemLookup	ASINなどで商品を検索
ItemSearch	商品名や著者名でキーワード検索
ListLookup	リストマニア情報をID検索
ListSearch	リストマニア情報を検索
SellerListingLookup	特定の売り手の商品をID検索
SellerListingSearch	特定の売り手の商品検索
SellerLookup	売り手を検索
SimilarityLookup	関連商品の検索
TagLookup	US only
TransactionLookup	US only
VehiclePartLookup	US only
VehiclePartSearch	US only
VehicleSearch	US only

オペレーション(Operation) – 共通パラメータ – Amazon Web サービス

Timestamp

認証用にタイムスタンプが必要です。
タイムスタンプの作り方が書かれたコードは、
第4回で説明してますので、参考にしてください。
⇒「Amazon API」の使い方を紹介④－リクエストURLの作成（PHP）と結果（XML）の確認－

【例】
Timestamp=2014-09-11T02:05:49Z

Signature

こちらも認証用に必要なパラメーターです。
（わたしにとっては）複雑な変換を行いなって作成していきます。

「Signature」の作り方も
第4回で説明しているので参照にしてください。
⇒「Amazon API」の使い方を紹介④－リクエストURLの作成（PHP）と結果（XML）の確認－

【例】
Signature=[エンコード等、変換して作られた値]

必須のパラメータをつなげたリクエストURL例

ベースとなるURLを頭に付けて、各パラメーターを「&」でつなげていきましたよね。

http://webservices.amazon.com/onca/xml?Service=AWSECommerceService&AWSAccessKeyId=[第2回で取得したアクセスキー（人によって異なる）]&Operation=ItemSearch&Timestamp=2014-09-11T02:05:49Z&Signature=[エンコード等、変換して作られた値]

といった感じです。

必須じゃないけど、だいたい付けているパラメーター

必須ではないけど、だいたい付けているパラメーターを紹介していきます。

Version

Amazon APIのバージョンです。
最新バージョンは、「2013-08-01」ですかね。（2014年9月11日現在）

APIのバージョンによって使えるパラメーターが変わってくるので、
指定しておいたほうがよいかと思います。

【例】
Version=2013-08-01

ResponseGroup

Amazonからどういった結果を返してもらうかを指定するパラメーターです。
価格が欲しいとか、画像が欲しいとか、複数のパラメーター値を設定できます。

また、「Operation」パラメーターと紐づいていて、
「Operation」の値によって「ResponseGroup」に設定できるかが変わってきます。

今回はよく使う「Operation=ItemSearch」の「ResponseGroup」について見ていきましょう。
（その他のやつを知らないだけですが・・・。）

さらにその中でもよく使うであろう値について確認していきます。

Small

名前の通り、少ない（最小限）の情報だけを結果として返してくれます。
タイトルとかリンクなど、ホント最小限です。

【例】
ResponseGroup=Small

Medium

上の「Small」よりもう少し多くの情報を加えて返してくれます。
画像とか価格とかの情報も含んでくれます。
わたしは、「Medium」くらいの情報があれば、満足です。

【例】
ResponseGroup=Medium

Large

「Small」「Medium」と来たら当然「Large」もあります。
「Medium」の情報に加えて、レビューとか、関連情報なんかも返してくれるみたいです。

何が必要か分からないから全部もらっちゃえっていうのもありですが、
情報が多いとそれだけ重くなることも忘れないでください。

【例】
ResponseGroup=Large

その他の値

「Small」「Medium」「Large」以外にも個別にたくさんの値があります。
他の値を知りたい場合は、以下のサイトを参考にしてください。
⇒取得する情報の種類(ResponseGroup) – Amazon Web サービス

わたしは、「Small」「Medium」「Large」のどれか使って、その中から抜き出す感じで作ってます。
（ただの面倒くさがり・・・。）

複数の値を組み合わせる

「ResponseGroup」のパラメーターは複数の値を組み合わせて持つことができます。
状況に合わせて色々設定しましょう。

【例】
ResponseGroup=Images,Reviews,SalesRank

「Operation=ItemSearch」関連パラメーター

商品検索結果を受け取るにあたって、いろんなパラメーターを追加することができます。

• 特定のカテゴリーを指定して検索、
• キーワードで検索、
• タイトルから検索、
• 著者名から検索

など様々です。

SearchIndex

検索の対象とするカテゴリーを指定できます。

各カテゴリーの値について、以下のサイトを参考にしてください。

指定する値	カテゴリー
All	全て
Apparel	アパレル
Baby	ベビー＆マタニティ
Beauty	コスメ
Blended	全て
Books	本(和書)
Classical	クラシック音楽
DVD	DVD
Electronics	エレクトロニクス
ForeignBooks	洋書
Grocery	食品
HealthPersonalCare	ヘルスケア
Hobbies	ホビー
Jewelry	ジュエリー
Kitchen	ホーム＆キッチン
Music	ミュージック
MusicTracks	曲名
Software	ソフトウェア
SportingGoods	スポーツ＆アウトドア
Toys	おもちゃ
VHS	VHS
Video	ビデオ
VideoGames	ゲーム
Watches	時計

商品カテゴリーの指定(SearchIndex) – 商品検索(ItemSearch) – Amazon Web サービス

【例】
SearchIndex=All とか
SearchIndex=DVD

Keywords

商品を検索するときのキーワードを設定できます。
わたしの例では「アナと雪の女王」でしたね。

【例】
Keywords=[好きな検索キーワード]

その他のパラメーター

基本的に商品検索で使うのは「SearchIndex」「Keywords」の2種類です。
その他にもパラメーターがありますが、利用頻度は低いと思うので説明は割愛します。

おわり

ざーっとですが、リクエストURLのパラメーターについて紹介していきました。

今回紹介したパラメーターを使えば、ある程度のサービスは作れるんじゃないかなと思います。
価格のデータを取得して安い順に並べ替えたり、
画像のデータを取得して見栄えを良くしたり、などなど。

実際に色々と試してみてください。

次回は最終回として、実際に簡単なサービスを作ってみましょう！

第1回：アソシエイトタグの取得
第2回：アクセスキーとシークレットキーの取得
第3回：リクエストURL作成の概要
第4回：リクエストURLの作成（PHP）と結果（XML）の確認
第5回：リクエスト結果（XML）の表示
第6回：パラメーターの種類とか
最終回：実際に作ってみよう