Address Validation API 提供 JSON 格式的响应正文 对象,该对象包含两个顶级属性:
result
,一个类型为ValidationResult
的对象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"
}
本文档重点介绍 result
对象。有关
responseID
部分,请参阅处理更新后的地址。
verdict
属性
verdict
属性汇总了地址验证和
应该是构建地址检查逻辑时要评估的第一个属性。
该属性可能会返回各种字段,具体取决于
输出地址。例如,以下代码显示了verdict
地址,对于此特定请求,会返回 4 个字段:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"addressComplete": true
}
以下部分总结了 verdict
属性中的所有字段。
请参阅 参考指南中的判定。 |
地址的细化程度
地址精细度是指确定
特定地址或地理编码的具体细节。在
validationGranularity
响应是判断某个地址是否
。
verdict
属性会返回以下粒度信号:
inputGranularity
- 描述从 发送到 Address Validation API 的 IP 地址。在 则会影响验证响应中的地址详情级别。 例如,inputGranularity
低于PREMISE
的某个地址 级别通常不会导致validationGranularity
到PREMISE
。validationGranularity
- 所选 Address Validation API 可以完全验证地址。在大多数情况下, 粒度级别PREMISE
或SUB_PREMISE
表示地址优质 可能能够交付geocodeGranularity
- 说明地理编码的详细程度 与该地址相关联。例如,Google 记录可能会指明 没有公寓号,但不是该门牌号的精确位置 位于大型公寓大楼内的特定公寓。在这种情况下,validationGranularity
为SUB_PREMISE
,但为geocodeGranularity
is
PREMISE`。
请参阅 细化程度 。 |
地址的完整性
判定结果会返回 addressComplete
属性作为
也就是说,该地址不会丢失
未解决或意外的组件:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"addressComplete": true
}
如果地址包含缺失、未解析或意外的组件,则该字段会设置为 false
。
请参阅下方的addressComplete
判定和
地址。 |
地址质量
一些可能的字段指明地址组成部分的问题,或
例如,推断出或缺失的地址组成部分。例如,以下 verdict
属性表示地址包含未经确认的组件且缺少 addressComplete
字段:
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "OTHER",
"geocodeGranularity": "OTHER",
"hasUnconfirmedComponents": true,
"hasInferredComponents": true
}
请参阅参考指南中的判定。 |
address
和 addressComponent
属性
address
属性可为请求中提供的经过处理的地址提供格式设置,以及地址的组件级摘要,包括地址中拼写有误的部分、替换的错误部分,以及推断出的缺失部分。
请参阅参考指南中的 Address 。 |
addressComponent
属性是 address
的子组件,用于提供
外部 IP 地址的
Address Validation API 已处理完毕。API 会标识每个组件
字段按其名称、类型和确认级别提供。
请参阅参考指南中的 addressComponent 。 |
geocode
属性
geocode
属性指示与输入相关联的经过地理编码的位置
地址。此属性提供有关营业地点本身的详细信息,例如
其地点 ID。
请参阅参考指南中的 Geocode 。 |
metadata
属性
系统可能不会为 地址验证 API,但表示地址是否为住宅。 商家或邮政信箱。
请参阅 Address Validation API 覆盖范围以及针对 Address metadata 的参考文档。
|
uspsData
属性
该属性提供美国邮政地址的有用信息。
不过,我们无法保证针对验证的每个地址都完整填充此字段
。因此,您不应依赖此属性,因为
唯一表示验证地址的方法是检查 verdict
和
address
。
请参阅处理美国地址以及 UspsData 的参考文档。
|