A API Address Validation fornece um corpo de resposta como um objeto JSON que contém duas propriedades de nível superior:
result
, um objeto do tipoValidationResult
responseID
{
"result": {
// Validation verdict.
"verdict": {},
// Address details determined by the API.
"address": {},
// The geocode generated for the input address.
"geocode": {},
// Information indicating if the address is a business, residence, etc.
"metadata": {},
// Information about the address from the US Postal Service
// ("US" and "PR" addresses only).
"uspsData": {},
},
// A unique identifier generated for every request to the API.
"responseId": "ID"
}
Este documento se concentra no objeto result
. Para informações sobre o
responseID
, consulte Processar endereços atualizados.
A propriedade verdict
A propriedade verdict
resume os resultados da validação de endereço e
precisa ser a primeira propriedade a ser avaliada ao criar a lógica de verificação de endereço.
A propriedade pode retornar vários campos, dependendo da qualidade do endereço de saída. Por exemplo, o exemplo a seguir mostra a propriedade verdict
de um endereço de boa qualidade, que retorna quatro campos para essa solicitação específica:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"addressComplete": true
}
As seções a seguir resumem todos os campos na propriedade verdict
.
Consulte Verdict no guia de referência. |
Granularidade do endereço
A granularidade do endereço se refere ao nível de detalhes usado para determinar a especificidade de um endereço ou geocódigo. A especificidade do endereço na
resposta validationGranularity
é um indicador importante para saber se um endereço
pode ser entregue.
A propriedade verdict
retorna estes indicadores de granularidade:
inputGranularity
: descreve o nível de detalhes capturado do endereço enviado para a API Address Validation. O nível de detalhes do endereço na solicitação influencia o nível de detalhes do endereço na resposta de validação. Por exemplo, um endereço com uminputGranularity
abaixo do nívelPREMISE
normalmente não resulta em um nívelvalidationGranularity
para um nívelPREMISE
.validationGranularity
: o nível de granularidade em que a API Address Validation pode validar totalmente o endereço. Na maioria dos casos, um nível de granularidade dePREMISE
ouSUB_PREMISE
indica um endereço de qualidade que provavelmente pode ser entregue.geocodeGranularity
: descreve o nível de detalhe do geocódigo associado ao endereço. Por exemplo, os registros do Google podem indicar a existência de um número de apartamento, mas não um local preciso para esse apartamento específico em um grande complexo. Nesse caso, ovalidationGranularity
éSUB_PREMISE
, mas ogeocodeGranularity
is
PREMISE`.
Consulte Granularidade no guia de referência. |
Completude do endereço
O veredito retorna a propriedade addressComplete
como um indicador de um
endereço de alta qualidade, o que significa especificamente que ele não tem componentes ausentes,
não resolvidos ou inesperados:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"addressComplete": true
}
Quando o endereço tem componentes ausentes, não resolvidos ou inesperados, o campo
é definido como false
.
Consulte addressComplete em
Verdict e
Address no guia de referência. |
Qualidade do endereço
Vários campos possíveis indicam problemas com componentes de endereço ou ajustes neles, como componentes de endereço inferidos ou ausentes. Por
exemplo, a propriedade verdict
a seguir indica um endereço com componentes não confirmados
e um campo addressComplete
ausente:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "OTHER",
"geocodeGranularity": "OTHER",
"hasUnconfirmedComponents": true,
"hasInferredComponents": true
}
Consulte Verdict no guia de referência. |
As propriedades address
e addressComponent
A propriedade address
fornece formatação para o endereço processado fornecido na
solicitação, além de resumos do endereço no nível do componente, incluindo
partes do endereço com erros ortográficos, partes incorretas substituídas e partes ausentes inferidas.
Consulte Address no guia de referência. |
A propriedade addressComponent
é um subcomponent de address
, que fornece
uma lista detalhada dos elementos ou componentes do endereço que a
API Address Validation processou. A API identifica cada campo
de componente pelo nome, tipo e nível de confirmação.
Consulte addressComponent no guia de referência. |
A propriedade geocode
A propriedade geocode
indica o local geocodificado associado ao endereço de entrada. Essa propriedade fornece detalhes sobre o local, como o ID do lugar.
Consulte Geocode no guia de referência. |
A propriedade metadata
Essa propriedade pode não ser preenchida para todos os endereços processados pela API Address Validation, mas indica se o endereço é residencial, comercial ou uma caixa postal.
Consulte a cobertura da API Address Validation e a referência para Address metadata .
|
A propriedade uspsData
Essa propriedade fornece informações úteis para endereços postais dos Estados Unidos.
No entanto, não há garantia de que ele será preenchido totalmente para todos os endereços validados
pelo serviço. Por esse motivo, não confie nessa propriedade como a
única forma de validar endereços. Em vez disso, verifique também o verdict
e
o address
.
Consulte Processar endereços dos Estados Unidos e a referência de UspsData .
|