Address Validation (beta)

Classe AddressValidation

Classe google.maps.addressValidation.AddressValidation

Classe estática para acessar as APIs AddressValidation.

Acesse ligando para const {AddressValidation} = await google.maps.importLibrary("addressValidation").
Consulte Bibliotecas na API Maps JavaScript.

Métodos estáticos
fetchAddressValidation	fetchAddressValidation(request) Parâmetros: request:  AddressValidationRequest Valor de retorno:Promise<AddressValidation> Valida um endereço. Consulte https://developers.google.com/maps/documentation/javascript/address-validation/validate-address.

Propriedades
address	Tipo:Address optional Informações sobre o endereço em si, e não o geocódigo.
geocode	Tipo:Geocode optional Informações sobre o local e o lugar para onde o endereço foi geocodificado.
metadata	Tipo:AddressMetadata optional Outras informações relevantes para a capacidade de entrega. Não há garantia de que metadata será totalmente preenchido para todos os endereços enviados à API Address Validation.
responseId	Tipo:string optional O UUID que identifica esta resposta. Se o endereço precisar ser revalidado, esse UUID deverá acompanhar a nova solicitação.
uspsData	Tipo:USPSData optional Sinalizações extras de capacidade de entrega fornecidas pelo USPS. Disponível apenas nas regiões US e PR.
verdict	Tipo:Verdict optional Flags de veredito geral

Métodos
toJSON	toJSON() Parâmetros:nenhum Valor de retorno:Object Converte a classe AddressValidation em um objeto JSON com as mesmas propriedades.

Interface AddressValidationRequest

Interface google.maps.addressValidation.AddressValidationRequest

Interface de solicitação para AddressValidation.fetchAddressValidation.

Propriedades
address	Tipo:PostalAddressLiteral O endereço que está sendo validado. Os endereços não formatados devem ser enviados por PostalAddress.addressLines.
previousResponseId optional	Tipo:string optional Este campo não pode ser definido para a primeira solicitação de validação de endereço. Se forem necessárias mais solicitações para validar totalmente um único endereço (por exemplo, se as mudanças feitas pelo usuário após a validação inicial precisarem ser revalidadas), cada solicitação de acompanhamento precisará preencher esse campo com o AddressValidation.responseId da primeira resposta na sequência de validação.
uspsCASSEnabled optional	Tipo:boolean optional Ativa o modo compatível com o CASS do USPS. Isso afeta apenas o campo AddressValidation.uspsData de AddressValidation. Observação: para solicitações ativadas pelo CASS dos EUA para endereços em Porto Rico, um PostalAddress.regionCode do address precisa ser fornecido como "PR", ou um PostalAddress.administrativeArea do address precisa ser fornecido como "Puerto Rico" (sem diferenciação entre maiúsculas e minúsculas) ou "PR".

Classe Address

Classe google.maps.addressValidation.Address

Detalhes do endereço pós-processado. O pós-processamento inclui corrigir partes do endereço com erros de ortografia, substituir partes incorretas e inferir partes ausentes.

Acesse ligando para const {Address} = await google.maps.importLibrary("addressValidation").
Consulte Bibliotecas na API Maps JavaScript.

Propriedades
components	Tipo:Array<AddressComponent> Os componentes individuais do endereço formatado e corrigido, além das informações de validação. Isso fornece informações sobre o status de validação dos componentes individuais.
formattedAddress	Tipo:string optional O endereço pós-processado, formatado como uma única linha de acordo com as regras de formatação da região em que ele está localizado.
missingComponentTypes	Tipo:Array<string> Os tipos de componentes que deveriam estar presentes em um endereço de correspondência formatado corretamente, mas não foram encontrados na entrada E não puderam ser inferidos. Componentes desse tipo não estão presentes em formatted_address, postal_address ou address_components. Por exemplo, ['street_number', 'route'] para uma entrada como "Boulder, Colorado, 80301, EUA". A lista de tipos possíveis pode ser encontrada aqui.
postalAddress	Tipo:PostalAddress optional O endereço pós-processado representado como um endereço postal.
unconfirmedComponentTypes	Tipo:Array<string> Os tipos de componentes que estão presentes no address_components, mas não foi possível confirmar se estão corretos. Esse campo é fornecido por conveniência: o conteúdo dele é equivalente a iterar o address_components para encontrar os tipos de todos os componentes em que o AddressComponent.confirmationLevel não é ConfirmationLevel.CONFIRMED ou a flag AddressComponent.inferred não está definida como true. A lista de tipos possíveis pode ser encontrada aqui.
unresolvedTokens	Tipo:Array<string> Todos os tokens na entrada que não puderam ser resolvidos. Isso pode ser uma entrada que não foi reconhecida como uma parte válida de um endereço. Por exemplo, em uma entrada como "123235253253 Main St, São Francisco, CA, 94105", os tokens não resolvidos podem aparecer como ["123235253253"], já que não parece um número de rua válido.

Classe AddressComponent

Classe google.maps.addressValidation.AddressComponent

Representa um único componente de um endereço (por exemplo, nome da rua, cidade).

Acesse ligando para const {AddressComponent} = await google.maps.importLibrary("addressValidation").
Consulte Bibliotecas na API Maps JavaScript.

Propriedades
componentName	Tipo:string optional O texto do nome do componente. Por exemplo, "Avenida Paulista" para um nome de rua ou "1253" para um número de rua.
componentNameLanguageCode	Tipo:string optional O código de idioma BCP-47. Isso não vai aparecer se o nome do componente não estiver associado a um idioma, como um número de rua.
componentType	Tipo:string optional O tipo do componente de endereço. Consulte Tabela 2: outros tipos retornados pelo serviço Places para ver uma lista de tipos possíveis.
confirmationLevel	Tipo:ConfirmationLevel optional Indica o nível de certeza de que o componente está correto.
inferred	Tipo:boolean Se for "true", esse componente não fazia parte da entrada, mas foi inferido para a localização do endereço. Recomendamos incluir esse componente para um endereço completo.
replaced	Tipo:boolean Indica que o nome do componente foi substituído por um completamente diferente. Por exemplo, substituir um CEP errado por um correto para o endereço. Essa não é uma mudança estética. O componente de entrada foi alterado para outro.
spellCorrected	Tipo:boolean Indica uma correção em um erro de ortografia no nome do componente. A API nem sempre sinaliza mudanças de uma variante ortográfica para outra, como "centre" para "center".
unexpected	Tipo:boolean Se for "true", não é esperado que esse componente esteja presente em um endereço postal da região especificada. Ele foi mantido apenas porque fazia parte da entrada.

Classe AddressMetadata

Classe google.maps.addressValidation.AddressMetadata

Os metadados do endereço. Não há garantia de que AddressMetadata será totalmente preenchido para todos os endereços enviados à API Address Validation.

Acesse ligando para const {AddressMetadata} = await google.maps.importLibrary("addressValidation").
Consulte Bibliotecas na API Maps JavaScript.

Propriedades
business	Tipo:boolean
poBox	Tipo:boolean
residential	Tipo:boolean

Constantes ConfirmationLevel

Constantes de google.maps.addressValidation.ConfirmationLevel

Os diferentes valores possíveis que indicam o nível de certeza de que o componente está correto.

Acesse ligando para const {ConfirmationLevel} = await google.maps.importLibrary("addressValidation").
Consulte Bibliotecas na API Maps JavaScript.

Constantes
CONFIRMED
UNCONFIRMED_AND_SUSPICIOUS
UNCONFIRMED_BUT_PLAUSIBLE

Classe Geocode

Classe google.maps.addressValidation.Geocode

Contém informações sobre o lugar em que a entrada foi geocodificada.

Acesse ligando para const {Geocode} = await google.maps.importLibrary("addressValidation").
Consulte Bibliotecas na API Maps JavaScript.

Propriedades
bounds	Tipo:LatLngBounds optional Os limites do lugar geocodificado.
featureSizeMeters	Tipo:number optional O tamanho do lugar geocodificado, em metros. Essa é outra medida da imprecisão do local geocodificado, mas em tamanho físico em vez de significado semântico.
location	Tipo:LatLngAltitude optional O local geocodificado da entrada.
placeId	Tipo:string optional O ID do lugar geocodificado. É melhor usar o Place do que endereços, coordenadas de latitude/longitude ou plus codes. Usar coordenadas para roteamento ou calcular rotas de carro sempre resulta no ponto sendo ajustado à via mais próxima dessas coordenadas. Essa pode não ser uma via que leve ao destino de forma rápida ou segura e pode não estar perto de um ponto de acesso à propriedade. Além disso, quando um local é geocodificado de forma reversa, não há garantia de que o endereço retornado corresponda ao original.
placeTypes	Tipo:Array<string> O tipo ou os tipos de lugar que a entrada geocodificou. Por exemplo, ['locality', 'political']. A lista completa de tipos pode ser encontrada na documentação da API Geocoding.
plusCode	Tipo:PlusCode optional O Plus Code correspondente ao location.

Métodos
fetchPlace	fetchPlace() Parâmetros:nenhum Valor de retorno:nenhum Retorna uma representação de lugar deste Geocode. Para receber todos os detalhes de um lugar, é necessário fazer uma chamada para place.fetchFields().

Constantes de granularidade

Constantes de google.maps.addressValidation.Granularity

As várias granularidades que um endereço ou um geocódigo podem ter. Quando usados para indicar granularidade de um endereço, esses valores indicam a granularidade com que o endereço identifica um destino de correspondência. Por exemplo, um endereço como "123 Main Street, Redwood City, CA, 94061" identifica um PREMISE, enquanto algo como "Redwood City, CA, 94061" identifica um LOCALITY. No entanto, se não for possível encontrar um geocódigo para "123 Main Street" em Redwood City, o geocódigo retornado poderá ser de granularidade LOCALITY, mesmo que o endereço seja mais granular.

Acesse ligando para const {Granularity} = await google.maps.importLibrary("addressValidation").
Consulte Bibliotecas na API Maps JavaScript.

Constantes
BLOCK	O endereço ou geocódigo indica um bloco. Usado apenas em regiões que têm endereçamento no nível do bloco, como o Japão.
OTHER	Todas as outras granularidades, que são agrupadas porque não podem ser veiculadas.
PREMISE	Resultado no nível do edifício.
PREMISE_PROXIMITY	Um geocódigo que se aproxima da localização do endereço no nível do edifício.
ROUTE	O geocódigo ou endereço é granular para a rota, como uma rua, via ou rodovia.
SUB_PREMISE	Resultado abaixo do nível do prédio, como um apartamento.

Classe USPSAddress

Classe google.maps.addressValidation.USPSAddress

Representação da USPS de um endereço nos EUA.

Acesse ligando para const {USPSAddress} = await google.maps.importLibrary("addressValidation").
Consulte Bibliotecas na API Maps JavaScript.

Propriedades
city	Tipo:string optional O nome da cidade.
cityStateZipAddressLine	Tipo:string optional A linha de endereço que contém a cidade, o estado e o CEP.
firm	Tipo:string optional O nome da empresa.
firstAddressLine	Tipo:string optional A primeira linha do endereço.
secondAddressLine	Tipo:string optional A segunda linha do endereço.
state	Tipo:string optional O código de duas letras do estado.
urbanization