DataForSEO API の keyword フィールドと keywords フィールドのルールと制限については、こちらの ヘルプセンター記事を参照してください"
},
"location_name": {
"type": "string",
"description": "ロケーションの正式名称location_code を指定しない場合は必須フィールド
注意：location_name または location_code のいずれかを指定する必要があります
別途 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages にリクエストを送信すると、利用可能なロケーションとその location_name パラメーターの一覧を取得できます
例：United Kingdom"
},
"location_code": {
"type": "integer",
"description": "ロケーションの一意の識別子location_name を指定しない場合は必須フィールド
注意：location_name または location_code のいずれかを指定する必要があります
別途 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages にリクエストを送信すると、利用可能なロケーションとその location_code パラメーターの一覧を取得できます
例：2840"
},
"language_name": {
"type": "string",
"description": "言語の正式名称language_code を指定しない場合は必須フィールド
注意：language_name または language_code のいずれかを指定する必要があります
別途 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages にリクエストを送信すると、利用可能な言語とその language_name パラメーターの一覧を取得できます
例：English"
},
"language_code": {
"type": [
"string",
"null"
],
"description": "言語の一意の識別子language_name を指定しない場合は必須フィールド
注意：language_name または language_code のいずれかを指定する必要があります
別途 https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages にリクエストを送信すると、利用可能な言語とその language_code パラメーターの一覧を取得できます
例：en"
},
"include_subdomains": {
"type": [
"boolean",
"null"
],
"description": "サブドメインを検索に含めるかどうかを示します
任意フィールドfalse に設定すると、サブドメインは無視されます
デフォルト値：true"
},
"item_types": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "検索結果タイプ
レスポンスに含める検索結果のタイプを示します
任意フィールド
指定可能な値： [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]
デフォルト値： [\"organic\", \"paid\"]"
},
"limit": {
"type": [
"integer",
"null"
],
"description": "返されるドメインの最大数
任意フィールド
デフォルト値: 100
最大値: 1000"
},
"offset": {
"type": [
"integer",
"null"
],
"description": "返されるドメインの結果配列内のオフセット
任意フィールド
デフォルト値：010 を指定すると、結果配列の最初の 10 件のドメインがスキップされ、後続のドメインのデータが返されます"
},
"filters": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
]
},
"description": "結果フィルターパラメーターの配列
任意フィールド
複数のフィルターを同時に追加できます（最大 8 個）
条件の間には論理演算子 and、or を設定してください
次の演算子がサポートされています：regex、not_regex、<、<=、>、>=、=、<>、in、not_in、match、not_match、ilike、not_ilike、like、not_likelike と not_like、および ilike と not_ilike で % 演算子を使用すると、0 文字以上の任意の文字列に一致させられます
例：[\"median_position\",\"in\",[1,10]]
[[\"median_position\",\"in\",[1,10]],\"and\",[\"domain\",\"not_like\",\"%wikipedia.org%\"]]
[[\"domain\",\"not_like\",\"%wikipedia.org%\"],
\"and\",
[[\"relevant_serp_items\",\">\",0],\"or\",[\"median_position\",\"in\",[1,10]]]]
フィルターの詳細については、Dataforseo Labs - Filters またはこちらの ヘルプセンターガイドを参照してください"
},
"order_by": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "結果の並べ替えルール
任意フィールドfilters 配列と同じ値を使用して結果を並べ替えられます
指定可能な並べ替えの種類：asc - 結果は昇順で並べ替えられますdesc - 結果は降順で並べ替えられます
区切り文字にはカンマを使用します
例：[\"avg_position,asc\"]
デフォルトのルール：[\"rating,desc\"]
1 回のリクエストで設定できる並べ替えルールは 3 つまでです
複数の並べ替えルールはカンマで区切ってください
例：[\"avg_position,asc\",\"etv,desc\"]"
},
"tag": {
"type": [
"string",
"null"
],
"description": "ユーザー定義のタスク識別子
任意フィールド
文字数上限は 255 です
このパラメーターを使ってタスクを識別し、結果と照合できます
指定した tag の値は、レスポンスの data オブジェクトに含まれます"
}
},
"example": [
{
"keywords": [
"phone"
],
"language_name": "English",
"location_code": 2840,
"item_types": [
"organic"
],
"limit": 5
}
]
}
]
},
"example": [
{
"keywords": [
"phone"
],
"language_name": "English",
"location_code": 2840,
"item_types": [
"organic"
],
"limit": 5
}
]
}
```
## Responses
### 200 — 操作成功
Headers:
- `X-Request-Id` (string) — Felo サポートに問い合わせる際に伝えるリクエスト識別子。
**application/json**
Schema: object | null
```json
{
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveResponseInfo"
}
]
}
```
### 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_DataforseoLabsGoogleSerpCompetitorsLiveItem
`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveItem`
```json
{
"type": "object",
"properties": {
"se_type": {
"type": [
"string",
"null"
],
"description": "検索エンジンの種類"
},
"domain": {
"type": [
"string",
"null"
],
"description": "検出された SERP 競合他社のドメイン名"
},
"avg_position": {
"type": [
"number",
"null"
],
"description": "指定したキーワードに対するドメインの平均位置keywords_positions 配列内の値の算術平均",
"format": "float"
},
"median_position": {
"type": [
"number",
"null"
],
"description": "指定したキーワードに対するドメインの中央値位置keywords_positions 配列内の値の中央値"
},
"rating": {
"type": [
"number",
"null"
],
"description": "可能な最大キーワード位置と実際のキーワード位置の差
指定したキーワードについての SERP におけるドメインの相対可視性を表します
sum(100-keywords_positions) として算出されます"
},
"etv": {
"type": [
"number",
"null"
],
"description": "推定トラフィック量
指定したキーワードがウェブサイトにもたらす推定月間トラフィックを表します
指定したキーワードの検索ボリューム値と、SERP の特定位置における CTR（クリック率）の積の合計として算出されます
指標の計算方法の詳細については、このヘルプセンター記事をご覧ください"
},
"keywords_count": {
"type": [
"integer",
"null"
],
"description": "ドメインが SERP で位置を持つ指定キーワードの数",
"format": "int64"
},
"visibility": {
"type": [
"number",
"null"
],
"description": "SERP 可視性
指定したキーワードの SERP 位置に基づくウェブサイトの可視性を表します
1 から 10 の範囲の位置のキーワードには、可視性指数がそれぞれ 1 から 0.1 に割り当てられます
11 から 20 の範囲の位置のキーワードには、可視性指数 0.05 が固定で割り当てられます
20 から 100 の位置のキーワードの可視性指数は 0 になります"
},
"relevant_serp_items": {
"type": [
"integer",
"null"
],
"description": "ドメインに関連する SERP 要素の数
指定したキーワードについてドメインに関連する SERP 内の検索結果の数を表します"
},
"keywords_positions": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"array",
"null"
],
"items": {
"type": [
"integer",
"null"
]
}
},
"description": "キーワード位置
関連ドメインが指定したキーワードについて SERP で保持している位置"
}
}
}
```
### Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveResponseInfo
`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveResponseInfo`
```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_DataforseoLabsGoogleSerpCompetitorsLiveTaskInfo"
}
]
},
"description": "タスクの配列"
}
}
}
]
}
```
### Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveResultInfo
`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveResultInfo`
```json
{
"type": "object",
"properties": {
"se_type": {
"type": [
"string",
"null"
],
"description": "検索エンジンの種類"
},
"seed_keywords": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "リクエストで指定したキーワード
キーワードはデコードされた %## で返されます（記号 '+' はスペース文字にデコードされます）"
},
"location_code": {
"type": [
"integer",
"null"
],
"description": "POST 配列内のロケーションコード
データがない場合、値は null になります"
},
"language_code": {
"type": [
"string",
"null"
],
"description": "POST 配列内の言語コード
データがない場合、値は null になります"
},
"total_count": {
"type": [
"integer",
"null"
],
"description": "当社データベース内のリクエストに関連する結果の総量",
"format": "int64"
},
"items_count": {
"type": [
"integer",
"null"
],
"description": "items 配列で返される結果の数",
"format": "int64"
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveItem"
}
]
},
"description": "検出された SERP 競合他社と関連データを含みます"
}
}
}
```
### Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveTaskInfo
`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveTaskInfo`
```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_DataforseoLabsGoogleSerpCompetitorsLiveResultInfo"
}
]
},
"description": "結果の配列"
}
}
}
]
}
```