ショッピング
コンテンツマッチアイテム
Version 1
リクエストURL
XML
http://shopping.yahooapis.jp/ShoppingWebService/
PHPserialize
http://shopping.yahooapis.jp/ShoppingWebService/
JSONP
http://shopping.yahooapis.jp/ShoppingWebService/
指定されたURLのコンテンツをキーワード、ブランド名、人物名の辞書を使い解析し、コンテンツにマッチする商品リストをダイナミックに返す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はエンコードする必要があります) |
| type | keyword(デフォルト)/ |
辞書選択。キーワード辞書、人物名辞書、ブランド名辞書を選べます。デフォルトはキーワード辞書。 例:コンテンツにマッチするブランド商品を出力したい場合は、type=brand。 |
| hits | integer | 一回のリクエストで取得する商品情報数の指定。デフォルトは6件で最大6件まで取得可能。 例:hits=1で1件の商品情報を取得。 |
| store_id | string | ストアのID、http://store.shopping.yahoo.co.jp/○○○○/index.htmlの○○○○の部分。指定ストア内の商品を絞り込みます。 |
| responsegroup | small(デフォルト)/ |
取得できるデータのサイズを指定します。smallが最小、最速です。詳細はレスポンスフィールドに記載があります。 |
| affiliate_from | デフォルト:0.0 | アフィリエイト料率指定(最低料率)した料率以上を検索する。 例:affiliate_from=2.5 |
| affiliate_to | デフォルト:100.0 | アフィリエイト料率指定(最高料率)した料率未満を検索する。 例:affiliate_to=3.3 |
サンプルリクエストURL
http://shopping.yahooapis.jp/ShoppingWebService/V1/contentMatchItem?※タイムアウトやコンテンツの読み込みができなかった場合、Yahoo!ショッピングのおすすめ順で商品情報を返します。精度向上とタイムアウト回避のためにコンテンツ解析タグの埋め込みを推奨しております。対応しているコンテンツ解析タグとクローラーについて、詳しくはこちらをご覧ください
レスポンスフィールド
コンテンツマッチアイテムWeb APIのスキーマの記述は、以下のURLをご覧ください。
http://shopping.yahooapis.jp/ShoppingWebService/V1/contentMatchItem.xsd
| フィールド | 説明 |
| ResultSet(small) | クエリーレスポンスのすべてを含み、次の属性を持ちます。
|
| Url(small) | リクエストしたURL |
| Hit(small) | 検索された結果
|
| Url(small) | 商品URL |
| Name(small) | 商品名 |
| Description(medium) | 商品説明 |
| Headline(small) | キャッチコピー |
| Availability(large) | 購入できるか (instock/outofstock) |
| Code(medium) | 商品コード |
| PersonId(large) | 人物ID |
| ProductId(large) | 製品ID |
| JanCode(medium) | JANコード |
| IsbnCode(large) | ISBN(書籍コード) |
| Model(large) | 型番 |
| Id(large) | ストアID |
| Url(large) | ストアURL |
| Name(large) | ストア名 |
| IsBestStore(large) | ベストストアかどうか (true/false) |
| Rate(large) | ストア評価【0.0-5.0】まで0.5刻み |
| Count(large) | 評価人数 |
| Id(small) | 商品画像ID |
| Small(small) | 76×76サイズの商品画像URL |
| Medium(medium) | 146×146サイズの商品画像URL |
| Id(large) | ストア画像ID |
| Medium(large) | 120×30サイズのストア画像URL |
| Rate(large) | アフィリエイト料率 0.1刻み |
| Count(medium) | レビュー保持数 |
| Rate(medium) | レビュー平均評価 |
| Url(medium) | レビューページへのURL/アフィリエイトURL |
| Price(small) | 価格
|
| PriceLabel(small) | 表示価格
|
| FixedPrice(small) | 定価 |
| SalePrice(small) | セール価格 |
| Id(large) | 現在のカテゴリIDまでのルートからのパス構造 |
| Name(large) | ブランド名 |
| Id(larege) | 現在のブランドIDまでのルートからのパス構造 |
| Amount(medium) | ポイント数 |
| Times(medium) | ポイント倍率 |
| Method(large) | 支払い情報 |
| Code(large) | 1=クレジットカード、2=銀行振込、4=商品代引、8=郵便振替、16=Yahoo!ウォレット、32=モバイルSuica、64=コンビニ支払い、128=ペイジー(対応する決済方法をbitwise論理和で表記) 例:クレジットカード、銀行振込、商品代引のみ可能なストアの場合、1+2+4=7でエレメントには7がレスポンスされます |
| Name(large) | クレジットカード、銀行振込、商品代引、郵便振替、Yahoo!ウォレット登録のクレジットカード、モバイルSuica、コンビニ支払い、ペイジー |
| Code(medium) |
条件コード 1=設定なし 2=送料無料 3=条件付送料無料 |
| Name(medium) | テキストで以下のいずれかの値 設定なし/送料無料/条件付送料無料 |
サンプルレスポンス
以下は、Yahoo!ショッピングの特集ページURLの、リクエストに対するレスポンスです。
エラー
コンテンツマッチアイテムWeb APIはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。
利用制限
※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を解除させていただきます。(無料)
まずはヘルプページのお問い合わせフォームからご相談ください。