DataForSEO API의 keyword 및 keywords 필드 규칙과 제한은 이 Help Center 문서에서 확인하세요"
},
"bid": {
"type": "number",
"description": "최대 맞춤 입찰가
필수 필드
수집되는 데이터는 이 값을 기준으로 합니다
광고에 지불할 의사가 있는 가격을 의미합니다. 여기에 높은 값을 지정할수록 반환되는 지표에서 더 높은 값을 얻게 됩니다
자세한 내용은 이 도움말 센터 문서에서 확인하세요"
},
"match": {
"type": "string",
"description": "키워드 일치 유형
필수 필드
다음 값을 사용할 수 있습니다: exact, broad, phrase"
},
"location_name": {
"type": [
"string",
"null"
],
"description": "검색 엔진 위치의 전체 이름
선택 필드
위치를 지정하지 않으면 전 세계 결과, 즉 사용 가능한 모든 위치의 결과를 받게 됩니다;
이 필드를 사용하면 location_code 또는 location_coordinate를 지정할 필요가 없습니다
사용 가능한 검색 엔진 위치와 해당 location_name 목록은 https://api.dataforseo.com/v3/keywords_data/google_ads/locations로 별도 요청해 받을 수 있습니다
예:London,England,United Kingdom"
},
"location_code": {
"type": [
"integer",
"null"
],
"description": "검색 엔진 위치 코드
선택 필드
위치를 지정하지 않으면 전 세계 결과, 즉 사용 가능한 모든 위치의 결과를 받게 됩니다;
이 필드를 사용하면 location_name 또는 location_coordinate를 지정할 필요가 없습니다;
사용 가능한 검색 엔진 위치와 해당 location_code 목록은 https://api.dataforseo.com/v3/keywords_data/google_ads/locations로 별도 요청해 받을 수 있습니다
예:2840"
},
"location_coordinate": {
"type": [
"string",
"null"
],
"description": "위치의 GPS 좌표
선택 필드
위치를 지정하지 않으면 전 세계 결과, 즉 사용 가능한 모든 위치의 결과를 받게 됩니다;
이 필드를 사용하면 location_name 또는 location_code를 지정할 필요가 없습니다;location_coordinate 매개변수는 \"위도,경도\" 형식으로 지정해야 합니다;
데이터는 지정한 좌표가 속한 국가에 대해 제공됩니다;
예:52.6178549,-155.352142"
},
"language_name": {
"type": [
"string",
"null"
],
"description": "검색 엔진 언어의 전체 이름
선택 필드
사용 가능한 검색 엔진 언어와 해당 language_name 목록은 https://api.dataforseo.com/v3/keywords_data/google_ads/languages로 별도 요청해 받을 수 있습니다
예:English"
},
"language_code": {
"type": [
"string",
"null"
],
"description": "검색 엔진 언어 코드
선택 필드
사용 가능한 검색 엔진 언어와 해당 language_code 목록은 https://api.dataforseo.com/v3/keywords_data/google_ads/languages로 별도 요청해 받을 수 있습니다
예: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’를 urlencoded $tag 변수로 사용할 수 있습니다. 요청을 보내기 전에 필요한 값을 설정합니다.
예:http://your-server.com/postbackscript?id=$idhttp://your-server.com/postbackscript?id=$id&tag=$tag
참고: postback_url의 특수 문자는 urlencoded됩니다;
즉, # 문자는 %23으로 인코딩됩니다
자세한 내용은 Help Center를 참고하세요"
},
"pingback_url": {
"type": [
"string",
"null"
],
"description": "완료된 작업의 알림 URL
선택 필드
작업이 완료되면 지정한 URL로 GET 요청을 보내 알립니다
‘$id’ 문자열을 $id 변수로, ‘$tag’를 urlencoded $tag 변수로 사용할 수 있습니다. 요청을 보내기 전에 필요한 값을 설정합니다.
예:http://your-server.com/pingscript?id=$idhttp://your-server.com/pingscript?id=$id&tag=$tag
참고: pingback_url의 특수 문자는 urlencoded됩니다;
즉, # 문자는 %23으로 인코딩됩니다
자세한 내용은 Help Center를 참고하세요"
},
"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입니다"
}
}
}
]
}
```