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 fará 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, acesse 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 a partir do endereço. Para um melhor desempenho, é recomendável incluir o código da região, se você souber. Ter regiões inconsistentes ou repetidas pode levar a um baixo desempenho. Por exemplo, se a addressLines já incluir a região, não forneça o código novamente neste campo. Consulte as regiões com suporte 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 apropriado ao local em que ele está localizado.

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 da linha 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 que contenha apenas addressLines e a geocodificação é 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 este campo. No momento, ela não é usada pela API Address Validation. Embora, no momento, a API não rejeite solicitações com esse campo definido, as informações serão descartadas e não serão retornadas na resposta.

string

Evite definir este campo. No momento, ela não é usada pela API Address Validation. Embora, no momento, a API não rejeite solicitações com esse campo definido, 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, e não o geocódigo.

object (Geocode)

Informações sobre o local e o local para o qual o endereço foi geocodificado.

object (AddressMetadata)

Outras informações relevantes para a capacidade de entrega. Não há garantia de que metadata será totalmente preenchido para cada endereço enviado à API Address Validation.

object (UspsData)

Sinalizações de entrega extra fornecidas pelo 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 pré-GA. As ofertas pré-GA são cobertas 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. Consulte aqui uma explicação sobre como o idioma alternativo é selecionado. Se parte do endereço não tiver traduções ou transliterações para um idioma que use script 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 estã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 entrada. Esse é o resultado da análise do endereço de entrada e não fornece sinais 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, o inputGranularity aqui será SUB_PREMISE. Se não for possível corresponder o número do apartamento nos bancos de dados ou o número do apartamento for inválido, o validationGranularity provavelmente será PREMISE ou inferior.

enum (Granularity)

O nível de granularidade em que a API pode validar totalmente o endereço. Por exemplo, um validationGranularity como PREMISE indica que todos os componentes de endereço no nível PREMISE ou mais abrangentes podem ser validados.

O resultado da validação do componente de 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 aproximado ou refinado é o local geocodificado.

Às vezes, 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 uma localização precisa dentro de um grande complexo de apartamentos. Nesse caso, o validationGranularity vai ser SUB_PREMISE, mas o geocodeGranularity vai ser PREMISE.

boolean

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

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 que não estava na entrada foi inferido (adicionado). 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 em que 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, além das 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 não foram inferidos. componentes desse tipo não estão presentes em formattedAddress, postalAddress ou addressComponents. Um exemplo pode ser ['street_number', 'route'] para uma entrada como "Boulder, Colorado, 80301, EUA". A lista de tipos possíveis pode ser encontrada aqui.

string

Os tipos dos componentes que estão presentes no 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 em que a sinalização inferred não está definida como true. A lista de tipos possíveis pode ser encontrada 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 ter o formato ["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 ver uma lista dos tipos possíveis.

enum (ConfirmationLevel)

Indica o nível de certeza 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 ortografia no nome do componente. A API nem sempre sinaliza alterações de uma variante de ortografia para outra, como ao alterar "centro" para "centro". Ela também nem sempre sinaliza erros ortográficos 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 sendo substituído por um correto para o endereço. Essa não é uma mudança estética, o componente de entrada foi alterado para outro.

boolean

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

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

string

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

string

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

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

object (LatLng)

A localização geocodificada da entrada.

É preferível usar IDs de lugares do que endereços, coordenadas de latitude/longitude ou Plus Codes. O uso de coordenadas ao criar trajetos ou calcular rotas de carro sempre resulta no direcionamento do ponto para a via mais próxima dessas coordenadas. Esta pode não ser uma estrada que levará de maneira rápida ou segura ao destino e não pode 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 local geocodificado.

number

O tamanho do local geocodificado, em metros. Essa é outra medida da proximidade 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.

Acesse mais informações sobre IDs de lugares.

string

Os tipos 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

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

Código composto do lugar, como "33GV+HQ, Ramberg, Noruega", que contém o sufixo do código global e substitui o prefixo pelo 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 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 esse é 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,
  "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 do USPS.

string

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

string

Dígito de verificação do ponto de entrega. Esse número é adicionado ao final do delivery_point_barcode para e-mails verificados automaticamente. A adição 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 a confirmação de DPV. Retorna um único caractere.

• Y: o endereço foi confirmado como DPV para números primários e secundários.
• N: as informações de número principal e secundário não foram confirmadas pelo DPV.
• S: o endereço foi confirmado como DPV apenas para o número principal, e as informações do número secundário estavam presentes, mas não foram confirmadas.
• D: o endereço foi confirmado como DPV apenas para o número principal, e as informações do número secundário estavam ausentes.

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 correspondente 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 (presente, mas inválido)
• 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 caixa de entrada ou RR do endereço de entrada está ausente
• P3: o número da ordem de compra, RR ou da caixa da Central de Ajuda é inválido
• F1: o endereço de entrada correspondente 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 do PMB
• R1: endereço confirmado de DPV sem informações do PMB
• R7: registro da Carrier Route R777 ou R779

string

Indica se o endereço é uma Agência Recebedora de E-mails Comercial (CMRA, na sigla em inglês), ou seja, 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

Esse é um endereço que não está disponível ou está ativo? Nenhum endereço de estatística é aquele que não está continuamente ocupado ou endereços não atendidos pelo USPS. Retorna um único caractere.

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

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 com três dígitos.

Prefixos:

• C: rota da transportadora (ou rota da cidade)
• R: rota rural
• H: trajeto do contrato 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

Cidade dos correios principal.

string

Estado da agência dos correios principal.

string

Cidade abreviada.

string

Código de condado FIPS.

string

Nome do condado.

string

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

string

Bandeira crescente/decrescente (A/D).

string

Código de devolução LACSLink.

string

Indicador LACSLink.

boolean

CEP apenas na caixa postal.

string

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

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

string

Designador da unidade PMB (caixa de correio particular).

string

número do PMB (caixa de correio particular);

string

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

• F: FIRM. Esta é uma correspondência com um registro firme, que é o melhor nível de correspondência disponível para um endereço.
• G: ENTREGA GERAL. Isso corresponde a um registro de Entrega Geral.
• H: Edifícios / Apartamentos. Esta é uma correspondência com um registro de edifício ou apartamento.
• P: CAIXA POSTAL DO ESCRITÓRIO. Corresponde a uma caixa postal.
• R: CONTRATO RURAL ou ALTA: corresponde a um registro de Trajeto Rural ou de Contrato de Rodovia, ambos podem ter intervalos de Número de Caixas associados.
• S: REGISTRO DA RUA: corresponde a um registro do Street View que contém um intervalo de números principal válido.

boolean

Indica que um endereço padrão foi encontrado, mas há endereços mais específicos.

string

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

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

boolean

Indicador de que a solicitação foi processada por 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 de duas letras.

string

Código postal, por exemplo, 10009.

string

Extensão de quatro dígitos do código postal, por exemplo, 5023.