keyword можно указать до 700 символовkeyword нужен символ «%», укажите его как «%25»;keyword нужен символ «+», укажите его как «%2B»Подробнее о правилах и ограничениях полей keyword и keywords в API DataForSEO читайте в статье Help Center"
},
"priority": {
"type": [
"integer",
"null"
],
"description": "приоритет задачи
необязательное поле
может принимать следующие значения:
1 — обычный приоритет выполнения (устанавливается по умолчанию)
2 — высокий приоритет выполнения
За задачи с высоким приоритетом выполнения взимается дополнительная плата.
Стоимость можно рассчитать на странице Тарифы."
},
"depth": {
"type": [
"integer",
"null"
],
"description": "глубина парсинга
необязательное поле
количество результатов в SERP
значение по умолчанию: 10
максимальное значение: 700
Оплата взимается за каждый SERP, содержащий до 10 результатов;
Установка глубины выше 10 может привести к дополнительным расходам, если поисковая система возвращает более 10 результатов;
Стоимость можно рассчитать на странице Тарифы."
},
"max_crawl_pages": {
"type": [
"integer",
"null"
],
"description": "лимит обхода страниц
необязательное поле
количество страниц результатов поиска для обхода
значение по умолчанию: 1
максимальное значение: 100
Примечание: параметры max_crawl_pages и depth дополняют друг друга;
подробнее в справочном центре"
},
"language_name": {
"type": "string",
"description": "полное название языка поисковой системы
обязательное поле, если не указан language_code
список доступных языков с их language_name можно получить отдельным запросом к https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesОбратите внимание, что в поисковой системе Baidu поддерживается только Chinese (Simplified). Однако Baidu может возвращать результаты и по запросам на других языках, поэтому указывать keyword на китайском не обязательно
пример:Chinese (Simplified)"
},
"language_code": {
"type": "string",
"description": "код языка поисковой системы
обязательное поле, если не указан language_name
список доступных языков с их language_code можно получить отдельным запросом к https://api.dataforseo.com/v3/serp/{{low_se_name}}/languagesОбратите внимание, что в поисковой системе Baidu поддерживается только Chinese (Simplified) с кодом языка zh_CN. Однако Baidu может возвращать результаты и по запросам на других языках, поэтому указывать keyword на китайском не обязательно
пример:zh_CN"
},
"location_name": {
"type": "string",
"description": "полное название местоположения поисковой системы
обязательное поле, если не указан location_code или location_coordinate
если используете это поле, location_code или location_coordinate указывать не нужно
список доступных местоположений с их location_name можно получить отдельным запросом к https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
пример:New York,New York,United States"
},
"location_code": {
"type": "integer",
"description": "код местоположения поисковой системы
обязательное поле, если не указан location_name или location_coordinate
если используете это поле, location_name или location_coordinate указывать не нужно
список доступных местоположений с их location_code можно получить отдельным запросом к https://api.dataforseo.com/v3/serp/{{low_se_name}}/locations
пример:2156"
},
"location_coordinate": {
"type": "string",
"description": "GPS-координаты местоположения
обязательное поле, если не указан location_name или location_code
если используете это поле, location_name или location_code указывать не нужно
параметр location_coordinate указывается в формате \"latitude,longitude,radius\"
максимальное число десятичных цифр для \"latitude\" и \"longitude\": 7
минимальное значение \"radius\": 199.9 (мм)
максимальное значение \"radius\": 199999 (мм)если используете это поле, возвращённые результаты будут основаны на ближайшем городе, найденном для ваших координат. Поэтому мы не рекомендуем использовать это поле, так как результаты могут не соответствовать указанным координатам
пример:53.476225,-2.243572,200"
},
"device": {
"type": [
"string",
"null"
],
"description": "тип устройства
необязательное поле
возвращать результаты для определённого типа устройства
может принимать значения: desktop, mobile, tablet
значение по умолчанию: desktop"
},
"os": {
"type": [
"string",
"null"
],
"description": "операционная система устройства
необязательное поле
если в поле device указано desktop, выбирайте из значений: windows, macos
значение по умолчанию: windows
если в поле device указано mobile, выбирайте из значений: android, ios
значение по умолчанию: android
если в поле device указано tablet, выбирайте из значений: android, ios
значение по умолчанию: android"
},
"get_website_url": {
"type": [
"boolean",
"null"
],
"description": "включать прямой URL для каждого результата в выдаче
необязательное поле
если задать true, возвращённые результаты будут содержать прямые URL сайтов из выдачи
по умолчанию URL в результатах Baidu кодируются поисковой системой,
например:http://www.baidu.com/link?url=KQt6LSwU5OHnPtB8210R8flBP40grY6lTPxH_0UO7S2kgiZMTmw3ztV0hCo5c1kLзначение по умолчанию: false
Примечание: если задать true, стоимость задачи умножается на 10, так как наша система выполняет отдельный запрос к каждому сайту из выдачи для получения его прямого URL"
},
"stop_crawl_on_match": {
"type": [
"array",
"null"
],
"items": {
"type": [
"object",
"null"
],
"oneOf": [
{
"type": "object",
"properties": {
"match_value": {
"type": [
"string",
"null"
],
"description": "целевой домен или значение с подстановкой\nобязательное поле, если указан stop_crawl_on_match;\nукажите целевой домен или значение с подстановкой;\nПримечание: имя домена указывается без протокола запроса;\nпример: dataforseo.com"
},
"match_type": {
"type": [
"string",
"null"
],
"description": "тип сопоставления цели\nобязательное поле, если указан stop_crawl_on_match;\nтип сопоставления для match_value\nвозможные значения: domain, with_subdomains, wildcard"
}
}
}
]
},
"description": "массив целей для остановки обхода\nнеобязательное поле\nесли указано, ответ будет содержать результаты SERP до указанного match_value включительно;\nв этом массиве можно указать до 10 целевых значений\nпример:\n\"stop_crawl_on_match\":[{\"match_value\":\"dataforseo.com\",\"match_type\":\"with_subdomains\"}]\nподробнее об этом параметре — в нашем справочном центре: https://dataforseo.com/help-center/using-the-stop_crawl_on_match-parameter-in-serp-api\nоплата взимается за каждый SERP, обойдённый по указанным целям"
},
"tag": {
"type": [
"string",
"null"
],
"description": "пользовательский идентификатор задачи
необязательное поле
ограничение — 255 символов
этот параметр позволяет идентифицировать задачу и сопоставить её с результатом
указанное значение tag вы найдёте в объекте data ответа"
},
"postback_url": {
"type": [
"string",
"null"
],
"description": "URL для отправки результатов задачи
необязательное поле
когда задача будет выполнена, мы отправим POST-запрос с результатами, сжатыми в формате gzip, на указанный вами postback_url
строку «$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"
},
"postback_data": {
"type": "string",
"description": "тип данных postback_url
обязательное поле, если указан postback_url
соответствует типу данных, который будет отправлен на ваш сервер
возможные значения:regular, html"
},
"pingback_url": {
"type": [
"string",
"null"
],
"description": "URL уведомления о завершении задачи
необязательное поле
когда задача будет выполнена, мы отправим GET-запрос на указанный вами URL
строку «$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"
}
},
"example": [
{
"location_code": 2156,
"keyword": "best iphone ever",
"tag": "some_string_123",
"priority": 2
}
]
}
]
},
"example": [
{
"location_code": 2156,
"keyword": "best iphone ever",
"tag": "some_string_123",
"priority": 2
}
]
}
```
## Responses
### 200 — Успешная операция
Headers:
- `X-Request-Id` (string) — Идентификатор запроса, который нужно указать при обращении в поддержку Felo.
**application/json**
Schema: object | null
```json
{
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_SerpBaiduOrganicTaskPostResponseInfo"
}
]
}
```
### 400 — Запрос не удалось обработать. Проверьте параметры запроса.
### 401 — Требуется действительный API-ключ Felo.
### 402 — Запрос не может быть выполнен: не выполнено требование биллинга.
### 403 — Аккаунту не разрешено выполнять эту операцию.
### 429 — Достигнут лимит запросов или расходов.
### 502 — Сервис не смог выполнить запрос.
### 503 — API или сервис биллинга временно недоступны.
### 504 — Истекло время ожидания обработки запроса.
### default — Ответ с ошибкой; сквозные ответы upstream могут использовать форматы провайдера
**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": "код состояния задачи\nформируется DataForSEO, может находиться в диапазоне 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_SerpBaiduOrganicTaskPostResponseInfo
`#/components/schemas/Response36Afe1097B20_SerpBaiduOrganicTaskPostResponseInfo`
```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_SerpBaiduOrganicTaskPostTaskInfo"
}
]
},
"description": "массив задач"
}
}
}
]
}
```
### Response36Afe1097B20_SerpBaiduOrganicTaskPostTaskInfo
`#/components/schemas/Response36Afe1097B20_SerpBaiduOrganicTaskPostTaskInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": [
"object",
"null"
],
"description": "массив результатов
в этом случае значение будет null"
}
}
}
]
}
```