検索
ウェブ検索
Version 1
リクエストURL
XML
http://search.yahooapis.jp/WebSearchService/V1/webSearch
ウェブ検索Web APIは、ウェブ上に公開されているページを検索する機能を提供します。
リクエストパラメータ
「RESTリクエストの構築(GET)」および、「RESTリクエストの構築(POST)」をご参照ください。
| パラメータ | 値 | 説明 |
|---|---|---|
| appid(必須) | string | アプリケーションID。詳細はこちらをご覧ください。 |
| query (必須) | string | (UTF-8エンコードされた)検索クエリーです。このクエリーはYahoo!検索の全言語をサポートし、またメタキーワードも含みます。 |
| type | all(デフォルト), any, phrase | 指定検索の種類:
|
| results | integer: 10(デフォルト), 50(最大) | 返却結果の数です。 |
| start | integer: 1(デフォルト) | 返却結果の先頭位置です。最終位置(start + results - 1)は、1000を超えられません。 |
| format | any(デフォルト), html, msword, pdf, ppt, rss, txt, xls | 検索するファイルの種類を指定します。 |
| adult_ok | 値なし(デフォルト), 1 | アダルトコンテンツの検索結果を含めるかどうかを指定します。1の場合はアダルトコンテンツを含みます。 |
| similar_ok | 値なし(デフォルト), 1 | 同じコンテンツを別の検索結果とするかどうかを指定します。1の場合は同じコンテンツを含みます。 |
| language | string: ja(デフォルト) | languageで書かれた結果になります。「サポートしている言語」をご参照ください。 |
| country | string: 値なし(デフォルト) | ウェブサイトが位置する国の国コードです。「サポートしている国・地域」をご参照ください。 |
| site | string: 値なし(デフォルト) | 検索するドメイン(例えば www.yahoo.co.jp)を制限します。30ドメインまで指定することができます ( |
サンプルリクエストURL
http://search.yahooapis.jp/WebSearchService/V1/webSearch?レスポンスフィールド
ウェブ検索Web APIのスキーマの記述は、以下のURLをご覧ください。
http://search.yahooapis.jp/WebSearchService/V1/WebSearchResponse.xsd
| フィールド | 説明 |
|---|---|
| ResultSet | クエリーレスポンスのすべてを含み、次の属性を持ちます。
|
| Result | 各個別レスポンスを含みます。 |
| Title | ページのタイトルです。 |
| Summary | ページに関連するテキストサマリーです。 |
| Url | ページのURLです。 |
| ClickUrl | ページのリンクURLです。詳細は、こちらをご覧ください。 |
| MimeType | ページのMIMEタイプです。 |
| ModificationDate | ページが最後に修正された日付です。UNIXタイムスタンプフォーマットです。 |
| Cache | キャシュ結果のURLです。サイズはbyteです。 |
サンプルレスポンス
以下は、沖縄 のクエリーの結果です。
エラー
ウェブ検索Web APIはYahoo! JAPAN Web APIに共通のエラーメッセージおよびコードを返します。