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