Places Autocomplete Service (deprecated)

Класс AutocompleteService

google.maps.places.AutocompleteService библиотека
класса "places"

Содержит методы, связанные с получением подсказок автозаполнения.

const {AutocompleteService} = await google.maps.importLibrary("places");
AutocompleteService
AutocompleteService()
Параметры: нет.
Создает новый экземпляр AutocompleteService.
getPlacePredictions
getPlacePredictions(request[, callback])
Параметры:
  • request: AutocompletionRequest Запрос автозаполнения.
  • callback: function(Array<AutocompletePrediction> optional, PlacesServiceStatus): void optional Обратный вызов, принимающий массив объектов AutocompletePrediction и значение PlacesServiceStatus в качестве аргумента.
Возвращаемое значение: Promise<AutocompleteResponse>
Получает подсказки автозаполнения мест на основе предоставленного запроса автозаполнения.
getQueryPredictions
getQueryPredictions(request, callback)
Параметры:
Возвращаемое значение: нет.
Получает подсказки автозаполнения на основе предоставленного запроса.

Интерфейс AutocompletionRequest

google.maps.places.AutocompletionRequest интерфейс

Запрос автозаполнения, который будет отправлен в AutocompleteService.getPlacePredictions.
input
Тип: string
Введенная пользователем строка.
bounds
необязательно
Границы для смещения прогноза. Подсказки будут подбираться с учетом указанного значения bounds, но не ограничиваться им. Если задано свойство bounds, то свойства location и radius будут игнорироваться.
componentRestrictions
необязательно
Тип: ComponentRestrictions optional
Ограничения для компонента. Ограничения компонентов используются, чтобы подсказки показывались только в родительском компоненте. например страну.
language
необязательно
Тип: string optional
Идентификатор языка, на котором должны быть возвращены результаты (если возможно). Результаты на выбранном языке могут иметь более высокий рейтинг, но рекомендации не ограничиваются этим языком. Вы можете ознакомиться со списком поддерживаемых языков.
location
необязательно
Тип: LatLng optional
Местоположение для уточнения подсказок. Прогнозы будут смещены в сторону заданных значений location и radius. В качестве альтернативы можно использовать bounds.
locationBias
необязательно
Тип: LocationBias optional
Мягкая граница или подсказка, которую следует использовать при поиске мест.
locationRestriction
необязательно
Тип: LocationRestriction optional
Границы для ограничения результатов поиска.
offset
необязательно
Тип: number optional
Позиция символа в поисковом запросе, на основе которого сервис предлагает подсказки (позиция курсора в поле ввода).
origin
необязательно
Тип: LatLng|LatLngLiteral optional
Местоположение, на основе которого рассчитывается AutocompletePrediction.distance_meters.
radius
необязательно
Тип: number optional
Радиус области, используемой для смещения подсказок. Значение свойства radius указывается в метрах и всегда должно сопровождаться свойством location. В качестве альтернативы можно использовать bounds.
region
необязательно
Тип: string optional
Код региона, который используется для форматирования и фильтрации результатов. Оно не ограничивает подсказки этой страной. Код региона указывается в виде двух буквенных символов ccTLD (домен верхнего уровня). Большинство кодов ccTLD идентичны кодам ISO 3166-1 с некоторыми существенными исключениями. Например, ccTLD Великобритании – uk (.co.uk), а код ISO 3166-1 – gb (технически для Соединенного Королевства Великобритании и Северной Ирландии).
sessionToken
необязательно
Тип: AutocompleteSessionToken optional
Уникальный идентификатор, используемый для объединения отдельных запросов в сеансы.
types
необязательно
Тип: Array<string> optional
Типы возвращаемых подсказок. Поддерживаемые типы перечислены в руководстве для разработчиков. Если типы не указаны, будут возвращены все типы.

Интерфейс AutocompleteResponse

google.maps.places.AutocompleteResponse интерфейс

Ответ Autocomplete, возвращенный вызовом AutocompleteService.getPlacePredictions и содержащий список AutocompletePrediction.
predictions
Список AutocompletePrediction.

Интерфейс QueryAutocompletionRequest

google.maps.places.QueryAutocompletionRequest интерфейс

Запрос QueryAutocompletion, который будет отправлен в QueryAutocompleteService.
input
Тип: string
Введенная пользователем строка.
bounds
необязательно
Границы для смещения прогноза. Подсказки будут подбираться с учетом указанного значения bounds, но не ограничиваться им. Если задано свойство bounds, то свойства location и radius будут игнорироваться.
location
необязательно
Тип: LatLng optional
Местоположение для уточнения подсказок. Прогнозы будут смещены в сторону заданных значений location и radius. В качестве альтернативы можно использовать bounds.
offset
необязательно
Тип: number optional
Позиция символа в поисковом запросе, на основе которого сервис предлагает подсказки (позиция курсора в поле ввода).
radius
необязательно
Тип: number optional
Радиус области, используемой для смещения подсказок. Значение свойства radius указывается в метрах и всегда должно сопровождаться свойством location. В качестве альтернативы можно использовать bounds.

Интерфейс ComponentRestrictions

google.maps.places.ComponentRestrictions интерфейс

Определяет ограничения компонентов, которые можно использовать с сервисом автозаполнения.
country
необязательно
Тип: string|Array<string> optional
Ограничивает подсказки указанной страной (код страны ISO 3166-1 Alpha-2, без учета регистра). Примеры: 'us', 'br', 'au'. Вы можете указать один код или массив, содержащий до пяти кодов.

Интерфейс AutocompletePrediction

google.maps.places.AutocompletePrediction интерфейс

Представляет одну подсказку автозаполнения.
description
Тип: string
Неформатированная версия запроса, предложенная сервисом Places.
matched_substrings
Набор подстрок в описании места, совпадающих с элементами введенных пользователем данных. Подходит для выделения этих подстрок. Каждая подстрока определяется смещением и длиной, выраженной в символах Unicode.
place_id
Тип: string
Идентификатор места, который можно использовать для получения сведений об этом месте с помощью сервиса информации о местах (см. PlacesService.getDetails).
structured_formatting
Структурированная информация об описании места, разделенная на основной и дополнительный текст, включая массив совпадающих подстрок из входных данных автозаполнения, идентифицируемых по смещению и длине, выраженных в символах Юникода.
terms
Информация об отдельных терминах в приведенном выше описании, от наиболее до наименее конкретных. Пример: "Taco Bell", "Willitis", "CA".
types
Тип: Array<string>
Массив типов, к которым относится подсказка, например 'establishment' или 'geocode'.
distance_meters
необязательно
Тип: number optional
Расстояние в метрах от места до указанной точки AutocompletionRequest.origin.

Интерфейс QueryAutocompletePrediction

google.maps.places.QueryAutocompletePrediction интерфейс

Представляет одну подсказку автозаполнения запроса.
description
Тип: string
Неформатированная версия запроса, предложенная сервисом Places.
matched_substrings
Набор подстрок в описании места, совпадающих с элементами введенных пользователем данных. Подходит для выделения этих подстрок. Каждая подстрока определяется смещением и длиной, выраженной в символах Unicode.
terms
Информация об отдельных терминах в описании выше. Сначала указываются категории (например, "ресторан"). Элементы адреса указываются в порядке от наиболее точного к наименее точному. Пример: "Москва", "Московская область".
place_id
необязательно
Тип: string optional
Доступно, только если подсказка относится к месту. Идентификатор места, который можно использовать для получения сведений об этом месте с помощью сервиса информации о местах (см. PlacesService.getDetails).

Интерфейс PredictionTerm

google.maps.places.PredictionTerm интерфейс

Представляет собой термин прогноза.
offset
Тип: number
Смещение (в символах Юникода) начала этого термина в описании места.
value
Тип: string
Значение этого термина, например "Taco Bell".

Интерфейс PredictionSubstring

google.maps.places.PredictionSubstring интерфейс

Представляет подстроку подсказки.
length
Тип: number
Длина подстроки.
offset
Тип: number
Смещение до начала подстроки в строке description.

Интерфейс StructuredFormatting

google.maps.places.StructuredFormatting интерфейс

Содержит структурированную информацию об описании места, разделенную на основной и дополнительный текст, включая массив совпадающих подстрок из ввода автозаполнения, идентифицируемых по смещению и длине, выраженных в символах Юникода.
main_text
Тип: string
Это основная текстовая часть неформатированного описания места, предложенного сервисом Places. Обычно это название места.
main_text_matched_substrings
Набор подстрок в основном тексте, совпадающих с элементами введенных пользователем данных. Подходит для выделения этих подстрок. Каждая подстрока определяется смещением и длиной, выраженной в символах Unicode.
secondary_text
Тип: string
Дополнительный текст неформатированного описания места, предложенного сервисом Places. Обычно это адрес места.