PostalAddress

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

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

Советы по вводу и изменению адреса:

  • Используйте виджет адреса, поддерживающий интернационализацию, например 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, которое соответствует последней версии.

Все новые версии должны быть обратно совместимы со старыми.

regionCode

string

Обязательно. Идентификатор CLDR для страны или региона, где находится адрес. Это значение не определяется автоматически, и пользователь должен убедиться, что оно указано правильно. Подробную информацию можно найти на страницах https://cldr.unicode.org/ и https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Пример: CH для Швейцарии.

languageCode

string

Необязательное поле. Код языка по стандарту BCP-47 для содержимого этого адреса (если известен). Часто это язык интерфейса формы ввода или один из языков, используемых в стране/регионе адреса, или их транслитерированные эквиваленты. Это может повлиять на форматирование в некоторых странах, но не критично для правильности данных и никогда не повлияет на проверку или другие операции, не связанные с форматированием.

Если это значение неизвестно, его следует опустить (а не указывать возможно неверное значение по умолчанию).

Примеры: zh-Hant, ja, ja-Latn, en.

postalCode

string

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

sortingCode

string

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

administrativeArea

string

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

locality

string

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

sublocality

string

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

addressLines[]

string

Неструктурированные строки адреса, описывающие его нижние уровни.

Поскольку значения в файле addressLines не содержат информации о типе и иногда могут содержать несколько значений в одном поле (например, "Austin, TX"), важно, чтобы порядок строк был понятным. Строки адреса должны быть расположены в порядке, принятом в стране или регионе, где находится адрес. В странах, где возможны разные варианты (например, в Японии), address_language используется для явного указания (например, "ja" для порядка от большего к меньшему и "ja-Latn" или "en" для порядка от меньшего к большему). Таким образом, наиболее конкретная строка адреса может быть выбрана на основе языка.

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

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

recipients[]

string

Необязательное поле. Получатель по адресу. В некоторых случаях это поле может содержать многострочную информацию. Например, в ней может быть указано, кому передать посылку.

organization

string

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