Índice
AddressValidation
(interface)Address
(mensagem)AddressComponent
(mensagem)AddressComponent.ConfirmationLevel
(enum)AddressMetadata
(mensagem)ComponentName
(mensagem)Geocode
(mensagem)LanguageOptions
(mensagem)PlusCode
(mensagem)ProvideValidationFeedbackRequest
(mensagem)ProvideValidationFeedbackRequest.ValidationConclusion
(enum)ProvideValidationFeedbackResponse
(mensagem)UspsAddress
(mensagem)UspsData
(mensagem)ValidateAddressRequest
(mensagem)ValidateAddressResponse
(mensagem)ValidationResult
(mensagem)Verdict
(mensagem)Verdict.Granularity
(enum)
AddressValidation
O serviço de validação de endereços.
ProvideValidationFeedback |
---|
Feedback sobre o resultado da sequência de tentativas de validação. Essa deve ser a última chamada feita após uma sequência de chamadas de validação para o mesmo endereço e deve ser chamada quando a transação for concluída. Ele precisa ser enviado apenas uma vez para a sequência de solicitações |
ValidateAddress |
---|
Valida um endereço. |
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.
Campos | |
---|---|
formatted_address |
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. |
postal_address |
O endereço pós-processado representado como um endereço postal. |
address_components[] |
Lista não ordenada. Os componentes de endereço individuais do endereço formatado e corrigido, junto com as informações de validação. Assim você vai ter 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. |
missing_component_types[] |
Os tipos de componentes que deveriam estar presentes em um endereço de correspondência formatado corretamente, mas que não foram encontrados na entrada, E não puderam ser inferidos. Componentes desse tipo não estão presentes em |
unconfirmed_component_types[] |
Os tipos dos componentes que estão presentes no |
unresolved_tokens[] |
Todos os tokens na entrada que não puderam ser resolvidos. Talvez seja uma entrada que não foi reconhecida como parte válida de um endereço. Por exemplo, em uma entrada como "123235253253 Main St, San Francisco, CA, 94105", os tokens não resolvidos podem parecer |
AddressComponent
Representa um componente de endereço, como uma rua, cidade ou estado.
Campos | |
---|---|
component_name |
O nome desse componente. |
component_type |
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. |
confirmation_level |
Indica o nível de certeza de que o componente está correto. |
inferred |
Indica que o componente não fazia parte da entrada, mas o inferimos para o local do endereço e acreditamos que ele deve ser fornecido para um endereço completo. |
spell_corrected |
Indica uma correção de um erro de digitação no nome do componente. A API nem sempre sinaliza alterações de uma variante de ortografia para outra, como ao alterar "centro" para "centro". Ele também nem sempre sinaliza erros ortográficos comuns, como ao alterar "Amphitheater Pkwy" para "Amphitheatre Pkwy". |
replaced |
Indica que o nome do componente foi substituído por um totalmente diferente. Por exemplo, um CEP incorreto está sendo substituído por um correto para o endereço. Como essa não é uma mudança estética, o componente de entrada foi alterado para outro diferente. |
unexpected |
Indica um componente de endereço que não deve estar presente em um endereço postal da região especificada. Ela foi mantida apenas porque fazia parte da entrada. |
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 |
Não foi possível confirmar esse componente, mas é plausível que ele exista. Por exemplo, um número dentro de um intervalo válido conhecido de números em uma rua em que os números específicos das casas não são conhecidos. |
UNCONFIRMED_AND_SUSPICIOUS |
Este componente não foi confirmado e provavelmente está errado. Por exemplo, um bairro que não se encaixa no restante do endereço. |
AddressMetadata
Os metadados do endereço. Não há garantia de que o metadata
será totalmente preenchido para cada endereço enviado à API Address Validation.
Campos | |
---|---|
business |
Indica que este é o endereço de uma empresa. Se não for definido, indica que o valor é desconhecido. |
po_box |
Indica o endereço de uma caixa postal. Se não for definido, indica que o valor é desconhecido. |
residential |
Indica que é o endereço de uma residência. Se não for definido, indica que o valor é desconhecido. |
ComponentName
Um wrapper para o nome do componente.
Campos | |
---|---|
text |
Texto do nome. Por exemplo, "5th Avenue" para o nome da rua ou "1253" para o número da rua. |
language_code |
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 da rua. |
Geocodificação
Contém informações sobre o local no qual a entrada foi geocodificada.
Campos | |
---|---|
location |
A localização geocodificada da entrada. É preferível usar IDs de lugar em vez de endereços, coordenadas de latitude/longitude ou Plus Codes. Usar coordenadas ao criar trajetos ou calcular rotas sempre resultará no direcionamento do ponto para a estrada mais próxima dessas coordenadas. Essa não pode ser uma estrada que leve ao destino com rapidez ou segurança 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. |
plus_code |
O Plus Code correspondente ao |
bounds |
Os limites do lugar geocodificado. |
feature_size_meters |
O tamanho do lugar geocodificado, em metros. Essa é outra medida da nitidez da localização geocodificada, mas em tamanho físico e não em significado semântico. |
place_id |
O PlaceID do lugar ao qual esta entrada é geocodificada. Para mais informações sobre IDs de lugares, clique aqui. |
place_types[] |
Os tipos de lugar para os quais a entrada foi geocodificada. Por exemplo, |
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. 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 informações adicionais na resposta.
Campos | |
---|---|
return_english_latin_address |
Prévia: retorne uma |
PlusCode
O Plus Code (http://plus.codes) é uma referência de local com dois formatos: código global que define um 14mx14m (1/8000o de grau) ou retângulo menor e código composto, que substitui o prefixo por um local de referência.
Campos | |
---|---|
global_code |
O código global (completo) do lugar, como "9FWM33GV+HQ", que representa uma área de 1/8.000 por 1/8.000 graus (aproximadamente 14 por 14 metros). |
compound_code |
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. |
ProvideValidationFeedbackRequest
A solicitação para enviar feedback de validação.
Campos | |
---|---|
conclusion |
Obrigatório. O resultado da sequência de tentativas de validação. Se este campo for definido como |
response_id |
Obrigatório. O ID da resposta a que este feedback se destina. 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. |
ValidationConclusion
Os possíveis resultados finais da sequência de solicitações de validação de endereço necessários para validar um endereço.
Enums | |
---|---|
VALIDATION_CONCLUSION_UNSPECIFIED |
Esse valor não é usado. Se o campo ProvideValidationFeedbackRequest.conclusion for definido como VALIDATION_CONCLUSION_UNSPECIFIED , um erro INVALID_ARGUMENT será retornado. |
VALIDATED_VERSION_USED |
A versão do endereço retornado pela API Address Validation foi usada para a transação. |
USER_VERSION_USED |
A versão do endereço informado pelo usuário foi usada para a transação |
UNVALIDATED_VERSION_USED |
Uma versão do endereço inserido após a última tentativa de validação, mas que não foi revalidado, foi usada na transação. |
UNUSED |
A transação foi abandonada, e o endereço não foi usado. |
ProvideValidationFeedbackResponse
Esse tipo não tem campos.
A resposta para o feedback de validação.
A resposta vai ficar vazia se o feedback for enviado.
UspsAddress
Representação do USPS de um endereço nos EUA.
Campos | |
---|---|
first_address_line |
Primeira linha de endereço. |
firm |
Nome da empresa. |
second_address_line |
Segunda linha de endereço. |
urbanization |
Nome da urbanização porto-riquenha. |
city_state_zip_address_line |
Cidade + estado + código postal. |
city |
Nome da cidade. |
state |
Código de estado de duas letras. |
zip_code |
Código postal, por exemplo, 10009. |
zip_code_extension |
Extensão de quatro dígitos do código postal, por exemplo, 5023. |
UspsData
Os dados do USPS para o endereço. Não é garantido que o uspsData
será totalmente preenchido para cada endereço dos EUA ou PR enviado à API Address Validation. É recomendável integrar os campos de endereço de backup na resposta se você utilizar uspsData como a parte principal da resposta.
Campos | |
---|---|
standardized_address |
Endereço padronizado do USPS. |
delivery_point_code |
Código do ponto de entrega de dois dígitos |
delivery_point_check_digit |
O dígito de verificação do ponto de entrega. Esse número é adicionado ao final do campo "delivery_point_barcode" de mensagens 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. |
dpv_confirmation |
Os valores possíveis para confirmação de DPV. Retorna um único caractere ou não retorna valor.
|
dpv_footnote |
Notas de rodapé da validação do ponto de entrega. Várias notas de rodapé podem ser agrupadas na mesma string.
|
dpv_cmra |
Indica se o endereço é uma Agência Recebedora de E-mails Comercial (CMRA, na sigla em inglês), uma empresa particular que recebe e-mails de clientes. Retorna um único caractere.
|
dpv_vacant |
Esse lugar está vazio? Retorna um único caractere.
|
dpv_no_stat |
Este é um endereço ativo ou sem estatísticas? 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.
|
dpv_no_stat_reason_code |
Indica o tipo de NoStat. Retorna um código de motivo como int.
|
dpv_drop |
A sinalização indica que os e-mails são entregues a um único recepcionável em um site. Retorna um único caractere.
|
dpv_throwback |
Indica que a correspondência não é entregue no endereço. Retorna um único caractere.
|
dpv_non_delivery_days |
A sinalização indica que a entrega de e-mails não é realizada todos os dias da semana. Retorna um único caractere.
|
dpv_non_delivery_days_values |
Número inteiro que identifica os dias de não entrega. Ele pode ser interrogado usando bit flags: 0x40 – Domingo é um dia de não entrega 0x20 – Segunda é 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 – Sábado é um dia de não entrega 0x02 – Sábado é um dia de não entrega 0x08 |
dpv_no_secure_location |
A flag indica que a porta está acessível, mas o pacote não será deixado por motivos de segurança. Retorna um único caractere.
|
dpv_pbsa |
Indica que o endereço corresponde ao registro do PBSA. Retorna um único caractere.
|
dpv_door_not_accessible |
A sinalização indica os endereços onde o USPS não pode bater em uma porta para entregar correspondências. Retorna um único caractere.
|
dpv_enhanced_delivery_code |
Indica que mais de um código de retorno DPV é válido para o endereço. Retorna um único caractere.
|
carrier_route |
O código de rota da transportadora. 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:
|
carrier_route_indicator |
Indicador de classificação da taxa de rota da transportadora. |
ews_no_match |
O endereço de entrega é compatível, mas o arquivo EWS indica que uma correspondência exata estará disponível em breve. |
post_office_city |
Principal cidade dos correios. |
post_office_state |
Estado da agência dos correios principal. |
abbreviated_city |
Cidade abreviada. |
fips_county_code |
o código do condado FIPS. |
county |
Nome do condado. |
elot_number |
Número da Linha de Viagem melhorada (eLOT, na sigla em inglês). |
elot_flag |
Bandeira crescente/decrescente eLOT (A/D). |
lacs_link_return_code |
Código de devolução LACSLink. |
lacs_link_indicator |
Indicador LACSLink. |
po_box_only_postal_code |
CEP apenas por caixa postal. |
suitelink_footnote |
Notas de rodapé que associam um registro da rua ou de um arranha-céu a informações da sala. Se o nome da empresa for correspondente, o número secundário vai ser retornado.
|
pmb_designator |
Designador de unidade de PMB (Private Mail Box). |
pmb_number |
Número do PMB (Private Mail Box) |
address_record_type |
Tipo do registro de endereço que corresponde ao endereço de entrada.
|
default_address |
Indicador de que um endereço padrão foi encontrado, mas existem endereços mais específicos. |
error_message |
Mensagem de erro para recuperação de dados USPS. Ele é preenchido quando o processamento do 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. |
cass_processed |
Indicador de que a solicitação foi processada pelo CASS. |
ValidateAddressRequest
Solicitação para validar um endereço.
Campos | |
---|---|
address |
Obrigatório. O endereço que está sendo validado. Endereços não formatados devem ser enviados por O tamanho total dos campos nessa entrada não pode exceder 280 caracteres. As regiões disponíveis podem ser encontradas aqui. O valor A API Address Validation ignora os valores em |
previous_response_id |
Este campo precisa estar vazio na 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 |
enable_usps_cass |
Ativa o modo compatível com USPS CASS. Isso afeta apenas o campo É recomendável usar um |
language_options |
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. 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 informações adicionais na resposta. |
session_token |
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 seleciona um lugar e faz uma chamada para Place Details ou Address Validation. Cada sessão pode ter várias consultas do Autocomplete, seguidas por uma solicitação do Place Details ou do 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 deixa de ser válido; seu aplicativo deve gerar um novo token para cada sessão. Se o parâmetro Observação: a validação de endereço 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 saber mais detalhes. |
ValidateAddressResponse
A resposta a uma solicitação de validação de endereço.
Campos | |
---|---|
result |
O resultado da validação de endereço. |
response_id |
O UUID que identifica essa resposta. Se o endereço precisar ser validado novamente, esse UUID precisa acompanhar a nova solicitação. |
ValidationResult
O resultado da validação de um endereço.
Campos | |
---|---|
verdict |
Sinalizações gerais de veredito |
address |
Informações sobre o endereço em si, não o geocódigo. |
geocode |
Informações sobre o local e o local para o qual o endereço foi geocodificado. |
metadata |
Outras informações relevantes para a capacidade de entrega. Não há garantia de que o |
usps_data |
Sinalizações de entrega extra fornecidas pelo USPS. Fornecido somente nas regiões |
english_latin_address |
Pré-lançamento: esse recurso está em pré-lançamento (pré-GA). Os produtos e recursos em pré-GA têm suporte limitado, e é possível que as mudanças neles não sejam compatíveis com outras versões nessa fase. Todos os produtos em pré-GA são cobertos pelos Termos de Serviço específicos da Plataforma Google Maps. Para mais informações, consulte as descrições da fase de lançamento. O endereço traduzido para o inglês. Endereços traduzidos não são reutilizáveis como entrada da API. O serviço as 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 retornará essa parte em um idioma alternativo que usa script latino. Clique aqui para 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 use script latino, o serviço retornará essa parte no idioma local associado ao endereço. Ative essa saída usando a sinalização Observação: o campo |
Veredito
Visão geral de alto nível do resultado da validação de endereço e do geocódigo.
Campos | |
---|---|
input_granularity |
A granularidade do endereço input. 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 Por exemplo, se o endereço de entrada incluir um número de apartamento específico, |
validation_granularity |
O nível de granularidade em que a API pode validate totalmente o endereço. Por exemplo, um O resultado da validação de componente por endereço pode ser encontrado em |
geocode_granularity |
Informações sobre a granularidade de Às vezes, ele pode ser diferente do |
address_complete |
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, indica que o valor é |
has_unconfirmed_components |
Pelo menos um componente de endereço não pode ser categorizado ou validado. Consulte |
has_inferred_components |
Pelo menos um componente de endereço foi inferido (adicionado) que não estava na entrada. Consulte |
has_replaced_components |
Pelo menos um componente de endereço foi substituído. Consulte |
Granularidade
As várias granularidades que um endereço ou geocódigo pode ter. Quando usados para indicar a granularidade de um endereço, esses valores indicam com que granularidade o endereço identifica um destino de correspondência. Por exemplo, um endereço como "123 Main Street, Redwood City, CA, 94061" identifica uma PREMISE
, enquanto algo como "Redwood City, CA, 94061" identifica uma 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 de 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 se aproxima da localização no nível do edifício do endereço. |
BLOCK |
O endereço ou geocódigo indica um bloco. Usado apenas em regiões que têm endereçamento no nível do bloco, como o Japão. |
ROUTE |
O geocódigo ou endereço é granular para um trajeto, como uma rua, estrada ou rodovia. |
OTHER |
Todas as outras granularidades, agrupadas porque não podem ser entregues. |