Method: validateAddress

{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}

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 пустым и используйте адресные строки.

string

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

string

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

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

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

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

string

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

string

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

{
  "returnEnglishLatinAddress": boolean
}

boolean

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

{
  "verdict": {
    object (Verdict)
  },
  "address": {
    object (Address)
  },
  "geocode": {
    object (Geocode)
  },
  "metadata": {
    object (AddressMetadata)
  },
  "uspsData": {
    object (UspsData)
  },
  "englishLatinAddress": {
    object (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 не заполняются.

{
  "inputGranularity": enum (Granularity),
  "validationGranularity": enum (Granularity),
  "geocodeGranularity": enum (Granularity),
  "addressComplete": boolean,
  "hasUnconfirmedComponents": boolean,
  "hasInferredComponents": boolean,
  "hasReplacedComponents": boolean
}

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 .

{
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "addressComponents": [
    {
      object (AddressComponent)
    }
  ],
  "missingComponentTypes": [
    string
  ],
  "unconfirmedComponentTypes": [
    string
  ],
  "unresolvedTokens": [
    string
  ]
}

string

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

object ( PostalAddress )

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

object ( AddressComponent )

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

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

string

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

string

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

string

Любые токены во входных данных, которые не удалось разрешить. Это может быть ввод, который не был распознан как допустимая часть адреса (например, при вводе типа «123235253253 Main St, San Francisco, CA, 94105» неразрешенные токены могут выглядеть как ["123235253253"] поскольку это не так. не похож на действительный номер улицы.

{
  "componentName": {
    object (ComponentName)
  },
  "componentType": string,
  "confirmationLevel": enum (ConfirmationLevel),
  "inferred": boolean,
  "spellCorrected": boolean,
  "replaced": boolean,
  "unexpected": boolean
}

object ( ComponentName )

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

string

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

enum ( ConfirmationLevel )

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

boolean

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

boolean

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

boolean

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

boolean

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

{
  "text": string,
  "languageCode": string
}

string

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

string

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

{
  "location": {
    object (LatLng)
  },
  "plusCode": {
    object (PlusCode)
  },
  "bounds": {
    object (Viewport)
  },
  "featureSizeMeters": number,
  "placeId": string,
  "placeTypes": [
    string
  ]
}

object ( LatLng )

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

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

object ( PlusCode )

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

object ( Viewport )

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

number

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

string

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

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

string

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

{
  "latitude": number,
  "longitude": number
}

number

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

number

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

{
  "globalCode": string,
  "compoundCode": string
}

string

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

string

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

{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}

object ( LatLng )

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

object ( LatLng )

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

{
  "business": boolean,
  "poBox": boolean,
  "residential": boolean
}

boolean

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

boolean

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

boolean

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

{
  "standardizedAddress": {
    object (UspsAddress)
  },
  "deliveryPointCode": string,
  "deliveryPointCheckDigit": string,
  "dpvConfirmation": string,
  "dpvFootnote": string,
  "dpvCmra": string,
  "dpvVacant": string,
  "dpvNoStat": string,
  "dpvNoStatReasonCode": integer,
  "dpvDrop": string,
  "dpvThrowback": string,
  "dpvNonDeliveryDays": string,
  "dpvNonDeliveryDaysValues": integer,
  "dpvNoSecureLocation": string,
  "dpvPbsa": string,
  "dpvDoorNotAccessible": string,
  "dpvEnhancedDeliveryCode": string,
  "carrierRoute": string,
  "carrierRouteIndicator": string,
  "ewsNoMatch": boolean,
  "postOfficeCity": string,
  "postOfficeState": string,
  "abbreviatedCity": string,
  "fipsCountyCode": string,
  "county": string,
  "elotNumber": string,
  "elotFlag": string,
  "lacsLinkReturnCode": string,
  "lacsLinkIndicator": string,
  "poBoxOnlyPostalCode": boolean,
  "suitelinkFootnote": string,
  "pmbDesignator": string,
  "pmbNumber": string,
  "addressRecordType": string,
  "defaultAddress": boolean,
  "errorMessage": string,
  "cassProcessed": 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 обработан.

{
  "firstAddressLine": string,
  "firm": string,
  "secondAddressLine": string,
  "urbanization": string,
  "cityStateZipAddressLine": string,
  "city": string,
  "state": string,
  "zipCode": string,
  "zipCodeExtension": string
}

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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