Address Validation

Класс AddressValidation

google.maps.addressValidation.AddressValidation класс

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

Чтобы получить доступ, позвоните по номеру const {AddressValidation} = await google.maps.importLibrary("addressValidation").
Подробнее о библиотеках Maps JavaScript API…
fetchAddressValidation
fetchAddressValidation(request)
Параметры: 
Возвращаемое значение:  Promise<AddressValidation>
Проверяет адрес. Подробнее: https://developers.google.com/maps/documentation/javascript/address-validation/validate-address.
address
Тип:  Address optional
Информация о самом адресе, а не о геокоде.
geocode
Тип:  Geocode optional
Информация о местоположении и месте, к которому привязан адрес.
metadata
Тип:  AddressMetadata optional
Другая информация, связанная с доставляемостью. Не гарантируется, что поле metadata будет заполнено для каждого адреса, отправленного в Address Validation API.
responseId
Тип:  string optional
UUID, идентифицирующий этот ответ. Если адрес нужно проверить повторно, этот UUID должен быть указан в новом запросе.
uspsData
Тип:  USPSData optional
Дополнительные пометки о возможности доставки, предоставленные USPS. Доступно только в регионах US и PR.
verdict
Тип:  Verdict optional
Общие параметры оценки
toJSON
toJSON()
Параметры: нет.
Возвращаемое значение:  Object
Преобразует класс AddressValidation в объект JSON с теми же свойствами.

Интерфейс AddressValidationRequest

google.maps.addressValidation.AddressValidationRequest интерфейс

Интерфейс запроса для AddressValidation.fetchAddressValidation.
address
Адрес, который проверяется. Неформатированные адреса следует отправлять через PostalAddress.addressLines.
placeAutocompleteElement optional
Тип:  PlaceAutocompleteElement optional
Если вы используете PlaceAutocompleteElement, включите его здесь, чтобы связать вызовы API AddressValidation с токеном сеанса автозаполнения.
previousResponseId optional
Тип:  string optional
Это поле не должно быть задано для первого запроса на проверку адреса. Если для полной проверки одного адреса требуется больше запросов (например, если изменения, внесенные пользователем после первоначальной проверки, необходимо проверить повторно), то в каждом последующем запросе это поле должно быть заполнено значением AddressValidation.responseId из самого первого ответа в последовательности проверки.
sessionToken optional
Тип:  AutocompleteSessionToken optional
Токен, который идентифицирует сеанс Autocomplete для выставления счетов.
uspsCASSEnabled optional
Тип:  boolean optional
Включает режим, совместимый с USPS CASS. Это влияет только на поле AddressValidation.uspsData в AddressValidation. Примечание. Для запросов с включенной системой CASS Почтовой службы США, относящихся к адресам в Пуэрто-Рико, необходимо указать "PR" в поле PostalAddress.regionCode объекта address или "Puerto Rico" (без учета регистра) или "PR" в поле PostalAddress.administrativeArea объекта address.

Класс Address

google.maps.addressValidation.Address класс

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

Чтобы получить доступ, позвоните по номеру const {Address} = await google.maps.importLibrary("addressValidation").
Подробнее о библиотеках Maps JavaScript API…
components
Отдельные компоненты отформатированного и исправленного адреса, а также информация о проверке. Здесь вы найдете информацию о статусе проверки отдельных компонентов.
formattedAddress
Тип:  string optional
Обработанный адрес, отформатированный как однострочный адрес в соответствии с правилами форматирования адресов региона, в котором находится адрес.
missingComponentTypes
Тип:  Array<string>
Типы компонентов, которые должны присутствовать в правильно отформатированном почтовом адресе, но не были найдены во входных данных и не могут быть выведены. Компоненты этого типа отсутствуют в formatted_address, postal_address и address_components. Например, для входных данных "Boulder, Colorado, 80301, USA" (Боулдер, Колорадо, 80301, США) будет возвращено значение ['street_number', 'route']. Список возможных типов можно найти здесь.
postalAddress
Тип:  PostalAddress optional
Обработанный адрес, представленный в виде почтового адреса.
unconfirmedComponentTypes
Тип:  Array<string>
Типы компонентов, которые есть в address_components, но правильность которых не удалось подтвердить. Это поле предназначено для удобства: его содержимое эквивалентно итерации по address_components для поиска типов всех компонентов, где AddressComponent.confirmationLevel не равно ConfirmationLevel.CONFIRMED или флаг AddressComponent.inferred не установлен в значение true. Список возможных типов можно найти здесь.
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…
componentName
Тип:  string optional
Текст названия компонента. например "5-я авеню" (название улицы) или "1253" (номер дома).
componentNameLanguageCode
Тип:  string optional
Код языка по стандарту BCP 47. Этот параметр не будет указан, если название компонента не связано с языком, например номер дома.
componentType
Тип:  string optional
Тип компонента адреса. Список возможных типов приведен в таблице 2.
confirmationLevel
Тип:  ConfirmationLevel optional
Указывает уровень уверенности в том, что компонент правильный.
inferred
Тип:  boolean
Если равно true, этот компонент не был частью входных данных, но был выведен для местоположения адреса. Рекомендуется указывать этот компонент, чтобы адрес был полным.
replaced
Тип:  boolean
Указывает, что название компонента было заменено на совершенно другое. Например, если вы замените неверный почтовый индекс на правильный, Это не косметическое изменение, а замена компонента ввода на другой.
spellCorrected
Тип:  boolean
Исправлена опечатка в названии компонента. API не всегда помечает изменения, связанные с вариантами написания, например "centre" и "center".
unexpected
Тип:  boolean
Если значение равно true, этот компонент не должен присутствовать в почтовом адресе для указанного региона. Оно было сохранено только потому, что было частью входных данных.

Класс AddressMetadata

google.maps.addressValidation.AddressMetadata класс

Метаданные адреса. Не гарантируется, что AddressMetadata будет полностью заполнено для каждого адреса, отправленного в Address Validation API.

Чтобы получить доступ, позвоните по номеру const {AddressMetadata} = await google.maps.importLibrary("addressValidation").
Подробнее о библиотеках Maps JavaScript API…
business
Тип:  boolean
poBox
Тип:  boolean
residential
Тип:  boolean

Константы ConfirmationLevel

google.maps.addressValidation.ConfirmationLevel константы

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

Чтобы получить доступ, позвоните по номеру const {ConfirmationLevel} = await google.maps.importLibrary("addressValidation").
Подробнее о библиотеках Maps JavaScript API…
CONFIRMED
UNCONFIRMED_AND_SUSPICIOUS
UNCONFIRMED_BUT_PLAUSIBLE

Класс Geocode

google.maps.addressValidation.Geocode класс

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

Чтобы получить доступ, позвоните по номеру const {Geocode} = await google.maps.importLibrary("addressValidation").
Подробнее о библиотеках Maps JavaScript API…
bounds
Тип:  LatLngBounds optional
Границы геокодированного места.
featureSizeMeters
Тип:  number optional
Размер геокодированного места в метрах. Это ещё один показатель точности геокодирования, но он относится к физическому размеру, а не к семантическому значению.
location
Тип:  LatLngAltitude optional
Геокодированное местоположение входных данных.
placeId
Тип:  string optional
Идентификатор места, для которого выполнено геокодирование. Использовать Place предпочтительнее, чем адреса, координаты широты и долготы или коды Plus Code. Если вы используете координаты для прокладки маршрута или расчета автомобильного маршрута, точка всегда будет привязана к дороге, ближайшей к этим координатам. Это может быть дорога, которая не ведет к пункту назначения быстро или безопасно и может не находиться рядом с точкой доступа к объекту. Кроме того, при обратном геокодировании местоположения нет гарантии, что возвращенный адрес будет соответствовать исходному.
placeTypes
Тип:  Array<string>
Типы мест, к которым относится геокодированный адрес. например ['locality', 'political'] (2-е издание). Полный список типов можно найти в документации по Geocoding API.
plusCode
Тип:  PlusCode optional
Код Plus Code, соответствующий location.
fetchPlace
fetchPlace()
Параметры: нет.
Возвращаемое значение: нет.
Возвращает место, соответствующее этому геокоду. Чтобы получить полную информацию о месте, необходимо вызвать place.fetchFields().

Константы Granularity

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…
BLOCK Адрес или геокод указывает на квартал. Используется только в регионах, где адресация выполняется на уровне кварталов, например в Японии.
OTHER Все остальные уровни детализации, которые объединены в одну группу, поскольку не могут быть показаны.
PREMISE Результат на уровне здания.
PREMISE_PROXIMITY Геокод, который приблизительно соответствует местоположению здания.
ROUTE Геокод или адрес детализирован до уровня маршрута, например улицы, дороги или шоссе.
SUB_PREMISE Результат на уровне ниже здания, например квартира.

Константы PossibleNextAction

google.maps.addressValidation.PossibleNextAction константы

Интерпретирующее резюме ответа API, которое помогает определить потенциальное последующее действие. Это поле формируется на основе других полей в ответе API и не гарантирует точность адреса или возможность доставки.

Чтобы получить доступ, позвоните по номеру const {PossibleNextAction} = await google.maps.importLibrary("addressValidation").
Подробнее о библиотеках Maps JavaScript API…
ACCEPT Ответ API не содержит сигналов, которые гарантируют одно из других значений PossibleNextAction. Вы можете использовать обработанный адрес, не запрашивая у клиента дополнительную информацию, но это не гарантирует, что адрес действителен и не содержит исправлений. Вы сами решаете, нужно ли показывать клиенту запрос и как это делать, исходя из собственной оценки рисков.
CONFIRM Одно или несколько полей ответа API указывают на потенциальные незначительные проблемы с обработанным адресом, например компонент адреса postal_code был replaced. Предложите клиенту проверить адрес, чтобы повысить его качество.
CONFIRM_ADD_SUBPREMISES Ответ API указывает, что в обработанном адресе может отсутствовать номер помещения. Попросите клиента проверить адрес и добавить номер квартиры или офиса. Это поможет повысить качество адреса. В обработанном адресе могут быть и другие незначительные проблемы. Примечание. Это значение перечисления может возвращаться только для адресов в США.
FIX Одно или несколько полей ответа API указывают на потенциальную проблему с обработанным адресом, например verdict.validation_granularity – OTHER. Предложите клиенту изменить адрес, чтобы повысить его качество.

Класс USPSAddress

google.maps.addressValidation.USPSAddress класс

Адрес в США в формате Почтовой службы США.

Чтобы получить доступ, позвоните по номеру const {USPSAddress} = await google.maps.importLibrary("addressValidation").
Подробнее о библиотеках Maps JavaScript API…
city
Тип:  string optional
Название города.
cityStateZipAddressLine
Тип:  string optional
Строка адреса, содержащая город, штат и почтовый индекс.
firm
Тип:  string optional
Название фирмы.
firstAddressLine
Тип:  string optional
Первая строка адреса.
secondAddressLine
Тип:  string optional
Вторая строка адреса.
state
Тип:  string optional
Двухбуквенный код штата.
urbanization
Тип:  string optional
Название урбанизации в Пуэрто-Рико.
zipCode
Тип:  string optional
Почтовый индекс, например "10009".
zipCodeExtension
Тип:  string optional
Четырехзначный почтовый индекс, например "5023".

Класс USPSData

google.maps.addressValidation.USPSData класс

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

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

Класс Verdict

google.maps.addressValidation.Verdict класс

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

Чтобы получить доступ, позвоните по номеру const {Verdict} = await google.maps.importLibrary("addressValidation").
Подробнее о библиотеках Maps JavaScript API…
addressComplete
Тип:  boolean
Адрес считается полным, если в нем нет нераспознанных токенов, а также отсутствующих или лишних компонентов. Если значение не задано, используется false. Подробную информацию можно найти в полях Address.missingComponentTypes, Address.unresolvedTokens и AddressComponent.unexpected.
geocodeGranularity
Тип:  Granularity optional
Информация о детализации Geocode. Это можно понимать как семантическое значение того, насколько грубым или точным является геокодированное местоположение.
hasInferredComponents
Тип:  boolean
Добавлен по крайней мере один компонент адреса, которого не было в исходных данных. Подробности: AddressComponent.
hasReplacedComponents
Тип:  boolean optional
По крайней мере один компонент адреса был заменен. Подробности: AddressComponent.
hasUnconfirmedComponents
Тип:  boolean
Не удалось классифицировать или проверить по крайней мере один компонент адреса. Подробности: AddressComponent.
inputGranularity
Тип:  Granularity optional
Уровень детализации входного адреса. Это результат синтаксического анализа входного адреса, который не дает никаких сигналов проверки. Сигналы проверки описаны в разделе validationGranularity.
BetapossibleNextAction
Тип:  PossibleNextAction optional
Возможное следующее действие, которое можно предпринять на основе других полей в ответе API. Рекомендуем ознакомиться с более подробными сведениями об элементе PossibleNextAction.
validationGranularity
Тип:  Granularity optional
Уровень детализации, до которого API может полностью проверить адрес. Например, если validationGranularity имеет значение PREMISE, это означает, что все компоненты адреса на уровне PREMISE и выше могут быть проверены.