keyword можно указать до 700 символовkeyword нужен символ «%», укажите его как «%25»; Подробнее о правилах и ограничениях полей keyword и keywords в API DataForSEO читайте в этой статье Help Center"
},
"priority": {
"type": [
"integer",
"null"
],
"description": "приоритет задачи
необязательное поле
может принимать следующие значения:
1 — обычный приоритет выполнения (устанавливается по умолчанию)
2 — высокий приоритет выполнения. За задачи с высоким приоритетом взимается дополнительная плата.
Стоимость можно рассчитать на странице тарифов."
},
"location_name": {
"type": "string",
"description": "полное название местоположения поисковой системы
обязательное поле, если не указаны location_code или location_coordinate
если используете это поле, location_code или location_coordinate указывать не нужно
список доступных местоположений с их location_name можно получить отдельным запросом кhttps://api.dataforseo.com/v3/business_data/google/locations
пример:London,England,United Kingdom
Примечание: для получения точных результатов поиска указанное значение location_name будет автоматически добавлено к ключевому слову"
},
"location_code": {
"type": "integer",
"description": "код местоположения поисковой системы
обязательное поле, если не указаны location_name или location_coordinate
если используете это поле, location_name или location_coordinate указывать не нужно
список доступных местоположений с их location_code можно получить отдельным запросом кhttps://api.dataforseo.com/v3/business_data/google/locations
пример:2840"
},
"location_coordinate": {
"type": "string",
"description": "GPS-координаты местоположения
обязательное поле, если не указаны location_name или location_code
если используете это поле, location_name или location_code указывать не нужно
параметр location_coordinate должен быть указан в формате \"latitude,longitude\"
максимальное число десятичных знаков для \"latitude\" и \"longitude\": 7
Примечание: если координаты используются для задания местоположения, поиск выполняется в ближайшем населённом пункте;
пример:53.476225,-2.243572"
},
"search_this_area": {
"type": [
"boolean",
"null"
],
"description": "показывать отели из отображаемой области
необязательное поле
может принимать значения: true, false
значение по умолчанию: true
если задано false, режим search_this_area будет отключён
Примечание: если режим search_this_area отключён, location_name не будет добавляться к keyword при поиске
Подробнее об этом параметре — в нашем Help Center"
},
"language_name": {
"type": "string",
"description": "полное название языка поисковой системы
обязательное поле, если не указан language_code
если используете это поле, language_code указывать не нужно
список доступных языков с их language_name можно получить отдельным запросом к https://api.dataforseo.com/v3/business_data/google/languages
пример:English"
},
"language_code": {
"type": "string",
"description": "код языка поисковой системы
обязательное поле, если не указан language_name
если используете это поле, language_name указывать не нужно
список доступных языков с их language_code можно получить отдельным запросом к https://api.dataforseo.com/v3/business_data/google/languages
пример:en"
},
"depth": {
"type": [
"integer",
"null"
],
"description": "глубина парсинга
необязательное поле
количество результатов в Google Hotels
значение по умолчанию: 18 органических результатов
максимальное значение: 140
Примечание: плата с аккаунта взимается за каждые 18 органических результатов независимо от платных объявлений в ответе;
поэтому установка глубины выше 18 может привести к дополнительным расходам, если Google Hotels вернёт больше 18 результатов;
если указанная глубина превышает количество результатов в ответе, разница будет автоматически возвращена на баланс аккаунта"
},
"check_in": {
"type": [
"string",
"null"
],
"description": "дата заезда
необязательное поле
если не указать это поле, по умолчанию будет использована завтрашняя дата;
формат даты: \"yyyy-mm-dd\"
пример:\"2019-01-15\"
Примечание: значение не может быть раньше сегодняшней даты"
},
"check_out": {
"type": [
"string",
"null"
],
"description": "дата выезда
необязательное поле
если не указать это поле, система по умолчанию применит дату через два дня;
формат даты: \"yyyy-mm-dd\"
пример:\"2019-01-15\"
Примечание: значение не может быть меньше или равно check_in;
диапазон между значениями check_in и check_out не может превышать 30 дней"
},
"currency": {
"type": [
"string",
"null"
],
"description": "валюта
необязательное поле
пример:\"USD\""
},
"adults": {
"type": [
"integer",
"null"
],
"description": "количество взрослых
необязательное поле
если не указать это поле, будет применено значение по умолчанию 2;
Примечание: можно указать до 6 человек, включая взрослых и детей
пример:1"
},
"children": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "количество и возраст детей
необязательное поле
если не указать это поле, дети не будут включены в поиск;
возраст ребёнка может быть от 0 до 17;
Примечание: можно указать до 6 человек, включая взрослых и детей
укажите следующее значение, чтобы включить одного ребёнка 14 лет:[14]
укажите следующее значение, чтобы включить одного ребёнка 13 лет и одного ребёнка 8 лет:[13,8]"
},
"stars": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "звёздность отеля
необязательное поле
установите для этого поля значение [5], чтобы получить список только 5-звёздочных отелей
пример:[3,4,5]"
},
"min_rating": {
"type": [
"number",
"null"
],
"description": "минимальный рейтинг
необязательное поле
это поле позволяет указать рейтинг гостей выше определённого значения
пример:2.5"
},
"sort_by": {
"type": [
"string",
"null"
],
"description": "параметры сортировки результатов
необязательное поле
это поле позволяет сортировать результаты
возможные типы сортировки:relevance – сортировка по релевантностиlowest_price – сортировка по самой низкой ценеhighest_rating – сортировка по самому высокому рейтингуmost_reviewed – сортировка по количеству отзывов
значение по умолчанию: relevance"
},
"min_price": {
"type": [
"integer",
"null"
],
"description": "минимальная цена за ночь
необязательное поле
валюта этого значения зависит от поля currency
пример:100"
},
"max_price": {
"type": [
"integer",
"null"
],
"description": "максимальная цена за ночь
необязательное поле
валюта этого значения зависит от поля currency
пример:600"
},
"free_cancellation": {
"type": [
"boolean",
"null"
],
"description": "отели с бесплатной отменой
необязательное поле
установите для этого поля значение true, чтобы получить список отелей с бесплатной отменой бронирования
значение по умолчанию: false"
},
"is_vacation_rentals": {
"type": [
"boolean",
"null"
],
"description": "поиск жилья для отпуска
необязательное поле
установите для этого поля значение true, чтобы получить список жилья для отпуска вместо отелей
значение по умолчанию: false"
},
"amenities": {
"type": [
"array",
"null"
],
"items": {
"type": "string"
},
"description": "удобства отеля
необязательное поле
это поле позволяет указать различные удобства отеля
пример: [
\"free_parking\",
\"pets_allowed\"
]
возможные значения:\"air_conditioning\","
},
"tag": {
"type": [
"string",
"null"
],
"description": "пользовательский идентификатор задачи
\"all_inclusive_available\",
\"bar\",
\"free_breakfast\",
\"fitness_center\",
\"kid_friendly\",
\"free_parking\",
\"pets_allowed\",
\"pool\",
\"restaurant\",
\"room_service\",
\"spa\",
\"free_wifi\",
\"parking\",
\"indoor_pool\",
\"outdoor_pool\",
\"wheelchair_accessible\",
\"beach_access\"
необязательное поле
ограничение — 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"
},
"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": [
{
"language_code": "en",
"location_name": "New York,New York,United States",
"keyword": "cheap hotel",
"check_in": "2023-06-01",
"check_out": "2023-06-30",
"currency": "USD",
"adults": 2,
"children": [
"14"
],
"sort_by": "highest_rating",
"priority": 2,
"tag": "example"
}
]
}
]
},
"example": [
{
"language_code": "en",
"location_name": "New York,New York,United States",
"keyword": "cheap hotel",
"check_in": "2023-06-01",
"check_out": "2023-06-30",
"currency": "USD",
"adults": 2,
"children": [
"14"
],
"sort_by": "highest_rating",
"priority": 2,
"tag": "example"
}
]
}
```
## Responses
### 200 — Успешная операция
Headers:
- `X-Request-Id` (string) — Идентификатор запроса, который нужно указать при обращении в поддержку Felo.
**application/json**
Schema: object | null
```json
{
"type": [
"object",
"null"
],
"oneOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BusinessDataGoogleHotelSearchesTaskPostResponseInfo"
}
]
}
```
### 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_BusinessDataGoogleHotelSearchesTaskPostResponseInfo
`#/components/schemas/Response36Afe1097B20_BusinessDataGoogleHotelSearchesTaskPostResponseInfo`
```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_BusinessDataGoogleHotelSearchesTaskPostTaskInfo"
}
]
},
"description": "массив задач"
}
}
}
]
}
```
### Response36Afe1097B20_BusinessDataGoogleHotelSearchesTaskPostTaskInfo
`#/components/schemas/Response36Afe1097B20_BusinessDataGoogleHotelSearchesTaskPostTaskInfo`
```json
{
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/Response36Afe1097B20_BaseResponseTaskInfo"
},
{
"type": "object",
"properties": {
"result": {
"type": [
"object",
"null"
],
"description": "массив результатов
в этом случае значение будет null"
}
}
}
]
}
```