価格コム WEBサービス API マニュアル

バージョン:1.0
1.商品検索API
a.リクエストURL
http://api.kakaku.com/WebAPI/ItemSearch/Ver1.0/ItemSearch.aspx?パラメータ名=パラメータ値・・・
b.リクエストパラメータ
*ApiKey、Keywordの指定が必須となります。
パラメータ名 説明
ApiKey アクセスキー(1日の利用制限は5000回です)
Keyword 検索したいキーワード
ResultSet ヒットしたアイテムの取得したい属性をminiもしくはmediumで指定します。 mini/mediumに含まれる情報に関しては、リターンパラメータの項を参照ください。*指定のない場合はmediumとして検索されます。
CategoryGroup 検索対象のカテゴリを指定します。*指定の無い場合は全てのカテゴリから検索されます。
カテゴリ名パラメータ値
パソコン関連Pc
家電Kaden
カメラCamera
ゲームGame
楽器Gakki
自動車・バイクKuruma
スポーツ・レジャーSports
ブランド・腕時計Brand
ベビー・キッズBaby
ペットPet
ビューティー・ヘルスBeauty_Health
上記全てALL
SortOrder ソート並び順
pricerank :安い→高い
-pricerank :高い→安い
daterank :発売日順 (新しい→古い)
popularityrank : 人気順
*指定し無い場合は、人気順となります。
並び順の複数指定は、できません。
HitNum 取得する検索結果数
一度の検索で取得する検索結果数を1~20の間で指定します。*指定のない場合は5セットとなります。
PageNum ページ番号
何ページ目の結果リストが欲しいのかを指定します。*指定の無い場合は1ページ目が検索されます。
1200件を超えるページ指定はできません。1200件を超える場合は指定可能な最終ページが検索されます。
Charset 文字コード
sjis :SHIFT-JIS
utf8 :UTF-8
euc :EUC-JP
使用する文字コードを指定します。*指定し無い場合は、UTF-8として扱います。
MinPrice 最低金額
指定した金額以上の商品を検索します。*指定のない場合は金額の下限は無しとなります。
MaxPrice 最高金額
指定した金額以下の商品を検索します。*指定のない場合は金額の上限は無しとなります。
c.リターンパラメータ
ヒットした商品の情報をXML形式で返します。
※出力する文字コードはリクエストパラメータで指定した文字コードとなります。
パラメータ名 説明 データ型 対応ResultSet
NumOfResult ヒットしたアイテムの数
0件の場合はエラーコード”ItemNotFound”を返します。
Integer miniとmedium
ProductID プロダクトID String miniとmedium
ProductName 製品名 String miniとmedium
MakerName メーカー名 String miniとmedium
SaleDate 発売日
2008年1月1日などの文字列で返します。
String miniとmedium
Comment 製品に関するコメント
スペック情報の一部を返します。
String miniとmedium
CategoryName カテゴリ名 (トップカテゴリ>サブカテゴリ) String mediumのみ
PvRanking カテゴリ内での人気ランキング。
ランク外の場合は””(空文字)を返します。
Integer mediumのみ
TotalScoreAve 満足度
レビューのない場合は””(空文字)を返します。
Float mediumのみ
ImageUrl イメージのURL String mediumのみ
ItemPageUrl アイテムビューへのURL String miniとmedium
BbsPageUrl クチコミ掲示板へのURL String miniとmedium
ReviewPageUrl レビューページへのURL String miniとmedium
LowestPrice 最安価格(税込み)。
価格登録の無い場合は””(空文字)を返します。
Integer miniとmedium
NumOfBbs クチコミ掲示板書込み数
クチコミのない場合は””(空文字)を返します。
Integer miniとmedium
d.サンプル
リクエスト
http://api.kakaku.com/WebAPI/ItemSearch/Ver1.0/ItemSearch.aspx?Keyword=%e3%82%a2%e3%82%af%e3%82%aa%e3%82%b9&resultset=medium&categorygroup=kaden&pagenum=1&minprice=100000
&maxprice=150000&ApiKey=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
の場合。(KeyWordは、'アクオス'がUTF-8でエンコードされています)
結果
リクエスト
http://api.kakaku.com/WebAPI/ItemSearch/Ver1.0/ItemSearch.aspx?Keyword=%e3%82%a2%e3%82%af%e3%82%aa%e3%82%b9&resultset=mini&categorygroup=kaden&pagenum=1&minprice=100000
&maxprice=150000&ApiKey=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
の場合。(KeyWordは、'アクオス'がUTF-8でエンコードされています)
結果
e.エラー
エラーコード 内容
ItemNotFound 該当する商品がひとつもありませんでした。
TooManyItemsRequested 制限値を超えたアイテム数のリクエストがありました。
InvalidParameterValue パラメータの値が入っていないか、不正です。
No registration 登録されていないアクセスキーです。
Exceeded daily maximum 1日のアクセス制限を超えました。
Too many accesses 制限を超えたアクセスがありました。
Blocked IP address 禁止されているIPからのアクセスです。
InternalServerError サーバは、処理を完了できませんでした。
ItemNotFoundの場合

<?xml version="1.0" encoding="utf-8" ?>
<Error>
<Message>ItemNotFound</Message>
</Error>

TooManyItemsRequestedの場合

<?xml version="1.0" encoding="utf-8" ?>
<Error>
<Message>TooManyItemsRequested</Message>
</Error>

InvalidParameterValueの場合

<?xml version="1.0" encoding="utf-8" ?>
<Error>
<Message>InvalidParameterValue</Message>
</Error>

No registrationの場合

<?xml version="1.0" encoding="utf-8" ?>
<Error>
<Message>No registration</Message>
</Error>

Exceeded daily maximumの場合

<?xml version="1.0" encoding="utf-8" ?>
<Error>
<Message>Exceeded daily maximum</Message>
</Error>

Too many accessesの場合

<?xml version="1.0" encoding="utf-8" ?>
<Error>
<Message></Message>
</Error>

Blocked IP addressの場合

<?xml version="1.0" encoding="utf-8" ?>
<Error>
<Message>Blocked IP address</Message>
</Error>

InternalServerErrorの場合

<?xml version="1.0" encoding="utf-8" ?>
<Error>
<Message>InternalServerError</Message>
</Error>