レビュー検索API
レビュー検索APIとは、商品レビューサイトconecoクラブで、ユーザが書き込みを行った商品のレビュー情報を検索するためのAPIです。
カテゴリID、conecoクラブでのユーザIDなど、様々な条件を指定しての商品レビューが取得することが可能になります。
リクエストURL
- XML形式
- http://api.coneco.net/cws/v1/SearchReviews?apikey=***&userId=19
- JSON or JSONP形式
- http://api.coneco.net/cws/v1/SearchReviews_json?apikey=***&userId=19&callback=method
入力パラメータ
レビュー検索APIでの指定可能なパラメータの一覧です。
| 項目名 | フィールド名 | 型 | 必須 | デフォルト | 備考 |
|---|---|---|---|---|---|
| APIキー | apikey | String | ○ | - | 各ユーザごとのAPIキー |
| 商品ID | comId | integer | ※1 | - | 商品固有のIDを指定する。（「,」区切りで20個まで指定可能） |
| カテゴリID | categoryId | integer | ※1 | - | カテゴリ検索APIで取得したカテゴリを指定します。（categoryId=0で、全カテゴリを取得します。） |
検索キーワード | keyword | String | ※1 | - | 商品名を指定して検索を行います。 複数キーワードのAND検索を行うには入力するには各キーワードごとに半角スペースを入れてください。 尚、商品名はUTF-8でURLエンコードされている必要があります。 |
| or検索フラグ | integer | String | 0 | keyword半角スペースで区切られた各キーワードをorで検索します。（何も入れないとAND検索になります） ※検索条件にkeywordを指定したときのみ有効。
|
ユーザID | userId | integer | ※１ | - | conecoクラブでのユーザIDを指定します。※2 |
| ページ番号 | page | integer | ページ送りを行いたい場合に指定する。 | ||
| 表示件数 | count | integer | 20 | 1リクエストでの表示件数を指定する。（最大20件） | |
| ソート順 | sort | String | comId | 並び順を指定します。
|
|
| コールバック関数 | callback | String | JSONP形式の場合のみ使用する、コールバック関数。 |
※1. 商品ID、カテゴリID、検索キーワード、ユーザIDのうちいずれかひとつは必ず指定する必要があります。
※2. 自分のユーザIDを確認したい場合は、conecoクラブのマイページより設定変更を選択し、「自分の公開ページURL」欄の「http://club.coneco.net/user/19/index.htm」の「/user」の後ろの数値(この場合は19)が自分のユーザIDとなります。
出力パラメータ
商品検索API使用時の結果一覧です。
| 項目名 | フィールド名 | 型 | 備考 |
|---|---|---|---|
| 共通ヘッダ | |||
| APIバージョン | APIVersion | String | APIのバージョンを表します |
| ページ情報 | Page | 検索結果のページの情報を表します。 | |
| 該当件数 | Count | integer | 検索結果の該当件数を表します |
| 表示件数 | Size | integer | 1リクエスト当たりの表示件数を表します。（最大２０件） |
| 現在のページ数 | Current | integer | 検索結果の何ページ目か表します。 |
| 総ページ数 | PageCount | integer | 検索結果の総ページ数を表します。 |
| 入力条件 | Condition | 入力条件より得られる情報を表します。 | |
| 入力カテゴリ | Category | 検索条件にカテゴリIDを指定した場合、そのカテゴリ自体の情報を表します。 | |
| カテゴリID | Id | integer | カテゴリIDを表します。 |
| カテゴリ名 | Name | String | カテゴリ名称を表します。 |
| カテゴリURL | Url | String | カテゴリごとのURLを表します。 |
| 状態 | Status | String | APIの問合せ結果をメッセージで返します。 |
| サービス固有パラメータ | |||
| 商品ID | ComId | integer | coneco.net固有の商品のIDを表します。 |
| 商品名 | Name | String | coneco.netでの商品名を表します。 |
| 大カテゴリ | TopCategory | Level=1のカテゴリを表します。 | |
| カテゴリID | Id | integer | カテゴリIDを表します。 |
| カテゴリ名 | Name | String | カテゴリ名称を表します。 |
| カテゴリURL | Url | String | カテゴリごとのURLを表します。 |
| 中カテゴリ | MiddleCategory | Level=2のカテゴリを表します。 | |
| カテゴリID | Id | integer | カテゴリIDを表します。 |
| カテゴリ名 | Name | String | カテゴリ名称を表します。 |
| カテゴリURL | Url | String | カテゴリごとのURLを表します。 |
| カテゴリ | Category | Level=3のカテゴリを表します。 | |
| カテゴリID | Id | integer | カテゴリIDを表します。 |
| カテゴリ名 | Name | String | カテゴリ名称を表します。 |
| カテゴリURL | Url | String | カテゴリごとのURLを表します。 |
| 商品画像URL | ImageUrl | String | 商品画像を表すURL |
| 商品画像URL（小） | SmallImageUrl | String | 商品画像を表すURL |
| メーカー名 | Manufacturer | String | 製造メーカーを表します。 |
| 商品レビュー情報 | Review | 個別の商品レビュー | |
| レビューID | Id | integer | レビュー固有のIDを表します。 |
| ユーザID | UserId | integer | レビューを投稿したユーザのIDを表します。 |
| レビュータイトル | Summary | String | レビューのタイトルを表します。 |
| レビューURL | Url | String | レビューのURLを表します。 |
| ユーザページ | AuthorUrl | String | レビューを書いた人のconecoクラブでのマイページのURLを表します。 |
| 良い点 | Pros | String | 商品の良い点を表します。 |
| 悪い点 | Cons | String | 商品の悪い点を表します。 |
| 満足度 | OverallRating | integer | レビューごとの総合評価を表します。 |
| レビュー内容 | Description | String | レビュー本文を表します。（最大全角150文字） |
| 購入情報 | Purchase | ||
| 購入金額 | Price | int | ユーザがレビュー対象の商品を購入した金額を表します。 |
| 購入日時 | Date | String | ユーザがレビュー対象の商品を購入した日時を表します。 |
| 作成日 | Created | String | レビュー作成日時 |
| レビュー評価 | Ratings | ||
| 項目ごとの評価 | Rating | String | title(項目)：レビューごとの商品の評価項目を表します。 |
| String | 値：レビューごとの評価項目ごとの評価を5段階で表します。 | ||
サンプル出力
検索条件：ユーザID「19」が書いたレビューの一覧を取得する。
http://api.coneco.net/cws/v1/SearchReviews?apikey=******&userId=19&count=1
<?xml version="1.0" encoding="UTF-8"?>
<ItemInfos xmlns="http://api.coneco.net/cws/v1/">
<Header>
<APIVersion>1.4.5</APIVersion>
<Page>
<Count>9</Count>
<Size>1</Size>
<Current>1</Current>
<PageCount>9</PageCount>
</Page>
<Condition>
</Condition>
<Status>Success</Status>
</Header>
<ItemInfo>
<Item>
<ComId>1071103001</ComId>
<Name>MacBook Pro 2.2GHz MA895J/A (15.4インチ)</Name>
<TopCategory>
<Id>1</Id>
<Name>パソコン・周辺機器</Name>
<Url>http://www.coneco.net/top_pchard.html</Url>
</TopCategory>
<MiddleCategory>
<Id>10120</Id>
<Name>ノートパソコン</Name>
<Url>http://www.coneco.net/mid/10120.html</Url>
</MiddleCategory>
<Category>
<Id>1012020</Id>
<Name>ノートパソコン(Mac)</Name>
<Url>http://www.coneco.net/idx/01012020.html</Url>
</Category>
<ImageUrl>http://img.coneco.net/co/1071103001.gif</ImageUrl>
<SmallImageUrl>http://img.coneco.net/co/s/1071103001s.gif</SmallImageUrl>
<Manufacturer>Apple/アップル</Manufacturer>
</Item>
<Reviews>
<Review>
<Id>5093</Id>
<UserId>19</UserId>
<Summary>ストレスを感じることなく使用できるMac</Summary>
<Url>http://club.coneco.net/user/19/review/5093/</Url>
<AuthorUrl>http://club.coneco.net/user/19/</AuthorUrl>
<Pros>ストレスを感じさせないマシンパワーがある。あと、Leopardプレインストール</Pros>
<Cons>キーボードとタッチパットは相変わらず使いづらい</Cons>
<OverallRating>5</OverallRating>
<Description>これが本当にノートPCでいいの？というぐらいの、マシンパワーとWindowsとは比べ物にならないほど洗練されたMacOS X Leopard（10.5）が一緒になってます。さすがMacというべきか、Windowやフォルダ操作など細かいところまで手が行き届いているため、どんな操作一つを取ってみてもスト</Description>
<Purchase>
<Price>259000</Price>
<Date>2007/11/27</Date>
</Purchase>
<Created>2007-11-29 17:03</Created>
<Ratings>
<Rating title="スペック">5</Rating>
<Rating title="デザイン">3</Rating>
<Rating title="使いやすさ">4</Rating>
<Rating title="携帯性">2</Rating>
<Rating title="価格">3</Rating>
</Ratings>
</Review>
</Reviews>
</ItemInfo>
</ItemInfos>
