Method: validateAddress

{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}

integer

A revisão de esquema do PostalAddress. Qualquer valor diferente de 0 vai fazer com que a API retorne um erro INVALID_ARGUMENT.

string

Opcional. Código regional CLDR do país/região do endereço. Para mais detalhes, consulte https://cldr.unicode.org/ e https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html. Exemplo: "CH" para Suíça. Se o código da região não for fornecido, ele será inferido com base no endereço. Para ter o melhor desempenho, é recomendável incluir o código da região, se você souber. Ter regiões inconsistentes ou repetidas pode levar a um desempenho ruim. Por exemplo, se addressLines já incluir a região, não informe o código da região novamente neste campo. As regiões compatíveis podem ser encontradas nas Perguntas frequentes.

string

O código de idioma no endereço de entrada é reservado para usos futuros e é ignorado hoje. A API retorna o endereço no idioma correspondente.

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/CEP nos EUA).

string

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).

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. 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.

string

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.

string

Opcional. Sublocalidade do endereço. Por exemplo, pode ser bairro ou distrito.

string

Obrigatório. 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 das linhas seja clara. Ela precisa estar em “ordem de envelope” para o país ou região do endereço.

A representação estrutural mínima permitida de um endereço consiste em todas as informações colocadas no addressLines. Se um regionCode não for fornecido, a região será inferida a partir das linhas de endereço.

Criar um endereço contendo apenas addressLines e, em seguida, 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 político-administrativas).

string

Evite definir esse campo. A API Address Validation não o usa atualmente. No momento, a API não rejeitará solicitações com esse campo definido, mas as informações serão descartadas e não serão retornadas na resposta.

string

Evite definir esse campo. A API Address Validation não o usa atualmente. No momento, a API não rejeitará solicitações com esse campo definido, mas as informações serão descartadas e não serão retornadas na resposta.

{
  "returnEnglishLatinAddress": boolean
}

boolean

Prévia: retornar um google.maps.addressvalidation.v1.Address em inglês. Consulte google.maps.addressvalidation.v1.ValidationResult.english_latin_address para mais detalhes.

{
  "verdict": {
    object (Verdict)
  },
  "address": {
    object (Address)
  },
  "geocode": {
    object (Geocode)
  },
  "metadata": {
    object (AddressMetadata)
  },
  "uspsData": {
    object (UspsData)
  },
  "englishLatinAddress": {
    object (Address)
  }
}

object (Verdict)

Sinalizações gerais de vereditos

object (Address)

Informações sobre o endereço em si, não sobre o geocódigo.

object (Geocode)

Informações sobre o local e o local em que o endereço foi geocodificado.

object (AddressMetadata)

Outras informações relevantes para a capacidade de entrega. Não é garantido que o metadata seja totalmente preenchido para cada endereço enviado à API Address Validation.

object (UspsData)

Sinalizações de entrega extras fornecidas pela USPS. Fornecido somente nas regiões US e PR.

object (Address)

Pré-lançamento: esse recurso está em pré-lançamento (pré-GA). Os produtos e recursos em pré-GA têm suporte limitado, e é possível que as mudanças neles não sejam compatíveis com outras versões nessa fase. Todos os produtos em pré-GA são cobertos pelos Termos de Serviço específicos da Plataforma Google Maps. Para mais informações, consulte as descrições da fase de lançamento.

O endereço traduzido para o inglês. Se parte do endereço não tiver uma tradução em inglês, o serviço a retornará em um idioma alternativo que use script latino. Clique aqui para saber como o idioma alternativo é selecionado. Se parte do endereço não tiver traduções ou transliterações para um idioma que use alfabeto latino, o serviço retornará essa parte no idioma local associado ao endereço.

Você ativou essa saída usando a sinalização google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address.

Observação: os campos google.maps.addressvalidation.v1.Address.unconfirmed_component_types nos campos englishLatinAddress e google.maps.addressvalidation.v1.AddressComponent.confirmation_level em englishLatinAddress.address_components não são preenchidos.

{
  "inputGranularity": enum (Granularity),
  "validationGranularity": enum (Granularity),
  "geocodeGranularity": enum (Granularity),
  "addressComplete": boolean,
  "hasUnconfirmedComponents": boolean,
  "hasInferredComponents": boolean,
  "hasReplacedComponents": boolean
}

enum (Granularity)

A granularidade do endereço de input. Esse é o resultado da análise do endereço de entrada e não fornece nenhum sinal de validação. Para sinais de validação, consulte validationGranularity abaixo.

Por exemplo, se o endereço de entrada incluir um número de apartamento específico, inputGranularity aqui será SUB_PREMISE. Se não for possível corresponder o número do apartamento nos bancos de dados ou ele for inválido, provavelmente validationGranularity será PREMISE ou inferior.

enum (Granularity)

O nível de granularidade para o qual a API pode validate totalmente o endereço. Por exemplo, um validationGranularity de PREMISE indica que todos os componentes de endereço no nível PREMISE ou mais aproximados podem ser validados.

O resultado da validação de componente por endereço pode ser encontrado em google.maps.addressvalidation.v1.Address.address_components.

enum (Granularity)

Informações sobre a granularidade da geocode. Isso pode ser entendido como o significado semântico de quão aproximada ou fina é a localização geocodificada.

De vez em quando, esse valor pode ser diferente do validationGranularity acima. Por exemplo, nosso banco de dados pode registrar a existência de um número de apartamento, mas não ter um local preciso para esse apartamento em um grande complexo de apartamentos. Nesse caso, o validationGranularity será SUB_PREMISE, mas o geocodeGranularity será PREMISE.

boolean

O endereço é considerado completo se não houver tokens não resolvidos nem componentes de endereço inesperados ou ausentes. Consulte os campos missingComponentTypes, unresolvedTokens ou unexpected para saber mais.

boolean

Pelo menos um componente de endereço não pode ser categorizado ou validado. Consulte google.maps.addressvalidation.v1.Address.address_components para mais detalhes.

boolean

Pelo menos um componente de endereço foi inferido (adicionado) que não estava na entrada. Consulte google.maps.addressvalidation.v1.Address.address_components para mais detalhes.

boolean

Pelo menos um componente de endereço foi substituído. Consulte google.maps.addressvalidation.v1.Address.address_components para ver detalhes.

{
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "addressComponents": [
    {
      object (AddressComponent)
    }
  ],
  "missingComponentTypes": [
    string
  ],
  "unconfirmedComponentTypes": [
    string
  ],
  "unresolvedTokens": [
    string
  ]
}

string

O endereço pós-processado, formatado como um endereço de linha única, seguindo as regras de formatação da região onde o endereço está localizado.

object (PostalAddress)

O endereço pós-processado representado como um endereço postal.

object (AddressComponent)

Lista não ordenada. Os componentes de endereço individuais do endereço formatado e corrigido, junto com as informações de validação. Ela fornece informações sobre o status de validação dos componentes individuais.

Os componentes de endereço não são ordenados de uma maneira específica. Não faça suposições sobre a ordem dos componentes de endereço na lista.

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 que não puderam ser inferidos. Os componentes desse tipo não estão presentes em formattedAddress, postalAddress ou addressComponents. Por exemplo, ['street_number', 'route'] para uma entrada como "Boulder, Colorado, 80301, EUA". Você pode encontrar a lista de tipos possíveis aqui.

string

Os tipos dos componentes que estão presentes na addressComponents, mas não foram confirmados como corretos. Esse campo é fornecido por conveniência: o conteúdo dele é equivalente a iterar o addressComponents para encontrar os tipos de todos os componentes em que confirmationLevel não é CONFIRMED ou a sinalização inferred não está definida como true. Você pode encontrar a lista de tipos possíveis aqui.

string

Quaisquer 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 parecer ["123235253253"], já que isso não parece um número de rua válido.

{
  "componentName": {
    object (ComponentName)
  },
  "componentType": string,
  "confirmationLevel": enum (ConfirmationLevel),
  "inferred": boolean,
  "spellCorrected": boolean,
  "replaced": boolean,
  "unexpected": boolean
}

object (ComponentName)

O nome desse componente.

string

O tipo do componente de endereço. Consulte a Tabela 2: outros tipos retornados pelo serviço Places para conferir uma lista dos tipos possíveis.

enum (ConfirmationLevel)

Indica o nível de certeza que temos de que o componente está correto.

boolean

Indica que o componente não fazia parte da entrada, mas o inferimos para a localização do endereço e acreditamos que ele deve ser fornecido para um endereço completo.

boolean

Indica uma correção de um erro de digitação no nome do componente. A API nem sempre sinaliza alterações de uma variante de ortografia para outra, como ao alterar "centro" para "centro". Ele também nem sempre sinaliza erros de ortografia comuns, como ao alterar "Amphitheater Pkwy" para "Amphitheatre Pkwy".

boolean

Indica que o nome do componente foi substituído por um totalmente diferente. Por exemplo, um CEP incorreto está sendo substituído por um correto para o endereço. Essa não é uma mudança estética, o componente de entrada mudou para outro.

boolean

Indica um componente de endereço que não está presente em um endereço postal da região especificada. Ela foi retida apenas porque fazia parte da entrada.

{
  "text": string,
  "languageCode": string
}

string

O texto do nome. Por exemplo, "5th Avenue" para um nome de rua ou "1253" para um número de rua.

string

O código de idioma BCP-47. Este atributo não estará presente se o nome do componente não estiver associado a um idioma, como o número da rua.

{
  "location": {
    object (LatLng)
  },
  "plusCode": {
    object (PlusCode)
  },
  "bounds": {
    object (Viewport)
  },
  "featureSizeMeters": number,
  "placeId": string,
  "placeTypes": [
    string
  ]
}

object (LatLng)

O local geocodificado da entrada.

É preferível usar IDs de lugar em vez de endereços, coordenadas de latitude/longitude ou Plus Codes. O uso de coordenadas ao definir rotas ou calcular rotas sempre fará com que o ponto seja direcionado para a estrada mais próxima dessas coordenadas. Esta não pode ser uma estrada que levará de forma rápida ou segura ao destino e pode não estar perto de um ponto de acesso à propriedade. Além disso, quando um local é geocodificado inversamente, não há garantia de que o endereço retornado corresponderá ao original.

object (PlusCode)

O Plus Code correspondente ao location.

object (Viewport)

Os limites do lugar geocodificado.

number

O tamanho do local geocodificado, em metros. Essa é outra medida da precisão da localização geocodificada, mas em tamanho físico, e não em significado semântico.

string

O PlaceID do lugar ao qual esta entrada é geocodificada.

Para mais informações sobre IDs de lugares, clique aqui.

string

O(s) tipo(s) de lugar para o qual a entrada foi geocodificada. Por exemplo, ['locality', 'political']. A lista completa de tipos está disponível aqui.

{
  "latitude": number,
  "longitude": number
}

number

A latitude em graus. Precisa estar no intervalo [-90,0, +90,0].

number

A longitude em graus. Precisa estar no intervalo [-180,0, +180,0].

{
  "globalCode": string,
  "compoundCode": string
}

string

O código global (completo) do lugar, como "9FWM33GV+HQ", que representa uma área de 1/8.000 por 1/8.000 graus (aproximadamente 14 por 14 metros).

string

O código composto do lugar, como "33GV+HQ, Ramberg, Noruega", que contém o sufixo do código global e substitui o prefixo por um nome formatado de uma entidade de referência.

{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}

object (LatLng)

Obrigatório. O ponto inferior da janela de visualização.

object (LatLng)

Obrigatório. O ponto mais alto da janela de visualização.

{
  "business": boolean,
  "poBox": boolean,
  "residential": boolean
}

boolean

Indica que este é o endereço de uma empresa. Se não for definido, indica que o valor é desconhecido.

boolean

Indica o endereço de uma caixa postal. Se não for definido, indica que o valor é desconhecido.

boolean

Indica que este é o endereço de uma residência. Se não for definido, indica que o valor é desconhecido.

{
  "standardizedAddress": {
    object (UspsAddress)
  },
  "deliveryPointCode": string,
  "deliveryPointCheckDigit": string,
  "dpvConfirmation": string,
  "dpvFootnote": string,
  "dpvCmra": string,
  "dpvVacant": string,
  "dpvNoStat": string,
  "dpvNoStatReasonCode": integer,
  "dpvDrop": string,
  "dpvThrowback": string,
  "dpvNonDeliveryDays": string,
  "dpvNonDeliveryDaysValues": integer,
  "dpvNoSecureLocation": string,
  "dpvPbsa": string,
  "dpvDoorNotAccessible": string,
  "dpvEnhancedDeliveryCode": string,
  "carrierRoute": string,
  "carrierRouteIndicator": string,
  "ewsNoMatch": boolean,
  "postOfficeCity": string,
  "postOfficeState": string,
  "abbreviatedCity": string,
  "fipsCountyCode": string,
  "county": string,
  "elotNumber": string,
  "elotFlag": string,
  "lacsLinkReturnCode": string,
  "lacsLinkIndicator": string,
  "poBoxOnlyPostalCode": boolean,
  "suitelinkFootnote": string,
  "pmbDesignator": string,
  "pmbNumber": string,
  "addressRecordType": string,
  "defaultAddress": boolean,
  "errorMessage": string,
  "cassProcessed": boolean
}

object (UspsAddress)

Endereço padronizado da USPS.

string

Código do ponto de entrega de dois dígitos

string

O dígito de verificação do ponto de entrega. Esse número é adicionado ao final de "delivery_point_barcode" no caso de e-mails verificados automaticamente. A soma de todos os dígitos de delivery_point_barcode, deliveryPointCheckDigit, CEP e ZIP+4 deve resultar em um número divisível por 10.

string

Os valores possíveis para confirmação de DPV. Retorna um único caractere ou não retorna nenhum valor.

• N: as informações sobre os números principal e secundário não foram confirmadas.
• D: o endereço foi confirmado como DPV somente para o número principal, e as informações do número secundário estavam ausentes.
• S: o endereço foi confirmado como DPV somente para o número principal, e as informações do número secundário estavam presentes, mas não foram confirmadas.
• Y: o endereço foi confirmado como DPV para números principais e secundários.
• Vazio: se a resposta não contiver um valor dpvConfirmation, o endereço não foi enviado para confirmação do DPV.

string

As notas de rodapé da validação do ponto de entrega. Várias notas de rodapé podem ser agrupadas na mesma string.

• AA: o endereço de entrada corresponde ao arquivo ZIP+4
• A1: o endereço de entrada não corresponde ao arquivo ZIP+4
• BB: correspondente ao DPV (todos os componentes)
• CC: número secundário sem correspondência e não obrigatório
• C1: número secundário sem correspondência, mas obrigatório
• N1: endereço do arranha-céu sem número secundário
• M1: número principal ausente
• M3: o número principal é inválido
• P1: o número da ordem de compra, RR ou da caixa HC do endereço de entrada está ausente
• P3: o número da ordem de compra, RR ou caixa HC do endereço de entrada é inválido
• F1: o endereço de entrada corresponde a um endereço militar
• G1: o endereço de entrada corresponde a um endereço de entrega geral
• U1: o endereço de entrada corresponde a um CEP exclusivo
• PB: o endereço de entrada corresponde ao registro do PBSA
• RR: endereço confirmado de DPV com informações de PMB
• R1: endereço confirmado de DPV sem informações de PMB
• R7: registro da Rota da Operadora R777 ou R779
• IA: endereço informado identificado
• TA: número principal correspondido descartando um alfa final

string

Indica se o endereço é uma agência de recebimento de e-mails comercial (CMRA, na sigla em inglês), uma empresa particular que recebe e-mails para clientes. Retorna um único caractere.

• Y: o endereço é uma CMRA
• N: o endereço não é uma CMRA

string

Esse lugar está vazio? Retorna um único caractere.

• Y: o endereço está vazio.
• N: o endereço não está vazio.

string

Este é um endereço sem estatísticas ou ativo? Nenhum endereço de estatística não é ocupado continuamente ou endereços que a USPS não atende. Retorna um único caractere.

• Y: o endereço não está ativo.
• N: o endereço está ativo.

integer

Indica o tipo NoStat. Retorna um código de motivo como int.

• 1: IDA (endereço de entrega interno): endereços que não recebem e-mails diretamente da USPS, mas são entregues em um endereço de entrega que os atende.
• 2: CDS – endereços que ainda não se tornaram entregues. Por exemplo, uma nova subdivisão em que os lotes e números primários foram determinados, mas ainda não há estrutura para a ocupação.
• 3: Colisão: endereços que não confirmam realmente o DPV.
• 4: CMZ (faculdade, militar e outros tipos) – ZIP + 4 registros da USPS incorporada aos dados.
• 5: regular: indica que os endereços não recebem entrega e que não são contabilizados como possíveis entregas.
• 6: secundário obrigatório: o endereço requer informações secundárias.

string

A sinalização indica que os e-mails são entregues a um único recepcionável em um site. Retorna um único caractere.

• Y: o e-mail é entregue a um único receptível em um site.
• N: o e-mail não é entregue a um único recepcionável em um site.

string

Indica que correspondência não é entregue no endereço. Retorna um único caractere.

• Y: a correspondência não é entregue no endereço.
• N: a correspondência é entregue no endereço.

string

A sinalização indica que a entrega de e-mails não é realizada todos os dias da semana. Retorna um único caractere.

• Y: a entrega de e-mails não é realizada todos os dias da semana.
• N: nenhuma indicação de que a entrega de e-mails não é realizada todos os dias da semana.

integer

Número inteiro que identifica os dias de não entrega. Ele pode ser interrogado usando flags de bit: 0x40 – Domingo é um dia de não entrega 0x20 – Segunda-feira é um dia de não exibição 0x10 – Terça é um dia de não exibição 0x08 – Quarta-feira é um dia de não entrega 0x04 – Quinta é um dia de não entrega 0x02 – Sábado é um dia de não exibição – Sábado é um dia de não entrega 0x02

string

A flag indica que a porta está acessível, mas o pacote não será deixado por motivos de segurança. Retorna um único caractere.

• Y: o pacote não será enviado por motivos de segurança.
• N: nenhuma indicação de que o pacote não será enviado por motivos de segurança.

string

Indica que o endereço corresponde ao registro do PBSA. Retorna um único caractere.

• Y: o endereço corresponde ao registro da PBSA.
• N: o endereço não corresponde ao registro da PBSA.

string

A sinalização indica os endereços onde a USPS não pode bater em uma porta para entregar correspondências. Retorna um único caractere.

• Y: a porta não está acessível.
• N: nenhuma indicação de que a porta não está acessível.

string

Indica que mais de um código de retorno DPV é válido para o endereço. Retorna um único caractere.

• Y: o endereço foi confirmado como DPV para números principais e secundários.
• N: as informações sobre os números principal e secundário não foram confirmadas.
• S: o endereço foi confirmado como DPV somente para o número principal, e as informações do número secundário estavam presentes como "não confirmadas" ou um único alfa final em um número principal foi descartado para fazer uma correspondência de DPV e as informações secundárias necessárias.
• D: o endereço foi confirmado como DPV somente para o número principal, e as informações do número secundário estavam ausentes.
• R: o endereço confirmado, mas atribuído à rota fantasma R777 e R779 e à entrega da USPS não foi informado.

string

O código de rota da operadora. Um código de quatro caracteres que consiste em um prefixo de uma letra e um indicador de trajeto de três dígitos.

Prefixos:

• C: rota da transportadora (ou rota da cidade)
• R: rota rural
• H: trajeto de contratação de rodovia
• B: seção de caixa postal
• G: unidade de entrega geral

string

Indicador de classificação da taxa de rota da transportadora.

boolean

O endereço de entrega é compatível, mas o arquivo EWS indica que uma correspondência exata estará disponível em breve.

string

Principal cidade dos correios.

string

Estado da agência dos correios principal.

string

Cidade abreviada.

string

Código do condado do FIPS.

string

Nome do condado.

string

Número da linha de viagem avançada (eLOT).

string

eLOT Bandeira Crescente/Descendente (A/D).

string

Código de devolução de LACSLink.

string

Indicador LACSLink.

boolean

CEP apenas na caixa postal.

string

Notas de rodapé que correspondem a um registro de rua ou arranha-céu com informações de conjuntos. Se o nome da empresa for correspondente, o número secundário será retornado.

• A: correspondência de registro da SuiteLink e melhoria do endereço comercial.
• 00: sem correspondência, o endereço comercial não foi melhorado.

string

Designador da unidade de PMB (Private Mail Box).

string

número do PMB (Private Mail Box);

string

Tipo do registro do endereço que corresponde ao endereço de entrada.

• F: FIRM. Essa é uma correspondência com um registro firme, que é o melhor nível de correspondência disponível para um endereço.
• G: ENTREGA GERAL. Essa é uma correspondência com um registro de entrega geral.
• H: EDIÇÃO / APARTAMENTO. Esta é uma correspondência com um registro de Edifício ou Apartamento.
• P: POSTAR CAIXA DO ESCRITÓRIO. Isso corresponde a uma caixa postal.
• R: CONTRATO RURAL ou VISUALIZADO: corresponde a um registro de Rota Rural ou Contrato de rodovia, ambos os quais podem ter intervalos de número de caixas associados.
• S: REGISTRO DE RUA: uma correspondência com um registro de rua que contém um intervalo de números principal válido.

boolean

Indicador de que um endereço padrão foi encontrado, mas existem endereços mais específicos.

string

Mensagem de erro para recuperação de dados USPS. Ele é preenchido quando o processamento da USPS é suspenso devido à detecção de endereços criados artificialmente.

Os campos de dados do USPS podem não ser preenchidos quando esse erro estiver presente.

boolean

Indicador de que a solicitação foi processada pelo CASS.

{
  "firstAddressLine": string,
  "firm": string,
  "secondAddressLine": string,
  "urbanization": string,
  "cityStateZipAddressLine": string,
  "city": string,
  "state": string,
  "zipCode": string,
  "zipCodeExtension": string
}

string

Primeira linha de endereço.

string

Nome da empresa.

string

Segunda linha de endereço.

string

Nome da urbanização porto-riquenha.

string

Cidade + estado + código postal.

string

Nome da cidade.

string

Código de estado com duas letras.

string

CEP, por exemplo, 10009.

string

Extensão de CEP de quatro dígitos, por exemplo, 5023.