Places Autocomplete Service

Класс 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)
Параметры:
  • request : QueryAutocompletionRequest Запрос на автодополнение запроса.
  • callback : function( Array < QueryAutocompletePrediction > optional , PlacesServiceStatus ): void Обратный вызов, принимающий массив объектов QueryAutocompletePrediction и значение PlacesServiceStatus в качестве аргумента.
Возвращаемое значение: нет
Извлекает прогнозы автозаполнения запроса на основе предоставленного запроса автозаполнения запроса.

Интерфейс AutocompletionRequest

google.maps.places . AutocompletionRequest

Запрос на автодополнение, который необходимо отправить в AutocompleteService.getPlacePredictions .

input
Тип: string
Пользователь ввел строку ввода.
bounds optional
Тип: LatLngBounds | LatLngBoundsLiteral optional
Границы для смещения прогноза. Прогнозы будут смещены в сторону заданных bounds , но не ограничены ими. Если заданы bounds , location и radius будут игнорироваться.
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, за некоторыми заметными исключениями. Например, ccTLD Великобритании — «uk» ( .co.uk ), а код ISO 3166-1 — «gb» (технически обозначает «Соединённое Королевство Великобритании и Северной Ирландии»).
sessionToken optional
Тип: AutocompleteSessionToken optional
Уникальная ссылка, используемая для объединения отдельных запросов в сеансы.
types optional
Тип: Array <string> optional
Типы возвращаемых прогнозов. Поддерживаемые типы см. в руководстве разработчика . Если типы не указаны, будут возвращены все типы.

Интерфейс AutocompleteResponse

google.maps.places . AutocompleteResponse

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

predictions
Список AutocompletePrediction s.

Интерфейс QueryAutocompletionRequest

google.maps.places . QueryAutocompletionRequest

Запрос QueryAutocompletion, который необходимо отправить в QueryAutocompleteService .

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

Интерфейс ComponentRestrictions

google.maps.places . ComponentRestrictions

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

country optional
Тип: 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
Тип: Array < PredictionTerm >
Информация об отдельных терминах в описании выше, от наиболее к наименее конкретным. Например, «Taco Bell», «Willitis» и «CA».
types
Тип: Array <string>
Массив типов, к которым принадлежит прогноз, например 'establishment' или 'geocode' .
distance_meters optional
Тип: number optional
Расстояние в метрах от места AutocompletionRequest.origin .

Интерфейс QueryAutocompletePrediction

google.maps.places . QueryAutocompletePrediction

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

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

Интерфейс PredictionTerm

google.maps.places . PredictionTerm

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

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

Интерфейс PredictionSubstring

google.maps.places . PredictionSubstring

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

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

Интерфейс структурированного форматирования

google.maps.places . StructuredFormatting

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

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