Индекс
-
AddressValidation
(интерфейс) -
Address
(сообщение) -
AddressComponent
(сообщение) -
AddressComponent.ConfirmationLevel
(перечисление) -
AddressMetadata
(сообщение) -
ComponentName
(сообщение) -
Geocode
(сообщение) -
LanguageOptions
(сообщение) -
PlusCode
(сообщение) -
ProvideValidationFeedbackRequest
(сообщение) -
ProvideValidationFeedbackRequest.ValidationConclusion
(перечисление) -
ProvideValidationFeedbackResponse
(сообщение) -
UspsAddress
(сообщение) -
UspsData
(сообщение) -
ValidateAddressRequest
(сообщение) -
ValidateAddressResponse
(сообщение) -
ValidationResult
(сообщение) -
Verdict
(сообщение) -
Verdict.Granularity
(перечисление)
Проверка адреса
Сервис проверки адресов.
Предоставление проверки, обратная связь |
---|
Обратная связь о результатах последовательности попыток проверки. Это должен быть последний вызов после последовательности вызовов проверки для одного и того же адреса, и его следует вызывать после завершения транзакции. Его следует отправлять только один раз для последовательности запросов |
Проверить адрес |
---|
Проверяет адрес. |
Адрес
Подробности постобработанного адреса. Постобработка включает в себя исправление частей адреса с ошибками, замену неправильных частей и определение недостающих частей.
Поля | |
---|---|
formatted_ address | Адрес после постобработки, отформатированный как однострочный адрес в соответствии с правилами форматирования адреса региона, в котором расположен адрес. Примечание. Формат этого адреса может не совпадать с форматом адреса в поле |
postal_ address | Адрес после обработки, представленный как почтовый адрес. |
address_ components[] | Неупорядоченный список. Отдельные компоненты адреса отформатированного и исправленного адреса, а также информация проверки. Это предоставляет информацию о статусе проверки отдельных компонентов. Компоненты адреса не упорядочены определенным образом. Не делайте никаких предположений относительно порядка компонентов адреса в списке. |
missing_ component_ types[] | Типы компонентов, которые должны были присутствовать в правильно отформатированном почтовом адресе, но не были найдены во входных данных И не могли быть определены. Компоненты этого типа отсутствуют в |
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 не всегда отмечает изменения одного варианта написания на другой, например, при изменении «центра» на «центр». Он также не всегда отмечает распространенные орфографические ошибки, например, при замене «Амфитеатр Пкви» на «Амфитеатр Пкви». |
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[] | Тип(ы) места, к которому геокодированы входные данные. Например, |
Языковые параметры
Предварительная версия. Эта функция находится в предварительной версии (до GA). Продукты и функции Pre-GA могут иметь ограниченную поддержку, а изменения в продуктах и функциях Pre-GA могут быть несовместимы с другими версиями Pre-GA. На предложения Pre-GA распространяются Особые условия обслуживания платформы Google Maps . Дополнительную информацию см. в описании этапов запуска .
Позволяет API проверки адреса включать дополнительную информацию в ответ.
Поля | |
---|---|
return_ english_ latin_ address | Предварительная версия: возврат адреса |
ПлюсКод
Плюс-код ( http://plus.codes ) — это ссылка на местоположение в двух форматах: глобальный код, определяющий прямоугольник размером 14 x 14 м (1/8000 градуса) или меньше, и составной код, заменяющий префикс на ссылку на местоположение.
Поля | |
---|---|
global_ code | Глобальный (полный) код места, например «9FWM33GV+HQ», представляющий площадь 1/8000 на 1/8000 градусов (~ 14 на 14 метров). |
compound_ code | Составной код места, например «33GV+HQ, Рамберг, Норвегия», содержащий суффикс глобального кода и заменяющий префикс форматированным именем ссылочного объекта. |
Предоставление проверки обратной связи
Запрос на отправку отзыва о проверке.
Поля | |
---|---|
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
не может быть полностью заполнена для каждого адреса в США или PR, отправленного в 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 (Коммерческое агентство по приему почты) — частной компанией, получающей почту для клиентов. Возвращает один символ.
|
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 | Код страны ФИПС. |
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 | Необязательный. Предварительная версия. Эта функция находится в предварительной версии (до GA). Продукты и функции Pre-GA могут иметь ограниченную поддержку, а изменения в продуктах и функциях Pre-GA могут быть несовместимы с другими версиями Pre-GA. На предложения Pre-GA распространяются Особые условия обслуживания платформы Google Maps . Дополнительную информацию см. в описании этапов запуска . Позволяет API проверки адреса включать дополнительную информацию в ответ. |
session_ token | Необязательный. Строка, которая идентифицирует сеанс автозаполнения для целей выставления счетов. Должна быть строкой в формате Base64, безопасной для URL и имени файла, длиной не более 36 символов ASCII. В противном случае возвращается ошибка INVALID_ARGUMENT. Сеанс начинается, когда пользователь выполняет запрос автозаполнения, и завершается, когда он выбирает место и вызывает функцию «Подробности о месте» или «Проверка адреса». В каждом сеансе может быть несколько запросов автозаполнения, за которыми следует один запрос сведений о месте или проверки адреса. Учетные данные, используемые для каждого запроса в рамках сеанса, должны принадлежать одному и тому же проекту Google Cloud Console. После завершения сеанса токен больше не действителен; ваше приложение должно генерировать новый токен для каждого сеанса. Если параметр Примечание. Проверка адреса может использоваться только в сеансах с API автозаполнения (нового), а не с API автозаполнения. Дополнительную информацию см. на странице 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 | Предварительная версия. Эта функция находится в предварительной версии (до GA). Продукты и функции Pre-GA могут иметь ограниченную поддержку, а изменения в продуктах и функциях Pre-GA могут быть несовместимы с другими версиями Pre-GA. На предложения Pre-GA распространяются Особые условия обслуживания платформы Google Maps . Дополнительную информацию см. в описании этапов запуска . Адрес переведен на английский. Переведенные адреса нельзя повторно использовать в качестве входных данных API. Служба предоставляет их, чтобы пользователь мог использовать свой родной язык для подтверждения или отклонения проверки первоначально предоставленного адреса. Если часть адреса не имеет перевода на английский язык, служба возвращает эту часть на альтернативном языке, использующем латиницу. См. здесь объяснение того, как выбирается альтернативный язык. Если часть адреса не имеет перевода или транслитерации на языке, использующем латиницу, служба возвращает эту часть на местном языке, связанном с адресом. Включите этот вывод, используя флаг Примечание. Поле |
Вердикт
Общий обзор результатов проверки адреса и геокодирования.
Поля | |
---|---|
input_ granularity | Детализация входного адреса. Это результат анализа входного адреса, который не дает никаких сигналов проверки. Сигналы проверки см. в разделе Например, если входной адрес включает конкретный номер квартиры, то |
validation_ granularity | Уровень детализации, на котором API может полностью проверить адрес. Например, уровень Результат проверки компонента адреса можно найти в |
geocode_ granularity | Информация о детализации Иногда это может отличаться от приведенного выше |
address_ complete | Адрес считается полным, если нет неразрешенных токенов, неожиданных или отсутствующих компонентов адреса. Если значение не установлено, это указывает на то, что значение равно |
has_ unconfirmed_ components | По крайней мере один компонент адреса не может быть классифицирован или проверен. Подробности см. в |
has_ inferred_ components | Был выведен (добавлен) по крайней мере один компонент адреса, которого не было во входных данных. Подробности см. в |
has_ replaced_ 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 | Все остальные детали, которые объединены в группы, поскольку они не могут быть доставлены. |