Esse recurso representa um local com informações geográficas completas.
Representação JSON | |
---|---|
{ "locationType": enum ( |
Campos | |
---|---|
locationType |
O tipo de local, que corresponde ao campo de linhas de endereço de |
postalAddress |
O endereço postal do local que inclui informações legíveis, como endereços para pagamento e distribuição postal. Com um endereço postal, um serviço postal pode entregar itens em um local, uma caixa postal ou outro local de entrega. |
latLng |
Um objeto que representa um par de latitude/longitude. |
radiusMiles |
Raio do local de trabalho, em milhas. Esse valor é derivado da caixa delimitadora de local em que um círculo com o raio especificado de |
LocationType
Um enum que representa o tipo de um local.
Enums | |
---|---|
LOCATION_TYPE_UNSPECIFIED |
Valor padrão caso o tipo não seja especificado. |
COUNTRY |
Um local no nível de país. |
ADMINISTRATIVE_AREA |
Um local no nível de estado ou equivalente. |
SUB_ADMINISTRATIVE_AREA |
Um local no nível de comarca ou equivalente. |
LOCALITY |
Um local no nível de cidade ou equivalente. |
POSTAL_CODE |
Um local no nível de código postal. |
SUB_LOCALITY |
Uma sublocalidade é uma subdivisão de uma localidade; por exemplo, bairro ou distrito de uma cidade. As sublocalidades geralmente são reconhecidas por uma autoridade política local. Por exemplo, Manhattan e Brooklyn são reconhecidos como bairros pela Cidade de Nova York e, portanto, são modelados como sublocalidades. |
SUB_LOCALITY_1 |
Um local no nível de distrito ou equivalente. |
SUB_LOCALITY_2 |
Um local no nível de distrito menor ou equivalente. |
NEIGHBORHOOD |
Um local no nível de bairro. |
STREET_ADDRESS |
Um local no nível de endereço. |
PostalAddress
Representa um endereço postal, por exemplo, para endereços para pagamento ou distribuição postal. Com um endereço postal, o serviço de correios pode entregar itens em um local, uma caixa postal ou outro local semelhante. Não se destina a modelar locais geográficos (estradas, cidades, montanhas).
No uso normal, um endereço seria criado por digitação do usuário ou pela importação de dados existentes, dependendo do tipo de processo.
Conselhos sobre entrada / edição de endereço: - Use um widget de endereço pronto para i18n, como https://github.com/google/libaddressinput. - Os usuários não devem ver elementos da UI para entrada ou edição de campos fora dos países onde esse campo é usado.
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 |
A revisão de esquema de Todas as novas revisões precisam ser compatíveis com versões anteriores. |
regionCode |
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 mais detalhes, acesse http://cldr.unicode.org/ e http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Exemplo: "CH" para a Suíça. |
languageCode |
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 |
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/CEP nos EUA). |
sortingCode |
Opcional. Código de classificação adicional específico de país. Não é usado na maioria das regiões. Nos locais em que é usado, o valor é uma string como “CEDEX”, que pode ser seguida por um número (por exemplo, “CEDEX 7”), ou apenas um número sozinho, representando o “código do setor” (Jamaica), o “indicador de área de entrega” (Malawi) ou o “indicador de agência de correio” (por exemplo, Costa do Marfim). |
administrativeArea |
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. Especificamente 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, isso deve ser deixado em branco. |
locality |
Opcional. Geralmente se refere à parte do endereço relativa a cidade/município. Exemplos: cidade nos EUA, comunidade na Itália, distrito postal no Reino Unido. Em regiões onde as localidades não são claramente definidas ou não se encaixam bem nessa estrutura, deixe a localidade em branco e use addressLines. |
sublocality |
Opcional. Sublocalidade do endereço. Por exemplo, pode ser bairro ou distrito. |
addressLines[] |
Linhas de endereço não estruturadas que descrevem os níveis mais detalhados 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” em 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 "pt" 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 em 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 apresente apenas um regionCode e addressLines e depois geocodificar é a maneira recomendada de lidar com endereços completamente não estruturados (em vez de adivinhar quais partes do endereço devem ser localidades ou áreas administrativas). |
recipients[] |
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 |
Opcional. O nome da organização no endereço. |
LatLng
Um objeto que representa um par de latitude/longitude. Ele é expresso como um par de valores duplos para representar graus de latitude e longitude. Salvo indicação em contrário, ele precisa estar em conformidade com o padrão WGS84. Os valores precisam estar dentro de intervalos normalizados.
Representação JSON | |
---|---|
{ "latitude": number, "longitude": number } |
Campos | |
---|---|
latitude |
A latitude em graus. Precisa estar no intervalo [-90,0, +90,0]. |
longitude |
A longitude em graus. Precisa estar no intervalo [-180,0, +180,0]. |