Method: validateAddress

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

integer

Версия схемы PostalAddress . Любое значение, отличное от 0, приведет к тому, что API вернет ошибку INVALID_ARGUMENT .

string

Необязательный. CLDR-код региона страны/региона адреса. Подробности см. на https://cldr.unicode.org/ и https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html . Пример: «CH» для Швейцарии. Если код региона не указан, он будет получен из адреса. Для лучшей производительности рекомендуется указать код региона, если вы его знаете. Наличие противоречивых или повторяющихся регионов может привести к снижению производительности. Например, если addressLines уже включают регион, не указывайте код региона снова в этом поле. Поддерживаемые регионы можно найти в FAQ .

string

Код языка во входном адресе зарезервирован для будущего использования и сегодня игнорируется. API возвращает адрес на языке, соответствующем тому, где находится адрес.

string

Необязательный. Почтовый индекс адреса. Не все страны используют или требуют наличия почтовых индексов, но там, где они используются, они могут вызвать дополнительную проверку других частей адреса (например, проверку штата или почтового индекса в США).

string

Необязательный. Дополнительный код сортировки для конкретной страны. В большинстве регионов это не используется. Там, где оно используется, значение представляет собой либо строку типа «CEDEX», за которой необязательно следует число (например, «CEDEX 7»), либо просто число, представляющее «код сектора» (Ямайка), «индикатор зоны доставки» (Малави) или «индикатор почтового отделения» (Кот-д'Ивуар).

string

Необязательный. Высшее административное подразделение, используемое для почтовых адресов страны или региона. Например, это может быть штат, провинция, область или префектура. Для Испании это провинция, а не автономное сообщество (например, «Барселона», а не «Каталония»). Многие страны не используют административную зону в почтовых адресах. Например, в Швейцарии это место следует оставить незаселенным.

string

Необязательный. Обычно относится к части адреса, посвященной городу или населенному пункту. Примеры: город в США, ИТ-коммуна, почтовый город Великобритании. В регионах мира, где населенные пункты не определены четко или не вписываются в эту структуру, оставьте locality пустым и используйте addressLines .

string

Необязательный. Сублокальность адреса. Например, это может быть район, район или район.

string

Необходимый. Неструктурированные адресные строки, описывающие нижние уровни адреса.

Поскольку значения в адресных строках не содержат информации о типе и иногда могут содержать несколько значений в одном поле (например, «Остин, Техас»), важно, чтобы порядок строк был ясен. Порядок адресных строк должен быть «порядком конверта» для страны/региона адреса.

Минимально допустимое структурное представление адреса состоит из всей информации, размещенной в addressLines . Если regionCode не указан, регион определяется по адресным строкам.

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

string

Пожалуйста, не заполняйте это поле. API проверки адреса в настоящее время не использует его. Хотя в настоящее время API не будет отклонять запросы с этим набором полей, информация будет отброшена и не будет возвращена в ответе.

string

Пожалуйста, не заполняйте это поле. API проверки адреса в настоящее время не использует его. Хотя в настоящее время API не будет отклонять запросы с этим набором полей, информация будет отброшена и не будет возвращена в ответе.

boolean

Предварительная версия: возврат адреса google.maps.addressvalidation.v1.Address на английском языке. Подробности см. google.maps.addressvalidation.v1.ValidationResult.english_latin_address .

object ( Verdict )

Общие флаги вердикта

object ( Address )

Информация о самом адресе в отличие от геокода.

object ( Geocode )

Информация о местоположении и месте, к которому геокодирован адрес.

object ( AddressMetadata )

Другая информация, относящаяся к доставляемости. metadata не могут быть полностью заполнены для каждого адреса, отправленного в API проверки адреса.

object ( UspsData )

Дополнительные флаги доставки, предоставляемые USPS. Предоставляется только в регионе US и PR .

object ( Address )

Предварительная версия. Эта функция находится в предварительной версии (до GA). Продукты и функции Pre-GA могут иметь ограниченную поддержку, а изменения в продуктах и ​​функциях Pre-GA могут быть несовместимы с другими версиями Pre-GA. На предложения Pre-GA распространяются Особые условия обслуживания платформы Google Maps . Дополнительную информацию см. в описании этапов запуска .

Адрес переведен на английский.

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

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

Включите этот вывод, используя флаг google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address .

Примечание. Поле google.maps.addressvalidation.v1.Address.unconfirmed_component_types в englishLatinAddress и поля google.maps.addressvalidation.v1.AddressComponent.confirmation_level в englishLatinAddress.address_components не заполняются.

enum ( Granularity )

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

Например, если входной адрес включает определенный номер квартиры, то inputGranularity здесь будет SUB_PREMISE . Если мы не можем сопоставить номер квартиры в базах данных или номер квартиры недействителен, то значение validationGranularity скорее всего, будет PREMISE или ниже.

enum ( Granularity )

Уровень детализации, на котором API может полностью проверить адрес. Например, значение validationGranularity PREMISE указывает на то, что все компоненты адреса на уровне PREMISE или более грубом уровне могут быть проверены.

Результат проверки компонента адреса можно найти в google.maps.addressvalidation.v1.Address.address_components .

enum ( Granularity )

Информация о детализации geocode . Это можно понимать как семантическое значение того, насколько грубым или точным является геокодированное местоположение.

Иногда это может отличаться от указанного выше параметра validationGranularity . Например, наша база данных может фиксировать наличие номера квартиры, но не иметь точного местоположения квартиры в большом жилом комплексе. В этом случае validationGranularity будет SUB_PREMISE , а geocodeGranularity будет PREMISE .

boolean

Адрес считается полным, если нет неразрешенных токенов, неожиданных или отсутствующих компонентов адреса. Если значение не установлено, это указывает на то, что значение равно false . Дополнительные сведения см. в разделе missingComponentTypes , unresolvedTokens или unexpected поля.

boolean

По крайней мере один компонент адреса не может быть классифицирован или проверен. Подробности см. в google.maps.addressvalidation.v1.Address.address_components .

boolean

Был выведен (добавлен) по крайней мере один компонент адреса, которого не было во входных данных. Подробности см. в google.maps.addressvalidation.v1.Address.address_components .

boolean

По крайней мере один компонент адреса был заменен. Подробности см. в google.maps.addressvalidation.v1.Address.address_components .

string

Адрес после постобработки, отформатированный как однострочный адрес в соответствии с правилами форматирования адреса региона, в котором расположен адрес.

Примечание. Формат этого адреса может не совпадать с форматом адреса в поле postalAddress . Например, postalAddress всегда представляет страну в виде двухбуквенного regionCode , например «US» или «NZ». Напротив, в этом поле используется более длинная форма названия страны, например «США» или «Новая Зеландия».

object ( PostalAddress )

Адрес после обработки, представленный как почтовый адрес.

object ( AddressComponent )

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

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

string

Типы компонентов, которые должны были присутствовать в правильно отформатированном почтовом адресе, но не были найдены во входных данных И не могли быть определены. Примером может быть ['street_number', 'route'] для ввода типа «Боулдер, Колорадо, 80301, США». Список возможных типов можно найти здесь .

Примечание. Вы можете увидеть отсутствующий тип компонента, если считаете, что уже предоставили недостающий компонент. Например, это может произойти, если входной адрес содержит название здания, а не номер помещения. В адресе «渋谷区渋谷３丁目 Shibuya Stream» название здания «Shibuya Stream» имеет тип компонента premise , но номер помещения отсутствует, поэтому missingComponentTypes будет содержать premise .

string

Типы компонентов, которые присутствуют в addressComponents , но их правильность не подтверждена. Это поле предоставлено для удобства: его содержимое эквивалентно перебору addressComponents для поиска типов всех компонентов, у которых confirmationLevel не CONFIRMED или inferred флаг не установлен в true . Список возможных типов можно найти здесь .

string

Любые токены во входных данных, которые не удалось разрешить. Это может быть ввод, который не был распознан как допустимая часть адреса. Например, для таких входных данных, как "Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US", неразрешенные токены могут выглядеть как ["Parcel", "0000123123", "&", "0000456456"] .

object ( ComponentName )

Имя этого компонента.

string

Тип компонента адреса. Список возможных типов см. в Таблице 2: Дополнительные типы, возвращаемые службой Places .

enum ( ConfirmationLevel )

Указывает уровень нашей уверенности в том, что компонент правильный.

boolean

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

boolean

Указывает на исправление ошибки в названии компонента. API не всегда отмечает изменения одного варианта написания на другой, например, при изменении «центра» на «центр». Он также не всегда отмечает распространенные орфографические ошибки, например, при замене «Амфитеатр Пкви» на «Амфитеатр Пкви».

boolean

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

boolean

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

string

Текст имени. Например, «5th Avenue» для названия улицы или «1253» для номера улицы.

string

Код языка BCP-47. Его не будет, если имя компонента не связано с языком, например, с номером улицы.

object ( LatLng )

Геокодированное местоположение входных данных.

Использование идентификаторов мест предпочтительнее использования адресов, координат широты/долготы или плюсовых кодов. Использование координат при маршрутизации или расчете направлений движения всегда приводит к привязке точки к дороге, ближайшей к этим координатам. Это может быть не дорога, которая быстро или безопасно приведет к месту назначения, и она может находиться не рядом с точкой доступа к объекту. Кроме того, когда местоположение подвергается обратному геокодированию, нет никакой гарантии, что возвращаемый адрес будет соответствовать оригиналу.

object ( PlusCode )

Плюс-код, соответствующий location .

object ( Viewport )

Границы геокодированного места.

number

Размер геокодированного места в метрах. Это еще одна мера грубости геокодированного местоположения, но по физическому размеру, а не по смысловому значению.

string

PlaceID места, куда геокодируется этот ввод.

Дополнительную информацию об идентификаторах мест смотрите здесь .

string

Тип(ы) места, к которому геокодированы входные данные. Например, ['locality', 'political'] . Полный список типов можно найти здесь .

number

Широта в градусах. Оно должно находиться в диапазоне [-90,0, +90,0].

number

Долгота в градусах. Оно должно находиться в диапазоне [-180,0, +180,0].

string

Глобальный (полный) код места, например «9FWM33GV+HQ», представляющий площадь 1/8000 на 1/8000 градусов (~ 14 на 14 метров).

string

Составной код места, например «33GV+HQ, Рамберг, Норвегия», содержащий суффикс глобального кода и заменяющий префикс форматированным именем ссылочного объекта.

object ( LatLng )

Необходимый. Нижняя точка смотрового окна.

object ( LatLng )

Необходимый. Самая высокая точка смотрового окна.

boolean

Указывает, что это адрес компании. Если значение не установлено, это означает, что значение неизвестно.

boolean

Указывает, что это адрес почтового ящика. Если значение не установлено, это означает, что значение неизвестно.

boolean

Указывает, что это адрес проживания. Если значение не установлено, это означает, что значение неизвестно.

object ( UspsAddress )

Стандартизированный адрес USPS.

string

2-значный код пункта доставки

string

Контрольная цифра пункта доставки. Этот номер добавляется в конец Delivery_point_barcode для механически сканированной почты. Сложение всех цифр Delivery_point_barcode, DeliveryPointCheckDigit, почтового индекса и ZIP+4 вместе должно дать число, кратное 10.

string

Возможные значения для подтверждения DPV. Возвращает один символ или не возвращает никакого значения.

• N : информация о первичном и дополнительном номере не была подтверждена DPV.
• D : Адрес был подтвержден DPV только для основного номера, а информация о дополнительном номере отсутствовала.
• S : Адрес был подтвержден DPV только для основного номера, а информация о дополнительном номере присутствовала, но не была подтверждена.
• Y : Адрес был подтвержден DPV для основных и дополнительных номеров.
• Пусто: если ответ не содержит значения dpvConfirmation , адрес не был отправлен для подтверждения DPV.

string

Сноски к проверке точки доставки. Несколько сносок могут быть объединены в одну строку.

• AA : входной адрес соответствует файлу ZIP+4.
• A1 : Входной адрес не соответствует файлу ZIP+4.
• BB : соответствует DPV (все компоненты).
• CC : Вторичный номер не совпадает и не требуется.
• C1 : Вторичный номер не совпадает, но требуется.
• N1 : В адресе высотного здания отсутствует дополнительный номер.
• M1 : отсутствует основной номер.
• M3 : Основной номер недействителен.
• P1 : отсутствует номер ящика PO, RR или HC адреса ввода.
• P3 : Входной адрес PO, RR или HC Номер ящика недействителен.
• F1 : Входной адрес соответствует военному адресу.
• G1 : Входной адрес соответствует общему адресу доставки.
• U1 : Входной адрес соответствует уникальному почтовому индексу.
• PB : Входной адрес соответствует записи PBSA.
• RR : адрес, подтвержденный DPV, с информацией PMB.
• R1 : адрес, подтвержденный DPV, без информации PMB.
• R7 : запись маршрута несущей R777 или R779.
• IA : Информированный адрес определен
• TA : основной номер, сопоставленный с отбрасыванием завершающей альфа.

string

Указывает, является ли адрес CMRA (Коммерческое агентство по приему почты) — частной компанией, получающей почту для клиентов. Возвращает один символ.

• Y : адрес является CMRA.
• N : адрес не является CMRA.

string

Это место свободно? Возвращает один символ.

• Y : адрес свободен.
• N : Адрес не свободен.

string

Это адрес без статистики или активный адрес? Статистические адреса – это адреса, которые не заняты постоянно, или адреса, которые USPS не обслуживает. Возвращает один символ.

• Y : адрес не активен
• N : адрес активен.

integer

Указывает тип NoStat. Возвращает код причины в виде int.

• 1 : IDA (внутренний адрес пересылки) — адреса, которые не получают почту напрямую от USPS, но доставляются на адрес пересылки, который их обслуживает.
• 2 : CDS — адреса, которые еще не доставлены. Например, новый микрорайон, в котором лоты и первичные номера определены, но структуры по заселению пока нет.
• 3 : Коллизия — адреса, которые фактически не подтверждаются DPV.
• 4 : CMZ (для колледжей, военных и других типов) — ZIP + 4 записи, включенные USPS в данные.
• 5 : Обычный — указывает на адреса, которые не получают доставку, и адреса не учитываются как возможные доставки.
• 6 : Требуется вторичная информация. Для адреса требуется вторичная информация.

string

Флаг указывает, что почта доставляется к одному получателю на сайте. Возвращает один символ.

• Y : почта доставляется к одному получателю на объекте.
• N : Почта не доставляется ни одному получателю на объекте.

string

Указывает, что почта не доставляется по указанному адресу. Возвращает один символ.

• Y : Почта не доставляется по указанному адресу.
• N : Почта доставляется по указанному адресу.

string

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

• Y : Доставка почты осуществляется не каждый день недели.
• N : Нет указания, что доставка почты осуществляется не каждый день недели.

integer

Целое число, обозначающее дни недоставки. Его можно запросить с помощью битовых флагов: 0x40 – воскресенье — день недоставки 0x20 — понедельник — день недоставки 0x10 — вторник — день недоставки 0x08 — среда — день недоставки 0x04 — четверг — день недоставки 0x02 — пятница — день недоставки 0x01 — суббота — день недоставки

string

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

• Y : Посылка не будет оставлена ​​из соображений безопасности.
• N : Нет никаких указаний на то, что посылка не будет оставлена ​​из соображений безопасности.

string

Указывает, что адрес соответствует записи PBSA. Возвращает один символ.

• Y : адрес соответствует записи PBSA.
• N : адрес не соответствует записи PBSA.

string

Флаг указывает адреса, по которым USPS не может постучать в дверь для доставки почты. Возвращает один символ.

• Y : Дверь недоступна.
• N : Нет указания на то, что дверь недоступна.

string

Указывает, что для адреса допустимо более одного кода возврата DPV. Возвращает один символ.

• Y : Адрес был подтвержден DPV для основных и дополнительных номеров.
• N : информация о первичном и дополнительном номере не была подтверждена DPV.
• S : Адрес был подтвержден DPV только для основного номера, а информация о дополнительном номере присутствовала, но не была подтверждена, или одна конечная буква в основном номере была удалена, чтобы обеспечить совпадение DPV и требуемую дополнительную информацию.
• D : Адрес был подтвержден DPV только для основного номера, а информация о дополнительном номере отсутствовала.
• R : Адрес подтвержден, но назначен фантомному маршруту R777 и R779, доставка USPS не осуществляется.

string

Код маршрута перевозчика. Четырехзначный код, состоящий из однобуквенного префикса и трехзначного обозначения маршрута.

Префиксы:

• C : Маршрут перевозчика (или городской маршрут)
• R : Сельский маршрут
• H : Контрактный маршрут шоссе
• B : Секция почтового ящика
• G : Общая единица поставки

string

Индикатор сортировки тарифов маршрута оператора связи.

boolean

Адрес доставки сопоставляется, но файл EWS указывает, что точное совпадение скоро будет доступно.

string

Главпочтамт города.

string

Состояние Главпочтамта.

string

Сокращенный город.

string

Код страны ФИПС.

string

Название округа.

string

Номер расширенной линии путешествия (eLOT).

string

Флаг возрастания/нисхождения eLOT (A/D).

string

Код возврата LACSLink.

string

Индикатор LACSLink.

boolean

Почтовый ящик только почтовый индекс.

string

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

• A : Соответствие записей SuiteLink, улучшен адрес компании.
• 00 : Нет совпадений, адрес компании не улучшен.

string

Обозначение единицы PMB (частный почтовый ящик).

string

номер PMB (личного почтового ящика);

string

Тип записи адреса, соответствующий входному адресу.

• F : ФИРМ. Это соответствие фирменной записи, которая является наивысшим уровнем соответствия, доступным для адреса.
• G : ОБЩАЯ ДОСТАВКА. Это соответствует записи общей доставки.
• H : ЗДАНИЕ/КВАРТИРА. Это соответствие записи здания или квартиры.
• P : ПОЧТОВЫЙ ЯЩИК. Это соответствует почтовому ящику.
• R : СЕЛЬСКИЙ МАРШРУТ или ДОГОВОР НА ШОССЕ: это соответствует записи либо Сельского маршрута, либо записи Контракта на автомагистраль, обе из которых могут иметь связанные диапазоны номеров ящиков.
• S : ЗАПИСЬ УЛИЦ: Это соответствие записи улицы, содержащей действительный диапазон основных номеров.

boolean

Индикатор того, что найден адрес по умолчанию, но существуют более конкретные адреса.

string

Сообщение об ошибке при получении данных USPS. Он заполняется, когда обработка USPS приостанавливается из-за обнаружения искусственно созданных адресов.

При наличии этой ошибки поля данных USPS могут быть не заполнены.

boolean

Индикатор того, что запрос CASS обработан.

string

Первая адресная строка.

string

Название фирмы.

string

Вторая адресная строка.

string

Название пуэрто-риканской урбанизации.

string

Город + штат + почтовый индекс.

string

Название города.

string

Двухбуквенный код штата.

string

Почтовый индекс, например, 10009.

string

Расширение почтового индекса из 4 цифр, например 5023.

integer

Редакция схемы PostalAddress . Любое значение, отличное от 0, приведет к возвращению INVALID_ARGUMENT API API.

string

Необязательный. Кодекс региона CLDR страны/регион адреса. См . Https://cldr.unicode.org/ и https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html для получения подробной информации. Пример: «Ch» для Швейцарии. Если код региона не предоставлен, он будет выведен из адреса. Для достижения наилучшей производительности рекомендуется включить код региона, если вы его знаете. Например, наличие непоследовательных или повторных регионов может привести к плохой производительности, например, если addressLines уже включают регион, не предоставляют код региона снова в этой области. Поддерживаемые регионы можно найти в FAQ .

string

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

string

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

string

Необязательный. Дополнительный, страновой, сортировочный код. Это не используется в большинстве регионов. Там, где он используется, значение представляет собой либо строку, такую ​​как «cedex», при желании следует число (например, «Cedex 7»), либо только только число, представляющее «код сектора» (Ямайка), «Индикатор зоны доставки» (Малави) или «Индикатор почтового отделения» (Côte d'ivoire).

string

Необязательный. Наибольшее административное подразделение, которое используется для почтовых адресов страны или региона. Например, это может быть государство, провинция, область или префектура. Для Испании это провинция, а не автономное сообщество (например, «Барселона», а не «каталония»). Многие страны не используют административный район в почтовых адресах. Например, в Швейцарии это должно быть оставлено незападным.

string

Необязательный. Как правило, относится к городу или городской части адреса. Примеры: Американский город, IT Comune, Великобритания, почтовый город. В регионах мира, где населенные пункты не очень хорошо определены или не вписываются в эту структуру, оставляйте locality пустыми и используйте addressLines .

string

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

string

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

Поскольку значения в адресах адреса не имеют информации типа и могут иногда содержать несколько значений в одном поле (например, «Остин, Техас»), важно, чтобы порядок линии был ясен. Порядок адресных линий должен быть «порядок конверта» для страны/региона адреса.

Минимальное разрешенное структурное представление адреса состоит из всей информации, размещенной в addressLines . Если regionCode не предоставлен, регион выведен из адресных линий.

Создание адреса, содержащего только addressLines , а затем геокодирование - это рекомендуемый способ обработки полностью неструктурированных адресов (в отличие от предположения, какие части адреса должны быть местными или административными областями).

string

Пожалуйста, избегайте установления этого поля. API проверки адреса в настоящее время не использует его. Хотя в настоящее время API не будет отклонять запросы с помощью этого поля, информация будет отброшена и не будет возвращена в ответ.

string

Пожалуйста, избегайте установления этого поля. API проверки адреса в настоящее время не использует его. Хотя в настоящее время API не будет отклонять запросы с помощью этого поля, информация будет отброшена и не будет возвращена в ответ.

boolean

Предварительный просмотр: вернуть google.maps.addressvalidation.v1.Address на английском языке. См. google.maps.addressvalidation.v1.ValidationResult.english_latin_address для деталей.

object ( Verdict )

Общие флаги вердикта

object ( Address )

Информация об самом адресе, в отличие от геокода.

object ( Geocode )

Информация о местоположении и размещении, к которому адресовал адрес.

object ( AddressMetadata )

Другая информация, относящаяся к доставке. metadata не гарантированно будут полностью заполнены для каждого адреса, отправленного в API проверки адреса.

object ( UspsData )

Дополнительные флаги доставки, предоставленные USPS. Предоставлено только в регионе US и PR .

object ( Address )

Предварительный просмотр: эта функция находится в предварительном просмотре (Pre-GA). Продукты и функции Pre-GA могут иметь ограниченную поддержку, а изменения в продуктах и ​​функциях Pre-GA могут быть несовместимы с другими версиями Pre-GA. На предложения Pre-GA распространяются Особые условия обслуживания платформы Google Maps . Дополнительную информацию см. в описании этапов запуска .

Адрес переведен на английский.

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

Если часть адреса не имеет английского перевода, сервис возвращает эту часть на альтернативном языке, который использует латинский сценарий. Смотрите здесь для объяснения того, как выбран альтернативный язык. Если часть адреса не имеет никаких переводов или трансляций на языке, который использует латинский сценарий, сервис возвращает эту часть на локальном языке, связанном с адресом.

Включите этот вывод, используя google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address .

ПРИМЕЧАНИЕ. google.maps.addressvalidation.v1.Address.unconfirmed_component_types в englishLatinAddress и google.maps.addressvalidation.v1.AddressComponent.confirmation_level Fields в englishLatinAddress.address_components .

enum ( Granularity )

Гранулярность входного адреса. Это результат анализа входного адреса и не дает никаких сигналов валидации. Для сигналов проверки см. В соответствии с validationGranularity .

Например, если входной адрес включает в себя конкретный номер квартиры, то inputGranularity гранулярность здесь будет SUB_PREMISE . Если мы не можем сопоставить номер квартиры в базах данных, или номер квартиры недействителен, validationGranularity , вероятно, будет PREMISE или ниже.

enum ( Granularity )

Уровень детализации, на который API может полностью подтвердить адрес. Например, validationGranularity PREMISE указывает на все компоненты адреса на уровне PREMISE или более грубого может быть подтверждена.

Результат проверки компонента адреса можно найти в google.maps.addressvalidation.v1.Address.address_components .

enum ( Granularity )

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

Это может отличаться от validationGranularity выше. Например, наша база данных может зафиксировать существование номера квартиры, но не имеет точного места для квартиры в большом квартире. В этом случае validationGranularity гранулярность будет SUB_PREMISE но geocodeGranularity будет PREMISE .

boolean

Адрес считается завершенным, если нет неразрешенных токенов, нет неожиданных компонентов или недостающих адресов. Если нет, указывает, что значение false . См. missingComponentTypes , unresolvedTokens и unexpected поля для получения более подробной информации.

boolean

По крайней мере, один компонент адреса не может быть классифицирован или проверен, см. google.maps.addressvalidation.v1.Address.address_components для получения подробной информации.

boolean

По крайней мере, один компонент адреса был выведен (добавлен), который не был в вводе, см. google.maps.addressvalidation.v1.Address.address_components для подробностей.

boolean

По крайней мере, один компонент адреса был заменен, см. google.maps.addressvalidation.v1.Address.address_components для получения подробной информации.

string

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

Примечание. Формат этого адреса не может соответствовать формату адреса в поле postalAddress . Например, postalAddress всегда представляет страну как 2 -буквенный regionCode , такой как «США» или «Новая Зеландия». Напротив, в этом поле используется более длинная форма названия страны, такую ​​как «США» или «Новая Зеландия».

object ( PostalAddress )

Пост-обрабощенный адрес, представленный в качестве почтового адреса.

object ( AddressComponent )

Неупомянутый список. Индивидуальные компоненты адреса форматированного и исправленного адреса вместе с информацией о проверке. Это предоставляет информацию о статусе проверки отдельных компонентов.

Компоненты адресов не упорядочены определенным образом. Не делайте никаких предположений о заказе компонентов адреса в списке.

string

Типы компонентов, которые, как ожидалось, будут присутствовать в правильно отформатированном почтовом адресе, но не были обнаружены на входе и не могли быть выведены. Примером может быть ['street_number', 'route'] для ввода, такого как «Боулдер, Колорадо, 80301, США». Список возможных типов можно найти здесь .

Примечание. Вы можете увидеть недостающий тип компонента, когда вы думаете, что уже предоставили недостающий компонент. Например, это может произойти, когда входной адрес содержит название здания, но не номер предпосылки. В адресе «渋谷区渋谷３丁目 Shibuya Stream» имя здания «Shibuya Stream» имеет premise типа компонента, но номер предпосылки отсутствует, поэтому missingComponentTypes будет содержать premise .

string

Типы компонентов, которые присутствуют в addressComponents но не могут быть подтверждены как правильные. Это поле предусмотрено для удобства: его содержимое эквивалентно итерации через addressComponents , чтобы найти типы всех компонентов, в которых confirmationLevel не CONFIRMED или inferred флаг не установлен на true . Список возможных типов можно найти здесь .

string

Любые токены на входе, которые не могут быть разрешены. Это может быть вход, который не был признан в качестве действительной части адреса. Например, для ввода, такого как «Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US», нерешенные токены могут выглядеть как ["Parcel", "0000123123", "&", "0000456456"] .

object ( ComponentName )

Имя для этого компонента.

string

Тип компонента адреса. См. Таблицу 2: Дополнительные типы, возвращаемые службой мест для списка возможных типов.

enum ( ConfirmationLevel )

Указывает уровень уверенности, который у нас есть, что компонент правильный.

boolean

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

boolean

Указывает коррекцию к неправильному написанию в имени компонента. API не всегда изменяет изменения от одного варианта орфографии к другому, например, при изменении «центра» на «Центр». Это также не всегда отмечает общие ошибки, например, при изменении «Amphitheater pkwy» на «Amphitheater pkwy».

boolean

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

boolean

Указывает адресный компонент, который не будет присутствовать в почтовом адресе для данного региона. Мы сохранили его только потому, что это было частью ввода.

string

Название текст. Например, «5 -я авеню» для названия улицы или «1253» для номера улицы.

string

Языковой код BCP-47. Это не будет присутствовать, если имя компонента не связано с языком, таким как номер улицы.

object ( LatLng )

Геокодированное местоположение ввода.

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

object ( PlusCode )

Плюс код, соответствующий location .

object ( Viewport )

Границы геокодированного места.

number

Размер геокодированного места, в метрах. Это еще одна мера грубости геокодированного местоположения, но в физическом размере, а не в семантическом значении.

string

Плосеид этого места в этом входном геокоде.

Для получения дополнительной информации о идентификаторах места см. Здесь .

string

Тип (ы) места, которое входные геокодировали. Например, ['locality', 'political'] . Полный список типов можно найти здесь .

number

Широта в градусах. Это должно быть в диапазоне [-90.0, +90.0].

number

Долгота в градусах. Это должно быть в диапазоне [-180.0, +180.0].

string

Глобальный (полный) код Place, такой как «9FWM33GV+HQ», представляющий площадь 1/8000 на 1/8000 градусов (~ 14 на 14 метров).

string

Составной код Place, такой как «33GV+HQ, Ramberg, Norway», содержащий суффикс глобального кода и замена префикса с форматированным именем эталонной объекта.

object ( LatLng )

Необходимый. Низкая точка просмотра.

object ( LatLng )

Необходимый. Высшая точка просмотра.

boolean

Указывает, что это адрес бизнеса. Если нет, указывает, что значение неизвестно.

boolean

Указывает, что адрес ящика PO. Если нет, указывает, что значение неизвестно.

boolean

Указывает, что это адрес резиденции. Если нет, указывает, что значение неизвестно.

object ( UspsAddress )

USPS стандартизированный адрес.

string

2 -значный код точки доставки

string

Цифровая цифра с доставкой. Этот номер добавляется к окончанию доставки_POINT_BARCODE для механического сканируемого почты. Добавление всех цифр доставки_point_barcode, reworkypointcheckdigit, почтового кода и Zip+4 вместе должен дать число делится на 10.

string

Возможные значения для подтверждения DPV. Возвращает один символ или не возвращает значения.

• N : Первичная и любая информация о вторичном номере не удалось подтвердить DPV.
• D : адрес был подтвержден DPV только для первичного номера, а информация о вторичном номере отсутствовала.
• S : Адрес был подтвержден DPV только для первичного номера, а информация о вторичном номере присутствовала, но не подтверждена.
• Y : Адрес был подтвержден DPV для первичных и любых вторичных чисел.
• Пусто: если ответ не содержит значения dpvConfirmation , адрес не был представлен для подтверждения DPV.

string

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

• AA : входной адрес, соответствующий файлу Zip+4
• A1 : Входной адрес не был сопоставлен с файлом ZIP+4
• BB : соответствует DPV (все компоненты)
• CC : вторичное число не соответствует и не требуется
• C1 : вторичное число не соответствует, но требуется
• N1 : Высотный адрес отсутствует вторичный номер
• M1 : Отсутствие первичного номера отсутствует
• M3 : первичный номер недействителен
• P1 : входной адрес PO, RR или HC -номер.
• P3 : входной адрес PO, RR или HC Numm
• F1 : входной адрес, соответствующий военному адресу
• G1 : входной адрес, соответствующий общему адресу доставки
• U1 : входной адрес, сопоставленный с уникальным почтовым индексом
• PB : входной адрес, сопоставленный с записи PBSA
• RR : DPV подтвержденный адрес с информацией PMB
• R1 : DPV подтвержденный адрес без информации PMB
• R7 : raintrier route R777 или R779
• IA : информированный адрес выявлено
• TA : Первичный номер, сопоставленный путем сброса зацепленной альфа

string

Указывает, является ли адрес CMRA (агентство по получению коммерческой почты)-частное бизнес, получающий почту для клиентов. Возвращает одного персонажа.

• Y : Адрес - CMRA
• N : Адрес не CMRA

string

Это место свободным? Возвращает одного персонажа.

• Y : адрес вакантный
• N : адрес не вакантный

string

Это адрес без статистики или активный адрес? Никакие адреса статистики не являются те, которые не постоянно заняты или адреса, которые USP не обслуживают. Возвращает одного персонажа.

• Y : Адрес не активен
• N : Адрес активен

integer

Указывает тип ностата. Возвращает код причины как int.

• 1 : IDA (внутренний адрес падения) - адреса, которые не получают почту непосредственно от USPS, но доставляются по адресу Drop, который их обслуживает.
• 2 : CDS - адреса, которые еще не стали результатом. Например, новое подразделение, в котором были определены лоты и первичные числа, но структура пока не существует для занятости.
• 3 : столкновение - адреса, которые на самом деле не подтверждают DPV.
• 4 : CMZ (колледж, военные и другие типы) - ZIP + 4 Records USPS включил в данные.
• 5 : Регулярно - указывает на адреса, не получающие доставки, а адреса не подсчитываются в качестве возможных поставки.
• 6 : Вторичное требуется - адрес требует вторичной информации.

string

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

• Y : Почта доставляется в один восприимчивый на сайте.
• N : почта не доставляется ни одному восприимчивому на сайте.

string

Указывает, что почта не доставляется по адресу улицы. Возвращает одного персонажа.

• Y : Почта не доставлена ​​по адресу улицы.
• N : Почта доставляется по адресу улицы.

string

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

• Y : Доставка почты не выполняется каждый день недели.
• N : нет указания, что доставка почты не выполняется каждый день недели.

integer

Целое число идентифицирует дни без доставки. Это может быть связано с использованием битовых флагов: 0x40-Воскресенье-это день без доставки 0x20-понедельник-день без доставки 0x10-вторник-день без доставки 0x08-среда-день без доставки 0x04-четверг-день невидповины 0x02-пятница-день не влева 0x01-в субботу.

string

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

• Y : Пакет не останется из -за проблем безопасности.
• N : нет указания, что пакет не останется из -за проблем безопасности.

string

Указывает, что адрес был сопоставлен с записью PBSA. Возвращает одного персонажа.

• Y : Адрес был сопоставлен с записью PBSA.
• N : Адрес не был сопоставлен с записью PBSA.

string

Флаг указывает адреса, где USPS не может постучать в дверь для доставки почты. Возвращает одного персонажа.

• Y : Дверь недоступна.
• N : нет указания, что дверь недоступна.

string

Указывает, что для адреса действительнее более одного кода возврата DPV. Возвращает одного персонажа.

• Y : Адрес был подтвержден DPV для первичных и любых вторичных чисел.
• N : Первичная и любая информация о вторичном номере не удалось подтвердить DPV.
• S : Адрес был подтвержден DPV только для первичного номера, а информация о вторичном номере присутствовала, но не подтверждена, или единственная альфа -альфа по первичному номеру была отброшена, чтобы сделать матч DPV и необходимую вторичную информацию.
• D : адрес был подтвержден DPV только для первичного номера, а информация о вторичном номере отсутствовала.
• R : Адрес подтвержден, но назначен на Phantom Route R777 и R779 и доставка USPS не предоставлен.

string

Код маршрута перевозчика. Четыре кода символа, состоящий из префикса одной буквы и трехзначного обозначения маршрута.

Префиксы:

• C : маршрут перевозчика (или городской маршрут)
• R : сельский маршрут
• H : Контрактный маршрут шоссе
• B : раздел «почтовый офис»
• G : Общая единица доставки

string

Индикатор сортировки скорости маршрута перевозчика.

boolean

Адрес доставки подходит, но файл EWS указывает, что в ближайшее время будет доступно точное совпадение.

string

Главное почтовое отделение города.

string

Основное государство почтового отделения.

string

Сокращенный город.

string

Кодекс округа Фипс.

string

Имя округа.

string

Усовершенствованная линия путешествия (ELOT).

string

ЭКОЛОТ АНЦИПАНСКИЙ/УГОДНЫЙ ФЛАГ (A/D).

string

Код возврата lacslink.

string

Индикатор LACSLINK.

boolean

Ящик для почтового ящика.

string

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

• A : SuiteLink Record Match, бизнес -адрес улучшен.
• 00 : нет матча, бизнес -адрес не улучшен.

string

PMB (Private Mail Box) Устройство устройства.

string

PMB (частный почтовый ящик) номер;

string

Тип адресной записи, которая соответствует входному адресу.

• F : фирма. Это совпадение с твердой записью, которая является лучшим уровнем совпадения, доступным для адреса.
• G : Общая доставка. Это совпадение с общей записью доставки.
• H : Здание / Квартира. Это матч с зданием или квартирой.
• P : почтовое ящик. Это совпадение с почтовым ящиком.
• R : сельский маршрут или контракт на шоссе: это совпадает либо с сельским маршрутом, либо с контрактной записью на шоссе, оба из которых могут иметь ассоциированные диапазоны номера коробки.
• S : Street Record: это совпадение с уличной записью, содержащей действительный диапазон первичных номеров.

boolean

Индикатор того, что адрес по умолчанию был найден, но существуют более конкретные адреса.

string

Сообщение об ошибке для поиска данных USPS. Это заполнено, когда обработка USPS приостановлена ​​из -за обнаружения искусственно созданных адресов.

Поля данных USPS не могут быть заполнены, когда присутствует эта ошибка.

boolean

Индикатор того, что запрос был обработан CASS.

string

Первая адресная строка.

string

Твердое название.

string

Вторая адресная строка.

string

Пуэрториканское имя урбанизации.

string

Город + государство + почтовый код.

string

Название города.

string

2 буквенного состояния код.

string

Почтовый код, например, 10009.

string

4-значное расширение почтового кода, например, 5023.

integer

The schema revision of the PostalAddress . Any value other than 0 will cause the API to return an INVALID_ARGUMENT error.

string

Необязательный. CLDR region code of the country/region of the address. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. If the region code is not provided, it will be inferred from the address. For best performance, it is recommended to include the region code if you know it. Having inconsistent or repeated regions can lead to poor performance, for example, if the addressLines already includes the region, do not provide the region code again in this field. Supported regions can be found in the FAQ .

string

The language code in the input address is reserved for future uses and is ignored today. The API returns the address in the appropriate language for where the address is located.

string

Необязательный. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).

string

Необязательный. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).

string

Необязательный. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.

string

Необязательный. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines .

string

Необязательный. Sublocality of the address. For example, this can be a neighborhood, borough, or district.

string

Необходимый. Unstructured address lines describing the lower levels of an address.

Because values in addressLines do not have type information and may sometimes contain multiple values in a single field (eg "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address.

The minimum permitted structural representation of an address consists of all information placed in the addressLines . If a regionCode is not provided, the region is inferred from the address lines.

Creating an address only containing addressLines , and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

string

Please avoid setting this field. The Address Validation API does not currently use it. Although at this time the API will not reject requests with this field set, the information will be discarded and will not be returned in the response.

string

Please avoid setting this field. The Address Validation API does not currently use it. Although at this time the API will not reject requests with this field set, the information will be discarded and will not be returned in the response.

boolean

Preview: Return a google.maps.addressvalidation.v1.Address in English. See google.maps.addressvalidation.v1.ValidationResult.english_latin_address for details.

object ( Verdict )

Overall verdict flags

object ( Address )

Information about the address itself as opposed to the geocode.

object ( Geocode )

Information about the location and place that the address geocoded to.

object ( AddressMetadata )

Other information relevant to deliverability. metadata is not guaranteed to be fully populated for every address sent to the Address Validation API.

object ( UspsData )

Extra deliverability flags provided by USPS. Only provided in region US and PR .

object ( Address )

Preview: This feature is in Preview (pre-GA). Продукты и функции Pre-GA могут иметь ограниченную поддержку, а изменения в продуктах и ​​функциях Pre-GA могут быть несовместимы с другими версиями Pre-GA. На предложения Pre-GA распространяются Особые условия обслуживания платформы Google Maps . Дополнительную информацию см. в описании этапов запуска .

The address translated to English.

Translated addresses are not reusable as API input. The service provides them so that the user can use their native language to confirm or deny the validation of the originally-provided address.

If part of the address doesn't have an English translation, the service returns that part in an alternate language that uses a Latin script. See here for an explanation of how the alternate language is selected. If part of the address doesn't have any translations or transliterations in a language that uses a Latin script, the service returns that part in the local language associated with the address.

Enable this output by using the google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address flag.

Note: the google.maps.addressvalidation.v1.Address.unconfirmed_component_types field in the englishLatinAddress and the google.maps.addressvalidation.v1.AddressComponent.confirmation_level fields in englishLatinAddress.address_components are not populated.

enum ( Granularity )

The granularity of the input address. This is the result of parsing the input address and does not give any validation signals. For validation signals, refer to validationGranularity below.

For example, if the input address includes a specific apartment number, then the inputGranularity here will be SUB_PREMISE . If we cannot match the apartment number in the databases or the apartment number is invalid, the validationGranularity will likely be PREMISE or below.

enum ( Granularity )

The granularity level that the API can fully validate the address to. For example, an validationGranularity of PREMISE indicates all address components at the level of PREMISE or more coarse can be validated.

Per address component validation result can be found in google.maps.addressvalidation.v1.Address.address_components .

enum ( Granularity )

Information about the granularity of the geocode . This can be understood as the semantic meaning of how coarse or fine the geocoded location is.

This can differ from the validationGranularity above occasionally. For example, our database might record the existence of an apartment number but do not have a precise location for the apartment within a big apartment complex. In that case, the validationGranularity will be SUB_PREMISE but the geocodeGranularity will be PREMISE .

boolean

The address is considered complete if there are no unresolved tokens, no unexpected or missing address components. If unset, indicates that the value is false . See missingComponentTypes , unresolvedTokens or unexpected fields for more details.

boolean

At least one address component cannot be categorized or validated, see google.maps.addressvalidation.v1.Address.address_components for details.

boolean

At least one address component was inferred (added) that wasn't in the input, see google.maps.addressvalidation.v1.Address.address_components for details.

boolean

At least one address component was replaced, see google.maps.addressvalidation.v1.Address.address_components for details.

string

The post-processed address, formatted as a single-line address following the address formatting rules of the region where the address is located.

Note: the format of this address may not match the format of the address in the postalAddress field. For example, the postalAddress always represents the country as a 2 letter regionCode , such as "US" or "NZ". By contrast, this field uses a longer form of the country name, such as "USA" or "New Zealand".

object ( PostalAddress )

The post-processed address represented as a postal address.

object ( AddressComponent )

Unordered list. The individual address components of the formatted and corrected address, along with validation information. This provides information on the validation status of the individual components.

Address components are not ordered in a particular way. Do not make any assumptions on the ordering of the address components in the list.

string

The types of components that were expected to be present in a correctly formatted mailing address but were not found in the input AND could not be inferred. An example might be ['street_number', 'route'] for an input like "Boulder, Colorado, 80301, USA". The list of possible types can be found here .

Note: you might see a missing component type when you think you've already supplied the missing component. For example, this can happen when the input address contains the building name, but not the premise number. In the address "渋谷区渋谷３丁目 Shibuya Stream", the building name "Shibuya Stream" has the component type premise , but the premise number is missing, so missingComponentTypes will contain premise .

string

The types of the components that are present in the addressComponents but could not be confirmed to be correct. This field is provided for the sake of convenience: its contents are equivalent to iterating through the addressComponents to find the types of all the components where the confirmationLevel is not CONFIRMED or the inferred flag is not set to true . The list of possible types can be found here .

string

Any tokens in the input that could not be resolved. This might be an input that was not recognized as a valid part of an address. For example, for an input such as "Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US", the unresolved tokens might look like ["Parcel", "0000123123", "&", "0000456456"] .

object ( ComponentName )

The name for this component.

string

The type of the address component. See Table 2: Additional types returned by the Places service for a list of possible types.

enum ( ConfirmationLevel )

Indicates the level of certainty that we have that the component is correct.

boolean

Indicates that the component was not part of the input, but we inferred it for the address location and believe it should be provided for a complete address.

boolean

Indicates a correction to a misspelling in the component name. The API does not always flag changes from one spelling variant to another, such as when changing "centre" to "center". It also does not always flag common misspellings, such as when changing "Amphitheater Pkwy" to "Amphitheatre Pkwy".

boolean

Indicates the name of the component was replaced with a completely different one, for example a wrong postal code being replaced with one that is correct for the address. This is not a cosmetic change, the input component has been changed to a different one.

boolean

Indicates an address component that is not expected to be present in a postal address for the given region. We have retained it only because it was part of the input.

string

The name text. For example, "5th Avenue" for a street name or "1253" for a street number.

string

The BCP-47 language code. This will not be present if the component name is not associated with a language, such as a street number.

object ( LatLng )

The geocoded location of the input.

Using place IDs is preferred over using addresses, latitude/longitude coordinates, or plus codes. Using coordinates when routing or calculating driving directions will always result in the point being snapped to the road nearest to those coordinates. This may not be a road that will quickly or safely lead to the destination and may not be near an access point to the property. Additionally, when a location is reverse geocoded, there is no guarantee that the returned address will match the original.

object ( PlusCode )

The plus code corresponding to the location .

object ( Viewport )

The bounds of the geocoded place.

number

The size of the geocoded place, in meters. This is another measure of the coarseness of the geocoded location, but in physical size rather than in semantic meaning.

string

The PlaceID of the place this input geocodes to.

For more information about Place IDs see here .

string

The type(s) of place that the input geocoded to. For example, ['locality', 'political'] . The full list of types can be found here .

number

The latitude in degrees. It must be in the range [-90.0, +90.0].

number

The longitude in degrees. It must be in the range [-180.0, +180.0].

string

Place's global (full) code, such as "9FWM33GV+HQ", representing an 1/8000 by 1/8000 degree area (~14 by 14 meters).

string

Place's compound code, such as "33GV+HQ, Ramberg, Norway", containing the suffix of the global code and replacing the prefix with a formatted name of a reference entity.

object ( LatLng )

Необходимый. The low point of the viewport.

object ( LatLng )

Необходимый. The high point of the viewport.

boolean

Indicates that this is the address of a business. If unset, indicates that the value is unknown.

boolean

Indicates that the address of a PO box. If unset, indicates that the value is unknown.

boolean

Indicates that this is the address of a residence. If unset, indicates that the value is unknown.

object ( UspsAddress )

USPS standardized address.

string

2 digit delivery point code

string

The delivery point check digit. This number is added to the end of the delivery_point_barcode for mechanically scanned mail. Adding all the digits of the delivery_point_barcode, deliveryPointCheckDigit, postal code, and ZIP+4 together should yield a number divisible by 10.

string

The possible values for DPV confirmation. Returns a single character or returns no value.

• N : Primary and any secondary number information failed to DPV confirm.
• D : Address was DPV confirmed for the primary number only, and the secondary number information was missing.
• S : Address was DPV confirmed for the primary number only, and the secondary number information was present but not confirmed.
• Y : Address was DPV confirmed for primary and any secondary numbers.
• Empty: If the response does not contain a dpvConfirmation value, the address was not submitted for DPV confirmation.

string

The footnotes from delivery point validation. Multiple footnotes may be strung together in the same string.

• AA : Input address matched to the ZIP+4 file
• A1 : Input address was not matched to the ZIP+4 file
• BB : Matched to DPV (all components)
• CC : Secondary number not matched and not required
• C1 : Secondary number not matched but required
• N1 : High-rise address missing secondary number
• M1 : Primary number missing
• M3 : Primary number invalid
• P1 : Input address PO, RR or HC box number missing
• P3 : Input address PO, RR, or HC Box number invalid
• F1 : Input address matched to a military address
• G1 : Input address matched to a general delivery address
• U1 : Input address matched to a unique ZIP code
• PB : Input address matched to PBSA record
• RR : DPV confirmed address with PMB information
• R1 : DPV confirmed address without PMB information
• R7 : Carrier Route R777 or R779 record
• IA : Informed Address identified
• TA : Primary number matched by dropping a trailing alpha

string

Indicates if the address is a CMRA (Commercial Mail Receiving Agency)--a private business receiving mail for clients. Returns a single character.

• Y : The address is a CMRA
• N : The address is not a CMRA

string

Is this place vacant? Returns a single character.

• Y : The address is vacant
• N : The address is not vacant

string

Is this a no stat address or an active address? No stat addresses are ones which are not continuously occupied or addresses that the USPS does not service. Returns a single character.

• Y : The address is not active
• N : The address is active

integer

Indicates the NoStat type. Returns a reason code as int.

• 1 : IDA (Internal Drop Address) – Addresses that do not receive mail directly from the USPS but are delivered to a drop address that services them.
• 2 : CDS - Addresses that have not yet become deliverable. For example, a new subdivision where lots and primary numbers have been determined, but no structure exists yet for occupancy.
• 3 : Collision - Addresses that do not actually DPV confirm.
• 4 : CMZ (College, Military and Other Types) - ZIP + 4 records USPS has incorporated into the data.
• 5 : Regular - Indicates addresses not receiving delivery and the addresses are not counted as possible deliveries.
• 6 : Secondary Required - The address requires secondary information.

string

Flag indicates mail is delivered to a single receptable at a site. Returns a single character.

• Y : The mail is delivered to a single receptable at a site.
• N : The mail is not delivered to a single receptable at a site.

string

Indicates that mail is not delivered to the street address. Returns a single character.

• Y : The mail is not delivered to the street address.
• N : The mail is delivered to the street address.

string

Flag indicates mail delivery is not performed every day of the week. Returns a single character.

• Y : The mail delivery is not performed every day of the week.
• N : No indication the mail delivery is not performed every day of the week.

integer

Integer identifying non-delivery days. It can be interrogated using bit flags: 0x40 – Sunday is a non-delivery day 0x20 – Monday is a non-delivery day 0x10 – Tuesday is a non-delivery day 0x08 – Wednesday is a non-delivery day 0x04 – Thursday is a non-delivery day 0x02 – Friday is a non-delivery day 0x01 – Saturday is a non-delivery day

string

Flag indicates door is accessible, but package will not be left due to security concerns. Returns a single character.

• Y : The package will not be left due to security concerns.
• N : No indication the package will not be left due to security concerns.

string

Indicates the address was matched to PBSA record. Returns a single character.

• Y : The address was matched to PBSA record.
• N : The address was not matched to PBSA record.

string

Flag indicates addresses where USPS cannot knock on a door to deliver mail. Returns a single character.

• Y : The door is not accessible.
• N : No indication the door is not accessible.

string

Indicates that more than one DPV return code is valid for the address. Returns a single character.

• Y : Address was DPV confirmed for primary and any secondary numbers.
• N : Primary and any secondary number information failed to DPV confirm.
• S : Address was DPV confirmed for the primary number only, and the secondary number information was present but not confirmed, or a single trailing alpha on a primary number was dropped to make a DPV match and secondary information required.
• D : Address was DPV confirmed for the primary number only, and the secondary number information was missing.
• R : Address confirmed but assigned to phantom route R777 and R779 and USPS delivery is not provided.

string

The carrier route code. A four character code consisting of a one letter prefix and a three digit route designator.

Prefixes:

• C : Carrier route (or city route)
• R : Rural route
• H : Highway Contract Route
• B : Post Office Box Section
• G : General delivery unit

string

Carrier route rate sort indicator.

boolean

The delivery address is matchable, but the EWS file indicates that an exact match will be available soon.

string

Main post office city.

string

Main post office state.

string

Abbreviated city.

string

FIPS county code.

string

County name.

string

Enhanced Line of Travel (eLOT) number.

string

eLOT Ascending/Descending Flag (A/D).

string

LACSLink return code.

string

LACSLink indicator.

boolean

PO Box only postal code.

string

Footnotes from matching a street or highrise record to suite information. If business name match is found, the secondary number is returned.

• A : SuiteLink record match, business address improved.
• 00 : No match, business address is not improved.

string

PMB (Private Mail Box) unit designator.

string

PMB (Private Mail Box) number;

string

Type of the address record that matches the input address.

• F : FIRM. This is a match to a Firm Record, which is the finest level of match available for an address.
• G : GENERAL DELIVERY. This is a match to a General Delivery record.
• H : BUILDING / APARTMENT. This is a match to a Building or Apartment record.
• P : POST OFFICE BOX. This is a match to a Post Office Box.
• R : RURAL ROUTE or HIGHWAY CONTRACT: This is a match to either a Rural Route or a Highway Contract record, both of which may have associated Box Number ranges.
• S : STREET RECORD: This is a match to a Street record containing a valid primary number range.

boolean

Indicator that a default address was found, but more specific addresses exists.

string

Error message for USPS data retrieval. This is populated when USPS processing is suspended because of the detection of artificially created addresses.

The USPS data fields might not be populated when this error is present.

boolean

Indicator that the request has been CASS processed.

string

First address line.

string

Firm name.

string

Second address line.

string

Puerto Rican urbanization name.

string

City + state + postal code.

string

City name.

string

2 letter state code.

string

Postal code eg 10009.

string

4-digit postal code extension eg 5023.

integer

The schema revision of the PostalAddress . Any value other than 0 will cause the API to return an INVALID_ARGUMENT error.

string

Необязательный. CLDR region code of the country/region of the address. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland. If the region code is not provided, it will be inferred from the address. For best performance, it is recommended to include the region code if you know it. Having inconsistent or repeated regions can lead to poor performance, for example, if the addressLines already includes the region, do not provide the region code again in this field. Supported regions can be found in the FAQ .

string

The language code in the input address is reserved for future uses and is ignored today. The API returns the address in the appropriate language for where the address is located.

string

Необязательный. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (for example, state or zip code validation in the United States).

string

Необязательный. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (for example, "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (Côte d'Ivoire).

string

Необязательный. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. For Spain, this is the province and not the autonomous community (for example, "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. For example, in Switzerland, this should be left unpopulated.

string

Необязательный. Generally refers to the city or town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use addressLines .

string

Необязательный. Sublocality of the address. For example, this can be a neighborhood, borough, or district.

string

Необходимый. Unstructured address lines describing the lower levels of an address.

Because values in addressLines do not have type information and may sometimes contain multiple values in a single field (eg "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address.

The minimum permitted structural representation of an address consists of all information placed in the addressLines . If a regionCode is not provided, the region is inferred from the address lines.

Creating an address only containing addressLines , and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

string

Please avoid setting this field. The Address Validation API does not currently use it. Although at this time the API will not reject requests with this field set, the information will be discarded and will not be returned in the response.

string

Please avoid setting this field. The Address Validation API does not currently use it. Although at this time the API will not reject requests with this field set, the information will be discarded and will not be returned in the response.

boolean

Preview: Return a google.maps.addressvalidation.v1.Address in English. See google.maps.addressvalidation.v1.ValidationResult.english_latin_address for details.

object ( Verdict )

Overall verdict flags

object ( Address )

Information about the address itself as opposed to the geocode.

object ( Geocode )

Information about the location and place that the address geocoded to.

object ( AddressMetadata )

Other information relevant to deliverability. metadata is not guaranteed to be fully populated for every address sent to the Address Validation API.

object ( UspsData )

Extra deliverability flags provided by USPS. Only provided in region US and PR .

object ( Address )

Preview: This feature is in Preview (pre-GA). Продукты и функции Pre-GA могут иметь ограниченную поддержку, а изменения в продуктах и ​​функциях Pre-GA могут быть несовместимы с другими версиями Pre-GA. На предложения Pre-GA распространяются Особые условия обслуживания платформы Google Maps . Дополнительную информацию см. в описании этапов запуска .

The address translated to English.

Translated addresses are not reusable as API input. The service provides them so that the user can use their native language to confirm or deny the validation of the originally-provided address.

If part of the address doesn't have an English translation, the service returns that part in an alternate language that uses a Latin script. See here for an explanation of how the alternate language is selected. If part of the address doesn't have any translations or transliterations in a language that uses a Latin script, the service returns that part in the local language associated with the address.

Enable this output by using the google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address flag.

Note: the google.maps.addressvalidation.v1.Address.unconfirmed_component_types field in the englishLatinAddress and the google.maps.addressvalidation.v1.AddressComponent.confirmation_level fields in englishLatinAddress.address_components are not populated.

enum ( Granularity )

The granularity of the input address. This is the result of parsing the input address and does not give any validation signals. For validation signals, refer to validationGranularity below.

For example, if the input address includes a specific apartment number, then the inputGranularity here will be SUB_PREMISE . If we cannot match the apartment number in the databases or the apartment number is invalid, the validationGranularity will likely be PREMISE or below.

enum ( Granularity )

The granularity level that the API can fully validate the address to. For example, an validationGranularity of PREMISE indicates all address components at the level of PREMISE or more coarse can be validated.

Per address component validation result can be found in google.maps.addressvalidation.v1.Address.address_components .

enum ( Granularity )

Information about the granularity of the geocode . This can be understood as the semantic meaning of how coarse or fine the geocoded location is.

This can differ from the validationGranularity above occasionally. For example, our database might record the existence of an apartment number but do not have a precise location for the apartment within a big apartment complex. In that case, the validationGranularity will be SUB_PREMISE but the geocodeGranularity will be PREMISE .

boolean

The address is considered complete if there are no unresolved tokens, no unexpected or missing address components. If unset, indicates that the value is false . See missingComponentTypes , unresolvedTokens or unexpected fields for more details.

boolean

At least one address component cannot be categorized or validated, see google.maps.addressvalidation.v1.Address.address_components for details.

boolean

At least one address component was inferred (added) that wasn't in the input, see google.maps.addressvalidation.v1.Address.address_components for details.

boolean

At least one address component was replaced, see google.maps.addressvalidation.v1.Address.address_components for details.

string

The post-processed address, formatted as a single-line address following the address formatting rules of the region where the address is located.

Note: the format of this address may not match the format of the address in the postalAddress field. For example, the postalAddress always represents the country as a 2 letter regionCode , such as "US" or "NZ". By contrast, this field uses a longer form of the country name, such as "USA" or "New Zealand".

object ( PostalAddress )

The post-processed address represented as a postal address.

object ( AddressComponent )

Unordered list. The individual address components of the formatted and corrected address, along with validation information. This provides information on the validation status of the individual components.

Address components are not ordered in a particular way. Do not make any assumptions on the ordering of the address components in the list.

string

The types of components that were expected to be present in a correctly formatted mailing address but were not found in the input AND could not be inferred. An example might be ['street_number', 'route'] for an input like "Boulder, Colorado, 80301, USA". The list of possible types can be found here .

Note: you might see a missing component type when you think you've already supplied the missing component. For example, this can happen when the input address contains the building name, but not the premise number. In the address "渋谷区渋谷３丁目 Shibuya Stream", the building name "Shibuya Stream" has the component type premise , but the premise number is missing, so missingComponentTypes will contain premise .

string

The types of the components that are present in the addressComponents but could not be confirmed to be correct. This field is provided for the sake of convenience: its contents are equivalent to iterating through the addressComponents to find the types of all the components where the confirmationLevel is not CONFIRMED or the inferred flag is not set to true . The list of possible types can be found here .

string

Any tokens in the input that could not be resolved. This might be an input that was not recognized as a valid part of an address. For example, for an input such as "Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US", the unresolved tokens might look like ["Parcel", "0000123123", "&", "0000456456"] .

object ( ComponentName )

The name for this component.

string

The type of the address component. See Table 2: Additional types returned by the Places service for a list of possible types.

enum ( ConfirmationLevel )

Indicates the level of certainty that we have that the component is correct.

boolean

Indicates that the component was not part of the input, but we inferred it for the address location and believe it should be provided for a complete address.

boolean

Indicates a correction to a misspelling in the component name. The API does not always flag changes from one spelling variant to another, such as when changing "centre" to "center". It also does not always flag common misspellings, such as when changing "Amphitheater Pkwy" to "Amphitheatre Pkwy".

boolean

Indicates the name of the component was replaced with a completely different one, for example a wrong postal code being replaced with one that is correct for the address. This is not a cosmetic change, the input component has been changed to a different one.

boolean

Indicates an address component that is not expected to be present in a postal address for the given region. We have retained it only because it was part of the input.

string

The name text. For example, "5th Avenue" for a street name or "1253" for a street number.

string

The BCP-47 language code. This will not be present if the component name is not associated with a language, such as a street number.

object ( LatLng )

The geocoded location of the input.

Using place IDs is preferred over using addresses, latitude/longitude coordinates, or plus codes. Using coordinates when routing or calculating driving directions will always result in the point being snapped to the road nearest to those coordinates. This may not be a road that will quickly or safely lead to the destination and may not be near an access point to the property. Additionally, when a location is reverse geocoded, there is no guarantee that the returned address will match the original.

object ( PlusCode )

The plus code corresponding to the location .

object ( Viewport )

The bounds of the geocoded place.