楽天オークション商品検索API リクエストの作成
リクエストURLの作成
基本URLに検索したいパラメータを追加していけば、URLを作成することができます。作成したURLをブラウザに入力すれば応答が返ってくるので、正常に動作しているか確認することができます。
関連ページ XML構造 サンプルコード
サンプル リクエストURL
http://api.rakuten.co.jp/rws/1.10/rest? developerId=★★&affiliateId=◆◆ &operation=AuctionItemSearch&version=2007-12-13 &keyword=web
「web」というキーワードで検索するURLです。★★にはデベロッパーIDを、◆◆には、アフィリエイトIDを入れます。サンプルURLは改行されていますが、実際には改行せずに使用します。
リクエストURLをブラウザに入力し、エラーなどが表示されなければ、OKです。
10,000円未満の商品を指定する場合
上記のURLに 「&maxPrice=10000」 を付け足します。
このようにパラメータを追加することで、検索条件を追加することができます。
アフィリエイトID
アフィリエイトIDについては、アフィリエイトIDの説明を参照下さい。
リクエストパラメータ
リクエストパラメータの一覧です。ここからのコピー
コードに関しては、サンプルコードで説明しています。
| 楽天オークション商品検索API（AuctionItemSearch) 入力パラメーター version:2007-12-13 | |||||||
| 区分 | ID | 項目名 | フィールド名 | 型 (括弧内は 最大 バイト数） |
必須 | デフォルト | 備考 |
| 共 通 パ ラ メ | タ | |
1 | デベロッパーID | developerId | String | ○ | --- | デベロッパーID |
| 2 | アフィリエイトID | affiliateId | String | - | 指定無し | アフィリエイトID | |
| 3 | 操作 | operation | String | ○ | --- | 使用するAPIの操作名:AuctionItemSearch | |
| 4 | コールバック関数名 | callBack | String | - | --- | JSONPとして出力する際のコールバック関数名 （UTF-8でURLエンコードした文字列） 英数字、「.(ドット)」、「_(アンダーバー)」、「[(中括弧)」、「](中括弧)」のいずれか1文字以上 |
|
| サ | ビ ス 固 有 パ ラ メ | タ | |
1 | 検索キーワード | keyword | String | ○ (*1) |
--- | UTF-8でURLエンコードした文字列 (*1)検索キーワード、ジャンルIDのいずれかが指定されていることが必須です |
| 2 | バージョン | version | String | ○ | --- | 2007-12-13 | |
| 3 | ジャンルID | genreId | long | ○ (*1) |
--- | 楽天オークションにおけるジャンルを特定するためのID。 ジャンル名、ジャンルの親子関係を調べたい場合は、「楽天ジャンル検索API(GenreSearch)」をご利用ください。 (*1)検索キーワード、ジャンルIDのいずれかが指定されていることが必須です |
|
| 4 | 1ページあたりの取得件数 | hits | int | - | 30 | 1から30までの整数 | |
| 5 | 取得ページ | page | int | - | 1 | 1から100までの整数 | |
| 6 | 最低入札価格 | minPrice | long | - | 指定無し | 0以上の整数 | |
| 7 | 最高入札価格 | maxPrice | long | - | 指定無し | 0以上の整数 maxPriceはminPriceより大きい必要がある | |
| 8 | ソート | sort | String | - | +endTime | +endTime: 残り時間順（昇順） -endTime: 残り時間順（降順） +itemPrice: 現在価格順（昇順） -itemPrice: 現在価格順（降順） +bidCount: 入札件数順（昇順） -bidCount: 入札件数順（降順） +affiliateRate: アフィリエイト料率順（昇順） -affiliateRate: アフィリエイト料率順（降順） ※UTF-8でURLエンコードされている必要があります。 |
|
| 9 | 即落フラグ | blowFlag | int(1) | - | 0 | 0:すべての商品を検索対象とする 1:即落商品のみ検索対象とする ※即落商品とは、オークションの入札期間終了を待たずに即落札することが可能な商品のことです。 |
|
| 10 | 対象商品識別フラグ | itemType | int(1) | - | 0 | 0:すべての商品を検索対象とする 1:個人の出品商品のみ検索対象とする 2:楽天市場店舗の出品商品のみ検索対象とする 3:楽オク事業者の出品商品のみ検索対象とする (複数指定可) |
|
| 11 | 商品状態フラグ | newFlag | int(1) | - | 0 | 0:すべて 1:中古のみ 2:新品のみ |
|
| 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エンコードした文字列 |
|
