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

Отправьте запрос на проверку адреса, отправив запрос POST на одну из следующих конечных точек:

• валидироватьадрес (REST)
• Валидатеадрес (gRPC)

Ваш запрос также должен передавать тело запроса JSON в запрос, который определяет адрес для проверки. Следующий текст запроса содержит одно поле и три подполя:

curl -X POST -d '{
  "address": {
    "regionCode": "US",
    "locality": "Mountain View",
    "addressLines": ["1600 Amphitheatre Pkwy"]
  }
}' \
-H 'Content-Type: application/json' \
"https://addressvalidation.googleapis.com/v1:validateAddress?key=API_KEY"

Вы также можете опустить locality и указать ее как элемент массива addressLines :

{
  "address": {
    "regionCode": "US",
    "addressLines": ["1600 Amphitheatre Pkwy", "Mountain View, CA, 94043"]
  },
}

Обозреватель API позволяет вам делать запросы в реальном времени, чтобы вы могли ознакомиться с API и опциями API:

Поля запроса адреса

Тело запроса состоит из одного поля:

• address — поле типа PostalAddress , которое должно содержать хотя бы одну запись в addressLines .

При отправке поля address в API проверки адреса вам нужно указать только одно поле: addressLines . Однако самый простой запрос адреса должен содержать следующие подполя:

• regionCode — рекомендуется. Это необязательное поле, но если оно опущено, API проверки адреса определяет регион по адресу. Однако для достижения наилучших результатов укажите regionCode , если вы его знаете. Список поддерживаемых регионов см. в разделе «Поддерживаемые регионы» .
• addressLines — Обязательные. Массив с адресами, описывающий нижнюю структуру адреса.

Опция USPS CASS™

Почтовая служба США® (USPS®) ¹ поддерживает Систему поддержки точности кодирования (CASS™) для поддержки и сертификации поставщиков проверки адресов.

Только для регионов США и PR вы можете включить обработку CASS, задав для параметра enableUspsCass значение true в теле запроса. Для достижения наилучших результатов при использовании CASS укажите адрес, включающий улицу и номер улицы, а также город, штат и почтовый индекс:

{
  "address": {
    "regionCode": "US",
    "locality": "Mountain View",
    "administrativeArea": "CA",
    "postalCode": "94043",
    "addressLines": ["1600 Amphitheatre Pkwy"]
  },
  "enableUspsCass": true
}

Попробуйте!

Обозреватель API позволяет вам создавать образцы запросов, чтобы вы могли ознакомиться с API и опциями API.

1. Выберите значок API API в правой части страницы.

2. При желании отредактируйте параметры запроса.

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

4. На панели «Обозреватель API» выберите полноэкранный значок, чтобы развернуть окно Обозревателя API.