Autocomplete Data (new)

Класс AutocompleteSuggestion

google.maps.places . AutocompleteSuggestion

Результат предложения автозаполнения.

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

fetchAutocompleteSuggestions
fetchAutocompleteSuggestions(autocompleteRequest)
Параметры:
Возвращаемое значение: Promise <{suggestions: Array < AutocompleteSuggestion >}>
Выводит список вариантов автозаполнения.

Если в запросе указан AutocompleteRequest.sessionToken , то этот токен сеанса будет автоматически включен при первом вызове Place.fetchFields для каждого Place , возвращаемого PlacePrediction.toPlace для результирующего PlacePrediction s.
placePrediction
Тип: PlacePrediction optional
Содержит понятное для человека название возвращаемого результата. Для результатов поиска по учреждениям это обычно название и адрес компании.

Если в AutocompleteRequest, используемом для извлечения этого AutocompleteSuggestion, был предоставлен AutocompleteRequest.sessionToken , тот же токен будет автоматически включен при первом вызове Place.fetchFields для Place , возвращаемого вызовом PlacePrediction.toPlace .

Интерфейс AutocompleteRequest

google.maps.places . AutocompleteRequest

Интерфейс запроса для AutocompleteSuggestion.fetchAutocompleteSuggestions .

input
Тип: string
Текстовая строка, по которой будет производиться поиск.
includedPrimaryTypes optional
Тип: Array <string> optional
Включен основной тип места (например, «ресторан» или «заправочная станция»).

Место возвращается только в том случае, если его основной тип указан в этом списке. Можно указать до 5 значений. Если типы не указаны, возвращаются все типы мест.
includedRegionCodes optional
Тип: Array <string> optional
Включать результаты только в указанных регионах, заданных как до 15 двухсимвольных кодов регионов CLDR. Пустой набор не ограничивает результаты. Если заданы оба locationRestriction и includedRegionCodes , результаты будут расположены в области пересечения.
inputOffset optional
Тип: number optional
Смещение символа Unicode в input , начинающееся с нуля, указывает позицию курсора в input . Положение курсора может влиять на возвращаемые прогнозы. Если не указано иное, по умолчанию используется длина, указанная в строке input .
language optional
Тип: string optional
Язык, на котором возвращаются результаты. По умолчанию используется язык, выбранный браузером. Результаты могут быть представлены на смешанных языках, если язык input отличается от language , указанного в поле , или если возвращаемое место не имеет перевода с локального языка на language .
locationBias optional
Тип: LocationBias optional
Смещение результатов в указанное место.

Следует задать максимум один из параметров locationBias или locationRestriction . Если ни один из них не задан, результаты будут смещены по IP-адресу, то есть IP-адрес будет сопоставлен с неточным местоположением и использован в качестве сигнала смещения.
locationRestriction optional
Тип: LocationRestriction optional
Ограничить результаты указанным местоположением.

Следует задать максимум один из параметров locationBias или locationRestriction . Если ни один из них не задан, результаты будут смещены по IP-адресу, то есть IP-адрес будет сопоставлен с неточным местоположением и использован в качестве сигнала смещения.
origin optional
Тип: LatLng | LatLngLiteral optional
Начальная точка, от которой рассчитывается геодезическое расстояние до пункта назначения (возвращается как PlacePrediction.distanceMeters ). Если это значение пропущено, геодезическое расстояние не возвращается.
region optional
Тип: string optional
Код региона, указанный как двухсимвольный код региона CLDR. Он влияет на форматирование адреса, ранжирование результатов и может влиять на возвращаемые результаты. Результаты не ограничиваются указанным регионом.
sessionToken optional
Тип: AutocompleteSessionToken optional
Токен, идентифицирующий сеанс автозаполнения для выставления счетов. Создайте новый токен сеанса с помощью AutocompleteSessionToken .

Сеанс начинается с того, что пользователь начинает вводить запрос, и завершается выбором места и вызовом Place.fetchFields . В каждом сеансе может быть несколько запросов, за которыми следует один вызов fetchFields . Учётные данные, используемые для каждого запроса в рамках сеанса, должны принадлежать одному проекту Google Cloud Console. После завершения сеанса токен становится недействительным; ваше приложение должно генерировать новый токен для каждого сеанса. Если параметр sessionToken пропущен или вы повторно используете токен сеанса, сеанс тарифицируется так, как если бы токен сеанса не предоставлялся (каждый запрос оплачивается отдельно).

Если токен сеанса указан в запросе к AutocompleteSuggestion.fetchAutocompleteSuggestions , тот же токен будет автоматически включен в первый вызов fetchFields для Place , возвращаемого путем вызова PlacePrediction.toPlace для одного из полученных AutocompleteSuggestion .

Мы рекомендуем следующие рекомендации:
  • Используйте токены сеанса для всех вызовов Place Autocomplete.
  • Генерируйте новый токен для каждого сеанса.
  • Обязательно передавайте уникальный токен сеанса для каждого нового сеанса. Использование одного и того же токена для нескольких сеансов приведёт к тому, что каждый запрос будет оплачиваться отдельно.

Класс AutocompleteSessionToken

google.maps.places . AutocompleteSessionToken

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

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

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

Класс PlacePrediction

google.maps.places . PlacePrediction

Результаты прогнозирования для функции автозаполнения места.

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

distanceMeters
Тип: number optional
Длина геодезической линии в метрах от origin если origin указано.
mainText
Тип: FormattableText optional
Представляет название места.
placeId
Тип: string
Уникальный идентификатор предлагаемого места. Этот идентификатор можно использовать в других API, принимающих идентификаторы мест.
secondaryText
Тип: FormattableText optional
Представляет собой дополнительные неоднозначные признаки (например, город или регион) для дальнейшей идентификации места.
text
Содержит понятное для человека название возвращаемого результата. Для результатов поиска по учреждениям это обычно название и адрес компании.

text рекомендуется разработчикам, желающим отобразить один элемент пользовательского интерфейса. Разработчикам, желающим отобразить два отдельных, но связанных элемента пользовательского интерфейса, можно использовать PlacePrediction.mainText и PlacePrediction.secondaryText .
types
Тип: Array <string>
Список типов, которые применяются к этому месту из таблицы A или таблицы B в https://developers.google.com/maps/documentation/places/web-service/place-types .
Beta fetchAddressValidation
fetchAddressValidation(request)
Параметры:
Возвращаемое значение: нет
Отправляет запрос на проверку адреса, связанный с этим сеансом автозаполнения (заполняя запрос токеном сеанса автозаполнения). Информация о месте из PlacePrediction автоматически не добавляется — это удобный метод для управления сеансом автозаполнения.
toPlace
toPlace()
Параметры: нет
Возвращаемое значение: Place
Возвращает представление PlacePrediction в виде Place . Для получения полной информации о месте требуется последующий вызов Place.fetchFields .

Если в AutocompleteRequest , используемом для извлечения этого PlacePrediction, был предоставлен AutocompleteRequest.sessionToken , тот же токен будет автоматически включен при вызове fetchFields.

В качестве альтернативы, при использовании PlaceAutocompleteElement первый вызов Place.fetchFields для Place , возвращаемого PlacePrediction.toPlace , автоматически включит токен сеанса.

Класс StringRange

google.maps.places . StringRange

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

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

endOffset
Тип: number
Смещение от нуля последнего символа Unicode подстроки (исключая его).
startOffset
Тип: number
Смещение от нуля первого символа Unicode подстроки (включительно).

Класс FormattableText

google.maps.places . FormattableText

Текст, представляющий собой прогноз места. Текст можно использовать как есть или отформатировать.

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

matches
Тип: Array < StringRange >
Список диапазонов строк, указывающих, где запрос ввода совпал с FormattableText.text . Эти диапазоны можно использовать для форматирования отдельных частей text . Подстроки могут не совпадать с AutocompleteRequest.input , если соответствие было определено по критериям, отличным от соответствия строк (например, исправление орфографии или транслитерация). Эти значения представляют собой смещения символов Unicode для FormattableText.text . Диапазоны гарантированно упорядочены по возрастанию значений смещения.
text
Тип: string
Текст, который можно использовать как есть или отформатировать с помощью FormattableText.matches .