オークション

カテゴリ情報

Version 1 ｜ Version 2

リクエストURL

XML

http://auctions.yahooapis.jp/AuctionWebService/V2/categoryTree

PHPserialize

http://auctions.yahooapis.jp/AuctionWebService/V2/php/categoryTree

JSONP

http://auctions.yahooapis.jp/AuctionWebService/V2/json/categoryTree

Yahoo!オークションのカテゴリ情報を提供します。

リクエストパラメータ

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

パラメータ	値	説明
appid（必須）	string	アプリケーションのIDです。詳細はこちらをご覧ください。
callback	string	JSONPとして出力する際のコールバック関数名を入力するためのパラメータです。UTF-8でエンコードした文字列を入力します。
category	integer	取得したいYahoo!オークションのカテゴリIDを指定します。最上位のカテゴリの場合は`0`を指定します。（categoryパラメータがない場合も最上位カテゴリのリクエストとみなします）

サンプルリクエストURL

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

レスポンスフィールド

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

フィールド	説明
ResultSet	クエリーレスポンスのすべてを含み、以下の属性を持ちます。 totalResultsAvailable：該当件数の総個数です。（1固定） totalResultsReturned：返された値の個数です。（1固定） firstResultPosition：最初のデータが何個目に当たるかです。（1固定）
Result	各個別レスポンスを含みます。
CategoryId	このカテゴリのIDです。
CategoryName	このカテゴリの名前です。
CategoryPath	このカテゴリの最上位カテゴリからのパスです。
CategoryIdPath	このカテゴリの最上位カテゴリからのIDです。
ParentCategoryId	このカテゴリの親カテゴリ（一つ上のカテゴリ）のパスです。
IsLeaf	このカテゴリが、末端カテゴリ（商品リスト）かどうかを示します。（あり：`true`　なし：`false`）
Depth	このカテゴリの最上位カテゴリからの階層数です。
Order	このカテゴリの順番です。
IsLink	このカテゴリが、リンクカテゴリかどうかを示します。（あり：true　なし：false）
ChildCategoryNum	このカテゴリの子カテゴリ（一つ下のカテゴリ）の数です。「isLeaf」が「false」の場合に数値が入ります。
ChildCategory	子カテゴリの情報です。
CategoryId	子カテゴリのIDです。リンクカテゴリの場合は、リンク先のカテゴリIDを表示します。
CategoryName	子カテゴリの名前です。
CategoryPath	子カテゴリの最上位カテゴリからのパスです。
CategoryIdPath	子カテゴリの最上位カテゴリからのIDです。
NumOfAuctions	子カテゴリのオークション数（商品数）です。リンクカテゴリは出力しません。
ParentCategoryId	子カテゴリの親カテゴリ（一つ上のカテゴリ）のパスです。
IsLeaf	子カテゴリが、末端カテゴリ（商品リスト）かどうかを示します。（あり：`true`　なし：`false`）
Depth	子カテゴリの最上位カテゴリからの階層数です。
Order	子カテゴリの順番です。
IsLink	子カテゴリが、リンクカテゴリかどうかを示します。（あり：`true`　なし：`false`）

サンプルレスポンス

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

<?xml version="1.0" encoding="utf-8" ?>
<ResultSet xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="urn:yahoo:jp:auc:categoryTree" xsi:schemaLocation="urn:yahoo:jp:auc:categoryTree http://auctions.yahooapis.jp/AuctionWebService/V2/categoryTree.xsd" totalResultsAvailable="1" totalResultsReturned="1" firstResultPosition="1">
 <Result>
  <CategoryId>23568</CategoryId>
  <CategoryName>ソフトウェア</CategoryName>
  <CategoryPath>オークション > コンピュータ > ソフトウェア</CategoryPath>
  <CategoryIdPath>0,23336,23568</CategoryIdPath>
  <ParentCategoryId>23336</ParentCategoryId>
  <IsLeaf>false</IsLeaf>
  <Depth>2</Depth>
  <Order>0</Order>
  <IsLink>false</IsLink>
  <ChildCategoryNum>4</ChildCategoryNum>
  <ChildCategory>
   <CategoryId>2084041727</CategoryId>
   <CategoryName>Windows</CategoryName>
   <CategoryPath>オークション > コンピュータ > ソフトウェア > Windows</CategoryPath>
   <CategoryIdPath>0,23336,23568,2084041727</CategoryIdPath>
   <NumOfAuctions>64975</NumOfAuctions>
   <ParentCategoryId>23568</ParentCategoryId>
   <IsLeaf>false</IsLeaf>
   <Depth>3</Depth>
   <Order>0</Order>
   <IsLink>false</IsLink>
  </ChildCategory>
  <ChildCategory>
   <CategoryId>2084041730</CategoryId>
   <CategoryName>Macintosh</CategoryName>
   <CategoryPath>オークション > コンピュータ > ソフトウェア > Macintosh</CategoryPath>
   <CategoryIdPath>0,23336,23568,2084041730</CategoryIdPath>
   <NumOfAuctions>3162</NumOfAuctions>
   <ParentCategoryId>23568</ParentCategoryId>
   <IsLeaf>false</IsLeaf>
   <Depth>3</Depth>
   <Order>1</Order>
   <IsLink>false</IsLink>
  </ChildCategory>
  <ChildCategory>
   <CategoryId>2084047381</CategoryId>
   <CategoryName>PC-98</CategoryName>
   <CategoryPath>オークション > コンピュータ > ソフトウェア > PC-98</CategoryPath>
   <CategoryIdPath>0,23336,23568,2084047381</CategoryIdPath>
   <NumOfAuctions>483</NumOfAuctions>
   <ParentCategoryId>23568</ParentCategoryId>
   <IsLeaf>false</IsLeaf>
   <Depth>3</Depth>
   <Order>2</Order>
   <IsLink>false</IsLink>
  </ChildCategory>
  <ChildCategory>
   <CategoryId>2084032471</CategoryId>
   <CategoryName>その他</CategoryName>
   <CategoryPath>オークション > コンピュータ > ソフトウェア > その他</CategoryPath>
   <CategoryIdPath>0,23336,23568,2084032471</CategoryIdPath>
   <NumOfAuctions>23920</NumOfAuctions>
   <ParentCategoryId>23568</ParentCategoryId>
   <IsLeaf>false</IsLeaf>
   <Depth>3</Depth>
   <Order>3</Order>
   <IsLink>false</IsLink>
  </ChildCategory>
 </Result>
</ResultSet>

サンプルレスポンス（PHPserialize）

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

array (
  'ResultSet' => 
  array (
    'totalResultsAvailable' => '1',
    'totalResultsReturned' => '1',
    'firstResultPosition' => '1',
    'Result' => 
    array (
      'CategoryId' => '23568',
      'CategoryName' => 'ソフトウェア',
      'CategoryPath' => 'オークション > コンピュータ > ソフトウェア',
      'CategoryIdPath' => '0,23336,23568',
      'ParentCategoryId' => '23336',
      'IsLeaf' => false,
      'Depth' => '2',
      'Order' => '0',
      'IsLink' => false,
      'ChildCategoryNum' => '4',
      'ChildCategory' => 
      array (
        0 => 
        array (
          'CategoryId' => '2084041727',
          'CategoryName' => 'Windows',
          'CategoryPath' => 'オークション > コンピュータ > ソフトウェア > Windows',
          'CategoryIdPath' => '0,23336,23568,2084041727',
          'NumOfAuctions' => '64975',
          'ParentCategoryId' => '23568',
          'IsLeaf' => false,
          'Depth' => '3',
          'Order' => '0',
          'IsLink' => false,
        ),
        1 => 
        array (
          'CategoryId' => '2084041730',
          'CategoryName' => 'Macintosh',
          'CategoryPath' => 'オークション > コンピュータ > ソフトウェア > Macintosh',
          'CategoryIdPath' => '0,23336,23568,2084041730',
          'NumOfAuctions' => '3162',
          'ParentCategoryId' => '23568',
          'IsLeaf' => false,
          'Depth' => '3',
          'Order' => '1',
          'IsLink' => false,
        ),
        2 => 
        array (
          'CategoryId' => '2084047381',
          'CategoryName' => 'PC-98',
          'CategoryPath' => 'オークション > コンピュータ > ソフトウェア > PC-98',
          'CategoryIdPath' => '0,23336,23568,2084047381',
          'NumOfAuctions' => '483',
          'ParentCategoryId' => '23568',
          'IsLeaf' => false,
          'Depth' => '3',
          'Order' => '2',
          'IsLink' => false,
        ),
        3 => 
        array (
          'CategoryId' => '2084032471',
          'CategoryName' => 'その他',
          'CategoryPath' => 'オークション > コンピュータ > ソフトウェア > その他',
          'CategoryIdPath' => '0,23336,23568,2084032471',
          'NumOfAuctions' => '23920',
          'ParentCategoryId' => '23568',
          'IsLeaf' => false,
          'Depth' => '3',
          'Order' => '3',
          'IsLink' => false,
        ),
      ),
    ),
  ),
)

サンプルレスポンス（JSONP）

以下は、category=23336, callback=loaded のクエリーの結果です。

loaded(
{
    "ResultSet":
    {
        "@attributes":
        {
            "totalResultsAvailable":"1",
            "totalResultsReturned":"1",
            "firstResultPosition":"1"
        },
        "Result":
        {
            "CategoryId":"23336",
            "CategoryName":"\u30b3\u30f3\u30d4\u30e5\u30fc\u30bf",
            "CategoryPath":"\u30aa\u30fc\u30af\u30b7\u30e7\u30f3 > \u30b3\u30f3\u30d4\u30e5\u30fc\u30bf",
            "CategoryIdPath":"0,23336",
            "ParentCategoryId":"0",
            "IsLeaf":"false",
            "Depth":"1",
            "Order":"0",
            "IsLink":"false",
            "ChildCategoryNum":"16",
            "ChildCategory":[
            {
                "CategoryId":"2084039759",
                "CategoryName":"\u30d1\u30fc\u30bd\u30ca\u30eb\u30b3\u30f3\u30d4\u30e5\u30fc\u30bf",
                "CategoryPath":"\u30aa\u30fc\u30af\u30b7\u30e7\u30f3 > \u30b3\u30f3\u30d4\u30e5\u30fc\u30bf > \u30d1\u30fc\u30bd\u30ca\u30eb\u30b3\u30f3\u30d4\u30e5\u30fc\u30bf",
                "CategoryIdPath":"0,23336,2084039759",
                "NumOfAuctions":"81890",
                "ParentCategoryId":"23336",
                "IsLeaf":"false",
                "Depth":"2",
                "Order":"0",
                "IsLink":"false"
                },
            }]
        }
    }
})

エラー

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

カテゴリ情報

リクエストURL

リクエストパラメータ

レスポンスフィールド

サンプルレスポンス

サンプルレスポンス（PHPserialize）

サンプルレスポンス（JSONP）

エラー

カテゴリ情報を使用した開発に関するQ＆A

お役立ち度の高い解決済みの質問

Web APIとその他のサービス

API

その他

このAPIを使ったサンプルコード

関連ドキュメント

開発者ブログ

開発者コミュニティ

開発のヒント

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