Places Autocomplete Service

Класс автозаполненияService

google.maps.places . AutocompleteService Класс google.maps.places . AutocompleteService

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

Доступ осуществляется путем вызова const {AutocompleteService} = await google.maps.importLibrary("places") . См. раздел Библиотеки в Maps JavaScript API .

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)
Параметры:
Возвращаемое значение: Нет
Извлекает прогнозы автозаполнения запроса на основе предоставленного запроса автозаполнения запроса.

Интерфейс автозаполнения запроса

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

Запрос автозаполнения для отправки в AutocompleteService.getPlacePredictions .

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

Интерфейс автозаполнения ответа

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

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

predictions
Список AutocompletePrediction s.

Интерфейс запросаавтозаполнения запроса

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

Запрос QueryAutocompleteService для отправки в QueryAutocompleteService .

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

Класс AutocompleteSessionToken

google.maps.places . AutocompleteSessionToken Класс google.maps.places . AutocompleteSessionToken

Представляет токен сеанса, используемый для отслеживания сеанса автозаполнения, который может представлять собой серию вызовов AutocompleteService.getPlacePredictions , за которыми следует один вызов PlacesService.getDetails .

Доступ осуществляется путем вызова const {AutocompleteSessionToken} = await google.maps.importLibrary("places") . См. раздел Библиотеки в Maps JavaScript API .

AutocompleteSessionToken
AutocompleteSessionToken()
Параметры: Нет
Создает новый экземпляр AutocompleteSessionToken .

Интерфейс ComponentRestrictions

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

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

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

Интерфейс автозаполнения прогнозов

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

Представляет один прогноз автозаполнения.

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

Интерфейс QueryAutocompletePrediction

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

Представляет один прогноз автозаполнения запроса.

description
Тип: string
Это неформатированная версия запроса, предлагаемая службой Places.
matched_substrings
Набор подстрок в описании места, которые соответствуют элементам, введенным пользователем, и подходит для выделения этих подстрок. Каждая подстрока идентифицируется смещением и длиной, выраженными в символах Юникода.
terms
Тип: Array < PredictionTerm >
Информация об отдельных терминах в приведенном выше описании. На первом месте стоят категориальные термины (например, «ресторан»). Условия обращения располагаются от наиболее конкретного к наименее конкретному. Например, «Сан-Франциско» и «Калифорния».
place_id optional
Тип: string optional
Доступно только в том случае, если предсказание является местом. Идентификатор места, который можно использовать для получения сведений об этом месте с помощью службы сведений о месте (см. PlacesService.getDetails ).

Интерфейс прогнозирования

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

Представляет термин прогнозирования.

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

Интерфейс PredictionSubstring

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

Представляет подстроку прогноза.

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

Структурированный интерфейс форматирования

google.maps.places . StructuredFormatting интерфейс форматирования

Содержит структурированную информацию об описании места, разделенную на основной текст и дополнительный текст, включая массив совпадающих подстрок из ввода автозаполнения, идентифицируемых смещением и длиной, выраженными в символах Юникода.

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