Method: validateAddress

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

HTTP-запрос

POST https://addressvalidation.googleapis.com/v1:validateAddress

URL-адрес использует синтаксис транскодирования gRPC .

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление
{
  "address": {
    object (PostalAddress)
  },
  "previousResponseId": string,
  "enableUspsCass": boolean,
  "languageOptions": {
    object (LanguageOptions)
  }
}
Поля
address

object ( PostalAddress )

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

Общая длина полей в этом вводе не должна превышать 280 символов.

Поддерживаемые регионы можно найти здесь .

Значение languageCode во входном адресе зарезервировано для будущего использования и сегодня игнорируется. Результат проверки адреса будет заполнен на основе предпочтительного языка для данного адреса, определенного системой.

API проверки адреса игнорирует значения recipients и organization . Любые значения в этих полях будут отброшены и не возвращены. Пожалуйста, не устанавливайте их.

previousResponseId

string

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

enableUspsCass

boolean

Включает режим совместимости с USPS CASS. Это влияет только на поле google.maps.addressvalidation.v1.ValidationResult.usps_data в google.maps.addressvalidation.v1.ValidationResult . Примечание. Для запросов адресов в Пуэрто-Рико с поддержкой USPS CASS google.type.PostalAddress.region_code address должен быть указан как «PR», или google.type.PostalAddress.administrative_area address должен быть указан как «Puerto». Рико» (без учета регистра) или «PR».

Рекомендуется использовать компонентный address или указать как минимум две строки google.type.PostalAddress.address_lines , где первая строка содержит номер улицы и название, а вторая строка – город, штат и почтовый индекс.

languageOptions

object ( LanguageOptions )

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

Позволяет API проверки адреса включать дополнительную информацию в ответ.

Тело ответа

Ответ на запрос проверки адреса.

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление
{
  "result": {
    object (ValidationResult)
  },
  "responseId": string
}
Поля
result

object ( ValidationResult )

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

responseId

string

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

Почтовый адрес

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

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

Советы по вводу/редактированию адреса: – Используйте готовый к интернационализации виджет адреса, например https://github.com/google/libaddressinput . – Пользователям не должны предоставляться элементы пользовательского интерфейса для ввода или редактирования полей за пределами стран, где это поле есть. использовал.

Дополнительные инструкции по использованию этой схемы см. на странице https://support.google.com/business/answer/6397478 .

JSON-представление
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Поля
revision

integer

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

regionCode

string

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

languageCode

string

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

postalCode

string

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

sortingCode

string

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

administrativeArea

string

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

locality

string

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

sublocality

string

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

addressLines[]

string

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

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

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

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

recipients[]

string

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

organization

string

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

Языковые параметры

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

Позволяет API проверки адреса включать дополнительную информацию в ответ.

JSON-представление
{
  "returnEnglishLatinAddress": boolean
}
Поля
returnEnglishLatinAddress

boolean

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

Результат проверки

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

JSON-представление
{
  "verdict": {
    object (Verdict)
  },
  "address": {
    object (Address)
  },
  "geocode": {
    object (Geocode)
  },
  "metadata": {
    object (AddressMetadata)
  },
  "uspsData": {
    object (UspsData)
  },
  "englishLatinAddress": {
    object (Address)
  }
}
Поля
verdict

object ( Verdict )

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

address

object ( Address )

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

geocode

object ( Geocode )

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

metadata

object ( AddressMetadata )

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

uspsData

object ( UspsData )

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

englishLatinAddress

object ( Address )

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

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

Вы включили этот вывод, используя флаг 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 не заполняются.

Вердикт

Общий обзор результатов проверки адреса и геокодирования.

JSON-представление
{
  "inputGranularity": enum (Granularity),
  "validationGranularity": enum (Granularity),
  "geocodeGranularity": enum (Granularity),
  "addressComplete": boolean,
  "hasUnconfirmedComponents": boolean,
  "hasInferredComponents": boolean,
  "hasReplacedComponents": boolean
}
Поля
inputGranularity

enum ( Granularity )

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

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

validationGranularity

enum ( Granularity )

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

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

geocodeGranularity

enum ( Granularity )

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

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

addressComplete

boolean

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

hasUnconfirmedComponents

boolean

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

hasInferredComponents

boolean

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

hasReplacedComponents

boolean

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

Детализация

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

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

Адрес

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

JSON-представление
{
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "addressComponents": [
    {
      object (AddressComponent)
    }
  ],
  "missingComponentTypes": [
    string
  ],
  "unconfirmedComponentTypes": [
    string
  ],
  "unresolvedTokens": [
    string
  ]
}
Поля
formattedAddress

string

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

postalAddress

object ( PostalAddress )

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

addressComponents[]

object ( AddressComponent )

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

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

missingComponentTypes[]

string

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

unconfirmedComponentTypes[]

string

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

unresolvedTokens[]

string

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

Адресный компонент

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

JSON-представление
{
  "componentName": {
    object (ComponentName)
  },
  "componentType": string,
  "confirmationLevel": enum (ConfirmationLevel),
  "inferred": boolean,
  "spellCorrected": boolean,
  "replaced": boolean,
  "unexpected": boolean
}
Поля
componentName

object ( ComponentName )

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

componentType

string

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

confirmationLevel

enum ( ConfirmationLevel )

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

inferred

boolean

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

spellCorrected

boolean

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

replaced

boolean

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

unexpected

boolean

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

ИмяКомпонента

Обертка для имени компонента.

JSON-представление
{
  "text": string,
  "languageCode": string
}
Поля
text

string

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

languageCode

string

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

Уровень подтверждения

Различные возможные значения уровней подтверждения.

Перечисления
CONFIRMATION_LEVEL_UNSPECIFIED Значение по умолчанию. Это значение не используется.
CONFIRMED Нам удалось убедиться, что этот компонент существует и имеет смысл в контексте остальной части адреса.
UNCONFIRMED_BUT_PLAUSIBLE Этот компонент не может быть подтвержден, но вполне вероятно, что он существует. Например, номер улицы в известном допустимом диапазоне номеров на улице, где конкретные номера домов не известны.
UNCONFIRMED_AND_SUSPICIOUS Этот компонент не был подтвержден и, скорее всего, ошибочен. Например, район, который не соответствует остальной части адреса.

Геокодирование

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

JSON-представление
{
  "location": {
    object (LatLng)
  },
  "plusCode": {
    object (PlusCode)
  },
  "bounds": {
    object (Viewport)
  },
  "featureSizeMeters": number,
  "placeId": string,
  "placeTypes": [
    string
  ]
}
Поля
location

object ( LatLng )

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

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

plusCode

object ( PlusCode )

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

bounds

object ( Viewport )

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

featureSizeMeters

number

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

placeId

string

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

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

placeTypes[]

string

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

ШиротаДлительность

Объект, представляющий пару широты и долготы. Это выражается в виде пары двойных чисел, обозначающих градусы широты и градусы долготы. Если не указано иное, этот объект должен соответствовать стандарту WGS84 . Значения должны находиться в пределах нормализованных диапазонов.

JSON-представление
{
  "latitude": number,
  "longitude": number
}
Поля
latitude

number

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

longitude

number

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

ПлюсКод

Плюс-код ( http://plus.codes ) — это ссылка на местоположение в двух форматах: глобальный код, определяющий прямоугольник размером 14 x 14 м (1/8000 градуса) или меньше, и составной код, заменяющий префикс на ссылку на местоположение.

JSON-представление
{
  "globalCode": string,
  "compoundCode": string
}
Поля
globalCode

string

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

compoundCode

string

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

Область просмотра

Окно просмотра широты и долготы, представленное в виде двух диагонально противоположных low и high точек. Область просмотра считается закрытой областью, т. е. включает в себя ее границу. Границы широты должны находиться в диапазоне от -90 до 90 градусов включительно, а границы долготы должны находиться в диапазоне от -180 до 180 градусов включительно. Различные случаи включают в себя:

  • Если low = high , область просмотра состоит из этой единственной точки.

  • Если low.longitude > high.longitude , диапазон долготы инвертируется (окно просмотра пересекает линию долготы в 180 градусов).

  • Если low.longitude = -180 градусов и high.longitude = 180 градусов, область просмотра включает все значения долготы.

  • Если low.longitude = 180 градусов и high.longitude = -180 градусов, диапазон долготы пуст.

  • Если low.latitude > high.latitude , диапазон широт пуст.

Оба low и high должны быть заполнены, а представленное поле не может быть пустым (как указано в определениях выше). Пустое окно просмотра приведет к ошибке.

Например, это окно просмотра полностью охватывает Нью-Йорк:

{ "низкая": { "широта": 40,477398, "долгота": -74,259087 }, "высокая": { "широта": 40,91618, "долгота": -73,70018 } }

JSON-представление
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Поля
low

object ( LatLng )

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

high

object ( LatLng )

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

АдресМетаданные

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

JSON-представление
{
  "business": boolean,
  "poBox": boolean,
  "residential": boolean
}
Поля
business

boolean

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

poBox

boolean

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

residential

boolean

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

UspsData

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

JSON-представление
{
  "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
}
Поля
standardizedAddress

object ( UspsAddress )

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

deliveryPointCode

string

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

deliveryPointCheckDigit

string

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

dpvConfirmation

string

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

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

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 : основной номер, сопоставленный с отбрасыванием завершающей альфа.
dpvCmra

string

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

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

string

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

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

string

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

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

integer

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

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

string

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

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

string

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

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

string

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

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

integer

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

dpvNoSecureLocation

string

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

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

string

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

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

string

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

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

string

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

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

string

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

Префиксы:

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

string

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

ewsNoMatch

boolean

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

postOfficeCity

string

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

postOfficeState

string

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

abbreviatedCity

string

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

fipsCountyCode

string

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

county

string

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

elotNumber

string

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

elotFlag

string

eLOT восходящий/нисходящий флаг (A/D).

poBoxOnlyPostalCode

boolean

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

pmbDesignator

string

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

pmbNumber

string

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

addressRecordType

string

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

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

boolean

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

errorMessage

string

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

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

cassProcessed

boolean

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

UspsАдрес

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

JSON-представление
{
  "firstAddressLine": string,
  "firm": string,
  "secondAddressLine": string,
  "urbanization": string,
  "cityStateZipAddressLine": string,
  "city": string,
  "state": string,
  "zipCode": string,
  "zipCodeExtension": string
}
Поля
firstAddressLine

string

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

firm

string

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

secondAddressLine

string

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

urbanization

string

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

cityStateZipAddressLine

string

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

city

string

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

state

string

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

zipCode

string

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

zipCodeExtension

string

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