PostalAddress

Representa um endereço postal (por exemplo, endereços para pagamento ou envio postal). Com um endereço postal, o serviço de correios pode entregar itens em um local, caixa postal ou lugar semelhante. Não se destina a modelar locais geográficos (estradas, cidades, montanhas).

No uso normal, um endereço seria criado por entrada do usuário ou pela importação de dados, dependendo do tipo de processo.

Orientações sobre a inserção ou edição de endereços: – Use um widget de endereço preparado para internacionalização, como https://github.com/google/libaddressinput. – Os usuários não devem ver elementos da IU para inserção ou edição de campos fora dos países em que os campos são usados.

Para mais orientações sobre como usar este esquema, consulte: https://support.google.com/business/answer/6397478.

Representação 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

A revisão do esquema do PostalAddress. Precisa ser definido como 0, que é a revisão mais recente.

Todas as novas revisões precisam ser compatíveis com versões anteriores.
regionCode

string

Obrigatório. Código de região CLDR do país/região do endereço. Nunca é inferido e cabe ao usuário garantir que o valor esteja correto. Para detalhes, consulte https://cldr.unicode.org/ e https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Exemplo: "CH" para Suíça.
languageCode

string

Opcional. Código de idioma BCP-47 do conteúdo deste endereço (se conhecido). Costuma ser o idioma da IU do formulário de entrada ou espera-se que corresponda a um dos idiomas usados no país/região do endereço ou nos equivalentes transliterados dele. Pode afetar a formatação em determinados países, mas não é fundamental para a exatidão dos dados e nunca afetará a validação ou outras operações relacionadas à não formatação.

Se você não conhece o valor, omita-o (em vez de especificar um padrão possivelmente incorreto).

Exemplos: "zh-Hant", "ja", "ja-latn", "pt".
postalCode

string

Opcional. Código postal do endereço. Nem todos os países usam ou exigem códigos postais, mas, nos locais onde são usados, eles podem desencadear uma validação adicional com outras partes do endereço (por exemplo, validação de estado ou código postal nos EUA).
sortingCode

string

Opcional. Código de classificação adicional específico de país. Não é usado na maioria das regiões. Quando usado, o valor é uma string como "CEDEX", opcionalmente seguida por um número (por exemplo, "CEDEX 7") ou apenas um número, representando o "código do setor" (Jamaica), o "indicador de área de entrega" (Malawi) ou o "indicador de correio" (Costa do Marfim).
administrativeArea

string

Opcional. A maior subdivisão administrativa que é usada para endereços postais de um país ou uma região. Por exemplo, pode ser um estado, uma província, uma zona ou uma prefeitura. Na Espanha, é a província, e não a comunidade autônoma (por exemplo, "Barcelona", não "Catalunha"). Muitos países não usam área administrativa em endereços postais. Por exemplo, na Suíça, ela deve ficar em branco.
locality

string

Opcional. Geralmente se refere à parte do endereço relacionada à cidade/município. Exemplos: cidade nos EUA, comunidade na Itália, distrito postal no Reino Unido. Em regiões do mundo com localizações que não são bem definidas ou que não se encaixam bem nessa estrutura, deixe locality em branco e use addressLines.
sublocality

string

Opcional. Sublocalidade do endereço. Por exemplo, pode ser um bairro ou distrito.
addressLines[]

string

Linhas de endereço não estruturadas que descrevem os níveis mais baixos de um endereço.

Como os valores em addressLines não têm informações de tipo e podem conter diversos valores em um único campo (por exemplo, "Austin, TX"), é importante que a ordem da linha seja clara. Ela precisa estar em "ordem de envelope" para o país ou região do endereço. Em locais em que isso pode variar (por exemplo, Japão), address_language é usado para explicitar (por exemplo, "ja" para ordem do maior para o menor e "ja-Latn" ou "en" para ordem do menor para o maior). Desta forma, a linha mais específica de um endereço pode ser selecionada com base no idioma.

A representação estrutural mínima permitida de um endereço consiste em um regionCode com todas as informações restantes colocadas no addressLines. Seria possível formatar esse endereço sem geocodificação, mas nenhum raciocínio semântico poderia ser feito sobre qualquer um dos componentes do endereço até que ele fosse pelo menos parcialmente resolvido.

Criar um endereço que contenha apenas um regionCode e addressLines e depois geocodificar é a maneira recomendada de lidar com endereços não estruturados (em vez de adivinhar quais partes do endereço devem ser regiões ou áreas administrativas).
recipients[]

string

Opcional. O destinatário no endereço. Sob certas circunstâncias, este campo pode conter informações em várias linhas. Por exemplo, informações sobre cuidados.
organization

string

Opcional. O nome da organização no endereço.