DataForSEO API における keyword および keywords フィールドのルールと制限については、こちらのヘルプセンター記事を参照してください"
},
"bid": {
"type": "number",
"description": "カスタム入札額の上限
必須フィールド
収集されるデータはこの値に基づきます
広告に対して支払ってもよい価格を表します。ここで指定する値が大きいほど、返される指標の値も大きくなります
こちらのヘルプセンター記事で詳しく確認できます"
},
"match": {
"type": "string",
"description": "キーワードのマッチタイプ
必須フィールド
次の値を指定できます：exact、broad、phrase"
},
"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"
},
"date_from": {
"type": "string",
"description": "予測期間の開始日date_to を指定する場合は必須フィールドdate_from と date_to を指定する場合、date_interval を指定する必要はありません
最小値は明日の日付ですdate_from に指定する値は date_to より後にできません
日付形式：\"yyyy-mm-dd\"
例：\"2021-10-30\"Status エンドポイント が actual_data フィールドで false を返す場合、date_from は先々月以前に設定できます；
Status エンドポイント が actual_data フィールドで true を返す場合、date_from は先月以前に設定できます"
},
"date_to": {
"type": "string",
"description": "予測期間の終了日date_from を指定する場合は必須フィールドdate_from と date_to を指定する場合、date_interval を指定する必要はありません
最小値は date_from +1 日です
最大値は翌年の同じ日付（現在の日付の月と日）です
日付形式：\"yyyy-mm-dd\"
例：\"2022-10-30\""
},
"date_interval": {
"type": [
"string",
"null"
],
"description": "予測の日付間隔
任意フィールドdate_interval を指定する場合、date_from と date_to を指定する必要はありません
指定可能な値：next_week、next_month、next_quarter
デフォルト値：next_month"
},
"sort_by": {
"type": [
"string",
"null"
],
"description": "結果の並べ替えパラメーター
任意フィールド
これらのパラメーターを使用して、relevance、average_cpc、cost、clicks で結果を降順に並べ替えられます
デフォルト値：relevance"
},
"postback_url": {
"type": [
"string",
"null"
],
"description": "タスク結果送信用の URL
任意フィールド
タスクが完了すると、結果を gzip 形式で圧縮し、指定した postback_url に POST リクエストを送信します
‘$id’ 文字列を $id 変数として、‘$tag’ を URL エンコードされた $tag 変数として使用できます。リクエストの送信前に必要な値を設定します。
例:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
注意: postback_url 内の特殊文字は URL エンコードされます
たとえば、# 文字は %23 にエンコードされます
詳細については、ヘルプセンターを参照してください"
},
"pingback_url": {
"type": [
"string",
"null"
],
"description": "タスク完了通知の URL
任意フィールド
タスクが完了すると、指定した URL に GET リクエストを送信して通知します
‘$id’ 文字列を $id 変数として、‘$tag’ を URL エンコードされた $tag 変数として使用できます。リクエストの送信前に必要な値を設定します。
例:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
注意: pingback_url 内の特殊文字は URL エンコードされます
たとえば、# 文字は %23 にエンコードされます
詳細については、ヘルプセンターを参照してください"
},
"tag": {
"type": [
"string",
"null"
],
"description": "ユーザー定義のタスク識別子
任意フィールド
文字数上限は 255 です
このパラメーターを使ってタスクを識別し、結果と照合できます
指定した tag の値は、レスポンスの data オブジェクトに含まれます"
}
},
"example": [
{
"language_code": "en",
"location_code": 2840,
"bid": 999,
"match": "exact",
"keywords": [
"seo marketing"
]
}
]
}
]
},
"example": [
{
"language_code": "en",
"location_code": 2840,
"bid": 999,
"match": "exact",
"keywords": [
"seo marketing"
]
}
]
}
```
## Responses
### 200 — 操作成功
Headers:
- `X-Request-Id` (string) — Felo サポートに問い合わせる際に伝えるリクエスト識別子。
**application/json**
Schema: object | null
```json
{
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostResponseInfo"
}
]
}
```
### 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_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostResponseInfo
`#/components/schemas/Response36Afe1097B20_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostResponseInfo`
```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_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostTaskInfo"
}
]
},
"description": "タスクの配列"
}
}
}
]
}
```
### Response36Afe1097B20_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostTaskInfo
`#/components/schemas/Response36Afe1097B20_KeywordsDataGoogleAdsAdTrafficByKeywordsTaskPostTaskInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": [
"object",
"null"
],
"description": "結果の配列
この場合、値は null になります"
}
}
}
]
}
```