注意: 一部の記号や文字（UTF 記号、絵文字など）は使用できません
使用できる記号や文字については、こちらの記事を参照してください
DataForSEO API の keyword フィールドと keywords フィールドのルールと制限については、こちらの ヘルプセンター記事を参照してください"
},
"location_name": {
"type": "string",
"description": "検索エンジンの所在地の正式名location_code を指定しない場合は必須フィールドhttps://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages に個別にリクエストすると、location_name を付した利用可能な所在地の一覧を取得できます
例:United Kingdom"
},
"location_code": {
"type": "integer",
"description": "検索エンジンの所在地コードlocation_name を指定しない場合は必須フィールド
このフィールドを使用する場合、https://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages に個別にリクエストすると、location_code を付した利用可能な所在地の一覧を取得できます
例:2826"
},
"language_name": {
"type": "string",
"description": "検索エンジンの言語の正式名language_code を指定しない場合は必須フィールドhttps://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages に個別にリクエストすると、利用可能な言語とその language_name の一覧を取得できます
例:English"
},
"language_code": {
"type": "string",
"description": "検索エンジンの言語コードlanguage_name を指定しない場合は必須フィールドhttps://api.dataforseo.com/v3/keywords_data/clickstream_data/locations_and_languages に個別にリクエストすると、利用可能な言語とその language_code の一覧を取得できます
例:en"
},
"use_clickstream": {
"type": [
"boolean",
"null"
],
"description": "クリックストリームデータを使用して結果を提供
任意フィールドtrue に設定すると、クリックストリームデータに基づく DataForSEO 検索ボリューム値が提供されますfalse に設定すると、Bing の検索ボリュームデータを使用して DataForSEO 検索ボリュームが計算されます
デフォルト値: true
注意: Bing の検索ボリュームは、Bing Search Volume History Locations と Bing Ads Locations の各エンドポイントで提供されている所在地でのみ利用できます。このパラメーターを false に設定しても、それ以外の所在地の検索ボリューム値はクリックストリームデータに基づいて計算されます"
},
"tag": {
"type": [
"string",
"null"
],
"description": "ユーザー定義のタスク識別子
任意フィールド
文字数上限は 255 です
このパラメーターを使ってタスクを識別し、結果と照合できます
指定した tag の値は、レスポンスの data オブジェクトに含まれます"
}
},
"example": [
{
"location_code": 2840,
"language_code": "en",
"tag": "test-tag",
"keywords": [
"you tube",
"youtube",
"youtub"
]
}
]
}
]
},
"example": [
{
"location_code": 2840,
"language_code": "en",
"tag": "test-tag",
"keywords": [
"you tube",
"youtube",
"youtub"
]
}
]
}
```
## Responses
### 200 — 操作成功
Headers:
- `X-Request-Id` (string) — Felo サポートに問い合わせる際に伝えるリクエスト識別子。
**application/json**
Schema: object | null
```json
{
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResponseInfo"
}
]
}
```
### 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_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResponseInfo
`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResponseInfo`
```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_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveTaskInfo"
}
]
},
"description": "タスクの配列"
}
}
}
]
}
```
### Response36Afe1097B20_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResultInfo
`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResultInfo`
```json
{
"type": "object",
"properties": {
"location_code": {
"type": [
"integer",
"null"
],
"description": "POST 配列内のロケーションコード
データがない場合、値は null になります"
},
"language_code": {
"type": [
"string",
"null"
],
"description": "POST 配列内の言語コード
注意：POST 配列内のキーワードのスペルが誤っている場合、正しいスペルのキーワードのデータが返されます。
キーワードのスペルを確認および検証するために Google Ads API の機能を使用しています。こちらのリンクで詳細を確認できます"
},
"use_clickstream": {
"type": [
"boolean",
"null"
],
"description": "use_clickstream パラメーターが有効かどうかを示します
可能な値：true、false"
},
"items_count": {
"type": [
"integer",
"null"
],
"description": "items 配列で返される結果の数"
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataSearchVolumeLiveItem"
}
]
},
"description": "キーワードの配列
キーワードとその検索ボリュームを含みます"
}
}
}
```
### Response36Afe1097B20_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveTaskInfo
`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveTaskInfo`
```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_KeywordsDataClickstreamDataDataforseoSearchVolumeLiveResultInfo"
}
]
},
"description": "結果の配列"
}
}
}
]
}
```
### Response36Afe1097B20_KeywordsDataClickstreamDataSearchVolumeLiveItem
`#/components/schemas/Response36Afe1097B20_KeywordsDataClickstreamDataSearchVolumeLiveItem`
```json
{
"type": "object",
"properties": {
"keyword": {
"type": [
"string",
"null"
],
"description": "POST 配列で指定されたキーワード"
},
"search_volume": {
"type": [
"integer",
"null"
],
"description": "キーワードの現在の検索ボリューム",
"format": "int64"
},
"monthly_searches": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_MonthlySearchesInfo"
}
]
},
"description": "月間検索ボリューム
1 年の中のある月の検索ボリュームを含むオブジェクトの配列"
}
}
}
```
### Response36Afe1097B20_MonthlySearchesInfo
`#/components/schemas/Response36Afe1097B20_MonthlySearchesInfo`
```json
{
"type": "object",
"properties": {
"year": {
"type": [
"integer",
"null"
],
"description": "年"
},
"month": {
"type": [
"integer",
"null"
],
"description": "月"
},
"search_volume": {
"type": [
"integer",
"null"
],
"description": "月間平均検索ボリューム"
}
}
}
```