- HTTP-запрос
- Тело запроса
- Тело ответа
- РангПредпочтение
- Предвзятость местоположения
- Ограничение местоположения
- EVOptions
Поиск места на основе текстового запроса.
HTTP-запрос
POST https://places.googleapis.com/v1/places:searchText
URL-адрес использует синтаксис транскодирования gRPC .
Тело запроса
Тело запроса содержит данные следующей структуры:
JSON-представление |
---|
{ "textQuery": string, "languageCode": string, "regionCode": string, "rankPreference": enum ( |
Поля | |
---|---|
textQuery | Необходимый. Текстовый запрос для текстового поиска. |
languageCode | Информация о месте будет отображаться на предпочитаемом языке, если он доступен. Если код языка не указан или не распознан, могут быть возвращены сведения о месте на любом языке, причем предпочтение отдается английскому, если такие сведения существуют. Текущий список поддерживаемых языков: https://developers.google.com/maps/faq#languagesupport . |
regionCode | Код страны/региона Unicode (CLDR) места, откуда поступает запрос. Этот параметр используется для отображения сведений о месте, например названия места для конкретного региона, если оно доступно. Параметр может повлиять на результаты в соответствии с действующим законодательством. Для получения дополнительной информации см. https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html . Обратите внимание, что трехзначные коды регионов в настоящее время не поддерживаются. |
rankPreference | Как результаты будут ранжироваться в ответе. |
includedType | Запрошенный тип места. Полный список поддерживаемых типов: https://developers.google.com/maps/documentation/places/web-service/place-types . Поддерживается только один включенный тип. |
openNow | Используется для ограничения поиска местами, которые в данный момент открыты. По умолчанию — ложь. |
minRating | Отфильтровывайте результаты, средний рейтинг пользователей которых строго меньше этого предела. Допустимое значение должно быть числом с плавающей запятой от 0 до 5 (включительно) с частотой 0,5, т. е. [0, 0,5, 1,0, ..., 5,0] включительно. Входной рейтинг округляется до ближайших 0,5 (потолок). Например, рейтинг 0,6 исключит все результаты с рейтингом менее 1,0. |
maxResultCount | Максимальное количество возвращаемых результатов. Оно должно быть от 1 до 20 включительно. По умолчанию — 20. Если число не установлено, оно возвращается к верхнему пределу. Если число установлено отрицательным или превышает верхний предел, возвращается ошибка INVALID_ARGUMENT. |
priceLevels[] | Используется для ограничения поиска местами, отмеченными определенными уровнями цен. Пользователи могут выбирать любые комбинации уровней цен. По умолчанию выбираются все уровни цен. |
strictTypeFiltering | Используется для установки строгой фильтрации типов для includeType. Если установлено значение true, будут возвращены только результаты одного типа. По умолчанию — ложь. |
locationBias | Регион для поиска. Это местоположение служит предвзятостью, что означает, что могут быть возвращены результаты вокруг данного местоположения. Невозможно установить вместе с locationRestriction. |
locationRestriction | Регион для поиска. Это местоположение служит ограничением, которое означает, что результаты за пределами данного местоположения не будут возвращены. Невозможно установить вместе с locationBias. |
evOptions | Необязательный. Установите доступные для поиска параметры EV запроса на поиск места. |
Тело ответа
Прототип ответа для Places.searchText.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{
"places": [
{
object ( |
Поля | |
---|---|
places[] | Список мест, соответствующих критериям текстового поиска пользователя. |
РангПредпочтение
Как результаты будут ранжироваться в ответе.
Перечисления | |
---|---|
RANK_PREFERENCE_UNSPECIFIED | Для категориального запроса, такого как «Рестораны в Нью-Йорке», значением по умолчанию является РЕЛЕВАНТНОСТЬ. Для некатегорийных запросов, таких как «Маунтин-Вью, Калифорния», мы рекомендуем оставить RankPreference неустановленным. |
DISTANCE | Ранжирует результаты по расстоянию. |
RELEVANCE | Ранжирует результаты по релевантности. Порядок сортировки определяется обычным стеком ранжирования. |
Предвзятость местоположения
Регион для поиска. Это местоположение служит предвзятостью, что означает, что могут быть возвращены результаты вокруг данного местоположения.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
| |
rectangle | Прямоугольный блок, определяемый северо-восточным и юго-западным углами. |
circle | Круг, определяемый центральной точкой и радиусом. |
Ограничение местоположения
Регион для поиска. Это местоположение служит ограничением, которое означает, что результаты за пределами данного местоположения не будут возвращены.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
| |
rectangle | Прямоугольный блок, определяемый северо-восточным и юго-западным углами. |
EVOptions
Доступные для поиска параметры EV запроса на поиск места.
JSON-представление |
---|
{
"minimumChargingRateKw": number,
"connectorTypes": [
enum ( |
Поля | |
---|---|
minimumChargingRateKw | Необязательный. Минимальная необходимая мощность зарядки в киловаттах. Место, в котором тариф начисления меньше указанного, отфильтровывается. |
connectorTypes[] | Необязательный. Список предпочтительных типов разъемов EV. Место, не поддерживающее ни один из перечисленных типов соединителей, отфильтровывается. |