オークション
コンテンツマッチアイテム
リクエストURL
XML
http://auctions.yahooapis.jp/AuctionWebService/V1/contentsMatchItem
PHPserialize
http://auctions.yahooapis.jp/AuctionWebService/V1/contentsMatchItem
JSONP
http://auctions.yahooapis.jp/AuctionWebService/V1/contentsMatchItem
こちらのAPIは、2015年11月26日に終了致しました。
※PHPserialize、JSONPのリクエストURLは非推奨です。outputパラメータを利用してください。
指定したコンテンツにマッチしたオークション情報を取得できるAPIです。
リクエストパラメータ
「RESTリクエストの構築(GET)」および、「RESTリクエストの構築(POST)」をご参照ください。
パラメータ | 値 | 説明 |
---|---|---|
appid(必須) | string | アプリケーションIDです。詳細はこちらをご覧ください。 |
output | string |
XML、PHPserialize、JSONPでレスポンスの出し別けを行います。
|
callback | string | JSONPとして出力する際のコールバック関数名を入力するためのパラメータです。UTF-8でエンコードした文字列を入力します。 |
type(必須) | string | 解析方法を指定します。(url : URLより解析 sentence : 文章より解析) |
url | string | コンテンツマッチ解析対象のURLです。URLエンコードが必要です。typeでurlを指定したときに入力してください。 |
sentence | string | コンテンツマッチ解析対象の文章です。typeでsentenceを指定したときに入力してください。 |
category | integer | カテゴリIDです。強制的にこのカテゴリに出品されているオークションを絞り込みたい場合に使用します。全カテゴリを対象としたい場合は、0を指定してください。 |
results | integer | 1回のリクエストで取得するオークションの件数です。1から6まで指定可能で、指定のない場合は6件とします。 |
サンプルリクエストURL
http://auctions.yahooapis.jp/AuctionWebService/V1/contentsMatchItem?レスポンスフィールド
コンテンツマッチアイテムAPIのスキーマの記述は、以下になります。
フィールド | 説明 |
---|---|
/ResultSet | クエリーレスポンスのすべてを含みます。
|
/ResultSet/Result | 各個別レスポンスを含みます。 |
/ResultSet/Result/AuctionId | 商品(オークション)のIDです。 |
/ResultSet/Result/Title | 商品(オークション)のタイトルです。 |
/ResultSet/Result/ItemUrl | 商品詳細を取得するリクエストURLです。(appidは含まれていませんのでご注意ください) |
/ResultSet/Result/AuctionItemUrl | 商品(オークション)のURLです。 |
/ResultSet/Result/Image | 画像(サムネイル)の情報です。 |
/ResultSet/Result/Image/Url | 画像(サムネイル)のURLです。 |
/ResultSet/Result/Image/Width | 画像(サムネイル)の幅です。 |
/ResultSet/Result/Image/Height | 画像(サムネイル)の高さです。 |
/ResultSet/Result/CurrentPrice | 現在価格です。\記号やカンマは含みません。小数第二位までの精度です。 |
/ResultSet/Result/Bids | 現在の入札数です。 |
/ResultSet/Result/EndTime | 終了予定日時です。RFC3339に準拠した表現を用います。(例:2004-04-01T12:00:00+09:00) |
/ResultSet/Result/BidOrBuy | 即決価格です。(設定されていない場合は要素なし) |
/ResultSet/Result/IsReserved | 最低落札価格の有無です。(あり:true なし:false) |
/ResultSet/Result/Option | 商品(オークション)に設定されているオプション情報です。 |
/ResultSet/Result/Option/NewIconUrl | 「New」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Option/StoreIconUrl | 「ストア」アイコンのURLです。 (設定されていない場合は要素なし) |
/ResultSet/Result/Option/CheckIconUrl | 「鑑定済み」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Option/PublicIconUrl | 「官公庁オークション」アイコンのURLです。 (設定されていない場合は要素なし) |
/ResultSet/Result/Option/FeaturedIconUrl | 「注目のオークション」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Option/FreeshippingIconUrl | 「送料無料」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Option/NewItemIconUrl | 「新品」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Option/WrappingIconUrl | 「贈答品」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Option/BuynowIconUrl | 「即決価格」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Option/EasyPaymentIconUrl | 「Yahoo!かんたん決済」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Option/GiftIconUrl | 「目立ち」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Option/StarClubIconUrl | 「スタークラブ限定セール」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Option/PointIconUrl | 「Tポイント」アイコンのURLです。(設定されていない場合は要素なし) |
/ResultSet/Result/Option/IsBold | 太字設定の有無です。(あり:true なし:false) |
/ResultSet/Result/Option/IsBackGroundColor | 背景色設定の有無です。(あり:true なし:false) |
/ResultSet/Result/Option/IsOffer | 値下げ交渉設定の有無です。(あり:true なし:false) |
サンプルレスポンス
<?xml version="1.0" encoding="UTF-8" ?> <ResultSet xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:yahoo:jp:auc:contentsMatchItem" xsi:schemaLocation="urn:yahoo:jp:auc:contentsMatchItem http://auctions.yahooapis.jp/AuctionWebService/V1/contentsMatchItem.xsd" totalResultsAvailable="1" totalResultsReturned="1" firstResultPosition="1"> <Result> <AuctionId>1359200</AuctionId> <Title>hogehoge</Title> <ItemUrl>http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem?auctionID=1359200</ItemUrl> <AuctionItemUrl>http://page.auctions.yahoo.co.jp/jp/auction/1359200</AuctionItemUrl> <Image> <Url>http://a1017.lm.a.yimg.com/7/1017/1783/000/f03batchimg.auctions.yahoo.co.jp/users/5/2/7/1/xxxxx-thumb1208052000152677.jpg</Url> <Width>75</Width> <Height>75</Height> </Image> <CurrentPrice>9999.00</CurrentPrice> <Bids>0</Bids> <EndTime>2008-11-23T16:49:25+09:00</EndTime> <BidOrBuy>20000.00</BidOrBuy> <IsReserved>true</IsReserved> <Option> <NewIconUrl>http://image.auctions.yahoo.co.jp/i/auctions/new3.gif</NewIconUrl> <EscrowIconUrl>http://image.auctions.yahoo.co.jp/images/uketorigo.gif</EscrowIconUrl> <NewItemIconUrl>http://image.auctions.yahoo.co.jp/images/gift/c_attention_01.gif</NewItemIconUrl> <YBankIconUrl>http://i.yimg.jp/images/sicons/bank16.gif</YBankIconUrl> <WrappingIconUrl>http://image.auctions.yahoo.co.jp/images/wrapping.gif</WrappingIconUrl> <BuynowIconUrl>http://image.auctions.yahoo.co.jp/images/buynow.gif</BuynowIconUrl> <EasyPaymentIconUrl>http://img.yahoo.co.jp/images/pay/icon_s16.gif</EasyPaymentIconUrl> <GiftIconUrl>http://a1017.lm.a.yimg.com/7/1017/1783/000/image.auctions.yahoo.co.jp/images/gift/c_attention_04.gif</GiftIconUrl> <IsBold>true</IsBold> <IsBackGroundColor>true</IsBackGroundColor> </Option> </Result> </ResultSet>
サンプルレスポンス(PHPserialize)
array ( 'ResultSet' => array ( 'totalResultsAvailable' => '1', 'totalResultsReturned' => '1', 'firstResultPosition' => '1', 'Result' => array ( 'AuctionId' => '1359200', 'Title' => 'hogehoge', 'ItemUrl' => 'http://auctions.yahooapis.jp/AuctionWebService/V2/auctionItem?auctionID=1359200', 'AuctionItemUrl' => 'http://page.auctions.yahoo.co.jp/jp/auction/1359200', 'Image' => array ( 'Url' => 'http://a1017.lm.a.yimg.com/7/1017/1783/000/f03batchimg.auctions.yahoo.co.jp/users/5/2/7/1/xxxxx-thumb1208052000152677.jpg', 'Width' => '75', 'Height' => '75', ), 'CurrentPrice' => '9999.00', 'Bids' => '0', 'EndTime' => '2008-11-23T16:49:25+09:00', 'BidOrBuy' => '20000.00', 'IsReserved' => true, 'Option' => array ( 'NewIconUrl' => 'http://image.auctions.yahoo.co.jp/i/auctions/new3.gif', 'EscrowIconUrl' => 'http://image.auctions.yahoo.co.jp/images/uketorigo.gif', 'NewItemIconUrl' => 'http://image.auctions.yahoo.co.jp/images/gift/c_attention_01.gif', 'YBankIconUrl' => 'http://i.yimg.jp/images/sicons/bank16.gif', 'WrappingIconUrl' => 'http://image.auctions.yahoo.co.jp/images/wrapping.gif', 'BuynowIconUrl' => 'http://image.auctions.yahoo.co.jp/images/buynow.gif', 'EasyPaymentIconUrl' => 'http://img.yahoo.co.jp/images/pay/icon_s16.gif', 'GiftIconUrl' => 'http://a1017.lm.a.yimg.com/7/1017/1783/000/image.auctions.yahoo.co.jp/images/gift/c_attention_04.gif', 'IsBold' => true, 'IsBackGroundColor' => true, ), ), ), )
サンプルレスポンス(JSONP)
loaded( { "ResultSet": { "@attributes": { "totalResultsAvailable":"1", "totalResultsReturned":"1", "firstResultPosition":"1" }, "Result": { "AuctionId":"1359200", "Title":"hogehoge", "ItemUrl":"http:\/\/auctions.yahooapis.jp\/AuctionWebService\/V2\/auctionItem?auctionID=1359200", "AuctionItemUrl":"http:\/\/page.auctions.yahoo.co.jp\/jp\/auction\/1359200", "Image": { "Url":"http:\/\/a1017.lm.a.yimg.com\/7\/1017\/1783\/000\/f03batchimg.auctions.yahoo.co.jp\/users\/5\/2\/7\/1\/xxxxx-thumb1208052000152677.jpg", "Width":"75", "Height":"75" }, "CurrentPrice":"9999.00", "Bids":"0", "EndTime":"2008-11-23T16:49:25+09:00", "BidOrBuy":"20000.00", "IsReserved":true, "Option": { "NewIconUrl":"http:\/\/image.auctions.yahoo.co.jp\/i\/auctions\/new3.gif", "EscrowIconUrl":"http:\/\/image.auctions.yahoo.co.jp\/images\/uketorigo.gif", "NewItemIconUrl":"http:\/\/image.auctions.yahoo.co.jp\/images\/gift\/c_attention_01.gif", "YBankIconUrl":"http:\/\/i.yimg.jp\/images\/sicons\/bank16.gif", "WrappingIconUrl":"http:\/\/image.auctions.yahoo.co.jp\/images\/wrapping.gif", "BuynowIconUrl":"http:\/\/image.auctions.yahoo.co.jp\/images\/buynow.gif", "EasyPaymentIconUrl":"http:\/\/img.yahoo.co.jp\/images\/pay\/icon_s16.gif", "GiftIconUrl":"http:\/\/a1017.lm.a.yimg.com\/7\/1017\/1783\/000\/image.auctions.yahoo.co.jp\/images\/gift\/c_attention_04.gif", "IsBold":true, "IsBackGroundColor":true } } } })
エラー
コンテンツマッチアイテムはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。
利用制限
※このWeb APIは、24時間中1アプリケーションIDにつき50000件のリクエストが上限となっています。詳しくは「利用制限」をご参照ください。
※短い時間の間に同一URLに大量にアクセスを行った場合、一定時間利用できなくなることもございます。(1クエリー/秒)
※大規模なサイト構築やアプリ開発等にご利用いただけるデベロッパー様や、法人様向けに、クエリー数制限/秒を解除させていただきます。(無料)
まずはヘルプページのお問い合わせフォームからご相談ください。