ログイン
IDでもっと便利に[ 新規取得 ]

ショッピング

商品関連付け 商品情報検索

Version 1

リクエストURL

JSONP

http://shopping.yahooapis.jp/ShoppingWebService/V1/json/urlItemMatchSearch

商品関連付け 商品情報検索APIは、URLに対して任意の商品を関連付ける為の商品検索と、商品情報登録に必要な署名(signature)を発行します。
発行した署名(signature)は、商品関連付け 商品情報登録APIにて使用します。

リクエストパラメータ

RESTリクエストの構築(GET)」をご参照ください。

パラメータ 説明
appid
(必須)
string アプリケーションID。詳細はこちらをご覧ください。
affiliate_type yid/vc Yahoo! JAPANアフィリエイト(yid)とバリューコマースアフィリエイト(vc)の選択。
例:affiliate_type=yid
affiliate_id string Yahoo! JAPANアフィリエイトIDもしくは、バリューコマースアフィリエイトIDを入力。
callback string JSONPとして出力する際のコールバック関数名を入力する為のパラメータ。UTF-8でエンコードした文字列を入力する。
url
(必須)
string 商品を登録したいURL(要URLエンコード)
最大128byte。GETパラメータは含めない
query
(必須)
string 検索キーワード(要UTF-8 エンコード) 最大64byte
category_id integer ジャンルカテゴリID 検索対象のカテゴリID絞り込み
results integer 取得件数、取得する検索結果数の指定 デフォルト値は10件、最大値は50件
start integer 取得開始位置、ヒットした商品のうち、何件目から表示させるか(1件目は1)

サンプルリクエストURL

http://shopping.yahooapis.jp/ShoppingWebService/V1/json/urlItemMatchSearch?appid=<あなたのアプリケーションID>&url=http%3A%2F%2Fshopping.yahoo.co.jp%2F&query=vaio

レスポンスフィールド

フィールド 説明
totalResultsAvailable検索数HIT数
totalResultsReturned返された値の個数
firstResultPosition最初のデータが何個目にあたるか(最初=1)
Query 検索したキーワード
Url 登録するURL
Start 署名有効開始時間
2004-04-01T12:00:00+09:00 RFC3339に準拠
End 署名有効終了時間
2004-04-01T12:00:00+09:00 RFC3339に準拠
index 数字 検索結果の番号
Signature 署名
Code 商品コード
Name 商品名
Url 商品URL
Headline 商品のキャッチコピー
Id 画像ID
Url 76px×76px画像のURL
Width 画像の横幅 数字(px単位)
Height 画像の高さ 数字(px単位)
Url 146px×146px画像のURL
Width 画像の横幅 数字(px単位)
Height 画像の高さ 数字(px単位)
currency 通貨
通貨表記(ISO 4217)
Price 現在価格
数字(現在価格を表示、セール期間中の場合はセール価格、それ以外は販売価格)
taxIncluded 税込み価格かどうか
true(税込み) false(税込みじゃない)
FixedPrice 定価
数字(商品のオリジナル価格)
SalePrice セール価格
数字(セール期間中の価格)
Id ストアID
Name ストア名
Url ストアURL

サンプルレスポンス

以下は、url=http%3A%2F%2Fshopping.yahoo.co.jp%2F, callback=loaded, query=vaioでリクエストした場合のレスポンスです。

エラー

商品関連付け 商品情報検索Web APIはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。

利用制限

※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を解除させていただきます。(無料)
まずはヘルプページのお問い合わせフォームからご相談ください。

開発者ブログ

Yahoo! JAPANのスタッフや著名なデベロッパーのブログを紹介しています。新しいサービスのアイデアにお役立てください。

開発者コミュニティ

Yahoo!グループに開発者のためのグループを用意しています。ほかのデベロッパーと交流し、質問やアイデアの共有にお役立てください。

法人デベロッパー専用お問い合わせ