Package google.maps.addressvalidation.v1

string

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

Примечание: формат этого адреса может не совпадать с форматом адреса в поле postal_address . Например, postal_address всегда представляет страну как 2-буквенный region_code , например "US" или "NZ". Напротив, это поле использует более длинную форму названия страны, например "USA" или "New Zealand".

PostalAddress

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

AddressComponent

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

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

string

Типы компонентов, которые должны были присутствовать в правильно отформатированном почтовом адресе, но не были найдены во входных данных И не могли быть выведены. Примером может быть ['street_number', 'route'] для входных данных типа "Boulder, Colorado, 80301, USA". Список возможных типов можно найти здесь .

Примечание: вы можете увидеть отсутствующий тип компонента, когда думаете, что уже предоставили отсутствующий компонент. Например, это может произойти, когда входной адрес содержит название здания, но не номер помещения. В адресе "渋谷区渋谷３丁目 Shibuya Stream" название здания "Shibuya Stream" имеет тип компонента premise , но номер помещения отсутствует, поэтому missing_component_types будет содержать premise .

string

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

string

Любые токены во входных данных, которые не удалось разрешить. Это может быть входные данные, которые не были распознаны как допустимая часть адреса. Например, для таких входных данных, как "Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US", неразрешенные токены могут выглядеть как ["Parcel", "0000123123", "&", "0000456456"] .

ComponentName

Название этого компонента.

string

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

ConfirmationLevel

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

bool

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

bool

Указывает на исправление опечатки в имени компонента. API не всегда отмечает изменения с одного варианта написания на другой, например, при замене "centre" на "center". Он также не всегда отмечает распространенные опечатки, например, при замене "Amphitheatre Pkwy" на "Amphitheatre Pkwy".

bool

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

bool

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

bool

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

bool

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

bool

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

string

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

string

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

LatLng

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

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

PlusCode

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

Viewport

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

float

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

string

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

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

string

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

bool

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

string

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

string

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

ValidationConclusion

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

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

string

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

string

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

string

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

string

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

string

Пуэрториканское название урбанизации.

string

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

string

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

string

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

string

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

string

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

UspsAddress

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

string

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

string

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

string

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

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

string

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

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

string

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

• Y : Адрес — CMRA
• N : Адрес не является CMRA

string

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

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

string

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

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

int32

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

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

string

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

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

string

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

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

string

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

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

int32

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

string

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

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

string

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

• Y : Адрес сопоставлен с записью PBSA.
• N : Адрес не сопоставлен с записью PBSA.

string

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

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

string

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

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

string

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

Префиксы:

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

string

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

bool

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

string

Главное почтовое отделение города.

string

Главное почтовое отделение штата.

string

Сокращенное название города.

string

Код округа FIPS.

string

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

string

Номер расширенной линии проезда (eLOT).

string

Флаг возрастания/убывания eLOT (A/D).

string

Код возврата LACSLink.

string

Индикатор LACSLink.

bool

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

string

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

• A : Запись SuiteLink совпадает, адрес компании улучшен.
• 00 : Совпадений нет, адрес компании не улучшен.

string

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

string

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

string

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

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

bool

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

string

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

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

bool

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

PostalAddress

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

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

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

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

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

string

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

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 Rico» (без учета регистра) или «PR».

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

LanguageOptions

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

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

string

Необязательно. Строка, которая идентифицирует сеанс автозаполнения для выставления счетов. Должна быть безопасной строкой base64 URL и имени файла длиной не более 36 символов ASCII. В противном случае возвращается ошибка INVALID_ARGUMENT.

Сеанс начинается, когда пользователь делает запрос Autocomplete, и завершается, когда он выбирает место и вызывает Place Details или Address Validation. Каждый сеанс может иметь несколько запросов Autocomplete, за которыми следует один запрос Place Details или Address Validation. Учетные данные, используемые для каждого запроса в сеансе, должны принадлежать одному проекту Google Cloud Console. После завершения сеанса токен больше недействителен; ваше приложение должно генерировать новый токен для каждого сеанса. Если параметр sessionToken пропущен или если вы повторно используете токен сеанса, сеанс тарифицируется так, как если бы токен сеанса не был предоставлен (каждый запрос тарифицируется отдельно).

Примечание: Проверка адреса может использоваться только в сеансах с API Autocomplete (New), а не API Autocomplete. Подробнее см. на странице https://developers.google.com/maps/documentation/places/web-service/session-pricing .

ValidationResult

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

string

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

Verdict

Флаги общего вердикта

Address

Информация о самом адресе, а не о геокоде.

Geocode

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

AddressMetadata

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

UspsData

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

Address

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

Адрес переведен на английский язык.

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

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

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

Granularity

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

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

Granularity

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

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

Granularity

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

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

bool

Постобработанный адрес считается полным, если нет неразрешенных токенов, неожиданных или отсутствующих компонентов адреса. Если не установлено, указывает, что значение равно false . Подробнее см. missing_component_types , unresolved_tokens или unexpected fields.

bool

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

bool

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

bool

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

PossibleNextAction

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

Предлагает интерпретационное резюме ответа API, призванное помочь в определении потенциального последующего действия. Это поле выводится из других полей в ответе API и не должно рассматриваться как гарантия точности адреса или доставляемости. Подробнее см. в разделе Build your validation logic .

bool

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