Package google.maps.addressvalidation.v1

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

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 postal_address. Por exemplo, postal_address sempre representa o país como um region_code de duas letras, como "US" ou "NZ". Por outro lado, esse campo usa uma forma mais longa do nome do país, como "EUA" ou "Nova Zelândia".

PostalAddress

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

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.

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

Observação: talvez você veja um tipo de componente ausente quando achar que já forneceu o componente. Isso pode acontecer, por exemplo, quando o endereço de entrada contém o nome do edifício, mas não o número da instalação. No endereço "渋谷区渋谷３丁目　Shibuya Stream", o nome do edifício "Shibuya Stream" tem o tipo de componente premise, mas o número da instalação está ausente. Portanto, missing_component_types vai conter premise.

string

Os tipos dos componentes que estão presentes no address_components, mas não foi possível confirmar se estão corretos. Esse campo é fornecido por conveniência: o conteúdo dele é equivalente a iterar o address_components para encontrar os tipos de todos os componentes em que o confirmation_level não é CONFIRMED ou a flag inferred não está definida como true. Confira a lista de tipos possíveis aqui.

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

ComponentName

O nome do componente.

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

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

bool

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.

bool

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

bool

Indica que o nome do componente foi substituído por um completamente diferente, por exemplo, um código postal 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.

bool

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.

bool

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

bool

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

bool

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

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. Isso não vai aparecer se o nome do componente não estiver associado a um idioma, como um número de rua.

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 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 vai corresponder ao original.

PlusCode

O Plus Code correspondente ao location.

Viewport

Os limites do lugar geocodificado.

float

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.

string

O PlaceID do lugar que a entrada vai geocodificar.

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

string

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

bool

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

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

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.

ValidationConclusion

Obrigatório. O resultado da sequência de tentativas de validação.

Se esse campo for definido como VALIDATION_CONCLUSION_UNSPECIFIED, um erro INVALID_ARGUMENT será retornado.

string

Obrigatório. O ID da resposta a que este feedback se refere. Ele deve ser o [response_id][google.maps.addressvalidation.v1.ValidateAddressRequest.response_id] da primeira resposta em uma série de tentativas de validação de endereço.

string

Primeira linha do endereço.

string

Nome da empresa.

string

Segunda linha do endereço.

string

Nome da urbanização porto-riquenha.

string

Cidade + estado + código postal.

string

Nome da cidade.

string

Código do estado com duas letras.

string

Código postal, por exemplo, 10009.

string

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

UspsAddress

Endereço padronizado da USPS.

string

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

string

O dígito de verificação do ponto de entrega. Esse número é adicionado ao final de delivery_point_barcode para correspondências digitalizadas mecanicamente. A soma de todos os dígitos de delivery_point_barcode, delivery_point_check_digit, postal code 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 ou nenhum valor.

• N: a confirmação de DPV falhou para as informações do número principal e de qualquer número secundário.
• 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 dpv_confirmation, o endereço não foi enviado para confirmação de 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: endereço de entrada correspondente ao arquivo ZIP+4
• A1: o endereço de entrada não corresponde ao arquivo ZIP+4
• BB: correspondência com 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 número de caixa HC 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: 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

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

string

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

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

string

Esse endereço é inativo ou 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.

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

int32

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 do 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 confirmam o DPV.
• 4: CMZ (universidades, militares e outros tipos) - registros de CEP + 4 que a USPS incorporou aos dados.
• 5: normal: indica endereços que não recebem entrega e não são contados como possíveis entregas.
• 6: obrigatório secundário: o endereço exige informações secundárias.

string

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

• Y: o e-mail é entregue em um único receptáculo em um site.
• N: a correspondência não é entregue a um único receptável em um site.

string

Indica que a 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 da rua.

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 correspondência não é feita todos os dias da semana.
• N: nenhuma indicação de que a entrega de correspondências não é realizada todos os dias da semana.

int32

Número inteiro que identifica os dias sem entrega. Ele pode ser interrogado usando flags de bit: 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

string

A sinalização indica que a porta está acessível, mas o pacote não será deixado devido a 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.

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 foi associado ao registro PBSA.

string

Indica endereços em que o USPS não pode bater na porta para entregar a correspondência. Retorna um único caractere.

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

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: a confirmação de DPV falhou para as informações do número principal e de qualquer número secundário.
• 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 confirmadas, ou um único caractere alfabético 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 apenas 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.

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: rota rural
• H: rota de contrato de rodovia
• B: seção de caixa postal
• G: unidade de entrega geral

string

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

bool

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

string

Cidade da agência postal principal.

string

Estado da agência dos correios principal.

string

Cidade abreviada.

string

Código do condado FIPS.

string

Nome do condado.

string

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

string

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

string

Código de retorno do LACSLink.

string

Indicador de LACSLink.

bool

Código postal apenas para caixa postal.

string

Notas de rodapé que correspondem a um registro de rua ou edifício às informações do apartamento. Se uma correspondência de nome de empresa for encontrada, o número secundário será retornado.

• A: correspondência com o registro do SuiteLink, endereço comercial melhorado.
• 00: não há correspondência, o endereço comercial não foi aprimorado.

string

Designador de unidade PMB (caixa de correio particular).

string

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

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 DO CORREIO. Este endereço corresponde a uma 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úmero principal válido.

bool

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

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.

bool

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

PostalAddress

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

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

Confira as regiões com suporte aqui.

O valor language_code 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 preferencial para o endereço fornecido, 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.

string

Esse 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 response_id da primeira resposta na sequência de validação.

bool

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

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.

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 de 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 perde a validade. Seu app precisa 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.

ValidationResult

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

string

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

Verdict

Flags de veredito geral

Address

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

Geocode

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

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

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

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 em inglês, o serviço vai retornar essa parte em um idioma alternativo que usa 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 flag google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address.

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

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 sinais de validação, consulte validation_granularity abaixo.

Por exemplo, se o endereço de entrada incluir um número de apartamento específico, o input_granularity 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 validation_granularity provavelmente será PREMISE ou menor.

Granularity

O nível de granularidade em que a API pode validar o endereço. Por exemplo, um validation_granularity 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.

Granularity

Informações sobre a granularidade do geocode. Isso pode ser entendido como o significado semântico de quão grosseiro ou preciso é o local geocodificado.

Isso pode ser diferente do validation_granularity 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, o validation_granularity será SUB_PREMISE, mas o geocode_granularity será PREMISE.

bool

O endereço é considerado completo se não houver tokens não resolvidos, componentes de endereço inesperados ou ausentes. Se não for definido, indica que o valor é false. Consulte os campos missing_component_types, unresolved_tokens ou unexpected para mais detalhes.

bool

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.

bool

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.

bool

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