Address Validation (beta)

Класс AddressValidation

google.maps.addressValidation . AddressValidation

Статический класс для доступа к API AddressValidation.

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

Beta fetchAddressValidation
fetchAddressValidation(request)
Параметры:
Возвращаемое значение: Promise < AddressValidation >
Beta address
Тип: Address optional
Информация о самом адресе, а не о геокоде.
Beta geocode
Тип: Geocode optional
Информация о местоположении и месте, к которому привязан адрес.
Beta metadata
Тип: AddressMetadata optional
Прочая информация, имеющая отношение к доставляемости. Не гарантируется полное заполнение metadata для каждого адреса, отправляемого в API проверки адресов.
Beta responseId
Тип: string optional
UUID, идентифицирующий этот ответ. Если адрес необходимо повторно проверить, этот UUID должен сопровождать новый запрос.
Beta uspsData
Тип: USPSData optional
Дополнительные флаги доставки предоставляются USPS. Доступны только в регионах US и PR .
Beta verdict
Тип: Verdict optional
Флаги общего вердикта
Beta toJSON
toJSON()
Параметры: нет
Возвращаемое значение: Object
Преобразует класс AddressValidation в объект JSON с теми же свойствами.

Интерфейс AddressValidationRequest

google.maps.addressValidation . AddressValidationRequest

Запрос интерфейса для Beta AddressValidation.fetchAddressValidation .

Beta address
Адрес проверяется. Неформатированные адреса следует отправлять через PostalAddress.addressLines .
Beta previousResponseId optional
Тип: string optional
Это поле не должно быть заполнено для первого запроса на проверку адреса. Если для полной проверки одного адреса требуется больше запросов (например, если изменения, внесенные пользователем после первой проверки, требуют повторной проверки), то каждый последующий запрос должен заполнять это поле. Beta AddressValidation.responseId из самого первого ответа в последовательности проверки.
Beta uspsCASSEnabled optional
Тип: boolean optional
Включает режим совместимости с USPS CASS. Это влияет только на Beta AddressValidation.uspsData Поле Beta AddressValidation.uspsData в AddressValidation . Примечание: для запросов USPS CASS на адреса в Пуэрто-Рико необходимо указать PostalAddress.regionCode address как «PR» или PostalAddress.administrativeArea address как «Puerto Rico» (без учета регистра) или «PR».

Класс адреса

google.maps.addressValidation . Address

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

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

Beta components
Тип: Array < AddressComponent >
Отдельные компоненты отформатированного и исправленного адреса, а также информация о проверке. Здесь представлена ​​информация о статусе проверки отдельных компонентов.
Beta formattedAddress
Тип: string optional
Постобработанный адрес, отформатированный как однострочный адрес в соответствии с правилами форматирования адресов того региона, где расположен адрес.
Beta missingComponentTypes
Тип: Array <string>
Типы компонентов, которые должны были присутствовать в правильно отформатированном почтовом адресе, но не были обнаружены во входных данных и не могли быть выведены. Компоненты этого типа отсутствуют в formatted_address , postal_address и address_components . Примером может быть ['street_number', 'route'] для входных данных типа "Boulder, Colorado, 80301, USA". Список возможных типов можно найти здесь .
Beta postalAddress
Тип: PostalAddress optional
Постобработанный адрес, представленный в виде почтового адреса.
Beta unconfirmedComponentTypes
Тип: Array <string>
Типы компонентов, присутствующих в address_components , корректность которых не подтверждена. Это поле предоставлено для удобства: его содержимое эквивалентно итерации по address_components для поиска типов всех компонентов, где Beta AddressComponent.confirmationLevel не является Beta ConfirmationLevel.CONFIRMED или Beta AddressComponent.inferred Флаг Beta AddressComponent.inferred не имеет значения true . Список возможных типов можно найти здесь .
Beta unresolvedTokens
Тип: Array <string>
Любые токены во входных данных, которые не удалось распознать. Возможно, входные данные не были распознаны как допустимая часть адреса (например, в таких входных данных, как «123235253253 Main St, San Francisco, CA, 94105», неразрешённые токены могут выглядеть как ["123235253253"] поскольку это не похоже на допустимый номер дома).

Класс AddressComponent

google.maps.addressValidation . AddressComponent

Представляет собой отдельный компонент адреса (например, название улицы, города).

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

Beta componentName
Тип: string optional
Текст названия компонента. Например, «5th Avenue» для названия улицы или «1253» для номера дома.
Beta componentNameLanguageCode
Тип: string optional
Код языка BCP-47. Он будет отсутствовать, если название компонента не связано с языком, например, номер дома.
Beta componentType
Тип: string optional
Тип компонента адреса. Список возможных типов см. в Таблице 2: Дополнительные типы, возвращаемые службой Places .
Beta confirmationLevel
Тип: ConfirmationLevel optional
Указывает уровень уверенности в том, что компонент является правильным.
Beta inferred
Тип: boolean
Если значение равно true, этот компонент не был частью входных данных, но был выведен для определения местоположения адреса. Рекомендуется включить этот компонент для полного адреса.
Beta replaced
Тип: boolean
Указывает, что название компонента было заменено на совершенно другое. Например, неправильный почтовый индекс был заменен на правильный для адреса. Это не косметическое изменение; входной компонент был изменён на другой.
Beta spellCorrected
Тип: boolean
Указывает на исправление опечатки в названии компонента. API не всегда отмечает изменения написания, например, «center» на «center».
Beta unexpected
Тип: boolean
Если значение равно true, этот компонент не должен присутствовать в почтовом адресе для данного региона. Он был сохранён только потому, что был частью входных данных.

Класс AddressMetadata

google.maps.addressValidation . AddressMetadata

Метаданные для адреса. Полное заполнение AddressMetadata для каждого адреса, отправляемого в API проверки адресов, не гарантируется.

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

Beta business
Тип: boolean
Beta poBox
Тип: boolean
Beta residential
Тип: boolean

Константы уровня подтверждения

google.maps.addressValidation . ConfirmationLevel

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

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

Beta CONFIRMED
Beta UNCONFIRMED_AND_SUSPICIOUS
Beta UNCONFIRMED_BUT_PLAUSIBLE

Класс геокодирования

google.maps.addressValidation . Geocode

Содержит информацию о месте, к которому был геокодирован ввод.

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

Beta bounds
Тип: LatLngBounds optional
Границы геокодированного места.
Beta featureSizeMeters
Тип: number optional
Размер геокодируемого места в метрах. Это ещё одна мера грубости геокодируемого места, но по физическому размеру, а не по семантическому значению.
Beta location
Тип: LatLngAltitude optional
Геокодированное местоположение ввода.
Beta placeId
Тип: string optional
Идентификатор геокодированного места. Использование местоположения предпочтительнее использования адресов, координат широты/долготы или плюс-кодов. Использование координат для построения маршрута или расчета маршрутов всегда приводит к привязке точки к дороге, ближайшей к этим координатам. Эта дорога может не обеспечивать быстрого или безопасного доступа к пункту назначения и может находиться далеко от точки доступа к объекту недвижимости. Кроме того, при обратном геокодировании местоположения нет гарантии, что возвращаемый адрес будет соответствовать исходному.
Beta placeTypes
Тип: Array <string>
Тип(ы) места, к которому относится входной сигнал. Например, ['locality', 'political'] . Полный список типов можно найти в документации по API геокодирования .
Beta plusCode
Тип: PlusCode optional
Плюс-код, соответствующий location .
Beta fetchPlace
fetchPlace()
Параметры: нет
Возвращаемое значение: нет
Возвращает представление места для данного геокода. Чтобы получить полную информацию о месте, необходимо вызвать метод place.fetchFields().

Константы зернистости

google.maps.addressValidation . Granularity

Различные уровни детализации адреса или геокода. При использовании для указания уровня детализации адреса эти значения указывают, с какой степенью детализации адрес определяет почтовый пункт назначения. Например, такой адрес, как «123 Main Street, Redwood City, CA, 94061», определяет PREMISE , а такой адрес, как «Redwood City, CA, 94061», определяет LOCALITY . Однако, если нам не удаётся найти геокод для «123 Main Street» в Редвуд-Сити, возвращённый геокод может иметь уровень детализации НАСЕЛЕННЫЙ ПУНКТ LOCALITY , даже если адрес более детализирован.

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

Beta BLOCK Адрес или геокод указывает на блок. Используется только в регионах с адресацией на уровне блоков, например, в Японии.
Beta OTHER Все остальные уровни детализации объединены в одну группу, поскольку они не подлежат доставке.
Beta PREMISE Результат на уровне здания.
Beta PREMISE_PROXIMITY Геокод, который приблизительно определяет местоположение адреса на уровне здания.
Beta ROUTE Геокод или адрес детализируется для маршрута, например, улица, дорога или шоссе.
Beta SUB_PREMISE Результат, расположенный ниже уровня здания, например квартира.

Класс USPSAddress

google.maps.addressValidation . USPSAddress

Представление адреса в США USPS.

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

Beta city
Тип: string optional
Название города.
Beta cityStateZipAddressLine
Тип: string optional
Строка адреса, содержащая город, штат и почтовый индекс.
Beta firm
Тип: string optional
Название фирмы.
Beta firstAddressLine
Тип: string optional
Первая строка адреса.
Beta secondAddressLine
Тип: string optional
Вторая строка адреса.
Beta state
Тип: string optional
Двухбуквенный код штата.
Beta urbanization
Тип: string optional
Название урбанизации в Пуэрто-Рико.
Beta zipCode
Тип: string optional
Почтовый индекс, например «10009».
Beta zipCodeExtension
Тип: string optional
Четырехзначный почтовый индекс, например «5023».

Класс USPSData

google.maps.addressValidation . USPSData

Данные USPS для адреса. Полное заполнение USPSData для каждого адреса в США или Пуэрто-Рико, отправляемого в API проверки адресов, не гарантируется. Рекомендуется интегрировать резервные поля адреса в ответ, если вы используете uspsData в качестве основной части ответа.

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

Beta abbreviatedCity
Тип: string optional
Сокращенное название города.
Beta addressRecordType
Тип: string optional
Тип адресной записи, соответствующей входному адресу.
Beta carrierRoute
Тип: string optional
Код маршрута перевозчика. Четырехзначный код, состоящий из однобуквенного префикса и трехзначного обозначения маршрута.
Beta carrierRouteIndicator
Тип: string optional
Индикатор сортировки скорости маршрута перевозчика.
Beta cassProcessed
Тип: boolean
Индикатор того, что запрос обработан CASS.
Beta county
Тип: string optional
Название округа.
Beta deliveryPointCheckDigit
Тип: string optional
Контрольная цифра пункта доставки. Это число добавляется в конец штрихкода delivery_point_barcode для механически отсканированных почтовых отправлений. Сложение всех цифр штрихкода deliver_point_barcode, контрольной цифры deliver_point_check_digit, почтового индекса и ZIP+4 должно дать число, кратное 10.
Beta deliveryPointCode
Тип: string optional
Двузначный код пункта доставки.
Beta dpvCMRA
Тип: string optional
Указывает, принадлежит ли адрес коммерческому почтовому агентству (CMRA) — частной компании, получающей почту для клиентов. Возвращает один символ.
Beta dpvConfirmation
Тип: string optional
Возможные значения для подтверждения DPV. Возвращает один символ или не возвращает никакого значения.
Beta dpvDoorNotAccessible
Тип: string optional
Флаг указывает адреса, по которым USPS не может доставить почту. Возвращает один символ.
Beta dpvDrop
Тип: string optional
Флаг указывает, что почта доставляется в один приёмник на объекте. Возвращает один символ.
Beta dpvEnhancedDeliveryCode
Тип: string optional
Указывает, что для адреса допустимо более одного кода возврата DPV. Возвращает один символ.
Beta dpvFootnote
Тип: string optional
Сноски, полученные в результате проверки пункта доставки. Несколько сносок могут быть объединены в одну строку.
Beta dpvNonDeliveryDays
Тип: string optional
Флаг указывает, что доставка почты не осуществляется каждый день недели. Возвращает один символ.
Beta dpvNonDeliveryDaysValues
Тип: number optional
Целое число, идентифицирующее дни, когда доставка невозможна. Его можно запросить с помощью битовых флагов: 0x40 – воскресенье – день, когда доставка невозможна; 0x20 – понедельник – день, когда доставка невозможна; 0x10 – вторник – день, когда доставка невозможна; 0x08 – среда – день, когда доставка невозможна; 0x04 – четверг – день, когда доставка невозможна; 0x02 – пятница – день, когда доставка невозможна; 0x01 – суббота – день, когда доставка невозможна.
Beta dpvNoSecureLocation
Тип: string optional
Флаг указывает на то, что дверь доступна, но посылка не будет оставлена ​​из соображений безопасности. Возвращает один символ.
Beta dpvNoStat
Тип: string optional
Указывает, является ли адрес нестатистическим или активным. Нестатистические адреса — это адреса, которые не заняты постоянно или не обслуживаются USPS. Возвращает один символ.
Beta dpvNoStatReasonCode
Тип: number optional
Указывает тип NoStat. Возвращает код причины в виде целого числа.
Beta dpvPBSA
Тип: string optional
Указывает, что адрес соответствует записи PBSA. Возвращает один символ.
Beta dpvThrowback
Тип: string optional
Указывает, что почта не доставляется по указанному адресу. Возвращает один символ.
Beta dpvVacant
Тип: string optional
Указывает, свободен ли адрес. Возвращает один символ.
Beta elotFlag
Тип: string optional
Флаг возрастания/убывания eLOT (A/D).
Beta elotNumber
Тип: string optional
Номер расширенной линии перемещения (eLOT).
Beta errorMessage
Тип: string optional
Сообщение об ошибке при получении данных USPS. Оно появляется, когда обработка данных USPS приостановлена ​​из-за обнаружения искусственно созданных адресов.
Beta fipsCountyCode
Тип: string optional
Код округа FIPS.
Beta hasDefaultAddress
Тип: boolean
Индикатор того, что найден адрес по умолчанию, но существуют и более конкретные адреса.
Beta hasNoEWSMatch
Тип: boolean
Адрес доставки совпадает, но файл EWS указывает, что точное совпадение будет доступно в ближайшее время.
Beta lacsLinkIndicator
Тип: string optional
Индикатор LACSLink.
Beta lacsLinkReturnCode
Тип: string optional
Код возврата LACSLink.
Beta pmbDesignator
Тип: string optional
Обозначение единицы PMB (частный почтовый ящик).
Beta pmbNumber
Тип: string optional
Номер PMB (личный почтовый ящик).
Beta poBoxOnlyPostalCode
Тип: boolean
Только почтовый индекс почтового ящика.
Beta postOfficeCity
Тип: string optional
Главное почтовое отделение города.
Beta postOfficeState
Тип: string optional
Главное почтовое отделение штата.
Beta standardizedAddress
Тип: USPSAddress optional
Стандартизированный адрес USPS.
Beta suiteLinkFootnote
Тип: string optional
Сноски, полученные при сопоставлении записей об улице или высотном здании с информацией об офисах. Если найдено совпадение с названием компании, возвращается вторичный номер.

Класс вердикта

google.maps.addressValidation . Verdict

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

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

Beta addressComplete
Тип: boolean
Адрес считается полным, если нет неразрешённых токенов, неожиданных или отсутствующих компонентов адреса. Если не задано, это означает, что значение равно false . См. Beta Address.missingComponentTypes , Beta Address.unresolvedTokens или Beta AddressComponent.unexpected Поля Beta AddressComponent.unexpected для более подробной информации.
Beta geocodeGranularity
Тип: Granularity optional
Информация о степени детализации Geocode . Это можно понимать как семантическое значение степени детализации геокодированного местоположения.
Beta hasInferredComponents
Тип: boolean
По крайней мере один компонент адреса был выведен (т.е. добавлен), которого не было во входных данных, подробности см. в AddressComponent .
Beta hasReplacedComponents
Тип: boolean optional
По крайней мере один компонент адреса был заменен — подробности см. в AddressComponent .
Beta hasUnconfirmedComponents
Тип: boolean
По крайней мере один компонент адреса не может быть категоризирован или проверен, подробности см. в разделе AddressComponent .
Beta inputGranularity
Тип: Granularity optional
Степень детализации входного адреса. Это результат анализа входного адреса, не дающий никаких сигналов проверки. Подробнее о сигналах проверки см. в разделе validationGranularity .
Beta validationGranularity
Тип: Granularity optional
Уровень детализации, с которым API может полностью проверить адрес. Например, значение validationGranularity PREMISE указывает на возможность проверки всех компонентов адреса на уровне PREMISE и выше.