| 楽天ブックス総合検索API（BooksTotalSearch) 入力パラメーター version:2011-12-01 |
| 区分 |
ID |
項目名 |
フィールド名 |
型
(括弧内は
最大
バイト数） |
必須 |
デフォルト |
備考 |
共
通
パ
ラ
メ
|
タ
| |
1 |
デベロッパーID |
developerId |
String |
○ |
--- |
デベロッパーID |
| 2 |
アフィリエイトID |
affiliateId |
String |
- |
指定無し |
アフィリエイトID |
| 3 |
操作 |
operation |
String |
○ |
--- |
使用するAPIの操作名:BooksTotalSearch |
| 4 |
コールバック関数名 |
callBack |
String |
- |
--- |
JSONPとして出力する際のコールバック関数名
（UTF-8でURLエンコードした文字列）
英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上 |
サ
|
ビ
ス
固
有
パ
ラ
メ
|
タ
| |
1 |
検索キーワード |
keyword |
String |
○
(*1) |
--- |
UTF-8でURLエンコードした文字列
複数キーワードから検索したい場合は、半角スペースで区切って下さい
(*1)検索キーワード、楽天ブックスジャンルID、ISBNコード/JANコードのいずれかが指定されていることが必須です。 |
| 2 |
楽天ブックスジャンルID |
booksGenreId |
String |
○
(*1) |
000 |
楽天ブックスにおけるジャンルを特定するためのID
（楽天市場のジャンルIDとは違うので注意してください）
ジャンルのIDやジャンル名、ジャンルの親子関係を調べたい場合は、「楽天ブックスジャンル検索API(BooksGenreSearch)」をご利用ください。
(*1)検索キーワード、楽天ブックスジャンルID、ISBNコード/JANコードのいずれかが指定されていることが必須です。 |
| 3 |
ISBNコード/JANコード |
isbnjan |
String |
○
(*1)
(*2) |
--- |
※「-」ハイフンなどを取り除いた数字のみ13桁でリクエストしてください
(*1)検索キーワード、楽天ブックスジャンルID、ISBNコード/JANコードのいずれかが指定されていることが必須です。
(*2)ISBNコード/JANコードの入力があった場合、検索キーワードと楽天ブックスジャンルIDへの入力は無効となります |
| 4 |
バージョン |
version |
String |
○ |
--- |
2011-12-01 |
| 5 |
1ページあたりの取得件数 |
hits |
int |
- |
30 |
1から30までの整数 |
| 6 |
取得ページ |
page |
int |
- |
1 |
1から100までの整数 |
| 7 |
在庫状況 |
availability |
int(1) |
- |
0 |
0：すべての商品
1：在庫あり
2：3〜5営業日以内に発送予定
3：3〜7営業日以内に発送予定
4：7〜14営業日以内に発送予定
5：予約受付中
6：メーカーに在庫確認をいたします。 |
| 8 |
品切れ等購入不可商品表示フラグ |
outOfStockFlag |
int(1) |
- |
0 |
0：品切れや販売終了など購入不可の商品は結果に表示させない
1：品切れや販売終了など購入不可の商品を結果に表示させる |
| 9 |
チラよみフラグ |
chirayomiFlag |
int(1) |
- |
0 |
0：すべての商品
1：チラよみ対象商品で絞り込む |
| 10 |
ソート |
sort |
String |
- |
standard |
standard:標準
sales:売れている
+releaseDate:発売日(古い)
-releaseDate:発売日(新しい)
+itemPrice:価格が安い
-itemPrice:価格が高い
reviewCount:レビューの件数が多い
reviewAverage:レビューの評価(平均)が高い
※UTF-8でURLエンコードされている必要があります。 |
| 11 |
限定フラグ |
limitedFlag |
int(1) |
- |
0 |
0:すべての商品
1:限定版商品のみ
※限定版商品には期間限定・数量限定・予約限定などの商品が含まれます。 |
| 12 |
検索フィールド |
field |
int(1) |
- |
1 |
0:検索対象が広い（同じ検索キーワードでも多くの検索結果が得られる）
1:検索対象範囲が限定される（同じ検索キーワードでも少ない検索結果が得られる） |
| 13 |
キャリア |
carrier |
int(1) |
- |
0 |
PC用の情報を返すのか、モバイル用の情報を返すのかを選択
PC: 0
mobile: 1 |
| 14 |
OR検索フラグ |
orFlag |
int(1) |
- |
0 |
複数キーワードが設定された場合に、AND検索、OR検索のいずれかが選択可能。
0:AND検索
1:OR検索
※ただし、(A and B) or Cといった複雑な検索条件設定は指定不可。 |
| 15 |
除外キーワード(*3) |
NGKeyword |
String |
- |
指定無し |
検索結果から除外したいキーワード
UTF-8でURLエンコードした文字列
(*3)使用するには検索キーワードの入力が必須 |
| 16 |
ジャンルごとの商品数取得フラグ |
genreInformationFlag |
int(1) |
- |
0 |
0 :ジャンルごとの商品数の情報を取得しない
1 :ジャンルごとの商品数の情報を取得する |
