Address Validation API는 응답 본문을 2개의 최상위 수준 속성이 포함된 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로 전송된 주소에서 캡처된 세부정보 수준을 설명합니다. 요청의 주소 세부정보 수준은 유효성 검사 응답의 주소 세부정보 수준에 영향을 미칩니다. 예를 들어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 Validation API가 처리한 주소의 요소 또는 구성요소의 자세한 목록을 제공하는 address
의 하위 구성요소입니다. API는 제공하는 각 구성요소 필드를 이름, 유형, 확인 수준으로 식별합니다.
참조 가이드의 addressComponent 를 참고하세요. |
geocode
속성
geocode
속성은 입력된 주소와 연결된 지오코딩된 위치를 나타냅니다. 이 속성은 장소 ID와 같이 위치 자체에 관한 세부정보를 제공합니다.
참조 가이드의 Geocode 를 참고하세요. |
metadata
속성
이 속성은 Address Validation API에서 처리되는 모든 주소에 채워지지 않을 수 있지만 주소 유형이 주거지, 비즈니스, 사서함인지를 나타냅니다.
Address Validation API 범위 및 Address metadata 에 대한 참조를 확인하세요.
|
uspsData
속성
이 속성은 미국 우편 주소에 대한 유용한 정보를 제공합니다.
하지만 서비스에서 검증한 모든 주소에 완전히 채워지는 것은 아닙니다. 따라서 이 속성을 사용하여 주소를 검증해서는 안 되며, 대신 verdict
및 address
도 확인해야 합니다.
미국 주소 처리 및 UspsData 참조를 확인하세요.
|