Method: validateAddress

Valida um endereço.

Solicitação HTTP

POST https://addressvalidation.googleapis.com/v1:validateAddress

O URL usa a sintaxe de transcodificação gRPC.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "address": {
    object (PostalAddress)
  },
  "previousResponseId": string,
  "enableUspsCass": boolean,
  "languageOptions": {
    object (LanguageOptions)
  },
  "sessionToken": string
}
Campos
address

object (PostalAddress)

Obrigatório. O endereço que está sendo validado. Os endereços sem formatação devem ser enviados por addressLines.

O tamanho total dos campos nessa entrada não pode exceder 280 caracteres.

Confira as regiões com suporte aqui.

O valor languageCode no endereço de entrada é reservado para uso futuro e é ignorado no momento. O resultado do endereço validado será preenchido com base no idioma de preferência do endereço especificado, conforme identificado pelo sistema.

A API Address Validation ignora os valores em recipients e organization. Os valores nesses campos serão descartados e não retornados. Não defina.
previousResponseId

string

Este campo precisa estar vazio para a primeira solicitação de validação de endereço. Se mais solicitações forem necessárias para validar totalmente um único endereço (por exemplo, se as alterações feitas pelo usuário após a validação inicial precisarem ser revalidadas), cada solicitação de acompanhamento precisará preencher esse campo com o responseId da primeira resposta na sequência de validação.
enableUspsCass

boolean

Ativa o modo compatível com o USPS CASS. Isso afeta apenas o campo google.maps.addressvalidation.v1.ValidationResult.usps_data de google.maps.addressvalidation.v1.ValidationResult. Observação: para solicitações ativadas pelo CASS do USPS de endereços em Porto Rico, um google.type.PostalAddress.region_code do address precisa ser fornecido como "PR" ou um google.type.PostalAddress.administrative_area do address precisa ser fornecido como "Puerto Rico" (sem distinção entre maiúsculas e minúsculas) ou "PR".

É recomendável usar um address em componentes ou especificar pelo menos dois google.type.PostalAddress.address_lines, em que a primeira linha contém o número e o nome da rua e a segunda linha contém a cidade, o estado e o CEP.
languageOptions

object (LanguageOptions)

Opcional. 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. As Soluções 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.

Permite que a API Address Validation inclua mais informações na resposta.
sessionToken

string

Opcional. Uma string que identifica uma sessão de preenchimento automático para fins de faturamento. Precisa ser uma string base64 segura para URL e nome de arquivo com no máximo 36 caracteres ASCII. Caso contrário, um erro INVALID_ARGUMENT será retornado.

A sessão começa quando o usuário faz uma consulta do Autocomplete e termina quando ele seleciona um lugar e uma chamada para o Place Details ou a Validação de endereço é feita. Cada sessão pode ter várias consultas do Autocomplete, seguidas por uma solicitação de Place Details ou Address Validation. As credenciais usadas para cada solicitação em uma sessão precisam pertencer ao mesmo projeto do console do Google Cloud. Após a conclusão de uma sessão, o token não é mais válido. Seu aplicativo deve gerar um novo token para cada sessão. Se o parâmetro sessionToken for omitido ou você reutilizar um token, a sessão vai ser cobrada como se nenhum token de sessão tivesse sido fornecido e cada solicitação será faturada separadamente.

Observação: a API Address Validation só pode ser usada em sessões com a API Autocomplete (nova), não com a API Autocomplete. Consulte https://developers.google.com/maps/documentation/places/web-service/session-pricing para mais detalhes.

Corpo da resposta

A resposta a uma solicitação de validação de endereço.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "result": {
    object (ValidationResult)
  },
  "responseId": string
}
Campos
result

object (ValidationResult)

O resultado da validação do endereço.
responseId

string

O UUID que identifica essa resposta. Se o endereço precisar ser revalidado, esse UUID precisa acompanhar o novo pedido.

PostalAddress

Representa um endereço postal, por exemplo, para endereços para pagamento ou distribuição postal. Com um endereço postal, o serviço de correios pode entregar itens em um local, uma caixa postal ou outro local semelhante. Não se destina a modelar locais geográficos (estradas, cidades, montanhas).

No uso normal, um endereço seria criado por digitação do usuário ou pela importação de dados existentes, dependendo do tipo de processo.

Dicas sobre inserção / edição de endereços: - Use um widget de endereço pronto para internacionalização, como https://github.com/google/libaddressinput. - Os usuários não devem receber elementos da interface para entrada ou edição de campos fora dos países em que o campo é usado.

Para mais orientações sobre como usar este esquema, consulte: https://support.google.com/business/answer/6397478.

Representação JSON 
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Campos
revision

integer

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

string

Opcional. Código de região CLDR do país/região do endereço. Para 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 a partir do endereço. Para melhorar a performance, é 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 o addressLines já inclui a região, não forneça o código de região novamente neste campo. As regiões com suporte estão disponíveis nas Perguntas frequentes.
languageCode

string

O código de idioma no endereço de entrada é reservado para uso futuro e é ignorado no momento. A API retorna o endereço no idioma apropriado para o local.
postalCode

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

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

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

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

string

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

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 das linhas de endereço.

Criar um endereço que contenha apenas addressLines e depois geocodificar é a maneira recomendada de lidar com endereços não estruturados (em vez de adivinhar quais partes do endereço devem ser regiões ou áreas administrativas).
recipients[]

string

Evite definir esse campo. No momento, a API Address Validation não o usa. Embora 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.
organization

string

Evite definir este campo. No momento, a API Address Validation não o usa. Embora 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.

LanguageOptions

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. As Soluções 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.

Permite que a API Address Validation inclua mais informações na resposta.

Representação JSON 
{
  "returnEnglishLatinAddress": boolean
}
Campos
returnEnglishLatinAddress

boolean

Visualização: retorne uma google.maps.addressvalidation.v1.Address em inglês. Consulte google.maps.addressvalidation.v1.ValidationResult.english_latin_address para mais detalhes.

ValidationResult

O resultado da validação de um endereço.

Representação JSON 
{
  "verdict": {
    object (Verdict)
  },
  "address": {
    object (Address)
  },
  "geocode": {
    object (Geocode)
  },
  "metadata": {
    object (AddressMetadata)
  },
  "uspsData": {
    object (UspsData)
  },
  "englishLatinAddress": {
    object (Address)
  }
}
Campos
verdict

object (Verdict)

Flags de veredito geral
address

object (Address)

Informações sobre o endereço, e não o geocódigo.
geocode

object (Geocode)

Informações sobre o local e o lugar para onde o endereço foi geocodificado.
metadata

object (AddressMetadata)

Outras informações relevantes para a entrega. Não há garantia de que metadata será preenchido totalmente para todos os endereços enviados à API Address Validation.
uspsData

object (UspsData)

Sinalizações extras de entrega fornecidas pelo USPS. Disponível apenas nas regiões US e PR.
englishLatinAddress

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. As Soluções 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.

Os endereços traduzidos não podem ser reutilizados como entrada da API. O serviço fornece essas informações para que o usuário possa usar o idioma nativo para confirmar ou negar a validação do endereço fornecido originalmente.

Se parte do endereço não tiver uma tradução para o inglês, o serviço vai retornar essa parte em um idioma alternativo que use um script latino. Consulte este link para saber como o idioma alternativo é selecionado. Se parte do endereço não tiver traduções ou transliterações em um idioma que usa um alfabeto latino, o serviço vai retornar essa parte no idioma local associado ao endereço.

Ative 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 em englishLatinAddress e google.maps.addressvalidation.v1.AddressComponent.confirmation_level em englishLatinAddress.address_components não são preenchidos.

Veredito

Visão geral de alto nível do resultado da validação do endereço e do geocódigo.

Representação JSON 
{
  "inputGranularity": enum (Granularity),
  "validationGranularity": enum (Granularity),
  "geocodeGranularity": enum (Granularity),
  "addressComplete": boolean,
  "hasUnconfirmedComponents": boolean,
  "hasInferredComponents": boolean,
  "hasReplacedComponents": boolean
}
Campos
inputGranularity

enum (Granularity)

A granularidade do endereço de entrada. Esse é o resultado da análise do endereço de entrada e não gera indicadores de validação. Para indicadores de validação, consulte validationGranularity abaixo.

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

enum (Granularity)

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

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

enum (Granularity)

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

Isso pode ser diferente do validationGranularity acima ocasionalmente. 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 o apartamento em um grande complexo. Nesse caso, a validationGranularity vai ser SUB_PREMISE, mas a geocodeGranularity vai ser PREMISE.
addressComplete

boolean

O endereço é considerado completo quando não há tokens não resolvidos nem componentes de endereço inesperados ou ausentes. Se não for definido, o valor será false. Consulte os campos missingComponentTypes, unresolvedTokens ou unexpected para mais detalhes.
hasUnconfirmedComponents

boolean

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

boolean

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

boolean

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

Granularidade

As várias granularidades que um endereço ou um geocódigo pode ter. Quando usados para indicar a 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á ter granularidade LOCALITY, mesmo que o endereço seja mais granular.

Enums
GRANULARITY_UNSPECIFIED Valor padrão. Esse valor não é usado.
SUB_PREMISE Resultado abaixo do nível do edifício, como um apartamento.
PREMISE Resultado no nível do edifício.
PREMISE_PROXIMITY Um geocódigo que aproxima o local do endereço no nível do edifício.
BLOCK O endereço ou geocódigo indica um bloco. Usado apenas em regiões com endereçamento em nível de bloco, como o Japão.
ROUTE O geocódigo ou endereço é granular para a rota, como uma rua, estrada ou rodovia.
OTHER Todas as outras granularidades, que são agrupadas porque não podem ser entregues.

Endereço

Detalhes do endereço pós-processado. O pós-processamento inclui a correção de partes com erros ortográficos do endereço, a substituição de partes incorretas e a inferência de partes ausentes.

Representação JSON 
{
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "addressComponents": [
    {
      object (AddressComponent)
    }
  ],
  "missingComponentTypes": [
    string
  ],
  "unconfirmedComponentTypes": [
    string
  ],
  "unresolvedTokens": [
    string
  ]
}
Campos
formattedAddress

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 ele está localizado.

Observação: o formato desse endereço pode não corresponder ao formato do endereço no campo postalAddress. Por exemplo, o postalAddress sempre representa o país como um regionCode de duas letras, como "US" ou "NZ". Por outro lado, este campo usa uma forma mais longa do nome do país, como "EUA" ou "Nova Zelândia".
postalAddress

object (PostalAddress)

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

object (AddressComponent)

Lista não ordenada. 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.

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

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 formattedAddress, postalAddress ou addressComponents. Um exemplo pode ser ['street_number', 'route'] para uma entrada como "Boulder, Colorado, 80301, EUA". Confira a lista de tipos possíveis aqui.
unconfirmedComponentTypes[]

string

Os tipos dos componentes que estão presentes no addressComponents, 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 addressComponents para encontrar os tipos de todos os componentes em que o confirmationLevel não é CONFIRMED ou a flag inferred não está definida como true. Confira a lista de tipos possíveis aqui.
unresolvedTokens[]

string

Todos os tokens na entrada que não puderam ser resolvidos. Isso pode ser uma entrada que não foi reconhecida como parte válida de um endereço. Por exemplo, para uma entrada como "Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US", os tokens não resolvidos podem ter a aparência de ["Parcel", "0000123123", "&", "0000456456"].

AddressComponent

Representa um componente de endereço, como rua, cidade ou estado.

Representação JSON 
{
  "componentName": {
    object (ComponentName)
  },
  "componentType": string,
  "confirmationLevel": enum (ConfirmationLevel),
  "inferred": boolean,
  "spellCorrected": boolean,
  "replaced": boolean,
  "unexpected": boolean
}
Campos
componentName

object (ComponentName)

O nome desse componente.
componentType

string

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

enum (ConfirmationLevel)

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

boolean

Indica que o componente não fazia parte da entrada, mas foi inferido para o local do endereço e acreditamos que ele precisa ser fornecido para um endereço completo.
spellCorrected

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 ao mudar "centre" para "center". Ele também não sempre sinaliza erros ortográficos comuns, como ao mudar "Amphitheater Pkwy" para "Amphitheatre Pkwy".
replaced

boolean

Indica que o nome do componente foi substituído por um completamente 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.
unexpected

boolean

Indica um componente de endereço que não deve estar presente em um endereço postal da região. Ela foi mantida apenas porque fazia parte da entrada.

ComponentName

Um wrapper para o nome do componente.

Representação JSON 
{
  "text": string,
  "languageCode": string
}
Campos
text

string

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

string

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.

ConfirmationLevel

Os diferentes valores possíveis para os níveis de confirmação.

Enums
CONFIRMATION_LEVEL_UNSPECIFIED Valor padrão. Esse valor não é usado.
CONFIRMED Verificamos que esse componente existe e faz sentido no contexto do restante do endereço.
UNCONFIRMED_BUT_PLAUSIBLE Este componente não pôde ser confirmado, mas é provável que ele exista. Por exemplo, um número de rua dentro de um intervalo válido conhecido em uma rua em que os números específicos das casas não são conhecidos.
UNCONFIRMED_AND_SUSPICIOUS Esse componente não foi confirmado e provavelmente está incorreto. Por exemplo, um bairro que não se encaixa no restante do endereço.

Geocódigo

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

Representação JSON 
{
  "location": {
    object (LatLng)
  },
  "plusCode": {
    object (PlusCode)
  },
  "bounds": {
    object (Viewport)
  },
  "featureSizeMeters": number,
  "placeId": string,
  "placeTypes": [
    string
  ]
}
Campos
location

object (LatLng)

O local geocodificado da entrada.

É melhor usar IDs de local em vez de endereços, coordenadas de latitude/longitude ou Plus Codes. O uso de coordenadas ao calcular rotas ou trajetos por carro sempre resulta na fixação do ponto na via mais próxima a essas coordenadas. Essa pode não ser uma estrada que leva 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 corresponderá ao original.
plusCode

object (PlusCode)

O Plus Code correspondente ao location.
bounds

object (Viewport)

Os limites do lugar geocodificado.
featureSizeMeters

number

O tamanho do lugar geocodificado, em metros. Essa é outra medida da grosseria do local geocodificado, mas em tamanho físico, e não em significado semântico.
placeId

string

O PlaceID do lugar que a entrada vai geocodificar.

Para mais informações sobre os IDs de lugar, clique aqui.
placeTypes[]

string

Os tipos de lugar que a entrada geocodificou. Por exemplo, ['locality', 'political']. Confira a lista completa de tipos aqui.

LatLng

Um objeto que representa um par de latitude/longitude. Ele é expresso como um par de valores duplos para representar graus de latitude e longitude. Salvo indicação em contrário, esse objeto precisa estar em conformidade com o padrão WGS84. Os valores precisam estar dentro de intervalos normalizados.

Representação JSON 
{
  "latitude": number,
  "longitude": number
}
Campos
latitude

number

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

number

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

PlusCode

O Plus Code (http://plus.codes) é uma referência de local com dois formatos: o código global que define um 14mx14m (1/8.000 de grau) ou um retângulo menor e o código composto, substituindo o prefixo por um local de referência.

Representação JSON 
{
  "globalCode": string,
  "compoundCode": string
}
Campos
globalCode

string

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

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.

Janela de visualização

Uma viewport de latitude-longitude, representada como dois pontos low e high diagonalmente opostos. Uma janela de visualização é considerada uma região fechada, ou seja, inclui seus limites. Os limites de latitude devem variar entre -90 e 90 graus, e os limites de longitude devem variar entre -180 e 180 graus. Vários casos incluem:

  • Se low = high, a viewport consiste nesse único ponto.

  • Se low.longitude > high.longitude, o intervalo de longitude é invertido (a janela de visualização cruza a linha de longitude de 180 graus).

  • Se low.longitude = -180 graus e high.longitude = 180 graus, a viewport inclui todas as longitudes.

  • Se low.longitude = 180 graus e high.longitude = -180 graus, o intervalo de longitude estará vazio.

  • Se low.latitude for maior que high.latitude, o intervalo de latitude estará vazio.

low e high precisam ser preenchidos, e a caixa representada não pode estar vazia (conforme especificado nas definições acima). Uma janela de visualização vazia resultará em erro.

Por exemplo, esta viewport inclui toda a cidade de Nova York:

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

Representação JSON 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Campos
low

object (LatLng)

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

object (LatLng)

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

AddressMetadata

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

Representação JSON 
{
  "business": boolean,
  "poBox": boolean,
  "residential": boolean
}
Campos
business

boolean

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

boolean

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

boolean

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

UspsData

Os dados do 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 para a API Address Validation. É recomendável integrar os campos de endereço de backup na resposta se você usar o uspsData como a parte principal da resposta.

Representação JSON 
{
  "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
}
Campos
standardizedAddress

object (UspsAddress)

Endereço padronizado da USPS.
deliveryPointCode

string

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

string

O dígito de verificação do ponto de entrega. Este número é adicionado ao final do delivery_point_barcode para mensagens digitalizadas mecanicamente. A soma de todos os dígitos de delivery_point_barcode, deliveryPointCheckDigit, postal code e ZIP+4 deve resultar em um número divisível por 10.
dpvConfirmation

string

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

  • N: as informações do número principal e de qualquer número secundário não foram confirmadas pela DPV.
  • D: o endereço foi confirmado por DPV apenas para o número principal, e as informações do número secundário estavam ausentes.
  • S: o endereço foi confirmado por DPV apenas 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 por DPV para o número principal e todos os números secundários.
  • Vazio: se a resposta não contiver um valor dpvConfirmation, o endereço não foi enviado para confirmação de DPV.
dpvFootnote

string

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

  • AA: 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: o número secundário não corresponde e não é obrigatório
  • C1: o número secundário não corresponde, mas é obrigatório
  • N1: Endereço de edifício alto sem número secundário
  • M1: número principal ausente
  • M3: número principal inválido
  • P1: O endereço de entrada PO, RR ou HC não tem número de caixa
  • P3: Endereço de entrada PO, RR ou HC inválido
  • F1: o endereço de entrada corresponde a um endereço militar
  • G1: endereço de entrada correspondente a um endereço geral de entrega
  • U1: o endereço de entrada corresponde a um CEP exclusivo
  • PB: endereço de entrada correspondente ao registro PBSA
  • RR: endereço confirmado por DPV com informações de PMB
  • R1: endereço confirmado do DPV sem informações do PMB
  • R7: registro R777 ou R779 da rota da transportadora
  • IA: endereço informado identificado
  • TA: número principal correspondente ao largar um alfa de cauda
dpvCmra

string

Indica se o endereço é uma CMRA (agência comercial de recebimento de correspondências), uma empresa particular que recebe correspondências para clientes. Retorna um único caractere.

  • Y: o endereço é um CMRA
  • N: o endereço não é um CMRA
dpvVacant

string

O lugar está vago? Retorna um único caractere.

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

string

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

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

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 correspondência diretamente da USPS, mas são entregues em um endereço de entrega que os atende.
  • 2: CDS: endereços que ainda não podem ser entregues. Por exemplo, uma nova subdivisão em que os lotes e números principais foram determinados, mas ainda não há estrutura para ocupação.
  • 3: Colisão: endereços que não são confirmados pelo DPV.
  • 4: CMZ (universidade, militar e outros tipos) - registros de CEP + 4 que a USPS incorporou aos dados.
  • 5 (regular): indica que os endereços que não estão recebendo entregas e que não são contabilizados como possíveis entregas.
  • 6: obrigatório secundário: o endereço exige informações secundárias.
dpvDrop

string

Flag indica que a correspondência é entregue a um único receptáculo em um site. Retorna um único caractere.

  • Y: os e-mails são entregues a um único receptível em um site.
  • N: a correspondência não é entregue a um único receptáculo em um site.
dpvThrowback

string

Indica que correspondências não foram entregues 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 da rua.
dpvNonDeliveryDays

string

A flag indica que a entrega de correspondências 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 correspondências não é realizada todos os dias da semana.
dpvNonDeliveryDaysValues

integer

Número inteiro que identifica os dias sem entrega. Ele pode ser interrogado usando flags de bit: 0x40: o domingo não é um dia de entrega 0x20: a segunda-feira não é um dia de entrega 0x10: a terça-feira não é um dia de entrega 0x08: a quarta-feira não é um dia de entrega 0x04: a quinta-feira não é um dia de entrega 0x02: a sexta-feira não é um dia de entrega 0x01: o sábado não é um dia de entrega
dpvNoSecureLocation

string

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.

  • Y: o pacote não será deixado devido a questões de segurança.
  • N: nenhuma indicação de que o pacote não será deixado devido a questões de segurança.
dpvPbsa

string

Indica que o endereço foi associado ao registro PBSA. Retorna um único caractere.

  • Y: o endereço foi associado ao registro PBSA.
  • N: o endereço não corresponde ao registro do PBSA.
dpvDoorNotAccessible

string

A sinalização indica endereços onde a USPS não pode bater na 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 é acessível.
dpvEnhancedDeliveryCode

string

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

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

string

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.

Prefixos:

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

string

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

boolean

O endereço de entrega pode ser encontrado, mas o arquivo EWS indica que uma correspondência exata vai estar disponível em breve.
postOfficeCity

string

Cidade da agência postal principal.
postOfficeState

string

Estado da caixa postal principal.
abbreviatedCity

string

Cidade abreviada.
fipsCountyCode

string

Código do condado FIPS.
county

string

Nome do condado.
elotNumber

string

Número da rota de viagem otimizada (eLOT, na sigla em inglês).
elotFlag

string

Flag de ordenação crescente/decrescente (A/D) do eLOT.
poBoxOnlyPostalCode

boolean

Código postal apenas para caixa postal.
pmbDesignator

string

Designador de unidade de caixa de correio particular (PMB, na sigla em inglês).
pmbNumber

string

Número da caixa postal particular (PMB, na sigla em inglês);
addressRecordType

string

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

  • F: FIRM. Essa é uma correspondência com um registro de empresa, que é o nível mais preciso de correspondência disponível para um endereço.
  • G: ENTREGA GERAL. Este é um registro de entrega geral.
  • H: PRÉDIO / APARTAMENTO. Essa correspondência é com um registro de edifício ou apartamento.
  • P: CAIXA DE POSTAGEM. Este é um endereço de caixa postal.
  • R: RURAL ROUTE ou HIGHWAY CONTRACT: corresponde a um registro de Rural Route ou Highway Contract, que podem ter intervalos de número de caixa associados.
  • S: STREET RECORD: corresponde a um registro de rua que contém um intervalo de números principal válido.
defaultAddress

boolean

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

string

Mensagem de erro para a recuperação de dados do USPS. Esse campo é preenchido quando o processamento do USPS é suspenso devido à detecção de endereços criados artificialmente.

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

boolean

Indica que a solicitação foi processada pelo CASS.

UspsAddress

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

Representação JSON 
{
  "firstAddressLine": string,
  "firm": string,
  "secondAddressLine": string,
  "urbanization": string,
  "cityStateZipAddressLine": string,
  "city": string,
  "state": string,
  "zipCode": string,
  "zipCodeExtension": string
}
Campos
firstAddressLine

string

Primeira linha do endereço.
firm

string

Nome da empresa.
secondAddressLine

string

Segunda linha do endereço.
urbanization

string

Nome da urbanização porto-riquenha.
cityStateZipAddressLine

string

Cidade + estado + código postal.
city

string

Nome da cidade.
state

string

Código do estado com duas letras.
zipCode

string

Código postal, por exemplo, 10009.
zipCodeExtension

string

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