https://search.yahoo.com/search?p=rank+checker&n=100&vl=lang_en&vc=us&ei=UTF-8"
},
"keyword": {
"type": "string",
"description": "keywordkeyword フィールドに指定できますkeyword に “%” 文字を使用する必要がある場合は、“%25” として指定してください。keyword に “+” 文字を使用する必要がある場合は、“%2B” として指定してくださいDataForSEO API の keyword フィールドと keywords フィールドのルールと制限については、こちらのヘルプセンターの記事をご覧ください"
},
"location_name": {
"type": "string",
"description": "検索エンジンのロケーションの正式名location_code または location_coordinate を指定しない場合は必須フィールド
このフィールドを使用する場合、location_code または location_coordinate を指定する必要はありませんhttps://api.dataforseo.com/v3/serp/{{low_se_name}}/locations に個別にリクエストすると、検索エンジンで利用可能なロケーションとその location_name の一覧を取得できます
例：London,England,United Kingdom"
},
"location_code": {
"type": "integer",
"description": "検索エンジンのロケーションコードlocation_name または location_coordinate を指定しない場合は必須フィールド
このフィールドを使用する場合、location_name または location_coordinate を指定する必要はありませんhttps://api.dataforseo.com/v3/serp/{{low_se_name}}/locations に個別にリクエストすると、検索エンジンで利用可能なロケーションとその location_code の一覧を取得できます
例：2840"
},
"location_coordinate": {
"type": "string",
"description": "ロケーションの GPS 座標location_name または location_code を指定しない場合は必須フィールド
このフィールドを使用する場合、location_name または location_code を指定する必要はありませんlocation_coordinate パラメータは \"latitude,longitude,radius\" 形式で指定します
\"latitude\" と \"longitude\" の小数点以下の最大桁数：7
\"radius\" の最小値：199.9（mm）
\"radius\" の最大値：199999（mm）
例：53.476225,-2.243572,200"
},
"language_name": {
"type": "string",
"description": "検索エンジンの言語の完全名
指定しない場合は必須フィールド language_code
このフィールドを使用する場合、language_code を指定する必要はありません
検索エンジンがサポートする言語とその language_name の一覧は、https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages に別途リクエストを送信して取得できます
例:English"
},
"language_code": {
"type": "string",
"description": "検索エンジンの言語コード
指定しない場合は必須フィールド language_name
このフィールドを使用する場合、language_name を指定する必要はありません
検索エンジンがサポートする言語とその language_code_by の一覧は、https://api.dataforseo.com/v3/serp/{{low_se_name}}/languages に別途リクエストを送信して取得できます
例:enn"
},
"device": {
"type": [
"string",
"null"
],
"description": "デバイスの種類
任意フィールド
特定のデバイスの種類の結果を返します
次のいずれかの値を指定できます：desktop、mobile
デフォルト値：desktop"
},
"os": {
"type": [
"string",
"null"
],
"description": "デバイスのオペレーティングシステム
任意フィールドdevice フィールドに desktop を指定した場合は、次の値から選択します：windows、macos
デフォルト値：windowsdevice フィールドに mobile を指定した場合は、次の値から選択します：android、ios
デフォルト値：android"
},
"se_domain": {
"type": [
"string",
"null"
],
"description": "検索エンジンのドメイン
任意フィールド
指定したロケーションと言語に応じて、関連する検索エンジンのドメインが自動的に選択されます
ただし、このフィールドでカスタムの検索エンジンドメインを設定できます
例:au.search.yahoo.com、uk.search.yahoo.com、ca.search.yahoo.com など。"
},
"depth": {
"type": [
"integer",
"null"
],
"description": "解析深度
任意フィールド
SERP 内の結果数
デフォルト値: 10
最大値: 200
アカウントには、最大 10 件の結果を含む SERP ごとに課金されます;
検索エンジンが 10 件を超える結果を返した場合、深度を 10 より大きく設定すると追加料金がかかる可能性があります 検索エンジンが 10 件を超える結果を返す場合;
コストは料金ページで計算できます。"
},
"max_crawl_pages": {
"type": [
"integer",
"null"
],
"description": "ページクロールの上限
任意フィールド
クロールする検索結果ページ数
デフォルト値: 1
最大値: 100
注意: max_crawl_pages と depth パラメータは互いに補完し合う関係です。
詳細はヘルプセンターをご覧ください"
},
"search_param": {
"type": [
"string",
"null"
],
"description": "検索クエリの追加パラメータ
任意フィールド
使用可能なパラメータの一覧と詳細はこちら"
},
"stop_crawl_on_match": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"type": "object",
"properties": {
"match_value": {
"type": [
"string",
"null"
],
"description": "ターゲットのドメインまたはワイルドカード値\nstop_crawl_on_match を指定する場合は必須フィールドです。\nターゲットのドメインまたはワイルドカード値を指定します。\n注意: ドメイン名はリクエストプロトコルなしで指定する必要があります。\n例: dataforseo.com"
},
"match_type": {
"type": [
"string",
"null"
],
"description": "ターゲットのマッチタイプ\nstop_crawl_on_match を指定する場合は必須フィールドです。\nmatch_value のマッチタイプ\n可能な値: domain、with_subdomains、wildcard"
}
}
}
]
},
"description": "クロールを停止するターゲットの配列\n任意フィールド\n指定した場合、レスポンスには指定した match_value までの SERP 結果が含まれます。\nこの配列には最大 10 個のターゲット値を指定できます\n例:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nこのパラメータの詳細については、ヘルプセンターをご覧ください - https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nアカウントには、指定したターゲットを通じてクロールされた SERP ごとに課金されます"
}
},
"example": [
{
"language_code": "en",
"location_code": 2840,
"keyword": "albert einstein"
}
]
}
]
},
"example": [
{
"language_code": "en",
"location_code": 2840,
"keyword": "albert einstein"
}
]
}
```
## Responses
### 200 — 操作成功
Headers:
- `X-Request-Id` (string) — Felo サポートに問い合わせる際に伝えるリクエスト識別子。
**application/json**
Schema: object | null
```json
{
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_SerpYahooOrganicLiveHtmlResponseInfo"
}
]
}
```
### 400 — リクエストを処理できませんでした。リクエストパラメータを確認してください。
### 401 — 有効な Felo API キーが必要です。
### 402 — 請求要件が満たされていないため、リクエストを続行できません。
### 403 — このアカウントにはこの操作を行う権限がありません。
### 429 — リクエストまたは支出の上限に達しました。
### 502 — サービスがリクエストを完了できませんでした。
### 503 — API または請求サービスが一時的に利用できません。
### 504 — リクエストの処理中にサービスがタイムアウトしました。
### default — エラーレスポンス。上流のパススルーレスポンスはプロバイダーの形式を使用する場合があります
**application/json**
Schema:
```json
{}
```
## Schema definitions
### Response36Afe1097B20_BaseResponseInfo
`#/components/schemas/Response36Afe1097B20_BaseResponseInfo`
```json
{
"properties": {
"version": {
"type": [
"string",
"null"
],
"description": "API の現在のバージョン"
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "一般的なステータスコード\nレスポンスコードの完全な一覧はこちらです"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "一般的な情報メッセージ\n一般的な情報メッセージの完全な一覧はこちらです"
},
"time": {
"type": [
"string",
"null"
],
"description": "合計実行時間（秒）"
},
"cost": {
"type": [
"number",
"null"
],
"description": "タスクの総コスト（USD）",
"format": "double"
},
"tasks_count": {
"type": [
"integer",
"null"
],
"description": "tasks 配列内のタスク数",
"format": "int64"
},
"tasks_error": {
"type": [
"integer",
"null"
],
"description": "エラーで返された tasks 配列内のタスク数",
"format": "int64"
}
}
}
```
### Response36Afe1097B20_BaseResponseTaskInfo
`#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo`
```json
{
"properties": {
"id": {
"type": [
"string",
"null"
],
"description": "タスク識別子\n当社システム内で UUID 形式の一意のタスク識別子"
},
"status_code": {
"type": [
"integer",
"null"
],
"description": "タスクのステータスコード\nDataForSEO によって生成され、次の範囲の値になります: 10000-60000\nレスポンスコードの完全な一覧はこちらです"
},
"status_message": {
"type": [
"string",
"null"
],
"description": "タスクの情報メッセージ\n一般的な情報メッセージの完全な一覧はこちらです"
},
"time": {
"type": [
"string",
"null"
],
"description": "実行時間（秒）"
},
"cost": {
"type": [
"number",
"null"
],
"description": "タスクの総コスト（USD）",
"format": "double"
},
"result_count": {
"type": [
"integer",
"null"
],
"description": "result 配列内の要素数",
"format": "int64"
},
"path": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "URL パス"
},
"data": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"object",
"null"
]
},
"description": "POST リクエストで指定したものと同じパラメーターを含みます"
}
}
}
```
### Response36Afe1097B20_HtmlItemInfo
`#/components/schemas/Response36Afe1097B20_HtmlItemInfo`
```json
{
"type": "object",
"properties": {
"page": {
"type": [
"integer",
"null"
],
"description": "返された HTML ページのシリアル番号"
},
"date": {
"type": [
"string",
"null"
],
"description": "HTML ページがスキャンされた日時
UTC 形式：“yyyy-mm-dd hh-mm-ss +00:00”
例：2019-11-15 12:57:46 +00:00"
},
"html": {
"type": [
"string",
"null"
],
"description": "HTML ページ"
}
}
}
```
### Response36Afe1097B20_SerpYahooOrganicLiveHtmlResponseInfo
`#/components/schemas/Response36Afe1097B20_SerpYahooOrganicLiveHtmlResponseInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseInfo"
},
{
"type": "object",
"properties": {
"tasks": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_SerpYahooOrganicLiveHtmlTaskInfo"
}
]
},
"description": "タスクの配列"
}
}
}
]
}
```
### Response36Afe1097B20_SerpYahooOrganicLiveHtmlResultInfo
`#/components/schemas/Response36Afe1097B20_SerpYahooOrganicLiveHtmlResultInfo`
```json
{
"type": "object",
"properties": {
"keyword": {
"type": [
"string",
"null"
],
"description": "POST 配列で受信したキーワード
キーワードはデコードされた %## で返されます（プラス文字 '+' はスペース文字にデコードされます）"
},
"type": {
"type": [
"string",
"null"
],
"description": "要素の種類"
},
"se_domain": {
"type": [
"string",
"null"
],
"description": "POST 配列内の検索エンジンドメイン"
},
"location_code": {
"type": [
"integer",
"null"
],
"description": "POST 配列内のロケーションコード"
},
"language_code": {
"type": [
"string",
"null"
],
"description": "POST 配列内の言語コード"
},
"datetime": {
"type": [
"string",
"null"
],
"description": "結果を受信した日時
UTC 形式：“yyyy-mm-dd hh-mm-ss +00:00”
例：2019-11-15 12:57:46 +00:00"
},
"items_count": {
"type": [
"integer",
"null"
],
"description": "items 配列で返された結果数",
"format": "int64"
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_HtmlItemInfo"
}
]
},
"description": "SERP で見つかった検索結果の要素"
}
}
}
```
### Response36Afe1097B20_SerpYahooOrganicLiveHtmlTaskInfo
`#/components/schemas/Response36Afe1097B20_SerpYahooOrganicLiveHtmlTaskInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_SerpYahooOrganicLiveHtmlResultInfo"
}
]
},
"description": "結果の配列"
}
}
}
]
}
```