オークション

カテゴリ情報

リクエストURL
XML
http://auctions.yahooapis.jp/AuctionWebService/V1/CategoryTree

こちらのAPIは、2015年4月15日に終了させていただきました。最新バージョンのAPIをご利用下さい。

ヤフオク!のカテゴリ情報を提供します。

リクエストパラメータ

RESTリクエストの構築(GET)」および、「RESTリクエストの構築(POST)」をご参照ください。

パラメータ 説明
appid(必須) string アプリケーションID。詳細はこちらをご覧ください。
category integer 取得したいヤフオク!のカテゴリIDを指定します。最上位のカテゴリの場合は0を指定します。(categoryパラメータがない場合も最上位カテゴリのリクエストとみなします)

サンプルリクエストURL

http://auctions.yahooapis.jp/AuctionWebService/V1/CategoryTree?appid=<あなたのアプリケーションID>&category=<ヤフオク!のカテゴリID>


レスポンスフィールド

カテゴリ情報のスキーマの記述は、以下のURLをご覧ください。
http://auctions.yahooapis.jp/AuctionWebService/V1/CategoryTree.xsd

 
フィールド 説明
category レスポンスのすべてを含みます。
categoryId このカテゴリのIDです。
categoryName このカテゴリの名前です。
categoryPath このカテゴリの最上位カテゴリからのパスです。
parentCategoryPath このカテゴリの親カテゴリ(一つ上のカテゴリ)のパスです。
isLeaf このカテゴリが、末端カテゴリ(商品リスト)かどうかを示します。(true or false)
childCategoryNum このカテゴリの子カテゴリ(一つ下のカテゴリ)の数です。「isLeaf」が「false」の場合に数値が入ります。
childCategory このカテゴリの子カテゴリ(一つ下のカテゴリ)の情報です。
categoryId 子カテゴリのIDです。
categoryName 子カテゴリの名前です。
numOfAuctions 子カテゴリのオークション数(商品数)です。
isLeaf 子カテゴリが、末端カテゴリ(商品リスト)かどうかを示します。(true or false)



サンプルレスポンス

以下は、category=23568 のクエリーの結果です。

<?xml version="1.0" encoding="utf-8" ?> 
<category xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:yahoo:jp:auc:category" xsi:schemaLocation="urn:yahoo:jp:auc:category http://auctions.yahooapis.jp/AuctionWebService/V1/CategoryTree.xsd">
 <categoryId>23568</categoryId> 
 <categoryName>ソフトウェア</categoryName> 
 <categoryPath>オークション > コンピュータ > ソフトウェア</categoryPath> 
 <parentCategoryPath>オークション > コンピュータ</parentCategoryPath> 
 <isLeaf>false</isLeaf> 
 <childCategoryNum>4</childCategoryNum> 
 <childCategory>
  <categoryId>2084041727</categoryId> 
  <categoryName>Windows</categoryName> 
  <numOfAuctions>37425</numOfAuctions> 
  <isLeaf>false</isLeaf> 
 </childCategory>
 <childCategory>
  <categoryId>2084041730</categoryId> 
  <categoryName>Macintosh</categoryName> 
  <numOfAuctions>1941</numOfAuctions> 
  <isLeaf>false</isLeaf> 
 </childCategory>
 <childCategory>
  <categoryId>2084047381</categoryId> 
  <categoryName>PC-98</categoryName> 
  <numOfAuctions>590</numOfAuctions> 
  <isLeaf>false</isLeaf> 
 </childCategory>
 <childCategory>
  <categoryId>2084032471</categoryId> 
  <categoryName>その他</categoryName> 
  <numOfAuctions>16500</numOfAuctions> 
  <isLeaf>false</isLeaf> 
 </childCategory>
</category>



エラー

カテゴリ情報はYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。