カテゴリ
ディレクトリツリー
Version 1
リクエストURL
XML
http://dir.yahooapis.jp/Category/V1/Category
ディレクトリツリーは、Yahoo!カテゴリに登録されたサイトデータやカテゴリのツリー構造を表示する機能を提供します。
リクエストパラメータ
「RESTリクエストの構築（GET）」をご参照ください。
| パラメータ | 値 | 説明 |
| appid（必須） | string | アプリケーションID。詳細はこちらをご覧ください。 |
| id（またはpathのいずれか必須） | integer | カテゴリページのid。pathと両方が指定された場合には、idを優先。 |
| path（またはidのいずれか必須） | string | カテゴリページのURLから「http://dir.yahoo.co.jp」を除いた部分。idと両方が指定された場合には、idを優先。 |
| type | integer：0(デフォルト) | 0：カテゴリデータとサイトデータ。 1：カテゴリデータのみ。 2：サイトデータのみ。 |
| expand | integer:0（デフォルト） | 「地域情報」以下の一部のカテゴリでは、「プロパゲート」という処理を使用して、異なる地域以下にある同一カテゴリ名の中の登録サイトをまとめて表示している （例：「三重県 > フットサル」の場合には、「三重県」以下に存在する「伊勢市 > フットサル」「桑名市 > サッカー」などのカテゴリに登録されたサイトをまとめて表示）。 プロパゲートを有効にする場合には、1を指定。 |
サンプルリクエストURL
http://dir.yahooapis.jp/Category/V1/Category?レスポンスフィールド
ディレクトリツリーWeb APIのスキーマの記述は、以下のURLをご覧ください。
http://dir.yahooapis.jp/Category/V1/CategoryResponse.xsd
| フィールド | データタイプ | 説明 |
| CategoryResult | リクエストに対する結果。 | |
| Status | レスポンスの状態やサーバーからのメッセージ。 | |
| Args | APIに渡されたパラメータの集合。複数のArgから構成される。 | |
| Arg | string | Name（string）パラメータの名前。 Value（string）パラメータの値。 |
| Errors | APIでエラーが発生した際の説明。複数のErrorから構成される。 | |
| Error | string | エラーの説明。 |
| Space | カテゴリに関する情報。 | |
| Id | integer | カテゴリのID。 |
| Parent | integer | 親カテゴリのID。 |
| Depth | integer | 最上位カテゴリからの、カテゴリの階層の深さ。 |
| Title | string | カテゴリ名。 |
| JTitle | string | カテゴリ名の読み。 |
| Path | string | Yahoo! JAPANが提供するYahoo!カテゴリのページURLから、「http://dir.yahoo.co.jp」を除いたもの。 |
| JPath | string | Yahoo! JAPANが提供するYahoo!カテゴリの、ページの「カテゴリパス（Breadcrumb）」に使用されている文字列。 |
| Spath | string | IDを使ったカテゴリ階層の表示。 |
| Created | string | サイトが登録された日付もしくは、カテゴリが作成された日付。「YYYYMMDD」形式。 |
| Category | カテゴリからリンクしている下位カテゴリとショートカットカテゴリの集合。ひとつの<Count>要素と0件以上の<Item>要素で構成される。 | |
| Sites | Yahoo!カテゴリに登録されたサイト。ひとつの<Count>要素と0件以上の<Item>要素で構成される。 | |
| Count | integer | Itemの件数。 |
| Item | 下位カテゴリやショートカットカテゴリ、登録サイトや五十音インデックス（下記）に関する情報。 | |
| Type | string | category：下位カテゴリであることを示す。 link：ショートカットカテゴリであることを示す（ショートカットカテゴリは、そのカテゴリに移動する際に、最上位を経由しないとたどり着けないツリー内のカテゴリ）。 site：そのカテゴリに登録されているサイトであることを示す。 leaf：登録サイトとして扱われるカテゴリであることを示す。 link_leaf：登録サイトとして扱われるショートカットカテゴリであることを示す。 Index：カテゴリに多くのサイトが登録されているとき、登録サイトを分割するためのインデックス（五十音インデックス）が設定され、登録サイトが分割されている。このようなカテゴリを呼び出した場合、Typeの値が「Index」となっている複数のItemが、カテゴリ、登録サイトのデータとともに返される。この場合、（<Item>）は、インデックスの名前をあらわす（<Name>）と分割されたページのIDとなる（<Path>）のデータを含む。 |
| Id | integer | Type=categoryのときはカテゴリのID。 |
| Link | integer | Type=categoryのときは「0」。linkのときは、ショートカットカテゴリ自体のID。 |
| Path | string | Yahoo! JAPANで提供するYahoo!カテゴリのページURLから、「http://dir.yahoo.co.jp」を除いたもの。 |
| Title | string | カテゴリ名（Type=category、Type=linkのとき）、登録サイト名（Type=siteのとき）。 |
| JTitle | string | カテゴリ名の読み（Type=category、Type=linkのとき）、登録サイト名の読み（Type=siteのとき）。 |
| Url | string | Type=siteのとき、登録サイトのURL。表示用URL（Display URL）。 |
| ClickUrl | string | Type=siteのとき、登録サイトへのリンク用（クリック用）URL。 |
| Summary | string | 登録サイトの説明。 |
| Created | string | サイトが登録された日付もしくは、カテゴリが作成された日付。「YYYYMMDD」形式。 |
| New | integer | 過去1週間以内に新しく登録されたサイトの場合「1」、それ以外の場合「0」。 |
| Cool | integer | Yahoo!カテゴリ独自の基準によって、優れた内容であると評価されたサイトの場合「1」、それ以外の場合は「0」。 |
サンプルレスポンス
以下は、id=2075288777 のリクエストに対するレスポンスです。
エラー
ディレクトリツリーWeb APIはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。
利用制限
Yahoo!カテゴリWeb APIは、24時間中1アプリケーションIDにつき50000件のリクエストが上限となっています。詳しくは「利用制限」をご参照ください。
