Package google.maps.addressvalidation.v1

string

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

PostalAddress

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

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. Isso fornece informações sobre o status de validação dos componentes individuais.

Os componentes de endereço não são ordenados de determinada maneira. Não presuma 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 puderam ser inferidos. Componentes desse tipo não estão presentes em formatted_address, postal_address ou address_components. Por exemplo, ['street_number', 'route'] para uma entrada como "Boulder, Colorado, 80301, USA". Confira a lista de tipos possíveis aqui.

string

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

string

Quaisquer tokens na entrada que não foram resolvidos. Pode ser uma entrada que não foi reconhecida como parte válida de um endereço. Por exemplo, em uma entrada como "123235253253 Main St, San Francisco, CA, 94105", os tokens não resolvidos podem ser semelhantes a ["123235253253"], porque não parece um número de rua válido.

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 uma lista dos possíveis tipos.

ConfirmationLevel

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

bool

Indica que o componente não fazia parte da entrada, mas inferimos que ele é o local do endereço e acreditamos que ele deve 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 ortográfica para outra, como ao mudar "centro" para "centro". Ela também nem sempre sinaliza erros de ortografia comuns, como ao alterar "Amphitheater Pkwy" para "Anfiteatro Pkwy".

bool

Indica que o nome do componente foi substituído por outro completamente diferente, por exemplo, um CEP errado foi substituído por outro que esteja correto no endereço. Essa não é uma mudança estética, o componente de entrada foi alterado para um diferente.

bool

Indica um componente de endereço que não deve estar presente em um endereço postal da região especificada. Nós o retemos apenas porque era parte da entrada.

bool

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

bool

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

bool

Indica que este é o endereço de uma residência. Se não 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 da rua.

string

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

LatLng

O local geocodificado da entrada.

É preferível usar IDs de lugar em vez de usar endereços, coordenadas de latitude/longitude ou Plus Codes. O uso de coordenadas durante o trajeto ou no cálculo de rotas de carro sempre faz com que o ponto seja direcionado para a estrada mais próxima dessas coordenadas. Talvez essa não seja uma estrada que leve ao destino de forma rápida ou segura e não esteja próxima 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

O Plus Code correspondente ao location.

Viewport

Os limites do lugar geocodificado.

float

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

string

O PlaceID do lugar para o qual a entrada é geocodificada.

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

string

Os tipos de lugar para os quais a entrada foi geocodificada. Por exemplo, ['locality', 'political']. A lista completa de tipos pode ser encontrada aqui.

bool

Visualização: retornar um 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", representando uma área de 1/8.000 por 1/8.000 grau (aproximadamente 14 por 14 metros).

string

O código composto do lugar, como "33GV+HQ, Ramberg, Noruega", contendo o sufixo do código global e substituir 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 ele for definido como VALIDATION_CONCLUSION_UNSPECIFIED, será retornado um erro INVALID_ARGUMENT.

string

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

string

Primeira linha de endereço.

string

Nome da empresa.

string

Segunda linha de endereço.

string

Nome de 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 quatro dígitos do código postal, por exemplo, 5023.

UspsAddress

Endereço padronizado da USPS.

string

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

string

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, delivery_point_check_digit, CEP e ZIP+4 gera um número divisível por 10.

string

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

• N: as informações dos números principais e secundários não foram confirmadas pelo DPV.
• 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.
• 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 números principais e secundários.
• Vazio: se a resposta não contiver um valor dpv_confirmation, 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: 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 não correspondente e não obrigatório
• C1: o número secundário não corresponde, mas é obrigatório
• N1: endereço de 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 do endereço de entrada, RR ou HC está ausente
• P3: o número da caixa de entrada, PO, RR ou HC do endereço de entrada é inválido
• F1: endereço de entrada correspondente a um endereço militar
• G1: endereço de entrada correspondente a um endereço geral de entrega
• U1: endereço de entrada correspondente a um CEP exclusivo
• PB: endereço de entrada correspondente ao registro PBSA
• RR: endereço confirmado por DPV com informações do PMB
• R1: endereço confirmado por DPV sem informações do PMB
• R7: registro Carrier Route R777 ou R779
• IA: endereço informado identificado
• TA: número principal que é correspondido com a inclusão de um alfa à direita

string

Indica se o endereço é uma Agência de recebimento de correspondências comerciais (CMRA, na sigla em inglês), ou seja, uma empresa privada que recebe correspondências de clientes. Retorna um único caractere.

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

string

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

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

string

Esse é um endereço sem estatísticas 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

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ências diretamente do USPS, mas são entregues em um local que atende.
• 2: CDS – Endereços que ainda não estão disponíveis para entrega. Por exemplo, uma nova subdivisão em que lotes e números primários foram determinados, mas ainda não existe uma estrutura para ocupação.
• 3: Colisão: endereços que não são confirmados pelo DPV.
• 4: CMZ (faculdade, militar e outros tipos) – ZIP + quatro registros que o USPS incorporou nos 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: secundário obrigatório: o endereço precisa de informações secundárias.

string

A sinalização indica que o e-mail foi entregue a um único receptível em um site. Retorna um único caractere.

• Y: os e-mails são entregues a um único receptível em um site.
• N: o e-mail não é entregue a um único receptível em um local.

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.

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: não há indicação de que a entrega de e-mails não é realizada todos os dias da semana.

int32

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

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 por motivos de segurança.
• N: não há nenhuma indicação de que o pacote não será deixado por questões de segurança.

string

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

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

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: não há 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 por DPV para números principais e secundários.
• N: as informações dos números principais e secundários não foram confirmadas pelo 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 à direita de 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 confirmado, mas atribuído à rota fantasma R777 e R779, e a entrega do USPS não foi fornecida.

string

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

Prefixos:

• C: rota da transportadora (ou da cidade)
• R: trajeto rural
• H: rota de contrato da rodovia
• B: seção de caixas dos correios
• G: unidade de entrega geral

string

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

bool

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

string

Principal cidade dos correios.

string

Estado principal da agência dos correios.

string

Cidade abreviada.

string

Código do condado dos FIPS.

string

Nome do condado.

string

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

string

Bandeira crescente/decrescente do eLOT (A/D).

string

Código de retorno LACSLink.

string

Indicador LACSLink.

bool

Código postal somente para caixa postal.

string

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

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

string

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

string

Número de PMB (caixa de correio privada);

string

Tipo do registro de 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. Trata-se de uma correspondência para um registro de entrega geral.
• H: EDIFÍCIO / APARTAMENTO. Corresponde a um registro de edifício ou apartamento.
• P: CAIXA DE POSTAGEM. Corresponde a uma caixa postal.
• R: RURAL ROUTE ou HIGHWAY CONTRACT: corresponde a um registro de trajeto rural ou de contrato de rodovia, ambos os quais 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.

bool

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

string

Mensagem de erro para a recuperação de dados do USPS. Essa informação é preenchida 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 estiver presente.

bool

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

PostalAddress

Obrigatório. O endereço que está sendo validado. Endereços não formatados devem ser enviados por address_lines.

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

Consulte as regiões compatíveis aqui.

O valor language_code no endereço de entrada é reservado para usos futuros 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. Quaisquer valores nesses campos serão descartados e não serão retornados. Não os defina.

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 mudanças feitas pelo usuário após a validação inicial precisarem ser revalidadas), cada solicitação de acompanhamento vai precisar preencher esse campo com response_id desde a primeira resposta na sequência de validação.

bool

Ativa o modo compatível com CASS do USPS. Isso afeta apenas o campo google.maps.addressvalidation.v1.ValidationResult.usps_data do google.maps.addressvalidation.v1.ValidationResult. Observação: para solicitações com CASS do USPS habilitados para endereços em Porto Rico, um google.type.PostalAddress.region_code de address precisa ser fornecido como "PR", ou um google.type.PostalAddress.administrative_area de address precisa ser fornecido como "Porto Rico" (não diferencia maiúsculas de 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

Opcional. Pré-lançamento: este 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.

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

string

Opcional. 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, será retornado um erro INVALID_MCC.

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 Place Details ou Address Validation é 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 o término 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 (cada solicitação será faturada separadamente).

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

ValidationResult

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

string

O UUID que identifica essa resposta. Caso o endereço precise ser revalidado, esse UUID precisa acompanhar a nova solicitação.

Verdict

Sinalizações 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 o qual o endereço foi geocodificado.

AddressMetadata

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

UspsData

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

Address

Pré-lançamento: este 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.

Endereços traduzidos não são reutilizáveis como entradas de API. O serviço os fornece 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 a retornará em um idioma alternativo que usa script latino. Clique aqui para conferir uma explicação sobre como o idioma alternativo é selecionado. Se parte do endereço não tiver traduções ou transliterações em um idioma que usa script 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 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 fornece sinais de validação. Para indicadores 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 aqui será SUB_PREMISE. Se não conseguirmos fazer a correspondência com o número do apartamento nos bancos de dados ou se o número for inválido, o validation_granularity provavelmente será PREMISE ou menor.

Granularity

O nível de granularidade em que a API pode validate totalmente o endereço. Por exemplo, validation_granularity 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 por componente de endereço pode ser encontrado em google.maps.addressvalidation.v1.Address.address_components.

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.

Às vezes, pode ser diferente do validation_granularity 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 do apartamento dentro de um grande complexo de apartamentos. Nesse caso, a validation_granularity vai ser SUB_PREMISE, mas a geocode_granularity vai ser PREMISE.

bool

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 missing_component_types, unresolved_tokens ou unexpected para saber mais detalhes.

bool

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.

bool

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.

bool

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