DataForSEO API における keyword および keywords フィールドのルールと制限については、こちらのヘルプセンター記事を参照してください"
},
"location_name": {
"type": [
"string",
"null"
],
"description": "検索エンジンのロケーションの正式名称
任意フィールド
ロケーションを指定しない場合、利用可能なすべてのロケーションを対象としたグローバルな結果が返されます；
このフィールドを使用する場合、location_code または location_coordinate を指定する必要はありません
別途 https://api.dataforseo.com/v3/keywords_data/google_ads/locations にリクエストを送信すると、検索エンジンの利用可能なロケーションとその location_name の一覧を取得できます
例：London,England,United Kingdom"
},
"location_code": {
"type": [
"integer",
"null"
],
"description": "検索エンジンのロケーションコード
任意フィールド
ロケーションを指定しない場合、利用可能なすべてのロケーションを対象としたグローバルな結果が返されます；
このフィールドを使用する場合、location_name または location_coordinate を指定する必要はありません；
別途 https://api.dataforseo.com/v3/keywords_data/google_ads/locations にリクエストを送信すると、検索エンジンの利用可能なロケーションとその location_code の一覧を取得できます
例：2840"
},
"location_coordinate": {
"type": [
"string",
"null"
],
"description": "ロケーションの GPS 座標
任意フィールド
ロケーションを指定しない場合、利用可能なすべてのロケーションを対象としたグローバルな結果が返されます；
このフィールドを使用する場合、location_name または location_code を指定する必要はありません；location_coordinate パラメーターは \"latitude,longitude\" 形式で指定する必要があります；
指定した座標が属する国・地域のデータが提供されます；
例：52.6178549,-155.352142"
},
"language_name": {
"type": [
"string",
"null"
],
"description": "検索エンジンの言語の正式名称
任意フィールド
別途 https://api.dataforseo.com/v3/keywords_data/google_ads/languages にリクエストを送信すると、検索エンジンの利用可能な言語とその language_name の一覧を取得できます
例：English"
},
"language_code": {
"type": [
"string",
"null"
],
"description": "検索エンジンの言語コード
任意フィールド
別途 https://api.dataforseo.com/v3/keywords_data/google_ads/languages にリクエストを送信すると、検索エンジンの利用可能な言語とその language_code の一覧を取得できます
例：en"
},
"search_partners": {
"type": [
"boolean",
"null"
],
"description": "Google 検索パートナーを含める
任意フィールドtrue を指定すると、Google 検索をホストするGoogle およびパートナーサイト全体の自社運営ネットワークと統合ネットワークに対して結果が返されます；
デフォルト値：false - 結果は Google 検索サイトに対してのみ返されます"
},
"date_from": {
"type": [
"string",
"null"
],
"description": "期間の開始日
任意フィールド
日付形式：\"yyyy-mm-dd\"
最小値：現在の日付から 4 年前
デフォルトでは過去 12 か月分のデータが返されます；
注意：指定した日付は、date_to で指定した日付および/または昨日の日付より後にできません；Status エンドポイント が actual_data フィールドで false を返す場合、date_from は先々月以前に設定できます；
Status エンドポイント が actual_data フィールドで true を返す場合、date_from は先月以前に設定できます"
},
"date_to": {
"type": [
"string",
"null"
],
"description": "期間の終了日
任意フィールド
注意：指定した日付は先月より後にできません。Google Ads は当月のデータを返しません；
このフィールドを指定しない場合、デフォルトで昨日の日付が使用されます
日付形式：\"yyyy-mm-dd\"
例：\"2022-11-30\""
},
"include_adult_keywords": {
"type": [
"boolean",
"null"
],
"description": "アダルトコンテンツに関連するキーワードを含める
任意フィールドtrue に設定すると、アダルトキーワードがレスポンスに含まれます
デフォルト値：false
注意：Google Ads の制限により、API がこのようなキーワードのデータを返さない場合があります"
},
"sort_by": {
"type": [
"string",
"null"
],
"description": "結果の並べ替えパラメーター
任意フィールド
これらのパラメーターを使用して、relevance、search_volume、competition_index、low_top_of_page_bid、high_top_of_page_bid で結果を降順に並べ替えられます
デフォルト値：relevance"
},
"tag": {
"type": [
"string",
"null"
],
"description": "ユーザー定義のタスク識別子
任意フィールド
文字数上限は 255 です
このパラメーターを使ってタスクを識別し、結果と照合できます
指定した tag の値は、レスポンスの data 配列に含まれます"
}
},
"example": [
{
"location_code": 2840,
"keywords": [
"buy laptop",
"cheap laptops for sale",
"purchase laptop"
],
"date_from": "2021-08-01",
"search_partners": true
}
]
}
]
},
"example": [
{
"location_code": 2840,
"keywords": [
"buy laptop",
"cheap laptops for sale",
"purchase laptop"
],
"date_from": "2021-08-01",
"search_partners": true
}
]
}
```
## Responses
### 200 — 操作成功
Headers:
- `X-Request-Id` (string) — Felo サポートに問い合わせる際に伝えるリクエスト識別子。
**application/json**
Schema: object | null
```json
{
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_KeywordsDataGoogleAdsSearchVolumeLiveResponseInfo"
}
]
}
```
### 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_KeywordsDataGoogleAdsSearchVolumeLiveResponseInfo
`#/components/schemas/Response36Afe1097B20_KeywordsDataGoogleAdsSearchVolumeLiveResponseInfo`
```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_KeywordsDataGoogleAdsSearchVolumeLiveTaskInfo"
}
]
},
"description": "タスクの配列"
}
}
}
]
}
```
### Response36Afe1097B20_KeywordsDataGoogleAdsSearchVolumeLiveResultInfo
`#/components/schemas/Response36Afe1097B20_KeywordsDataGoogleAdsSearchVolumeLiveResultInfo`
```json
{
"type": "object",
"properties": {
"keyword": {
"type": [
"string",
"null"
],
"description": "キーワード
キーワードは %## がデコードされた状態で返されます（プラス記号 '+' は空白文字にデコードされます）"
},
"spell": {
"type": [
"string",
"null"
],
"description": "キーワードの正しいスペル
注意：POST 配列内のキーワードのスペルが誤っている場合、正しいスペルのキーワードのデータが返されます。
キーワードのスペルを確認および検証するために Google Ads API の機能を使用しています。こちらのリンクで詳細を確認できます"
},
"location_code": {
"type": [
"integer",
"null"
],
"description": "POST 配列内のロケーションコード
データがない場合、値は null になります"
},
"language_code": {
"type": [
"string",
"null"
],
"description": "POST 配列内の言語コード
データがない場合、値は null になります"
},
"search_partners": {
"type": [
"boolean",
"null"
],
"description": "パートナー ネットワークからのデータがレスポンスに含まれるかどうかを示します"
},
"competition": {
"type": [
"string",
"null"
],
"description": "競合
指定したキーワードの有料 SERP における相対的な競合の程度のみを表します。
この値は Google Ads データに基づき、次の値を取ることができます：HIGH、MEDIUM、LOW。
データがない場合、値は null です。
この指標の詳細についてはこちらのヘルプセンター記事をご覧ください"
},
"competition_index": {
"type": [
"integer",
"null"
],
"description": "競合
指定したキーワードの有料 SERP における相対的な競合の程度のみを表します。
この値は Google Ads データに基づき、0 から 100 の範囲（両端を含む）です。
データがない場合、値は null です。
この指標の詳細についてはこちらのヘルプセンター記事をご覧ください"
},
"search_volume": {
"type": [
"integer",
"null"
],
"description": "月間平均検索ボリューム。
ユーザーのターゲティングに応じた、google.com または google.com とパートナーの指定したキーワード アイデアの（おおよその）検索数を表します。
データがない場合、値は null です",
"format": "int64"
},
"low_top_of_page_bid": {
"type": [
"number",
"null"
],
"description": "広告を検索結果の 1 ページ目上部に表示するための最低入札額
広告が表示された最低入札額の約 20% を上回る値を示します（Google Ads の広告主統計に基づく）。
この値は POST リクエストで指定した所在地によって異なる場合があります"
},
"high_top_of_page_bid": {
"type": [
"number",
"null"
],
"description": "広告を検索結果の 1 ページ目上部に表示するための最大入札額
広告が表示された最低入札額の約 80% を上回る値を示します（Google Ads の広告主統計に基づく）。
この値は POST リクエストで指定した所在地によって異なる場合があります"
},
"cpc": {
"type": [
"number",
"null"
],
"description": "クリック単価
指定したキーワードの広告が表示された際のクリックごとの支払額（USD）を示します"
},
"monthly_searches": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_MonthlySearchesInfo"
}
]
},
"description": "月間検索数
指定した地理的位置を対象とした、このキーワード アイデアの（おおよその）検索数（既定では過去 12 か月分の利用可能なデータ）を表します。
データがない場合、値は null です"
}
}
}
```
### Response36Afe1097B20_KeywordsDataGoogleAdsSearchVolumeLiveTaskInfo
`#/components/schemas/Response36Afe1097B20_KeywordsDataGoogleAdsSearchVolumeLiveTaskInfo`
```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_KeywordsDataGoogleAdsSearchVolumeLiveResultInfo"
}
]
},
"description": "結果の配列"
}
}
}
]
}
```
### 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": "月間平均検索ボリューム"
}
}
}
```