楽天商品検索API リクエストの作成
リクエストURLの作成
基本URLに検索したいパラメータを追加していけば、URLを作成することができます。作成したURLをブラウザに入力すれば応答が返ってくるので、正常に動作しているか確認することができます。
関連ページ XML構造 サンプルコード
サンプル リクエストURL
http://api.rakuten.co.jp/rws/1.12/rest? developerId=★★&affiliateId=◆◆ &operation=ItemSearch&version=2008-09-01 &keyword=web
「web」というキーワードで検索するURLです。★★にはデベロッパーIDを、◆◆には、アフィリエイトIDを入れます。サンプルURLは改行されていますが、実際には改行せずに使用します。
リクエストURLをブラウザに入力し、エラーなどが表示されなければ、OKです。
10,000円未満の商品を指定する場合
上記のURLに 「&maxPrice=10000」 を付け足します。
このようにパラメータを追加することで、検索条件を追加することができます。
アフィリエイトID
アフィリエイトIDについては、アフィリエイトIDの説明を参照下さい。
リクエストパラメータ
リクエストパラメータの一覧です。ここからのコピー
コードに関しては、サンプルコードで説明しています。
| 楽天商品検索API（ItemSearch) 入力パラメーター version:2008-09-01 | |||||||
| 区分 | ID | 項目名 | フィールド名 | 型 (括弧内は 最大 バイト数） |
必須 | デフォルト | 備考 |
| 共 通 パ ラ メ | タ | |
1 | デベロッパID | developerId | String | ○ | --- | デベロッパーID |
| 2 | アフィリエイトID | affiliateId | String | - | 指定無し | アフィリエイトID | |
| 3 | 操作 | operation | String | ○ | --- | 使用するAPIの操作名： ItemSearch |
|
| 4 | コールバック関数名 | callBack | String | - | 指定無し | JSONPとして出力する際のコールバック関数名 （UTF-8でURLエンコードした文字列） 英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上 |
|
| サ | ビ ス 固 有 パ ラ メ | タ | |
1 | 検索キーワード | keyword | String | ○ (*1) |
--- | UTF-8でURLエンコードした文字列 (*1)検索キーワード、ジャンルID、カタログコードのいずれかが指定されていることが必須です。ただし、カタログコードが指定された場合、検索キーワード、ジャンルIDの指定は無効になります。 |
| 2 | バージョン | version | String | ○ | --- | 2008-09-01 | |
| 3 | ショップコード | shopCode | String | - | 指定無し | ショップごとのURL （http:// www.rakuten.co.jp/[xyz]）におけるxyzのこと |
|
| 4 | ジャンルID | genreId | long | ○ (*1) |
0 | 楽天市場におけるジャンルを特定するためのID ジャンル名、ジャンルの親子関係を調べたい場合は、「楽天ジャンル検索API(GenreSearch)」をご利用ください (*1)検索キーワード、ジャンルID、カタログコードのいずれかが指定されていることが必須です。ただし、カタログコードが指定された場合、検索キーワード、ジャンルIDの指定は無効になります。 |
|
| 5 | カタログコード | catalogCode | String | ○ (*1) |
--- | カタログコード 楽天カタログ検索API（CatalogSearch）の出力に含まれる (*1)検索キーワード、ジャンルID、カタログコードのいずれかが指定されていることが必須です。ただし、カタログコードが指定された場合、検索キーワード、ジャンルIDの指定は無効になります。 |
|
| 6 | 1ページあたりの取得件数 | hits | int | - | 30 | 1から30までの整数 | |
| 7 | 取得ページ | page | int | - | 1 | 1から100までの整数 | |
| 8 | ソート | sort | String | - | standard | +affiliateRate： アフィリエイト料率順（昇順） -affiliateRate： アフィリエイト料率順（降順） +reviewCount： レビュー件数順（昇順） -reviewCount： レビュー件数順（降順） +itemPrice： 価格順（昇順） -itemPrice： 価格順（降順） +updateTimestamp： 商品更新日時順（昇順） -updateTimestamp： 商品更新日時順（降順） standard： 楽天標準ソート順【NEW】 ※UTF-8でURLエンコードされている必要があります。 |
|
| 9 | 最小価格 | minPrice | long | - | 指定無し | 0以上の整数 | |
| 10 | 最大価格 | maxPrice | long | - | 指定無し | 0以上の整数 maxPriceはminPriceより大きい必要がある |
|
| 11 | 販売可能 | availability | int(1) | - | 1 | 0：すべての商品 1：販売可能な商品のみ |
|
| 12 | 検索フィールド | field | int(1) | - | 1 | 0：検索対象が広い（同じ検索キーワードでも多くの検索結果が得られる） 1：検索対象範囲が限定される（同じ検索キーワードでも少ない検索結果が得られる） |
|
| 13 | キャリア | carrier | int(1) | - | 0 | PC用の情報を返すのか、モバイル用の情報を返すのかを選択 PC: 0 mobile: 1 |
|
| 14 | 商品画像有無フラグ | imageFlag | int(1) | - | 0 | 0 : すべての商品を検索対象とする 1 : 商品画像ありの商品のみを検索対象とする |
|
| 15 | OR検索フラグ | orFlag | int(1) | - | 0 | 複数キーワードが設定された場合に、AND検索、OR検索のいずれかが選択可能。 0:AND検索 1:OR検索 ※ただし、(A and B) or Cといった複雑な検索条件設定は指定不可。 |
|
| 16 | 除外キーワード | NGKeyword | String | - | 指定無し | 検索結果から除外したいキーワード UTF-8でURLエンコードした文字列 |
|
| 17 | ジャンルごとの商品数取得フラグ | genreInformationFlag | int(1) | - | 0 | 0 :ジャンルごとの商品数の情報を取得しない 1 :ジャンルごとの商品数の情報を取得する |
|
