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.
fetchAddressValidation
fetchAddressValidation(request)
Parâmetros:
Valor de retorno:Promise<AddressValidation>
Valida um endereço. Consulte https://developers.google.com/maps/documentation/javascript/address-validation/validate-address.
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
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.
address
O endereço que está sendo validado. Os endereços não formatados devem ser enviados por PostalAddress.addressLines.
placeAutocompleteElement optional
Se você estiver usando um PlaceAutocompleteElement, inclua-o aqui para vincular as chamadas da API AddressValidation ao token de sessão do Autocomplete.
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.
sessionToken optional
Um token que identifica uma sessão do Autocomplete para fins de faturamento.
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.
components
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.
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.
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.
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.
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.
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.
BLOCK O endereço ou geocodificador 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 entregues.
PREMISE Resultado no nível do edifício.
PREMISE_PROXIMITY Um geocódigo que se aproxima do local no nível do edifício do endereço.
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 edifício, como um apartamento.

Constantes PossibleNextAction

Constantes de google.maps.addressValidation.PossibleNextAction

Oferece um resumo interpretativo da resposta da API, com o objetivo de ajudar a determinar uma possível ação subsequente a ser tomada. Esse campo é derivado de outros campos na resposta da API e não deve ser considerado uma garantia de precisão ou capacidade de entrega do endereço.

Acesse ligando para const {PossibleNextAction} = await google.maps.importLibrary("addressValidation").
Consulte Bibliotecas na API Maps JavaScript.
ACCEPT A resposta da API não contém indicadores que justifiquem um dos outros valores de "PossibleNextAction". Você pode usar o endereço pós-processado sem pedir mais informações ao cliente, mas isso não garante que o endereço seja válido, e ele ainda pode conter correções. É sua responsabilidade determinar se e como solicitar informações do cliente, dependendo da sua própria avaliação de risco.
CONFIRM Um ou mais campos da resposta da API indicam possíveis problemas leves com o endereço pós-processado. Por exemplo, o componente de endereço postal_code era replaced. Pedir ao cliente para revisar o endereço pode ajudar a melhorar a qualidade dele.
CONFIRM_ADD_SUBPREMISES A resposta da API indica que o endereço pós-processado pode estar sem um subconjunto de premissas. Pedir ao cliente para revisar o endereço e considerar adicionar um número de unidade pode ajudar a melhorar a qualidade dele. O endereço pós-processado também pode ter outros problemas menores. Observação: esse valor de enumeração só pode ser retornado para endereços dos EUA.
FIX Um ou mais campos da resposta da API indicam um possível problema com o endereço pós-processado. Por exemplo, o verdict.validation_granularity é OTHER. Pedir ao cliente para editar o endereço pode ajudar a melhorar a qualidade dele.

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.
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
Tipo:string optional
O nome da urbanização porto-riquenha.
zipCode
Tipo:string optional
O código postal, por exemplo, "10009".
zipCodeExtension
Tipo:string optional
A extensão de quatro dígitos do código postal, por exemplo, "5023".

Classe USPSData

Classe google.maps.addressValidation.USPSData

Os dados da USPS para o endereço. Não há garantia de que USPSData será totalmente preenchido para todos os endereços dos EUA ou de Porto Rico enviados à API Address Validation. Recomendamos integrar os campos de endereço de backup na resposta se você usar uspsData como a parte principal dela.

Acesse ligando para const {USPSData} = await google.maps.importLibrary("addressValidation").
Consulte Bibliotecas na API Maps JavaScript.
abbreviatedCity
Tipo:string optional
Cidade abreviada.
addressRecordType
Tipo:string optional
Tipo do registro de endereço que corresponde ao endereço de entrada.
carrierRoute
Tipo:string optional
O código do trajeto da transportadora. Um código de quatro caracteres que consiste em um prefixo de uma letra e um designador de rota de três dígitos.
carrierRouteIndicator
Tipo:string optional
Indicador de classificação da taxa de rota da transportadora.
cassProcessed
Tipo:boolean
Indicador de que a solicitação foi processada pelo CASS.
county
Tipo:string optional
Nome do condado.
deliveryPointCheckDigit
Tipo:string optional
O dígito de verificação do ponto de entrega. Esse número é adicionado ao final do delivery_point_barcode para correspondências digitalizadas mecanicamente. A soma de todos os dígitos de delivery_point_barcode, delivery_point_check_digit, código postal e CEP+4 precisa resultar em um número divisível por 10.
deliveryPointCode
Tipo:string optional
O código de dois dígitos do ponto de entrega.
dpvCMRA
Tipo:string optional
Indica se o endereço é uma CMRA (Commercial Mail Receiving Agency), uma empresa privada que recebe correspondências para clientes. Retorna um único caractere.
dpvConfirmation
Tipo:string optional
Os valores possíveis para confirmação de DPV. Retorna um único caractere ou nenhum valor.
dpvDoorNotAccessible
Tipo:string optional
A flag indica endereços em que o USPS não pode bater em uma porta para entregar correspondências. Retorna um único caractere.
dpvDrop
Tipo:string optional
A flag indica que a correspondência é entregue em um único receptáculo em um site. Retorna um único caractere.
dpvEnhancedDeliveryCode
Tipo:string optional
Indica que mais de um código de retorno da DPV é válido para o endereço. Retorna um único caractere.
dpvFootnote
Tipo:string optional
As notas de rodapé da validação do ponto de entrega. Várias notas de rodapé podem ser unidas na mesma string.
dpvNonDeliveryDays
Tipo:string optional
A flag indica que a entrega de correspondências não é feita todos os dias da semana. Retorna um único caractere.
dpvNonDeliveryDaysValues
Tipo:number optional
Número inteiro que identifica os dias de não exibição. Ele pode ser consultado usando flags de bits: 0x40 – domingo é um dia sem entrega 0x20 – segunda-feira é um dia sem entrega 0x10 – terça-feira é um dia sem entrega 0x08 – quarta-feira é um dia sem entrega 0x04 – quinta-feira é um dia sem entrega 0x02 – sexta-feira é um dia sem entrega 0x01 – sábado é um dia sem entrega
dpvNoSecureLocation
Tipo:string optional
A flag indica que a porta está acessível, mas o pacote não será deixado por questões de segurança. Retorna um único caractere.
dpvNoStat
Tipo:string optional
Indica se o endereço é um endereço sem estatísticas ou um endereço ativo. Não há endereços estatísticos que não sejam ocupados continuamente ou que não sejam atendidos pelo USPS. Retorna um único caractere.
dpvNoStatReasonCode
Tipo:number optional
Indica o tipo NoStat. Retorna um código de motivo como um número inteiro.
dpvPBSA
Tipo:string optional
Indica que o endereço foi correspondido a um registro de PBSA. Retorna um único caractere.
dpvThrowback
Tipo:string optional
Indica que o correio não é entregue no endereço da rua. Retorna um único caractere.
dpvVacant
Tipo:string optional
Indica se o endereço está vago. Retorna um único caractere.
elotFlag
Tipo:string optional
Flag de eLOT crescente/decrescente (A/D).
elotNumber
Tipo:string optional
Número da linha de viagem otimizada (eLOT).
errorMessage
Tipo:string optional
Mensagem de erro para recuperação de dados da USPS. Esse campo é preenchido quando o processamento do USPS é suspenso devido à detecção de endereços criados artificialmente.
fipsCountyCode
Tipo:string optional
Código FIPS do condado.
hasDefaultAddress
Tipo:boolean
Indicador de que um endereço padrão foi encontrado, mas existem endereços mais específicos.
hasNoEWSMatch
Tipo:boolean
O endereço de entrega é compatível, mas o arquivo EWS indica que uma correspondência exata estará disponível em breve.
lacsLinkIndicator
Tipo:string optional
Indicador do LACSLink.
lacsLinkReturnCode
Tipo:string optional
Código de retorno do LACSLink.
pmbDesignator
Tipo:string optional
Designador de unidade PMB (caixa postal particular).
pmbNumber
Tipo:string optional
Número da PMB (caixa postal particular).
poBoxOnlyPostalCode
Tipo:boolean
Código postal apenas para caixa postal.
postOfficeCity
Tipo:string optional
Cidade da agência principal dos correios.
postOfficeState
Tipo:string optional
Estado da agência principal dos correios.
standardizedAddress
Tipo:USPSAddress optional
Endereço padronizado da USPS.
suiteLinkFootnote
Tipo:string optional
Notas de rodapé da correspondência de um registro de rua ou prédio alto com informações de apartamento. Se uma correspondência for encontrada, o número secundário será retornado.

Classe Verdict

Classe google.maps.addressValidation.Verdict

Representa o endereço pós-processado do endereço fornecido.

Acesse ligando para const {Verdict} = await google.maps.importLibrary("addressValidation").
Consulte Bibliotecas na API Maps JavaScript.
addressComplete
Tipo:boolean
O endereço é considerado completo se não houver tokens não resolvidos nem componentes inesperados ou ausentes. Se não estiver definido, indica que o valor é false. Consulte os campos Address.missingComponentTypes, Address.unresolvedTokens ou AddressComponent.unexpected para mais detalhes.
geocodeGranularity
Tipo:Granularity optional
Informações sobre a granularidade do Geocode. Isso pode ser entendido como o significado semântico de quão aproximado ou preciso é o local geocodificado.
hasInferredComponents
Tipo:boolean
Pelo menos um componente de endereço foi inferido (ou seja, adicionado) que não estava na entrada. Consulte AddressComponent para mais detalhes.
hasReplacedComponents
Tipo:boolean optional
Pelo menos um componente de endereço foi substituído. Consulte AddressComponent para mais detalhes.
hasUnconfirmedComponents
Tipo:boolean
Não é possível categorizar ou validar pelo menos um componente de endereço. Consulte AddressComponent para mais detalhes.
inputGranularity
Tipo:Granularity optional
A granularidade do endereço input. Esse é o resultado da análise do endereço de entrada e não fornece indicadores de validação. Para ver indicadores de validação, consulte validationGranularity.
possibleNextAction
Tipo:PossibleNextAction optional
Uma possível próxima ação a ser realizada com base em outros campos na resposta da API. Consulte PossibleNextAction para ver detalhes.
validationGranularity
Tipo:Granularity optional
O nível de granularidade que a API pode validar totalmente. Por exemplo, um validationGranularity de PREMISE indica que todos os componentes de endereço no nível de PREMISE e mais amplos podem ser validados.