カテゴリ
ディレクトリサーチ
Version 1
リクエストURL
XML
http://dir.yahooapis.jp/Category/V1/directorySearch
ディレクトリサーチは、Yahoo!カテゴリに登録されたサイトデータやカテゴリを検索する機能を提供します。
リクエストパラメータ
「RESTリクエストの構築(GET)」をご参照ください。
| パラメータ | 値 | 説明 |
| appid(必須) | string | アプリケーションID。詳細はこちらをご覧ください。 |
| query(必須) | string | (UTF-8エンコードされた)検索クエリーです。「OR」「AND」「NOT」を使った検索式も指定できます。 |
| type | integer:0(デフォルト),1, 2 | 0:カテゴリデータとサイトデータ。 1:カテゴリデータのみ。 2:サイトデータのみ。 |
| results | integer:10(デフォルト),50(最大) | リクエストで受ける結果の最大件数を指定します。type=0で、results=10を指定した場合、カテゴリデータ、サイトデータそれぞれ10件ずつが検索結果として返されます。 |
| start | integer:1(デフォルト) | レスポンスで受ける最初の検索結果の位置を指定します。最終位置(start + results - 1)は、1000を超えられません。type=0を指定した場合、この設定は、カテゴリデータの検索結果、サイトデータの検索結果、両方に有効な値となります。 |
| adult_ok | string:値なし(デフォルト),1 | アダルトサイト、アダルトカテゴリを検索結果に含めるかどうかを指定します。1の場合はアダルトサイト、アダルトカテゴリを含みます。 |
| path | string | pathで指定されたカテゴリ以下のカテゴリに絞り込んで検索を行います。 |
| new | integer:0(デフォルト),1 | 1の場合、1週間以内に登録されたカテゴリや登録サイトのみが検索対象になります。 |
| picks | integer:0(デフォルト),1 | 1の場合、「今週のオススメ」に過去6カ月以内に掲載された、登録サイトのみが検索対象になります。type=2もしくは、type=0のときにのみ有効なパラメータです。 |
サンプルリクエストURL
http://dir.yahooapis.jp/Category/V1/directorySearch?レスポンスフィールド
ディレクトリサーチWeb APIのスキーマの記述は、以下のURLをご覧ください。
http://dir.yahooapis.jp/Category/V1/DirectorySearchResponse.xsd
| フィールド | データタイプ | 説明 |
| ResultSet | リクエストに対する結果。 | |
| Status | レスポンスの状態やサーバーからのメッセージ。 | |
| Args | APIに渡されたパラメータの集合。複数のArgから構成される。 | |
| Arg | string | Name(string)パラメータの名前。 Value(string)パラメータの値。 |
| Errors | APIでエラーが発生した際の説明。複数のErrorから構成される。 | |
| Error | string | エラーの説明。 |
| DirSearchResults | カテゴリの検索結果の集合。Itemで構成される。 | |
| TotalCount | integer | DirSearchResultsの属性。カテゴリの検索結果の総数。 |
| Count | integer | DirSearchResultsの属性。検索結果数。 |
| Start | integer | DirSearchResultsの属性。結果の取得開始位置。 |
| Item | 検索結果。 | |
| Id | integer | カテゴリのID。 |
| Type | string | category:カテゴリであることを示す。 |
| Title | string | カテゴリ名。 |
| Path | string | Yahoo! JAPANが提供するYahoo!カテゴリのページURLから、「http://dir.yahoo.co.jp/」を除いたもの。 |
| Url | string | カテゴリページのURL。 |
| ClickUrl | string | カテゴリページへのリンク用(クリック用)URL。 |
| JPath | string | Yahoo! JAPANが提供するYahoo!カテゴリの、ページの「カテゴリパス(Breadcrumb)」。 |
| Created | string | カテゴリが作成された日付。「YYYYMMDD」形式。 |
| Adult | integer | アダルトカテゴリの場合「1」、それ以外の場合「0」。 |
| New | integer | 過去1週間以内に新しく登録されたカテゴリの場合「1」、それ以外の場合「0」。 |
| SiteSearchResults | 登録サイト検索結果の集合Itemで構成される。 | |
| TotalCount | integer | SiteSearchResultsの属性。サイトの検索結果の総数。 |
| Count | integer | SiteSearchResultsの属性。検索結果数。 |
| Start | integer | SiteSearchResultsの属性。結果の取得開始位置。 |
| Item | 検索結果。 | |
| Parent | integer | サイトが登録されているカテゴリのID。 |
| ParentName | string | サイトが登録されているカテゴリのカテゴリ名。 |
| ParentCategoryUrl | string | サイトが登録されているカテゴリページURL。 |
| ParentCategoryClickUrl | string | サイトが登録されているカテゴリページへのリンク用(クリック用)URL。 |
| Type | string | site:サイトであることを示す。 leaf:登録サイトとして扱われるカテゴリであることを示す。 link_leaf:登録サイトとして扱われるショートカットカテゴリであることを示す。 |
| Title | string | 登録サイト名。 |
| Summary | string | 登録サイトの説明。 |
| Url | string | 登録サイトのURL。表示用URL(Display URL)。 |
| ClickUrl | string | 登録サイトへのリンク用(クリック用)URL。 |
| Created | string | サイトが登録された日付。「YYYYMMDD」形式。 |
| Adult | integer | アダルトサイトの場合「1」、それ以外の場合「0」。 |
| New | integer | 過去1週間以内に新しく登録されたサイトの場合「1」、それ以外の場合「0」。 |
| Picks | integer | 「今週のオススメ」に掲載されたサイトの場合「1」、それ以外の場合「0」。 |
| Cool | integer | Yahoo!カテゴリ独自の基準によって、優れた内容であると評価されたサイトの場合「1」、それ以外の場合は「0」。 |
サンプルレスポンス
以下は、query=yahoo のリクエストに対するレスポンスです。
エラー
ディレクトリサーチWeb APIはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。
利用制限
Yahoo!カテゴリWeb APIは、24時間中1アプリケーションIDにつき50000件のリクエストが上限となっています。詳しくは「利用制限」をご参照ください。