DataForSEO API의 keyword 및 keywords 필드 규칙과 제한은 이 Help Center 문서에서 확인하세요"
},
"device": {
"type": [
"string",
"null"
],
"description": "기기 유형
선택 필드
특정 기기 유형의 데이터를 가져오려면 이 필드를 지정하세요. 가능한 값: desktop, mobile, tablet, all
기본값: all"
},
"match": {
"type": [
"string",
"null"
],
"description": "키워드 일치 유형
선택 필드
다음 값을 사용할 수 있습니다:aggregate는 모든 일치 유형의 데이터를 반환합니다;broad는 지정한 키워드를 포함하며 단어 순서가 다른 모든 사용자 쿼리의 데이터를 반환합니다;phrase는 지정한 키워드를 포함하며 단어 순서가 동일한 모든 사용자 쿼리의 데이터를 반환합니다;exact는 지정한 키워드와 일치하는 사용자 쿼리의 데이터를 반환합니다;참고: 기본적으로 aggregate 일치 유형이 적용됩니다"
},
"location_name": {
"type": "string",
"description": "검색 엔진 위치의 전체 이름location_code 또는 location_coordinate를 지정하지 않으면 필수 필드
이 필드를 사용하면 location_code 또는 location_coordinate를 지정할 필요가 없습니다
사용 가능한 위치 및 언어 목록은 https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages로 별도 요청해 받을 수 있습니다
예:\"United States\""
},
"location_code": {
"type": "integer",
"description": "검색 엔진 위치 코드location_name 또는 location_coordinate를 지정하지 않으면 필수 필드
이 필드를 사용하면 location_name 또는 location_coordinate를 지정할 필요가 없습니다
사용 가능한 위치 및 언어 목록은 https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages로 별도 요청해 받을 수 있습니다
예:2840"
},
"location_coordinate": {
"type": "string",
"description": "위치의 GPS 좌표location_name 또는 location_code를 지정하지 않으면 필수 필드
이 필드를 사용하면 location_name 또는 location_code를 지정할 필요가 없습니다location_coordinate 매개변수는 \"위도,경도\" 형식으로 지정해야 합니다
데이터는 지정한 좌표가 속한 국가에 대해 제공됩니다
예:52.6178549,-155.352142"
},
"language_name": {
"type": "string",
"description": "검색 엔진 언어의 전체 이름language_code를 지정하지 않으면 필수 필드
이 필드를 사용하면 language_code를 지정할 필요가 없습니다
사용 가능한 위치 및 언어 목록은 https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages로 별도 요청해 받을 수 있습니다
예:English"
},
"language_code": {
"type": "string",
"description": "검색 엔진 언어 코드language_name을 지정하지 않으면 필수 필드
사용 가능한 위치 및 언어 목록은 https://api.dataforseo.com/v3/keywords_data/bing/keyword_performance/locations_and_languages로 별도 요청해 받을 수 있습니다
예:\"en\""
},
"tag": {
"type": [
"string",
"null"
],
"description": "사용자 정의 작업 식별자
선택 필드
최대 255자
이 매개변수를 사용해 작업을 식별하고 결과와 매칭할 수 있습니다tag에 지정한 값은 응답의 data 객체에서 확인할 수 있습니다"
}
},
"example": [
{
"location_code": 2840,
"language_code": "en",
"keywords": [
"dataforseo",
"seo",
"ranking"
]
}
]
}
]
},
"example": [
{
"location_code": 2840,
"language_code": "en",
"keywords": [
"dataforseo",
"seo",
"ranking"
]
}
]
}
```
## Responses
### 200 — 작업 성공
Headers:
- `X-Request-Id` (string) — Felo 지원팀에 문의할 때 포함할 요청 식별자입니다.
**application/json**
Schema: object | null
```json
{
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_KeywordsDataBingKeywordPerformanceLiveResponseInfo"
}
]
}
```
### 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_KeywordKpi
`#/components/schemas/Response36Afe1097B20_KeywordKpi`
```json
{
"type": "object",
"properties": {
"desktop": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_KeywordKpiItemInfo"
}
]
},
"description": "데스크톱 기기용으로 집계된 키워드 데이터
데이터가 없으면 값은_nulln"
},
"mobile": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_KeywordKpiItemInfo"
}
]
},
"description": "모바일 기기용으로 집계된 키워드 데이터
데이터가 없으면 값은_nulln"
},
"tablet": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_KeywordKpiItemInfo"
}
]
},
"description": "태블릿 기기용으로 집계된 키워드 데이터
데이터가 없으면 값은_nulln"
}
}
}
```
### Response36Afe1097B20_KeywordKpiItemInfo
`#/components/schemas/Response36Afe1097B20_KeywordKpiItemInfo`
```json
{
"type": "object",
"properties": {
"ad_position": {
"type": [
"string",
"null"
],
"description": "SERP에서 관련 광고의 위치를 나타냅니다
다음 값을 사용할 수 있습니다:FirstPage1: 첫 번째 검색 결과 페이지 오른쪽에 표시되는 첫 번째 광고FirstPage2: 첫 번째 검색 결과 페이지 오른쪽에 표시되는 두 번째 광고FirstPage3: 첫 번째 검색 결과 페이지 오른쪽에 표시되는 세 번째 광고FirstPage4: 첫 번째 검색 결과 페이지 오른쪽에 표시되는 네 번째 광고FirstPage5: 첫 번째 검색 결과 페이지 오른쪽에 표시되는 다섯 번째 광고FirstPage6: 첫 번째 검색 결과 페이지 오른쪽에 표시되는 여섯 번째 광고FirstPage7: 첫 번째 검색 결과 페이지 오른쪽에 표시되는 일곱 번째 광고FirstPage8: 첫 번째 검색 결과 페이지 오른쪽에 표시되는 여덟 번째 광고FirstPage9: 첫 번째 검색 결과 페이지 오른쪽에 표시되는 아홉 번째 광고FirstPage10: 첫 번째 검색 결과 페이지 오른쪽에 표시되는 열 번째 광고MainLine1: 검색 결과 페이지 상단에 표시되는 첫 번째 광고MainLine2: 검색 결과 페이지 상단에 표시되는 두 번째 광고MainLine3: 검색 결과 페이지 상단에 표시되는 세 번째 광고MainLine4: 검색 결과 페이지 상단에 표시되는 네 번째 광고"
},
"clicks": {
"type": [
"integer",
"null"
],
"description": "광고 클릭수
지난 한 달 동안 해당 키워드와 일치 유형이 생성한 클릭 수"
},
"impressions": {
"type": [
"integer",
"null"
],
"description": "광고 노출수
지난 한 달 동안 해당 키워드와 일치 유형이 생성한 노출 수"
},
"average_cpc": {
"type": [
"number",
"null"
],
"description": "평균 클릭당 비용, USD
모든 클릭의 비용을 클릭 수로 나누어 계산합니다",
"format": "double"
},
"ctr": {
"type": [
"number",
"null"
],
"description": "백분율로 표시된 클릭률
클릭 수를 노출 수로 나눈 뒤 그 결과에 100을 곱하여 계산합니다",
"format": "double"
},
"total_cost": {
"type": [
"number",
"null"
],
"description": "광고의 총비용, USD
지난 한 달 동안 지정된 키워드와 일치 유형을 사용한 비용",
"format": "int64"
},
"average_bid": {
"type": [
"number",
"null"
],
"description": "키워드의 평균 입찰가",
"format": "double"
}
}
}
```
### Response36Afe1097B20_KeywordsDataBingKeywordPerformanceLiveResponseInfo
`#/components/schemas/Response36Afe1097B20_KeywordsDataBingKeywordPerformanceLiveResponseInfo`
```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_KeywordsDataBingKeywordPerformanceLiveTaskInfo"
}
]
},
"description": "작업 배열"
}
}
}
]
}
```
### Response36Afe1097B20_KeywordsDataBingKeywordPerformanceLiveResultInfo
`#/components/schemas/Response36Afe1097B20_KeywordsDataBingKeywordPerformanceLiveResultInfo`
```json
{
"type": "object",
"properties": {
"keyword": {
"type": [
"string",
"null"
],
"description": "POST 배열의 키워드"
},
"location_code": {
"type": [
"integer",
"null"
],
"description": "POST 배열의 위치 코드
데이터가 없으면 값은 null입니다"
},
"language_code": {
"type": [
"string",
"null"
],
"description": "POST 배열의 언어 코드
데이터가 없으면 값은 null입니다"
},
"year": {
"type": [
"integer",
"null"
],
"description": "데이터가 제공되는 연도를 나타냅니다
예:2020"
},
"month": {
"type": [
"integer",
"null"
],
"description": "데이터가 제공되는 월을 나타냅니다
예:10"
},
"keyword_kpi": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_KeywordKpi"
}
],
"description": "키워드 지표를 담은 객체
데이터가 없으면 값은_nulln"
}
}
}
```
### Response36Afe1097B20_KeywordsDataBingKeywordPerformanceLiveTaskInfo
`#/components/schemas/Response36Afe1097B20_KeywordsDataBingKeywordPerformanceLiveTaskInfo`
```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_KeywordsDataBingKeywordPerformanceLiveResultInfo"
}
]
},
"description": "결과 배열"
}
}
}
]
}
```