Method: searchText

Поиск мест по текстовому запросу.

HTTP-запрос

POST https://mapstools.googleapis.com/v1:searchText

URL имеет синтаксис gRPC Transcoding.

Тело запроса

Ниже приведена структура данных в теле запроса.

JSON-представление
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "pageSize": integer,
  "includeExtendedDetails": boolean,
  "locationBias": {
    object (LocationBias)
  }
}
Поля
textQuery

string

Обязательно. Текстовый запрос.

languageCode

string

Необязательное поле. Язык, на котором нужно составить краткий пересказ. Если код языка не указан или не распознан, будет возвращена сводка на английском языке.

Например, "en" для английского языка.

Актуальный список поддерживаемых языков: https://developers.google.com/maps/faq#languagesupport.

regionCode

string

Необязательное поле. Код страны или региона (CLDR) в формате Unicode, откуда поступает запрос. Этот параметр используется для отображения информации о местах, например названия места для определенного региона, если оно доступно. Параметр может влиять на результаты в соответствии с действующим законодательством.

Например, "US" для США.

Подробную информацию можно найти на странице https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.

Обратите внимание, что трехзначные коды регионов в настоящее время не поддерживаются.

pageSize

integer

Необязательное поле. Максимальное количество мест в ответе (до 10). Сервис может вернуть меньше результатов, чем указано в этом значении. Значение по умолчанию – 5.

Если запросить более 5 Places, будет активирован уровень Pro, что приведет к увеличению суммы к оплате и задержки.

includeExtendedDetails

boolean

Необязательное поле. Включает в ответ расширенные сведения о месте.

Установите для этого поля значение true, если запрос пользователя требует подробных качественных данных, динамики в реальном времени или специализированных атрибутов объектов: - Качественные отзывы, настроения клиентов и обратная связь. – конкретные предложения, например позиции меню, блюда, фирменные блюда, напитки или особенности бизнеса. - Качественная атмосфера, декор интерьера, эстетика, атмосфера или настроение. - Данные в реальном времени и характеристики специализированных учреждений, правила/советы для посетителей, время ожидания.

Оставьте значение false (по умолчанию) для стандартных поисковых запросов (например, по типу кухни или магазина), поиска местоположения/адреса, контактной информации, часов работы и стандартных метаданных/удобств.

Если включить это поле, будет активирован уровень Pro, что приведет к увеличению суммы к оплате и задержки.

locationBias

object (LocationBias)

Необязательный параметр, позволяющий ограничить результаты поиска определенным регионом. Если в поле textQuery указано точное местоположение, то для уточнения результатов поиска будет использоваться оно, а не значение этого поля.

Тело ответа

Если ответ получен успешно, его тело содержит экземпляр SearchTextResponse.

Области авторизации

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/maps-platform.mapstools