keyword 및 keywords 필드의 규칙과 제한은 이 도움말 센터 문서에서 자세히 알아보세요"
},
"location_name": {
"type": "string",
"description": "위치의 전체 이름location_code를 지정하지 않으면 필수 필드
참고: location_name 또는 location_code 중 하나를 지정해야 합니다location_name 매개변수로 사용 가능한 위치 목록은 별도 요청으로 받을 수 있습니다https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
예시:United Kingdom"
},
"location_code": {
"type": "integer",
"description": "고유 위치 식별자location_name을 지정하지 않으면 필수 필드
참고: location_name 또는 location_code 중 하나를 지정해야 합니다location_code 매개변수로 사용 가능한 위치 목록은 별도 요청으로 받을 수 있습니다https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
예시:2840"
},
"language_name": {
"type": "string",
"description": "언어의 전체 이름language_code를 지정하지 않으면 필수 필드
참고: language_name 또는 language_code 중 하나를 지정해야 합니다language_name 매개변수로 사용 가능한 언어 목록은 별도 요청으로 받을 수 있습니다https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
예시:English"
},
"language_code": {
"type": [
"string",
"null"
],
"description": "고유 언어 식별자language_name을 지정하지 않으면 필수 필드
참고: language_name 또는 language_code 중 하나를 지정해야 합니다language_code 매개변수로 사용 가능한 언어 목록은 별도 요청으로 받을 수 있습니다https://api.dataforseo.com/v3/dataforseo_labs/locations_and_languages
예시:en"
},
"include_subdomains": {
"type": [
"boolean",
"null"
],
"description": "검색에 서브도메인 포함 여부
선택 필드false로 설정하면 서브도메인은 무시됩니다
기본값: true"
},
"item_types": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "검색 결과 유형
응답에 포함되는 검색 결과 유형을 나타냅니다
선택 필드
가능한 값: [\"organic\", \"paid\", \"featured_snippet\", \"local_pack\"]
기본값: [\"organic\", \"paid\"]"
},
"limit": {
"type": [
"integer",
"null"
],
"description": "반환되는 최대 도메인 수
선택 필드
기본값: 100
최댓값: 1000"
},
"offset": {
"type": [
"integer",
"null"
],
"description": "반환되는 도메인의 결과 배열에서의 오프셋
선택 필드
기본값: 010 값을 지정하면 결과 배열의 처음 열 도메인을 건너뛰고 그다음 도메인부터 데이터를 제공합니다"
},
"filters": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
]
},
"description": "결과 필터링 매개변수 배열
선택 필드
한 번에 여러 필터를 추가할 수 있습니다(최대 8개)
조건 사이에 논리 연산자 and, or를 설정해야 합니다
지원되는 연산자:regex, not_regex, <, <=, >, >=, =, <>, in, not_in, match, not_match, ilike, not_ilike, like, not_like% 연산자는 like 및 not_like, ilike 및 not_ilike와 함께 사용해 0자 이상의 임의 문자열을 일치시킬 수 있습니다
예시:[\"median_position\",\"in\",[1,10]]
[[\"median_position\",\"in\",[1,10]],\"and\",[\"domain\",\"not_like\",\"%wikipedia.org%\"]]
[[\"domain\",\"not_like\",\"%wikipedia.org%\"],
\"and\",
[[\"relevant_serp_items\",\">\",0],\"or\",[\"median_position\",\"in\",[1,10]]]]
필터에 대한 자세한 내용은 Dataforseo Labs - Filters 또는 도움말 센터 가이드를 참조하세요"
},
"order_by": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "결과 정렬 규칙
선택 필드filters 배열과 동일한 값을 사용해 결과를 정렬할 수 있습니다
가능한 정렬 유형:asc - 결과를 오름차순으로 정렬합니다desc - 결과를 내림차순으로 정렬합니다
쉼표를 구분자로 사용합니다
예시:[\"avg_position,asc\"]
기본 규칙:[\"rating,desc\"]
한 요청에는 정렬 규칙을 최대 3개까지만 설정할 수 있습니다.
여러 정렬 규칙은 쉼표로 구분해야 합니다
예시:[\"avg_position,asc\",\"etv,desc\"]"
},
"tag": {
"type": [
"string",
"null"
],
"description": "사용자 정의 작업 식별자
선택 필드
최대 255자
이 매개변수를 사용해 작업을 식별하고 결과와 매칭할 수 있습니다tag에 지정한 값은 응답의 data 객체에서 확인할 수 있습니다"
}
},
"example": [
{
"keywords": [
"phone"
],
"language_name": "English",
"location_code": 2840,
"item_types": [
"organic"
],
"limit": 5
}
]
}
]
},
"example": [
{
"keywords": [
"phone"
],
"language_name": "English",
"location_code": 2840,
"item_types": [
"organic"
],
"limit": 5
}
]
}
```
## Responses
### 200 — 작업 성공
Headers:
- `X-Request-Id` (string) — Felo 지원팀에 문의할 때 포함할 요청 식별자입니다.
**application/json**
Schema: object | null
```json
{
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveResponseInfo"
}
]
}
```
### 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_DataforseoLabsGoogleSerpCompetitorsLiveItem
`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveItem`
```json
{
"type": "object",
"properties": {
"se_type": {
"type": [
"string",
"null"
],
"description": "검색 엔진 유형"
},
"domain": {
"type": [
"string",
"null"
],
"description": "감지된 SERP 경쟁사의 도메인 이름"
},
"avg_position": {
"type": [
"number",
"null"
],
"description": "지정된 키워드에 대한 도메인의 평균 위치keywords_positions 배열 값의 산술 평균",
"format": "float"
},
"median_position": {
"type": [
"number",
"null"
],
"description": "지정된 키워드에 대한 도메인의 중앙값 위치keywords_positions 배열 값의 중앙값"
},
"rating": {
"type": [
"number",
"null"
],
"description": "가능한 최대 키워드 위치와 실제 키워드 위치의 차이
지정된 키워드에 대한 SERP에서 도메인의 상대적 가시성 비율을 나타냅니다
sum(100-keywords_positions)로 계산됩니다"
},
"etv": {
"type": [
"number",
"null"
],
"description": "예상 트래픽 규모
지정된 키워드가 웹사이트로 유도하는 예상 월간 트래픽을 나타냅니다
지정된 키워드의 검색량 값과 SERP 내 특정 위치의 CTR(클릭률)을 곱한 값의 합으로 계산됩니다
지표 계산 방법은 이 도움말 센터 문서에서 확인하세요"
},
"keywords_count": {
"type": [
"integer",
"null"
],
"description": "도메인이 SERP에서 위치를 가지는 지정된 키워드 수",
"format": "int64"
},
"visibility": {
"type": [
"number",
"null"
],
"description": "SERP 가시성 비율
지정된 키워드의 SERP 위치를 기준으로 웹사이트 가시성 비율을 나타냅니다
1~10 범위의 위치를 가진 키워드에는 각각 1~0.1의 가시성 지수가 부여됩니다
11~20 범위의 위치를 가진 키워드는 0.05의 고정 가시성 지수를 가집니다
20~100 위치의 키워드는 가시성 지수가 0입니다"
},
"relevant_serp_items": {
"type": [
"integer",
"null"
],
"description": "도메인과 관련된 SERP 요소 수
지정된 키워드에 대해 도메인과 관련된 SERP 내 검색 결과 수를 나타냅니다"
},
"keywords_positions": {
"type": [
"object",
"null"
],
"additionalProperties": {
"type": [
"array",
"null"
],
"items": {
"type": [
"integer",
"null"
]
}
},
"description": "키워드 위치
관련 도메인이 지정된 키워드에 대해 SERP에서 차지하는 SERP 위치"
}
}
}
```
### Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveResponseInfo
`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveResponseInfo`
```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_DataforseoLabsGoogleSerpCompetitorsLiveTaskInfo"
}
]
},
"description": "작업 배열"
}
}
}
]
}
```
### Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveResultInfo
`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveResultInfo`
```json
{
"type": "object",
"properties": {
"se_type": {
"type": [
"string",
"null"
],
"description": "검색 엔진 유형"
},
"seed_keywords": {
"type": [
"array",
"null"
],
"items": {
"type": [
"string",
"null"
]
},
"description": "요청에 지정된 키워드
키워드는 디코딩된 %##로 반환됩니다('+' 문자는 공백 문자로 디코딩됩니다)"
},
"location_code": {
"type": [
"integer",
"null"
],
"description": "POST 배열의 위치 코드
데이터가 없으면 값은 null입니다"
},
"language_code": {
"type": [
"string",
"null"
],
"description": "POST 배열의 언어 코드
데이터가 없으면 값은 null입니다"
},
"total_count": {
"type": [
"integer",
"null"
],
"description": "데이터베이스에서 요청과 관련된 총 결과 수",
"format": "int64"
},
"items_count": {
"type": [
"integer",
"null"
],
"description": "items 배열에 반환된 결과 수",
"format": "int64"
},
"items": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveItem"
}
]
},
"description": "감지된 SERP 경쟁사 및 관련 데이터를 포함합니다"
}
}
}
```
### Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveTaskInfo
`#/components/schemas/Response36Afe1097B20_DataforseoLabsGoogleSerpCompetitorsLiveTaskInfo`
```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_DataforseoLabsGoogleSerpCompetitorsLiveResultInfo"
}
]
},
"description": "결과 배열"
}
}
}
]
}
```