楽天 リクエストURLの入力パラメーターについて。

楽天ウェブサービス で使用する、リクエストURLの入力パラメーターについては、オンラインドキュメントに API 毎に詳細があります。

オンラインドキュメント → 楽天商品検索API → 入力パラメーター
http://webservice.rakuten.co.jp/api/itemsearch/

rakuten-29.gif


【1】入力パラメーターの基本的な見方について説明します。

「必須」と「デフォルト」に注目してください。

rakuten-38.gif


例えば affiliateId は必須ではなく、デフォルトでは何も指定されていないという意味です。

rakuten-40.gif


sort は必須ではないのですが、デフォルトで「-reviewCount」が指定されているため、何も書かなければ、レビュー件数順(降順)となるという意味です。

rakuten-39.gif


【2】前に使ったリクエストURLを例に、入力パラメーターの基本的な使い方を説明します。


http://api.rakuten.co.jp/rws/1.11/rest?
developerId=[YOUR_developerID]
&operation=ItemSearch
&version=2007-10-25
&keyword=%E7%A6%8F%E8%A2%8B
&sort=%2BitemPrice


これは ”「福袋」という検索キーワードで検索し、結果を価格が安い順に並べた場合” のリクエストURLでしたね。

リクエストURLを分解して、もっと詳しく見ていきましょう。

(1)APIへリクエストを送る場合のURLです。

http://api.rakuten.co.jp/rws/1.11/rest?

・1.11 は楽天ウェブサービスのバージョンです。
・rest は出力タイプの種類でREST形式を指定しています。
・? の後に入力パラメーターを書きます。
・入力パラメーターは「&」でつないで複数指定できます。


(2)デベロッパーIDを指定している部分です。

developerId=[YOUR_developerID]


(3)使用するAPIを指定している部分です。

&operation=ItemSearch

*2つ目以降のパラメーターは「&」でつなぎます。


(4)バージョンを指定している部分です。

&version=2007-10-25


(5)検索キーワードを指定している部分です。

&keyword=%E7%A6%8F%E8%A2%8B

リクエストURLに使える文字の種類は限られています。日本語は使えないので、「URLエンコード」という処理を行い、URLに使える文字に変換しています。

福袋
↓ UTF-8でURLエンコード
%E7%A6%8F%E8%A2%8B

ちなみに元に戻す処理は「URLデコード」といいます。

%E7%A6%8F%E8%A2%8B
↓ URLデコード
福袋


(6)ソートの方法を指定している部分です。

&sort=%2BitemPrice

URLに「+」文字は使えないため、URLエンコードして「%2B」と書きます。

本来は +itemPrice です。
価格順(昇順)

*「-」はそのまま使うことができます。
-itemPrice
価格順(降順)


スポンサードリンク

スポンサードリンク






楽天ウェブサービス初心者入門講座TOPへ