PostalAddress

Representa una dirección postal, como la dirección de entrega o de pagos. Con una dirección postal, un servicio de correos puede entregar artículos en un local, un apartado postal o lugares similares. Una dirección postal no está diseñada para modelar ubicaciones geográficas, como rutas, ciudades o montañas.

En el uso típico, se crearía una dirección a partir de la entrada del usuario o de la importación de datos existentes, según el tipo de proceso.

Asesoramiento para ingresar o editar direcciones:

  • Usa un widget de dirección listo para la internacionalización, como https://github.com/google/libaddressinput.
  • No se deben mostrar a los usuarios elementos de la IU para ingresar o editar campos fuera de los países en los que se usa ese campo.

Para obtener más orientación sobre cómo usar este esquema, consulta https://support.google.com/business/answer/6397478.

Representación JSON 
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Campos
revision

integer

Es la revisión del esquema de PostalAddress. Se debe configurar como 0, que es la última versión.

Todas las revisiones nuevas deben ser compatibles con las revisiones anteriores.
regionCode

string

Obligatorio Código de región de CLDR para el país o la región de la dirección. Nunca se infiere y depende del usuario garantizar que el valor sea correcto. Consulta https://cldr.unicode.org/ y https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html para obtener más detalles. Ejemplo: "CH" para Suiza.
languageCode

string

Opcional: Código de idioma BCP-47 de los contenidos de esta dirección (si se conoce). Suele ser el idioma de la IU del formulario de entrada o se espera que coincida con uno de los idiomas usados en la región o el país de la dirección, o sus transliteraciones equivalentes. Esto puede afectar el formato en ciertos países, pero no es fundamental para la precisión de los datos y nunca afectará una validación o alguna otra operación no relacionada con el formato.

Si este valor es desconocido, se debe omitir (en lugar de especificar una configuración predeterminada posiblemente incorrecta).

Ejemplos: "zh-Hant", "ja", "ja-Latn", "en".
postalCode

string

Opcional: Código postal de la dirección. No todos los países usan o requieren códigos postales, pero, en los que se usan, pueden activar validaciones adicionales con otras partes de la dirección (por ejemplo, la validación del estado o el código postal en Estados Unidos).
sortingCode

string

Opcional. Código de ordenamiento adicional específico para cada país. No se usa en la mayoría de las regiones. Cuando se usa, el valor es una cadena como "CEDEX", seguida opcionalmente por un número (por ejemplo, "CEDEX 7"), o solo un número, que representa el "código de sector" (Jamaica), el "indicador de área de entrega" (Malawi) o el "indicador de oficina de correos" (Costa de Marfil).
administrativeArea

string

Opcional. División administrativa más alta que se usa para las direcciones postales de un país o una región. Por ejemplo, puede ser un estado, una provincia, una óblast o una prefectura. En el caso de España, se refiere a la provincia y no a la comunidad autónoma (por ejemplo, "Barcelona" y no "Cataluña"). Muchos países no usan un área administrativa en las direcciones postales. Por ejemplo, en Suiza, este campo debe quedar vacío.
locality

string

Opcional. Por lo general, se refiere a la parte de la dirección que indica la ciudad. Ejemplos: ciudad de EE.UU., comuna de Italia o ciudad postal en el Reino Unido. En las regiones del mundo en las que las localidades no están bien definidas o no se ajustan bien a esta estructura, deja locality vacío y usa addressLines.
sublocality

string

Opcional. Sublocalidad de la dirección. Por ejemplo, puede ser un barrio, un distrito o una zona.
addressLines[]

string

Líneas de dirección no estructuradas que describen los niveles más bajos de una dirección.

Dado que los valores en addressLines no tienen información de tipo y, a veces, pueden contener varios valores en un solo campo (por ejemplo, "Austin, TX"), es importante que el orden de las líneas sea claro. El orden de las líneas de dirección debe ser el "orden de sobre" para el país o la región de la dirección. En los lugares donde esto puede variar (por ejemplo, Japón), se usa address_language para que sea explícito (por ejemplo, “ja” para el orden de grande a pequeño y “ja-Latn” o “en” para el orden de pequeño a grande). De esta manera, se puede seleccionar la línea más específica de una dirección según el idioma.

La representación estructural mínima permitida de una dirección consta de un regionCode con toda la información restante colocada en el addressLines. Sería posible dar un formato a una dirección así de manera muy aproximada sin codificación geográfica, pero no podría realizarse un análisis semántico de ningún componente de la dirección hasta que se resuelva, al menos, de manera parcial.

La forma recomendada de controlar las direcciones completamente no estructuradas (en lugar de adivinar qué partes de la dirección deben ser localidades o áreas administrativas) es crear una dirección que solo contenga regionCode y addressLines, y luego realizar la geocodificación.
recipients[]

string

Opcional. El destinatario en la dirección. Es posible que este campo contenga varias líneas de información en ciertas circunstancias. Por ejemplo, puede contener información sobre la entrega "por medio de".
organization

string

Opcional: El nombre de la organización de la dirección.