Индекс
-
AddressValidation
(интерфейс) -
Address
(сообщение) -
AddressComponent
(сообщение) -
AddressComponent.ConfirmationLevel
(перечисление) -
AddressMetadata
(сообщение) -
ComponentName
(сообщение) -
Geocode
(сообщение) -
LanguageOptions
(сообщение) -
PlusCode
(сообщение) -
ProvideValidationFeedbackRequest
(сообщение) -
ProvideValidationFeedbackRequest.ValidationConclusion
(перечисление) -
ProvideValidationFeedbackResponse
(сообщение) -
UspsAddress
(сообщение) -
UspsData
(сообщение) -
ValidateAddressRequest
(сообщение) -
ValidateAddressResponse
(сообщение) -
ValidationResult
(сообщение) -
Verdict
(сообщение) -
Verdict.Granularity
(перечисление) -
Verdict.PossibleNextAction
(перечисление)
Проверка адреса
Сервис проверки адресов.
Предоставьте отзыв о проверке |
---|
Обратная связь о результате последовательности попыток проверки. Это должен быть последний вызов после последовательности вызовов проверки для того же адреса, и он должен быть вызван после завершения транзакции. Он должен быть отправлен только один раз для последовательности запросов |
Проверить адрес |
---|
Проверяет адрес. |
Адрес
Подробности постобработанного адреса. Постобработка включает исправление неправильно написанных частей адреса, замену неверных частей и вывод недостающих частей.
Поля | |
---|---|
formatted_address | Постобработанный адрес, отформатированный как однострочный адрес в соответствии с правилами форматирования адресов региона, в котором расположен адрес. Примечание: формат этого адреса может не совпадать с форматом адреса в поле |
postal_address | Постобработанный адрес, представленный в виде почтового адреса. |
address_components[] | Неупорядоченный список. Отдельные компоненты форматированного и исправленного адреса вместе с информацией о проверке. Это предоставляет информацию о статусе проверки отдельных компонентов. Компоненты адреса не упорядочены определенным образом. Не делайте никаких предположений о порядке компонентов адреса в списке. |
missing_component_types[] | Типы компонентов, которые должны были присутствовать в правильно отформатированном почтовом адресе, но не были найдены во входных данных И не могли быть выведены. Примером может быть Примечание: вы можете увидеть отсутствующий тип компонента, когда думаете, что уже предоставили отсутствующий компонент. Например, это может произойти, когда входной адрес содержит название здания, но не номер помещения. В адресе "渋谷区渋谷3丁目 Shibuya Stream" название здания "Shibuya Stream" имеет тип компонента |
unconfirmed_component_types[] | Типы компонентов, которые присутствуют в |
unresolved_tokens[] | Любые токены во входных данных, которые не удалось разрешить. Это может быть входные данные, которые не были распознаны как допустимая часть адреса. Например, для таких входных данных, как "Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US", неразрешенные токены могут выглядеть как |
АдресКомпонент
Представляет компонент адреса, например улицу, город или штат.
Поля | |
---|---|
component_name | Название этого компонента. |
component_type | Тип компонента адреса. См. Таблицу 2: Дополнительные типы, возвращаемые службой Places, для списка возможных типов. |
confirmation_level | Указывает на уровень уверенности в том, что компонент правильный. |
inferred | Указывает, что компонент не был частью входных данных, но мы вывели его для местоположения адреса и считаем, что его следует указать для полного адреса. |
spell_corrected | Указывает на исправление опечатки в имени компонента. API не всегда отмечает изменения с одного варианта написания на другой, например, при замене "centre" на "center". Он также не всегда отмечает распространенные опечатки, например, при замене "Amphitheatre Pkwy" на "Amphitheatre Pkwy". |
replaced | Указывает, что имя компонента было заменено на совершенно другое, например, неправильный почтовый индекс был заменен на тот, который является правильным для адреса. Это не косметическое изменение, входной компонент был изменен на другой. |
unexpected | Указывает на компонент адреса, который не ожидается в почтовом адресе для данного региона. Мы сохранили его только потому, что он был частью ввода. |
ПодтверждениеУровня
Различные возможные значения уровней подтверждения.
Перечисления | |
---|---|
CONFIRMATION_LEVEL_UNSPECIFIED | Значение по умолчанию. Это значение не используется. |
CONFIRMED | Нам удалось убедиться, что этот компонент существует и имеет смысл в контексте остальной части адреса. |
UNCONFIRMED_BUT_PLAUSIBLE | Этот компонент не может быть подтвержден, но вполне вероятно, что он существует. Например, номер улицы в известном допустимом диапазоне номеров на улице, где конкретные номера домов неизвестны. |
UNCONFIRMED_AND_SUSPICIOUS | Этот компонент не был подтвержден и, скорее всего, неверен. Например, район, который не подходит под остальную часть адреса. |
АдресМетаданные
Метаданные для постобработанного адреса. Не гарантируется, что metadata
будут полностью заполнены для каждого адреса, отправленного в API проверки адресов.
Поля | |
---|---|
business | Указывает, что это адрес компании. Если не установлено, указывает, что значение неизвестно. |
po_box | Указывает, что адрес почтового ящика. Если не установлено, указывает, что значение неизвестно. |
residential | Указывает, что это адрес проживания. Если не установлено, указывает, что значение неизвестно. |
ИмяКомпонента
Оболочка для имени компонента.
Поля | |
---|---|
text | Текст названия. Например, «5th Avenue» для названия улицы или «1253» для номера дома. |
language_code | Код языка BCP-47. Он не будет присутствовать, если имя компонента не связано с языком, например, номер дома. |
Геокодировать
Содержит информацию о месте, к которому был геокодирован ввод.
Поля | |
---|---|
location | Геокодированное местоположение входа. Использование идентификаторов мест предпочтительнее использования адресов, координат широты/долготы или плюс-кодов. Использование координат при маршрутизации или расчете направлений движения всегда приведет к привязке точки к дороге, ближайшей к этим координатам. Это может быть не та дорога, которая быстро или безопасно приведет к месту назначения, и она может не находиться рядом с точкой доступа к объекту недвижимости. Кроме того, когда местоположение подвергается обратному геокодированию, нет гарантии, что возвращенный адрес будет соответствовать исходному. |
plus_code | Плюс-код, соответствующий |
bounds | Границы геокодированного места. |
feature_size_meters | Размер геокодированного места в метрах. Это еще одна мера грубости геокодированного места, но в физическом размере, а не в семантическом значении. |
place_id | PlaceID места, к которому относится этот ввод. Более подробную информацию об идентификаторах мест можно найти здесь . |
place_types[] | Тип(ы) места, к которому геокодирован ввод. Например, |
Языковые опции
Предварительный просмотр: эта функция находится в режиме предварительного просмотра (pre-GA). Продукты и функции Pre-GA могут иметь ограниченную поддержку, а изменения в продуктах и функциях pre-GA могут быть несовместимы с другими версиями pre-GA. Предложения Pre-GA подпадают под действие специальных условий сервиса Google Maps Platform . Для получения дополнительной информации см. описания этапа запуска .
Позволяет API проверки адресов включать дополнительную информацию в ответ.
Поля | |
---|---|
return_english_latin_address | Предварительный просмотр: Возвращает |
PlusCode
Плюс-код ( http://plus.codes ) — это ссылка на местоположение в двух форматах: глобальный код, определяющий прямоугольник размером 14x14 м (1/8000 градуса) или меньше, и составной код, заменяющий префикс на ссылку на местоположение.
Поля | |
---|---|
global_code | Глобальный (полный) код места, например «9FWM33GV+HQ», представляющий область размером 1/8000 на 1/8000 градуса (~14 на 14 метров). |
compound_code | Составной код места, например «33GV+HQ, Ramberg, Norway», содержащий суффикс глобального кода и заменяющий префикс на отформатированное имя ссылочной сущности. |
ПредоставитьПроверкуОбратнойСвязиЗапрос
Запрос на отправку отзыва о проверке.
Поля | |
---|---|
conclusion | Обязательно. Результат последовательности попыток проверки. Если это поле установлено в |
response_id | Обязательно. Идентификатор ответа, для которого предназначен этот отзыв. Это должен быть [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 | Первая строка адреса. |
firm | Название фирмы. |
second_address_line | Вторая адресная строка. |
urbanization | Пуэрториканское название урбанизации. |
city_state_zip_address_line | Город + штат + почтовый индекс. |
city | Название города. |
state | Двухбуквенный код штата. |
zip_code | Почтовый индекс, например, 10009. |
zip_code_extension | Расширение почтового индекса из 4 цифр, например, 5023. |
UspsData
Данные USPS для адреса. Не гарантируется полное заполнение uspsData
для каждого адреса США или Пуэрто-Рико, отправленного в API проверки адресов. Рекомендуется интегрировать резервные поля адреса в ответ, если вы используете uspsData в качестве основной части ответа.
Поля | |
---|---|
standardized_address | Стандартизированный адрес USPS. |
delivery_point_code | 2-значный код пункта доставки |
delivery_point_check_digit | Контрольная цифра пункта доставки. Это число добавляется в конец delivery_point_barcode для механически сканируемой почты. Сложение всех цифр delivery_point_barcode, delivery_point_check_digit, почтового индекса и ZIP+4 вместе должно дать число, кратное 10. |
dpv_confirmation | Возможные значения для подтверждения DPV. Возвращает один символ или не возвращает никакого значения.
|
dpv_footnote | Сноски из проверки точки доставки. Несколько сносок могут быть связаны в одну строку.
|
dpv_cmra | Указывает, является ли адрес CMRA (Commercial Mail Receiving Agency) — частным предприятием, получающим почту для клиентов. Возвращает один символ.
|
dpv_vacant | Это место свободно? Возвращает один символ.
|
dpv_no_stat | Это адрес без статистики или активный адрес? Адреса без статистики — это те, которые не заняты постоянно, или адреса, которые USPS не обслуживает. Возвращает один символ.
|
dpv_no_stat_reason_code | Указывает тип NoStat. Возвращает код причины как int.
|
dpv_drop | Флаг указывает, что почта доставляется в один приёмник на сайте. Возвращает один символ.
|
dpv_throwback | Указывает, что почта не доставляется по указанному адресу. Возвращает один символ.
|
dpv_non_delivery_days | Флаг указывает, что доставка почты не выполняется каждый день недели. Возвращает один символ.
|
dpv_non_delivery_days_values | Целое число, идентифицирующее дни не доставки. Его можно запросить с помощью битовых флагов: 0x40 — воскресенье — день не доставки 0x20 — понедельник — день не доставки 0x10 — вторник — день не доставки 0x08 — среда — день не доставки 0x04 — четверг — день не доставки 0x02 — пятница — день не доставки 0x01 — суббота — день не доставки |
dpv_no_secure_location | Флаг указывает на то, что дверь доступна, но посылка не будет оставлена из соображений безопасности. Возвращает один символ.
|
dpv_pbsa | Указывает, что адрес был сопоставлен с записью PBSA. Возвращает один символ.
|
dpv_door_not_accessible | Флаг указывает адреса, где USPS не может постучать в дверь, чтобы доставить почту. Возвращает один символ.
|
dpv_enhanced_delivery_code | Указывает, что для адреса допустимо более одного кода возврата DPV. Возвращает один символ.
|
carrier_route | Код маршрута перевозчика. Четырехзначный код, состоящий из однобуквенного префикса и трехзначного обозначения маршрута. Префиксы:
|
carrier_route_indicator | Индикатор сортировки тарифов маршрута перевозчика. |
ews_no_match | Адрес доставки можно сопоставить, но файл EWS указывает, что точное совпадение будет доступно в ближайшее время. |
post_office_city | Главное почтовое отделение города. |
post_office_state | Главное почтовое отделение штата. |
abbreviated_city | Сокращенное название города. |
fips_county_code | Код округа FIPS. |
county | Название округа. |
elot_number | Номер расширенной линии проезда (eLOT). |
elot_flag | Флаг возрастания/убывания eLOT (A/D). |
lacs_link_return_code | Код возврата LACSLink. |
lacs_link_indicator | Индикатор LACSLink. |
po_box_only_postal_code | Только почтовый индекс почтового ящика. |
suitelink_footnote | Сноски из сопоставления записи улицы или высотного здания с информацией о номере. Если найдено совпадение названия компании, возвращается вторичный номер.
|
pmb_designator | Обозначение единицы PMB (частный почтовый ящик). |
pmb_number | Номер личного почтового ящика (PMB); |
address_record_type | Тип адресной записи, соответствующей входному адресу.
|
default_address | Индикатор того, что адрес по умолчанию найден, но существуют и более конкретные адреса. |
error_message | Сообщение об ошибке извлечения данных USPS. Оно заполняется, когда обработка USPS приостановлена из-за обнаружения искусственно созданных адресов. При наличии этой ошибки поля данных USPS могут не заполняться. |
cass_processed | Индикатор того, что запрос был обработан CASS. |
ValidateAddressRequest
Запрос на проверку адреса.
Поля | |
---|---|
address | Обязательно. Адрес проверяется. Неформатированные адреса следует отправлять через Общая длина полей в этом поле не должна превышать 280 символов. Поддерживаемые регионы можно найти здесь . Значение API проверки адресов игнорирует значения в |
previous_response_id | Это поле должно быть пустым для первого запроса на проверку адреса. Если для полной проверки одного адреса необходимо больше запросов (например, если изменения, внесенные пользователем после первоначальной проверки, требуют повторной проверки), то каждый последующий запрос должен заполнять это поле |
enable_usps_cass | Включает режим совместимости с USPS CASS. Это влияет только на поле Рекомендуется использовать компонентный |
language_options | Необязательно. Предварительный просмотр: эта функция находится в режиме предварительного просмотра (pre-GA). Продукты и функции Pre-GA могут иметь ограниченную поддержку, а изменения в продуктах и функциях pre-GA могут быть несовместимы с другими версиями pre-GA. Предложения Pre-GA подпадают под действие специальных условий сервиса Google Maps Platform . Для получения дополнительной информации см. описания этапа запуска . Позволяет API проверки адресов включать дополнительную информацию в ответ. |
session_token | Необязательно. Строка, которая идентифицирует сеанс автозаполнения для выставления счетов. Должна быть безопасной строкой base64 URL и имени файла длиной не более 36 символов ASCII. В противном случае возвращается ошибка INVALID_ARGUMENT. Сеанс начинается, когда пользователь делает запрос Autocomplete, и завершается, когда он выбирает место и вызывает Place Details или Address Validation. Каждый сеанс может иметь несколько запросов Autocomplete, за которыми следует один запрос Place Details или Address Validation. Учетные данные, используемые для каждого запроса в сеансе, должны принадлежать одному проекту Google Cloud Console. После завершения сеанса токен больше недействителен; ваше приложение должно генерировать новый токен для каждого сеанса. Если параметр Примечание: Проверка адреса может использоваться только в сеансах с API Autocomplete (New), а не API Autocomplete. Подробнее см. на странице https://developers.google.com/maps/documentation/places/web-service/session-pricing . |
ValidateAddressResponse
Ответ на запрос проверки адреса.
Поля | |
---|---|
result | Результат проверки адреса. |
response_id | UUID, который идентифицирует этот ответ. Если адрес необходимо повторно проверить, этот UUID должен сопровождать новый запрос. |
Результат проверки
Результат проверки адреса.
Поля | |
---|---|
verdict | Флаги общего вердикта |
address | Информация о самом адресе, а не о геокоде. |
geocode | Информация о местоположении и месте, к которому привязан адрес. |
metadata | Другая информация, имеющая отношение к доставляемости. Не гарантируется, что |
usps_data | Дополнительные флаги доставки, предоставляемые USPS. Предоставляются только в регионе |
english_latin_address | Предварительный просмотр: эта функция находится в режиме предварительного просмотра (pre-GA). Продукты и функции Pre-GA могут иметь ограниченную поддержку, а изменения в продуктах и функциях pre-GA могут быть несовместимы с другими версиями pre-GA. Предложения Pre-GA подпадают под действие специальных условий сервиса Google Maps Platform . Для получения дополнительной информации см. описания этапа запуска . Адрес переведен на английский язык. Переводимые адреса не могут быть повторно использованы в качестве ввода API. Сервис предоставляет их, чтобы пользователь мог использовать свой родной язык для подтверждения или отклонения проверки изначально предоставленного адреса. Если часть адреса не имеет перевода на английский язык, служба возвращает эту часть на альтернативном языке, использующем латинский алфавит. См. здесь объяснение того, как выбирается альтернативный язык. Если часть адреса не имеет переводов или транслитераций на языке, использующем латинский алфавит, служба возвращает эту часть на локальном языке, связанном с адресом. Включите этот вывод с помощью флага Примечание: поля |
Вердикт
Общий обзор результатов проверки адреса и геокодирования.
Поля | |
---|---|
input_granularity | Гранулярность входного адреса. Это результат разбора входного адреса, который не дает никаких сигналов проверки. Для сигналов проверки см. Например, если входной адрес включает в себя определенный номер квартиры, то |
validation_granularity | Уровень детализации для постобработанного адреса, который API может полностью проверить. Например, Результат проверки компонента адреса можно найти в |
geocode_granularity | Информация о детализации Иногда это может отличаться от |
address_complete | Постобработанный адрес считается полным, если нет неразрешенных токенов, неожиданных или отсутствующих компонентов адреса. Если не установлено, указывает, что значение равно |
has_unconfirmed_components | По крайней мере один компонент адреса не может быть категоризирован или проверен, подробности см. в |
has_inferred_components | По крайней мере один компонент адреса был выведен (добавлен), которого не было во входных данных, подробности см. в |
has_replaced_components | По крайней мере один компонент адреса был заменен, подробности см. в |
possible_next_action | Предварительный просмотр: эта функция находится в режиме предварительного просмотра (pre-GA). Продукты и функции Pre-GA могут иметь ограниченную поддержку, а изменения в продуктах и функциях pre-GA могут быть несовместимы с другими версиями pre-GA. Предложения Pre-GA подпадают под действие специальных условий сервиса Google Maps Platform . Для получения дополнительной информации см. описания этапа запуска . Предлагает интерпретационное резюме ответа API, призванное помочь в определении потенциального последующего действия. Это поле выводится из других полей в ответе API и не должно рассматриваться как гарантия точности адреса или доставляемости. Подробнее см. в разделе Build your validation logic . |
has_spell_corrected_components | По крайней мере один компонент адреса был исправлен на предмет орфографии, подробности см. |
Зернистость
Различные степени детализации, которые может иметь адрес или геокод. При использовании для указания степени детализации адреса эти значения указывают, с какой степенью детализации адрес идентифицирует почтовый пункт назначения. Например, такой адрес, как "123 Main Street, Redwood City, CA, 94061", идентифицирует PREMISE
, в то время как что-то вроде "Redwood City, CA, 94061" идентифицирует LOCALITY
. Однако, если мы не можем найти геокод для "123 Main Street" в Redwood City, возвращенный геокод может иметь степень детализации LOCALITY
, даже если адрес более детализирован.
Перечисления | |
---|---|
GRANULARITY_UNSPECIFIED | Значение по умолчанию. Это значение не используется. |
SUB_PREMISE | Результат ниже уровня здания, например, квартира. |
PREMISE | Результат на уровне здания. |
PREMISE_PROXIMITY | Геокод, который приблизительно соответствует местоположению адреса на уровне здания. |
BLOCK | Адрес или геокод указывает на блок. Используется только в регионах, где есть адресация на уровне блока, например, в Японии. |
ROUTE | Геокод или адрес детализирован для маршрута, например, улица, дорога или шоссе. |
OTHER | Все остальные уровни детализации объединены, поскольку они не подлежат доставке. |
ВозможныеСледующиеДействия
Предварительный просмотр: эта функция находится в режиме предварительного просмотра (pre-GA). Продукты и функции Pre-GA могут иметь ограниченную поддержку, а изменения в продуктах и функциях pre-GA могут быть несовместимы с другими версиями pre-GA. Предложения Pre-GA подпадают под действие специальных условий сервиса Google Maps Platform . Для получения дополнительной информации см. описания этапа запуска .
Возможные дальнейшие действия, которые могут быть предприняты на основе ответа API.
Перечисления | |
---|---|
POSSIBLE_NEXT_ACTION_UNSPECIFIED | Значение по умолчанию. Это значение не используется. |
FIX | Одно или несколько полей ответа API указывают на потенциальную проблему с постобработанным адресом, например verdict.validation_granularity — OTHER . Предложение клиенту отредактировать адрес может помочь улучшить качество адреса. |
CONFIRM_ADD_SUBPREMISES | Ответ API указывает, что в постобработанном адресе может отсутствовать подпредмет. Побуждение клиента просмотреть адрес и рассмотреть возможность добавления номера подразделения может помочь улучшить качество адреса. Постобработанный адрес может также иметь другие незначительные проблемы. Примечание: это значение перечисления может быть возвращено только для адресов в США. |
CONFIRM | Одно или несколько полей ответа API указывают на потенциальные незначительные проблемы с постобработанным адресом, например, компонент адреса postal_code был replaced . Побуждая клиента проверить адрес, можно улучшить его качество. |
ACCEPT | Ответ API не содержит сигналов, которые требуют одного из других значений PossibleNextAction. Вы можете рассмотреть возможность использования постобработанного адреса без дальнейшего запроса вашего клиента, хотя это не гарантирует, что адрес действителен, и адрес все еще может содержать исправления. Вы несете ответственность за то, чтобы определить, следует ли и как запрашивать вашего клиента, в зависимости от вашей собственной оценки риска. |