Places Autocomplete Service

Класс службы автозаполнения

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

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

Требуется параметр URL &libraries=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.
Возвращаемое значение: нет
Извлекает прогнозы автозаполнения запроса на основе предоставленного запроса автозаполнения запроса.

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

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

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

Требуется параметр URL &libraries=places . См. Библиотеки в Maps JavaScript API .

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 .
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
Типы прогнозов, которые должны быть возвращены. Поддерживаемые типы см. в руководстве разработчика . Если типы не указаны, будут возвращены все типы.

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

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

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

Требуется параметр URL &libraries=places . См. Библиотеки в Maps JavaScript API .

predictions
Список AutocompletePrediction s.

Интерфейс QueryAutocompletionRequest

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

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

Требуется параметр URL &libraries=places . См. Библиотеки в Maps JavaScript API .

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 .

Требуется параметр URL &libraries=places . См. Библиотеки в Maps JavaScript API .

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

Интерфейс ComponentRestrictions

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

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

Требуется параметр URL &libraries=places . См. Библиотеки в Maps JavaScript API .

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

Интерфейс AutocompletePrediction

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

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

Требуется параметр URL &libraries=places . См. Библиотеки в Maps JavaScript API .

description
Тип: string
Это неформатированная версия запроса, предложенная службой Places.
matched_substrings
Набор подстрок в описании места, которые соответствуют элементам пользовательского ввода, пригодные для выделения этих подстрок. Каждая подстрока идентифицируется смещением и длиной, выраженной в символах Юникода.
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 Интерфейс google.maps.places . QueryAutocompletePrediction

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

Требуется параметр URL &libraries=places . См. Библиотеки в Maps JavaScript API .

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

Интерфейс PredictionTerm

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

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

Требуется параметр URL &libraries=places . См. Библиотеки в Maps JavaScript API .

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

Интерфейс PredictionSubstring

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

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

Требуется параметр URL &libraries=places . См. Библиотеки в Maps JavaScript API .

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

Интерфейс StructuredFormatting

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

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

Требуется параметр URL &libraries=places . См. Библиотеки в Maps JavaScript API .

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