Package google.maps.addressvalidation.v1

Индекс

Проверка адреса

Сервис проверки адресов.

Предоставление проверки, обратная связь

rpc ProvideValidationFeedback( ProvideValidationFeedbackRequest ) returns ( ProvideValidationFeedbackResponse )

Обратная связь о результатах последовательности попыток проверки. Это должен быть последний вызов после последовательности вызовов проверки для одного и того же адреса, и его следует вызывать после завершения транзакции. Его следует отправлять только один раз для последовательности запросов ValidateAddress , необходимой для полной проверки адреса.

Проверить адрес

rpc ValidateAddress( ValidateAddressRequest ) returns ( ValidateAddressResponse )

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

Адрес

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

Поля
formatted_address

string

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

postal_address

PostalAddress

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

address_components[]

AddressComponent

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

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

missing_component_types[]

string

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

unconfirmed_component_types[]

string

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

unresolved_tokens[]

string

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

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

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

Поля
component_name

ComponentName

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

component_type

string

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

confirmation_level

ConfirmationLevel

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

inferred

bool

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

spell_corrected

bool

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

replaced

bool

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

unexpected

bool

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

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

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

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

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

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

Поля
business

bool

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

po_box

bool

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

residential

bool

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

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

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

Поля
text

string

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

language_code

string

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

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

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

Поля
location

LatLng

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

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

plus_code

PlusCode

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

bounds

Viewport

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

feature_size_meters

float

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

place_id

string

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

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

place_types[]

string

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

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

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

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

Поля
return_english_latin_address

bool

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

ПлюсКод

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

Поля
global_code

string

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

compound_code

string

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

Предоставление проверки обратной связи

Запрос на отправку отзыва о проверке.

Поля
conclusion

ValidationConclusion

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

Если для этого поля установлено значение VALIDATION_CONCLUSION_UNSPECIFIED , будет возвращена ошибка INVALID_ARGUMENT .

response_id

string

Необходимый. Идентификатор ответа, для которого предназначен этот отзыв. Это должен быть [response_id][google.maps.addressvalidation.v1.ValidateAddressRequest.response_id] из первого ответа в серии попыток проверки адреса.

ВалидацияЗаключение

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

Перечисления
VALIDATION_CONCLUSION_UNSPECIFIED Это значение не используется. Если для поля ProvideValidationFeedbackRequest.conclusion установлено значение VALIDATION_CONCLUSION_UNSPECIFIED , будет возвращена ошибка INVALID_ARGUMENT .
VALIDATED_VERSION_USED Для транзакции использовалась версия адреса, возвращенная API проверки адреса.
USER_VERSION_USED Для транзакции была использована версия адреса, предоставленная пользователем.
UNVALIDATED_VERSION_USED Для транзакции использовалась версия адреса, введенная после последней попытки проверки, но не проверенная повторно.
UNUSED Транзакция была отменена, а адрес не использовался.

Провайдатионфидбакответс

Этот тип не имеет полей.

Ответ на отзыв о проверке.

Ответ пуст, если отзыв отправлен успешно.

UspsАдрес

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

Поля
first_address_line

string

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

firm

string

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

second_address_line

string

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

urbanization

string

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

city_state_zip_address_line

string

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

city

string

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

state

string

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

zip_code

string

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

zip_code_extension

string

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

UspsData

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

Поля
standardized_address

UspsAddress

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

delivery_point_code

string

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

delivery_point_check_digit

string

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

dpv_confirmation

string

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

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

string

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

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

string

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

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

string

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

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

string

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

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

string

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

Префиксы:

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

string

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

ews_no_match

bool

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

post_office_city

string

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

post_office_state

string

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

abbreviated_city

string

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

fips_county_code

string

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

county

string

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

elot_number

string

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

elot_flag

string

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

po_box_only_postal_code

bool

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

pmb_designator

string

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

pmb_number

string

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

address_record_type

string

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

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

bool

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

error_message

string

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

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

cass_processed

bool

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

ValidateAddressRequest

Запрос на проверку адреса.

Поля
address

PostalAddress

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

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

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

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

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

previous_response_id

string

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

enable_usps_cass

bool

Включает режим совместимости с 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 , где первая строка содержит номер улицы и название, а вторая строка — город, штат и почтовый индекс.

language_options

LanguageOptions

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

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

ValidateAddressResponse

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

Поля
result

ValidationResult

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

response_id

string

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

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

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

Поля
verdict

Verdict

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

address

Address

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

geocode

Geocode

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

metadata

AddressMetadata

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

usps_data

UspsData

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

english_latin_address

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 в english_latin_address и поля google.maps.addressvalidation.v1.AddressComponent.confirmation_level в english_latin_address.address_components не заполняются.

Вердикт

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

Поля
input_granularity

Granularity

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

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

validation_granularity

Granularity

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

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

geocode_granularity

Granularity

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

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

address_complete

bool

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

has_unconfirmed_components

bool

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

has_inferred_components

bool

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

has_replaced_components

bool

По крайней мере один компонент адреса был заменен. Подробности см. в 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 Все остальные детали, которые объединены в группы, поскольку они не могут быть доставлены.