Method: validateAddress

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

HTTP-запрос

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

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

Текст запроса

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

JSON-представление 
{
  "address": {
    object (PostalAddress)
  },
  "previousResponseId": string,
  "enableUspsCass": boolean,
  "languageOptions": {
    object (LanguageOptions)
  },
  "sessionToken": string
}
Поля
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 Rico» (без учета регистра) или «PR».

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

languageOptions

object ( LanguageOptions )

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

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

sessionToken

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 .

Тело ответа

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

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

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

languageCode

string

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

postalCode

string

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

sortingCode

string

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

administrativeArea

string

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

locality

string

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

sublocality

string

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

addressLines[]

string

Обязательно. Неструктурированные строки адреса, описывающие нижние уровни адреса.

Поскольку значения в addressLines не имеют информации о типе и иногда могут содержать несколько значений в одном поле (например, "Austin, TX"), важно, чтобы порядок строк был понятным. Порядок адресных строк должен быть "порядком конверта" для страны/региона адреса.

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

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

recipients[]

string

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

organization

string

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

Языковые опции

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

Позволяет 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 )

Предварительный просмотр: эта функция находится в режиме предварительного просмотра (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 в 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,
  "possibleNextAction": enum (PossibleNextAction),
  "hasSpellCorrectedComponents": 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

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

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 .

possibleNextAction

enum ( PossibleNextAction )

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

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

hasSpellCorrectedComponents

boolean

По крайней мере один компонент адреса был исправлен на предмет орфографии, подробности см. google.maps.addressvalidation.v1.Address.address_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 указывают на потенциальные незначительные проблемы с постобработанным адресом, например, компонент адреса postalCode был replaced . Побуждая клиента проверять адрес, можно улучшить его качество.
ACCEPT Ответ API не содержит сигналов, которые требуют одного из других значений PossibleNextAction. Вы можете рассмотреть возможность использования постобработанного адреса без дальнейшего запроса вашего клиента, хотя это не гарантирует, что адрес действителен, и адрес все еще может содержать исправления. Вы несете ответственность за то, чтобы определить, следует ли и как запрашивать вашего клиента, в зависимости от вашей собственной оценки риска.

Адрес

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

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

string

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

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

postalAddress

object ( PostalAddress )

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

addressComponents[]

object ( AddressComponent )

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

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

missingComponentTypes[]

string

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

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

unconfirmedComponentTypes[]

string

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

unresolvedTokens[]

string

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

АдресКомпонент

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

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 не всегда отмечает изменения с одного варианта написания на другой, например, при замене "centre" на "center". Он также не всегда отмечает распространенные опечатки, например, при замене "Amphitheatre Pkwy" на "Amphitheatre Pkwy".

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].

PlusCode

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

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

string

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

compoundCode

string

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

Видовой порт

Широта-долгота области просмотра, представленной как две диагонально противоположные 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 для каждого адреса США или Пуэрто-Рико, отправленного в 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 (Commercial Mail Receiving Agency) — частным предприятием, получающим почту для клиентов. Возвращает один символ.

  • 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 (колледж, военный и другие типы) - почтовый индекс + 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

Код округа FIPS.

county

string

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

elotNumber

string

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

elotFlag

string

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

poBoxOnlyPostalCode

boolean

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

pmbDesignator

string

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

pmbNumber

string

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

addressRecordType

string

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

  • F : FIRM. Это соответствие Firm Record, что является наивысшим уровнем соответствия, доступным для адреса.
  • 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

2 буквенного состояния код.

zipCode

string

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

zipCodeExtension

string

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