COMMERCE_SERP に site rakuten を指定すると検索結果の商品をストアの順に受け取り、COMMERCE_PRODUCT に商品の url を渡すとその商品を 1 つ読み取ります。完了した検索または商品ページ 1 件につき 0.5 クレジットです。
検索
GET /v1/async/task/{id} をポーリングするか Webhook で受け取ります。非同期タスクを参照してください。
パラメータ
site: 必須。rakutenです。query: 必須。検索語で、1-500 文字です。limit: 任意の整数、1-40。デフォルトは 20 です。country: 任意。デフォルトはストアの国のJPです。ほかの国は422 REGION_UNSUPPORTEDで拒否されます。
include は省略してください。include: {} でも、クレジットを確保する前に payload.include の 422 VALIDATION_ERROR を返します。
レスポンス例
結果フィールド
site、query、countryはリクエストの値です。returnedCountはproductsの件数です。- 各商品は
rank、productId、title、urlを含みます。productIdは商品ページのショップ ID と商品 ID をつないだshop:itemです。rankはストアのデフォルトの並び順で、ストアが広告と表示した商品は除きます。 price、rating、reviewCount、imageUrlは、検索結果の画面に表示されている場合に含みます。priceは商品ごとのcurrency(ISO 4217)の数値で、容量ごとに価格が異なる場合は最も低い価格です。ratingは 5 点満点です。 999+ のように省略表示されたレビュー数は含みません。- 検索ごとに、ストアの検索結果の 1 ページ目から商品を取得します。
商品ページ
パラメータ
url: 必須。楽天市場の商品ページで、2,048 文字以内です。形式はitem.rakuten.co.jp/{shop}/{item}/です。検索結果の商品urlはそのまま渡せます。トラッキングコードなど結果に影響しないパラメータは読み取り前に取り除きます。country: 任意。デフォルトはページの国のJPです。ほかの国は422 REGION_UNSUPPORTEDで拒否されます。
include は省略してください。include: {} でも、クレジットを確保する前に payload.include の 422 VALIDATION_ERROR を返します。
レスポンス例
結果フィールド
site、country、url、productIdでページを識別します。urlは読み取ったページで、productIdは検索結果の ID と同じです。titleは常に含みます。price、currency、inStock、seller、rating、reviewCount、images、description、descriptionImages、options、categories、gtinは、ページに表示されている場合に含みます。priceは、クーポンと送料を適用する前にページが最初に表示する購入価格で、currency(ISO 4217)の値です。inStockは在庫の有無です。sellerは販売者です。ratingは小数第 2 位までの 5 点満点の評価です。reviewCountはレビュー数です。imagesは商品ギャラリーの写真を、ページの順に最大 30 枚含みます。販売者がギャラリーに入れたバナーやお知らせも含まれます。descriptionは段落ごとに 1 行のプレーンテキストで、最大 10,000 文字です。画像の中にしかない文字は含みません。descriptionImagesは商品説明の画像を、ページの順に最大 300 枚含みます。販売者が説明に入れたバナーやお知らせも含まれ、画像の中の文字は読み取りません。optionsはサイズや色などの選択肢を最大 20 個、選択肢ごとにvaluesを最大 100 個含みます。ほかのフィールドは、ページが最初に選択している選択肢のものです。categoriesは最も広いカテゴリから最も狭いカテゴリまでの、最大 10 階層です。gtinはページに記載された UPC、EAN、JAN です。
エラーと課金
- 商品が 1 つもない検索は、失敗したタスクとして終了します。
- ストアが 404 または 410 で応答する商品ページ(削除された商品など)は
PAGE_UNAVAILABLEで終了し、メッセージにストアの応答が入ります。ストアが 403、412、429、435 で読み取りを拒否した場合、タスクは待機して最大 6 分間再試行します。ほかの読み取り失敗と、それより長く続く拒否はENGINE_NO_RESULTで終了します。 - 課金は完了したタスクだけで、検索または商品ページ 1 件につき 0.5 クレジットです。