Autocomplete Data

Класс AutocompleteSuggestion

class google.maps.places.AutocompleteSuggestion
library "places"

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

const {AutocompleteSuggestion} = await google.maps.importLibrary("places");
fetchAutocompleteSuggestions
fetchAutocompleteSuggestions(autocompleteRequest)
Параметры:
Возвращаемое значение: Promise<{suggestions:Array<AutocompleteSuggestion>}>
Получает список AutocompleteSuggestions.

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

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

Интерфейс AutocompleteRequest

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

Интерфейс запроса для AutocompleteSuggestion.fetchAutocompleteSuggestions.
input
Тип: string
Текстовая строка, по которой выполняется поиск.
futureOpeningBusinessesIncluded
необязательно
Тип: boolean optional
Включать в подсказки места, которые ещё не открылись, но должны открыться в будущем.
includedPrimaryTypes
необязательно
Тип: Array<string> optional
Основной тип места (например, "ресторан" или "АЗС").

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

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

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

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

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

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

Класс AutocompleteSessionToken

class google.maps.places.AutocompleteSessionToken
library "places"

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

const {AutocompleteSessionToken} = await google.maps.importLibrary("places");
AutocompleteSessionToken
AutocompleteSessionToken()
Параметры: нет.
Создает новый экземпляр класса AutocompleteSessionToken.

Класс PlacePrediction

class google.maps.places.PlacePrediction
library "places"

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

const {PlacePrediction} = await google.maps.importLibrary("places");
distanceMeters
readonly
Тип: number optional
Длина геодезической линии в метрах от origin, если указано origin.
mainText
readonly
Тип: FormattableText optional
Название места.
placeId
readonly
Тип: string
Уникальный идентификатор предложенного места. Этот идентификатор можно использовать в других API, которые принимают идентификаторы мест.
secondaryText
readonly
Тип: FormattableText optional
Представляет дополнительные уточняющие характеристики (например, город или регион) для дальнейшей идентификации места.
text
readonly
Содержит человекочитаемое название возвращенного результата. Для заведений это обычно название и адрес.

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

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

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

Класс StringRange

class google.maps.places.StringRange
library "places"

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

const {StringRange} = await google.maps.importLibrary("places");
endOffset
readonly
Тип: number
Смещение последнего символа Unicode в подстроке (не включительно). Нумерация начинается с нуля.
startOffset
readonly
Тип: number
Смещение первого символа Unicode в подстроке (включительно) относительно нуля.

Класс FormattableText

class google.maps.places.FormattableText
library "places"

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

const {FormattableText} = await google.maps.importLibrary("places");
matches
readonly
Список диапазонов строк, определяющих, где входной запрос совпал с FormattableText.text. Диапазоны можно использовать для форматирования определенных частей text. Подстроки могут не совпадать с AutocompleteRequest.input, если совпадение было определено по критериям, отличным от совпадения строк (например, исправление орфографии или транслитерация). Эти значения представляют собой смещения символов Юникода для FormattableText.text. Диапазоны гарантированно упорядочены по возрастанию значений смещения.
text
readonly
Тип: string
Текст, который можно использовать как есть или отформатировать с помощью FormattableText.matches.
toString
toString()
Параметры: нет.
Возвращаемое значение: string
Возвращает FormattableText.text.