Address Validation

Classe AddressValidation

google.maps.addressValidation.AddressValidation classe
biblioteca "addressValidation"

Classe estática para acessar as APIs AddressValidation.

const {AddressValidation} = await google.maps.importLibrary("addressValidation");

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 somente leitura	Tipo: Address optional Informações sobre o endereço em si, em vez do geocódigo.
geocode somente leitura	Tipo: Geocode optional Informações sobre o local e o lugar em que o endereço foi geocodificado.
metadata somente leitura	Tipo: AddressMetadata optional Outras informações relevantes para a entrega. Não há garantia de que o metadata será totalmente preenchido para todos os endereços enviados à API Address Validation.
responseId somente leitura	Tipo: string optional O UUID que identifica essa resposta. Se o endereço precisar ser revalidado, esse UUID precisa acompanhar a nova solicitação.
uspsData somente leitura	Tipo: USPSData optional Sinalizações extras de entrega fornecidas pelo USPS. Disponível apenas nas regiões US e PR.
verdict somente leitura	Tipo: Verdict optional Sinalizações de veredito geral

Métodos
Herdado: toJSON

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 precisam ser enviados por PostalAddress.addressLines.
placeAutocompleteElement opcional	Tipo: PlaceAutocompleteElement optional Se você estiver usando um PlaceAutocompleteElement, inclua-o aqui para vincular as chamadas de API da Address Validation ao token de sessão do preenchimento automático.
previousResponseId opcional	Tipo: string optional Esse campo não pode ser definido para a primeira solicitação de Address Validation. Se mais solicitações forem necessárias 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 opcional	Tipo: AutocompleteSessionToken optional Um token que identifica uma sessão do Autocomplete para fins de faturamento.
uspsCASSEnabled opcional	Tipo: boolean optional Ativa o modo compatível com o USPS CASS. Isso afeta apenas o campo AddressValidation.uspsData de AddressValidation. Observação: para solicitações com o USPS CASS ativado 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" (não diferencia maiúsculas de minúsculas) ou "PR".

Classe Address

google.maps.addressValidation.Address classe
biblioteca "addressValidation"

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.

const {Address} = await google.maps.importLibrary("addressValidation");

Propriedades
components somente leitura	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 somente leitura	Tipo: string optional O endereço pós-processado, formatado como um endereço de linha única de acordo com as regras de formatação de endereço da região em que o endereço está localizado.
missingComponentTypes somente leitura	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. Os 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". Confira a lista de tipos possíveis neste link.
postalAddress somente leitura	Tipo: PostalAddress optional O endereço pós-processado representado como um endereço postal.
unconfirmedComponentTypes somente leitura	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 para fins de conveniência: o conteúdo dele é equivalente a iterar pelo 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. Confira a lista de tipos possíveis neste link.
unresolvedTokens somente leitura	Tipo: Array<string> Todos os tokens na entrada que não puderam ser resolvidos. Pode ser uma entrada que não foi reconhecida como parte válida de um endereço. Por exemplo, em uma entrada como "123235253253 Main St, San Francisco, CA, 94105", os tokens não resolvidos podem ser ["123235253253"], já que não parece um número de rua válido.

Métodos
Herdado: toJSON

Classe AddressComponent

google.maps.addressValidation.AddressComponent classe
biblioteca "addressValidation"

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

const {AddressComponent} = await google.maps.importLibrary("addressValidation");

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

Classe AddressMetadata

google.maps.addressValidation.AddressMetadata classe
biblioteca "addressValidation"

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

const {AddressMetadata} = await google.maps.importLibrary("addressValidation");

Propriedades
business somente leitura	Tipo: boolean
poBox somente leitura	Tipo: boolean
residential somente leitura	Tipo: boolean

Métodos
Herdado: toJSON

Constantes ConfirmationLevel

google.maps.addressValidation.ConfirmationLevel biblioteca de constantes
"addressValidation"

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

Essas constantes também podem ser usadas como strings. No TypeScript, os literais de string são definidos pelo tipo ConfirmationLevelString.

const {ConfirmationLevel} = await google.maps.importLibrary("addressValidation");

Constantes
CONFIRMED
UNCONFIRMED_AND_SUSPICIOUS
UNCONFIRMED_BUT_PLAUSIBLE

Classe Geocode

google.maps.addressValidation.Geocode classe
biblioteca "addressValidation"

Contém informações sobre o lugar para onde a entrada foi geocodificada.

const {Geocode} = await google.maps.importLibrary("addressValidation");

Propriedades
bounds somente leitura	Tipo: LatLngBounds optional Os limites do lugar geocodificado.
featureSizeMeters somente leitura	Tipo: number optional O tamanho do lugar geocodificado, em metros. Essa é outra medida da imprecisão do local geocodificado, mas em tamanho físico, não em significado semântico.
location somente leitura	Tipo: LatLngAltitude optional O local geocodificado da entrada.
placeId somente leitura	Tipo: string optional O ID de lugar do lugar geocodificado. É preferível usar o Place em vez de endereços, coordenadas de latitude/longitude ou Plus Codes. O uso de coordenadas para roteamento ou cálculo de rotas de carro sempre resulta no ajuste do ponto à via mais próxima dessas coordenadas. Essa via pode não ser rápida ou segura para chegar ao destino 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 corresponderá ao original.
placeTypes somente leitura	Tipo: Array<string> 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 somente leitura	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 Place desse Geocode. Para ver todos os detalhes do lugar, faça uma chamada para place.fetchFields().
Herdado: toJSON

Constantes de granularidade

google.maps.addressValidation.Granularity biblioteca de constantes
"addressValidation"

As várias granularidades que um endereço ou uma geocodificação pode ter. Quando usados para indicar a granularidade de um endereço, esses valores indicam o nível de detalhamento 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á ter uma granularidade de LOCALITY, mesmo que o endereço seja mais granular.

Essas constantes também podem ser usadas como strings. No TypeScript, os literais de string são definidos pelo tipo GranularityString.

const {Granularity} = await google.maps.importLibrary("addressValidation");

Constantes
BLOCK	O endereço ou geocódigo indica um quarteirão. Usado apenas em regiões que têm endereçamento em nível de bloco, como o Japão.
OTHER	Todas as outras granularidades, que são agrupadas porque não podem ser exibidas.
PREMISE	Resultado no nível do edifício.
PREMISE_PROXIMITY	Um geocódigo que se aproxima do local do endereço no nível do edifício.
ROUTE	A geocodificação ou o endereço é granular para o trajeto, como uma rua, estrada ou rodovia.
SUB_PREMISE	Resultado abaixo do nível do edifício, como um apartamento.

Constantes PossibleNextAction

google.maps.addressValidation.PossibleNextAction biblioteca de constantes
"addressValidation"

Aviso: disponível apenas no canal v=beta.

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

Essas constantes também podem ser usadas como strings. No TypeScript, os literais de string são definidos pelo tipo PossibleNextActionString.

const {PossibleNextAction} = await google.maps.importLibrary("addressValidation");

Constantes
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 ao cliente, dependendo da sua própria avaliação de risco.
CONFIRM	Um ou mais campos da resposta da API indicam possíveis problemas menores com o endereço pós-processado. Por exemplo, o componente de endereço postal_code foi replaced. Pedir para o cliente 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 não ter um sublocal. Pedir ao cliente para revisar o endereço e considerar adicionar um número de unidade pode ajudar a melhorar a qualidade do endereço. O endereço pós-processado também pode ter outros problemas menores. Observação: esse valor de tipo enumerado 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

google.maps.addressValidation.USPSAddress classe
biblioteca "addressValidation"

Representação do USPS de um endereço dos EUA.

const {USPSAddress} = await google.maps.importLibrary("addressValidation");

Propriedades
city somente leitura	Tipo: string optional O nome da cidade.
cityStateZipAddressLine somente leitura	Tipo: string optional A linha de endereço que contém a cidade, o estado e o CEP.
firm somente leitura	Tipo: string optional O nome da empresa.
firstAddressLine somente leitura	Tipo: string optional A primeira linha do endereço.
secondAddressLine somente leitura	Tipo: string optional A segunda linha do endereço.
state somente leitura	Tipo: string optional O código de duas letras do estado.
urbanization somente leitura	Tipo: string optional O nome da urbanização porto-riquenha.
zipCode somente leitura	Tipo: string optional O código postal, por exemplo, "10009".
zipCodeExtension somente leitura	Tipo: string optional A extensão de quatro dígitos do código postal, por exemplo, "5023".

Métodos
Herdado: toJSON

Classe USPSData

google.maps.addressValidation.USPSData classe
biblioteca "addressValidation"

Os dados do USPS para o endereço. Não há garantia de que o 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 da resposta.

const {USPSData} = await google.maps.importLibrary("addressValidation");

Propriedades
abbreviatedCity somente leitura	Tipo: string optional Cidade abreviada.
addressRecordType somente leitura	Tipo: string optional Tipo do registro de endereço que corresponde ao endereço de entrada.
carrierRoute somente leitura	Tipo: string optional O código da rota 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 somente leitura	Tipo: string optional Indicador de classificação da taxa de rota da transportadora.
cassProcessed somente leitura	Tipo: boolean Indicador de que a solicitação foi processada pelo CASS.
county somente leitura	Tipo: string optional Nome do condado.
deliveryPointCheckDigit somente leitura	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 lidas mecanicamente. A soma de todos os dígitos de delivery_point_barcode, dígito de verificação do ponto de entrega, código postal e ZIP+4 precisa resultar em um número divisível por 10.
deliveryPointCode somente leitura	Tipo: string optional O código de ponto de entrega de dois dígitos.
dpvCMRA somente leitura	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 somente leitura	Tipo: string optional Os valores possíveis para a confirmação do DPV. Retorna um único caractere ou nenhum valor.
dpvDoorNotAccessible somente leitura	Tipo: string optional A sinalização indica endereços em que o USPS não pode bater na porta para entregar correspondências. Retorna um único caractere.
dpvDrop somente leitura	Tipo: string optional A sinalização indica que a correspondência é entregue em um único receptáculo em um local. Retorna um único caractere.
dpvEnhancedDeliveryCode somente leitura	Tipo: string optional Indica que mais de um código de retorno do DPV é válido para o endereço. Retorna um único caractere.
dpvFootnote somente leitura	Tipo: string optional As notas de rodapé da validação do ponto de entrega. Várias notas de rodapé podem ser agrupadas na mesma string.
dpvNonDeliveryDays somente leitura	Tipo: string optional A sinalização indica que a entrega de correspondência não é realizada todos os dias da semana. Retorna um único caractere.
dpvNonDeliveryDaysValues somente leitura	Tipo: number optional Número inteiro que identifica os dias sem entrega. Ele pode ser consultado usando sinalizações 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 somente leitura	Tipo: string optional A sinalização 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 somente leitura	Tipo: string optional Indica se o endereço é um endereço sem estatísticas ou um endereço ativo. Os endereços sem estatísticas são aqueles que não são ocupados continuamente ou que não são atendidos pelo USPS. Retorna um único caractere.
dpvNoStatReasonCode somente leitura	Tipo: number optional Indica o tipo NoStat. Retorna um código de motivo como int.
dpvPBSA somente leitura	Tipo: string optional Indica que o endereço correspondeu ao registro do PBSA. Retorna um único caractere.
dpvThrowback somente leitura	Tipo: string optional Indica que as correspondências não são entregues no endereço. Retorna um único caractere.
dpvVacant somente leitura	Tipo: string optional Indica se o endereço está vago. Retorna um único caractere.
elotFlag somente leitura	Tipo: string optional Sinalizador de eLOT ascendente/descendente (A/D).
elotNumber somente leitura	Tipo: string optional Número de linha de viagem aprimorada (eLOT, na sigla em inglês).
errorMessage somente leitura	Tipo: string optional Mensagem de erro para recuperação de dados do USPS. Isso é preenchido quando o processamento do USPS é suspenso devido à detecção de endereços criados artificialmente.
fipsCountyCode somente leitura	Tipo: string optional Código FIPS do condado.
hasDefaultAddress somente leitura	Tipo: boolean Indicador de que um endereço padrão foi encontrado, mas existem endereços mais específicos.
hasNoEWSMatch somente leitura	Tipo: boolean O endereço de entrega é correspondente, mas o arquivo EWS indica que uma correspondência exata estará disponível em breve.
lacsLinkIndicator somente leitura	Tipo: string optional Indicador LACSLink.
lacsLinkReturnCode somente leitura	Tipo: string optional Código de retorno do LACSLink.
pmbDesignator somente leitura	Tipo: string optional Designador de unidade de caixa postal particular (PMB, na sigla em inglês).
pmbNumber somente leitura	Tipo: string optional Número da caixa postal particular (PMB, na sigla em inglês).
poBoxOnlyPostalCode somente leitura	Tipo: boolean Código postal apenas para caixa postal.
postOfficeCity somente leitura	Tipo: string optional Cidade principal do distrito postal.
postOfficeState somente leitura	Tipo: string optional Estado da agência de correios principal.
standardizedAddress somente leitura	Tipo: USPSAddress optional Endereço padronizado do USPS.
suiteLinkFootnote somente leitura	Tipo: string optional Notas de rodapé da correspondência de um registro de rua ou de edifício com informações de apartamento. Se uma correspondência de nome de empresa for encontrada, o número secundário será retornado.

Métodos
Herdado: toJSON

Classe Verdict

google.maps.addressValidation.Verdict classe
biblioteca "addressValidation"

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

const {Verdict} = await google.maps.importLibrary("addressValidation");

Propriedades
addressComplete somente leitura	Tipo: boolean O endereço é considerado completo se não houver tokens não resolvidos nem componentes inesperados ou ausentes. Se não for definido, indica que o valor é false. Consulte os campos Address.missingComponentTypes, Address.unresolvedTokens ou AddressComponent.unexpected para mais detalhes.
geocodeGranularity somente leitura	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 somente leitura	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 somente leitura	Tipo: boolean optional Pelo menos um componente de endereço foi substituído. Consulte AddressComponent para mais detalhes.
hasUnconfirmedComponents somente leitura	Tipo: boolean Pelo menos um componente de endereço não pode ser categorizado ou validado. Consulte AddressComponent para mais detalhes.
inputGranularity somente leitura	Tipo: Granularity optional A granularidade do endereço de entrada. Esse é o resultado da análise do endereço de entrada e não fornece nenhum indicador de validação. Para indicadores de validação, consulte validationGranularity.
possibleNextAction somente leitura	Aviso: disponível apenas no canal v=beta. Tipo: PossibleNextAction optional Uma possível ação a ser realizada com base em outros campos na resposta da API. Consulte PossibleNextAction para ver detalhes.
validationGranularity somente leitura	Tipo: Granularity optional O nível de granularidade que a API pode validar totalmente o endereço. 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.