- HTTP 요청
- 요청 본문
- 응답 본문
- 우편 주소
- ValidationResult
- 결과
- 세부사항
- 주소
- AddressComponent
- 구성요소 이름
- 확인 수준
- 지오코드
- 위도
- 플러스코드
- 표시 영역
- AddressMetadata
- UspsData
- UspsAddress
주소를 확인합니다.
HTTP 요청
POST https://addressvalidation.googleapis.com/v1:validateAddress
URL은 gRPC 트랜스코딩 구문을 사용합니다.
요청 본문
요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.
JSON 표현 |
---|
{
"address": {
object ( |
필드 | |
---|---|
address |
필수 항목입니다. 유효성 검사 중인 주소입니다. 형식이 지정되지 않은 주소는 이 입력에 있는 필드의 총 길이는 280자(영문 기준) 이하여야 합니다. 지원되는 지역은 FAQ에서 확인할 수 있습니다. 입력 주소의 Address Validation API는 |
previousResponseId |
이 필드는 첫 번째 주소 유효성 검사 요청을 위해 비워 두어야 합니다. 단일 주소를 완전히 검증하기 위해 더 많은 요청이 필요한 경우 (예: 사용자가 초기 유효성 검사 후에 변경한 사항을 다시 검증해야 하는 경우) 각 후속 요청은 유효성 검사 시퀀스의 첫 번째 응답에서 이 필드를 |
enableUspsCass |
USPS CASS 호환 모드를 사용 설정합니다. 이는 구성요소 |
응답 본문
성공할 경우 응답 본문에 다음 구조의 데이터가 포함됩니다.
주소 유효성 검사 요청에 대한 응답입니다.
JSON 표현 |
---|
{
"result": {
object ( |
필드 | |
---|---|
result |
주소 유효성 검사 결과 |
responseId |
이 응답을 식별하는 UUID입니다. 주소를 재검증해야 하는 경우 이 UUID가 새 요청에 포함되어야 합니다. |
PostalAddress
우편 배송 또는 결제 주소와 같은 우편 주소를 나타냅니다. 우편 주소를 입력하면 우편 서비스에서 사서함, 사서함 등으로 상품을 배송할 수 있습니다. 지리적 위치 (도로, 마을, 산)를 모델링하는 것은 아닙니다.
일반적인 사용 방식에서는 프로세스 유형에 따라 사용자 입력을 통해 또는 기존 데이터 가져오기를 통해 주소가 만들어집니다.
주소 입력 / 수정에 관한 조언: - https://github.com/google/libaddressinput과 같은 다국어 지원 주소 위젯을 사용하세요. - 해당 입력란이 사용되는 국가 이외의 지역을 입력 또는 수정할 수 있는 UI 요소가 사용자에게 표시되어서는 안 됩니다.
이 스키마를 사용하는 방법에 대한 자세한 안내는 https://support.google.com/business/answer/6397478을 참조하세요.
JSON 표현 |
---|
{ "revision": integer, "regionCode": string, "languageCode": string, "postalCode": string, "sortingCode": string, "administrativeArea": string, "locality": string, "sublocality": string, "addressLines": [ string ], "recipients": [ string ], "organization": string } |
필드 | |
---|---|
revision |
|
regionCode |
선택사항. 주소의 국가/지역에 해당하는 CLDR 지역 코드입니다. 자세한 내용은 https://cldr.unicode.org/ 및 https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html을 참조하세요. 예: 스위스의 경우 'CH'. 지역 코드가 제공되지 않으면 주소로부터 유추됩니다. 최상의 성능을 위해 지역 코드를 알고 있는 경우 지역 코드를 포함하는 것이 좋습니다. 일관되지 않거나 반복되는 리전이 있으면 성능이 저하될 수 있습니다. 예를 들어 |
languageCode |
입력 주소의 언어 코드는 나중에 사용하도록 예약되어 있으며 오늘 무시됩니다. API는 주소가 위치한 지역의 언어로 주소를 반환합니다. |
postalCode |
선택사항. 주소의 우편번호입니다. 모든 국가에서 우편번호를 사용하거나 우편번호가 있어야 하는 것은 아니지만 사용되는 경우 주소의 다른 부분을 대상으로 추가 유효성 검사가 실행될 수 있습니다 (예: 미국의 주/우편번호 유효성 검사). |
sortingCode |
선택사항. 국가별 추가 정렬 코드입니다. 대부분의 지역에서 사용되지 않습니다. 사용되는 경우 값은 선택적으로 뒤에 숫자 (예: 'CEDEX 7')가 오는 'CEDEX'와 같은 문자열이거나 '섹터 코드'(자메이카), '배송 지역 표시기'(말라위) 또는 '우체국 표시기'(예: 코트디부아르)를 나타내는 숫자만 사용할 수 있습니다. |
administrativeArea |
선택사항. 국가 또는 지역의 우편 주소에 사용되는 최고 행정 구역 단위입니다. 예를 들어 주, 도, 도, 현을 포함할 수 있습니다. 특히 스페인의 경우에는 자치지구가 아닙니다. 예를 들어 '카탈로니아'가 아닌 '바르셀로나'입니다. 많은 국가에서는 우편 주소에 행정 구역을 사용하지 않습니다. 예를 들어 스위스에서는 이 필드를 채우지 않은 상태로 두어야 합니다. |
locality |
선택사항. 일반적으로 주소의 시/군/구 부분을 나타냅니다. 예: 미국 도시, IT 공동체, 영국 포스트 타운. 지역이 잘 정의되지 않거나 이 구조에 잘 맞지 않는 지역에서는 지역을 비워 두고 주소 입력란을 사용합니다. |
sublocality |
선택사항. 주소의 하위 지역입니다. 예를 들어 인근 지역, 자치구, 구일 수 있습니다. |
addressLines[] |
필수 항목입니다. 주소의 하위 수준을 설명하는 구조화되지 않은 주소 입력란입니다. |
recipients[] |
이 필드는 설정하지 마세요. Address Validation API에서는 현재 이 API를 사용하지 않습니다. 현재 API는 이 필드가 설정된 요청을 거부하지 않지만 정보는 삭제되며 응답에서 반환되지 않습니다. |
organization |
이 필드는 설정하지 마세요. Address Validation API에서는 현재 이 API를 사용하지 않습니다. 현재 API는 이 필드가 설정된 요청을 거부하지 않지만 정보는 삭제되며 응답에서 반환되지 않습니다. |
ValidationResult
주소 유효성 검사 결과
JSON 표현 |
---|
{ "verdict": { object ( |
필드 | |
---|---|
verdict |
전체 결과 플래그 |
address |
지오코드가 아닌 주소 자체에 대한 정보입니다. |
geocode |
주소가 지오코딩된 위치 및 장소에 대한 정보입니다. |
metadata |
기타 배송 가능성 관련 정보 Address Validation API에 전송된 모든 주소에는 |
uspsData |
USPS에서 제공하는 추가 제공 항목 플래그입니다. |
결과
주소 유효성 검사 결과 및 지오코딩의 대략적인 개요입니다.
JSON 표현 |
---|
{ "inputGranularity": enum ( |
필드 | |
---|---|
inputGranularity |
입력 주소의 세부사항입니다. 이는 입력 주소를 파싱한 결과이며 유효성 검사 신호를 제공하지 않습니다. 유효성 검사 신호는 아래 예를 들어 입력 주소에 특정 아파트 번호가 포함된 경우 여기서 |
validationGranularity |
API가 주소를 완전히 검증할 수 있는 세부사항 수준입니다. 예를 들어 주소별 구성요소 유효성 검사 결과는 |
geocodeGranularity |
경우에 따라 위의 |
addressComplete |
확인되지 않은 토큰, 예기치 않은 주소 구성요소 또는 누락된 주소 구성요소가 없는 경우 주소가 완전한 것으로 간주됩니다. 자세한 내용은 |
hasUnconfirmedComponents |
하나 이상의 주소 구성요소를 분류하거나 확인할 수 없습니다. 자세한 내용은 |
hasInferredComponents |
입력에 없는 주소 구성요소 중 하나 이상이 추론 (추가)되었습니다. 자세한 내용은 |
hasReplacedComponents |
하나 이상의 주소 구성요소가 대체되었습니다. 자세한 내용은 |
세부사항
주소 또는 지오코드가 가질 수 있는 다양한 세부사항입니다. 주소의 세부사항을 나타내는 데 사용되는 경우 이 값은 주소가 우편 주소를 식별하는 세분화 수준을 나타냅니다. 예를 들어 '123 Main Street, Redwood City, CA, 94061'과 같은 주소는 PREMISE
를 나타내고, 'Redwood City, CA, 94061'은 LOCALITY
을 나타냅니다. 하지만 레드우드 시티에서 '123 Main Street'에 해당하는 지오코드를 찾을 수 없는 경우 주소가 더 상세하더라도 반환된 지오코드는 LOCALITY
입니다.
열거형 | |
---|---|
GRANULARITY_UNSPECIFIED |
기본값 이 값은 사용되지 않습니다. |
SUB_PREMISE |
아파트와 같은 건물 수준 이하의 결과 |
PREMISE |
건물 수준 결과입니다. |
PREMISE_PROXIMITY |
주소의 건물 수준 위치와 매우 가까운 지오코드 지오코딩에만 사용되며 주소에는 사용되지 않습니다. |
BLOCK |
주소 또는 지오코드는 블록을 나타냅니다. 일본과 같이 블록 수준 주소가 있는 지역에서만 사용됩니다. |
ROUTE |
지오코드 또는 주소는 상세하여, 도로, 도로 또는 고속도로와 같이 라우팅합니다. |
OTHER |
다른 모든 세분화는 게재할 수 없기 때문에 버케팅됩니다. |
주소
입력에서 파싱된 주소의 세부정보입니다.
JSON 표현 |
---|
{ "formattedAddress": string, "postalAddress": { object ( |
필드 | |
---|---|
formattedAddress |
주소가 있는 지역의 주소 형식 규칙에 따라 한 줄 형식의 형식으로 된 올바른 주소입니다. |
postalAddress |
우편 주소로 표시된 검증된 주소입니다. |
addressComponents[] |
순서가 지정되지 않은 목록입니다. 유효성 검사 정보와 함께 형식이 지정되고 수정된 주소의 개별 주소 구성요소입니다. 개별 구성요소의 유효성 검사 상태에 대한 정보를 제공합니다. 주소 구성요소는 특정한 방식으로 정렬되지 않습니다. 목록에 있는 주소 구성요소의 순서를 가정하면 안 됩니다. |
missingComponentTypes[] |
올바른 형식의 우편 주소에 있을 것으로 예상되었지만 입력에서 찾을 수 없고 추론할 수 없는 구성요소의 유형입니다. 이 유형의 구성요소는 |
unconfirmedComponentTypes[] |
|
unresolvedTokens[] |
입력에서 확인할 수 없는 토큰입니다. 이는 주소의 유효한 부분으로 인식되지 않는 입력일 수 있습니다 (예: '123235253253 Main St, San Francisco, CA, 94105'와 같이). 확인되지 않은 토큰은 유효한 도로 번호처럼 보이지 않으므로 |
주소 구성요소
주소, 예: 거리, 도시, 주 등
JSON 표현 |
---|
{ "componentName": { object ( |
필드 | |
---|---|
componentName |
이 구성요소의 이름입니다. |
componentType |
주소 구성요소의 유형입니다. 가능한 유형 목록은 표 2: 장소 서비스에서 반환하는 추가 유형을 참고하세요. |
confirmationLevel |
구성요소가 올바르다고 확신하는 정도를 나타냅니다. |
inferred |
구성요소가 입력의 일부는 아님을 나타내지만 주소 위치에 관해 추론했으며 전체 주소에 제공해야 한다고 생각합니다. |
spellCorrected |
예를 들어 잘못된 순서로 표시된 두 문자를 전환하는 등 구성요소 이름의 철자가 약간 수정되었음을 나타냅니다. 이는 외관상의 변화를 나타냅니다. |
replaced |
구성요소의 이름이 완전히 다른 주소로 대체되었음을 나타냅니다. 예를 들어 잘못된 우편번호가 주소에 적합한 우편번호로 대체되었음을 나타냅니다. 이는 외관상의 변화가 아니며 입력 구성요소가 다른 요소로 변경되었습니다. |
unexpected |
지정된 지역의 우편 주소에 있을 것으로 예상되지 않는 주소 구성요소를 나타냅니다. 입력의 일부로만 보관되었습니다. |
구성요소 이름
구성요소 이름의 래퍼입니다.
JSON 표현 |
---|
{ "text": string, "languageCode": string } |
필드 | |
---|---|
text |
이름 텍스트입니다. 예를 들어 도로명은 '5번가', 도로 번호는 '1253'입니다. |
languageCode |
BCP-47 언어 코드입니다. 이 이름은 구성요소 이름이 도로 번호와 같은 언어와 연결되어 있지 않은 경우 나타나지 않습니다. |
확인 수준
확인 수준에 사용할 수 있는 서로 다른 값입니다.
열거형 | |
---|---|
CONFIRMATION_LEVEL_UNSPECIFIED |
기본값 이 값은 사용되지 않습니다. |
CONFIRMED |
이 구성요소가 존재하고 주소의 나머지 부분에서 의미가 있는지 확인할 수 있었습니다. |
UNCONFIRMED_BUT_PLAUSIBLE |
이 구성요소를 확인할 수는 없으나 존재할 가능성이 있습니다. 예를 들어, 특정 주택 번호를 알 수 없는 거리의 알려진 유효한 범위 내의 도로 번호 |
UNCONFIRMED_AND_SUSPICIOUS |
이 구성요소는 확인되지 않았으며 잘못되었을 수 있습니다. 예를 들어 주소의 나머지 부분과 맞지 않는 동네를 예로 들 수 있습니다. |
지오코드
입력이 지오코딩된 장소에 대한 정보를 포함합니다.
JSON 표현 |
---|
{ "location": { object ( |
필드 | |
---|---|
location |
입력의 지오코딩된 위치입니다. 주소, 위도/경도 좌표 또는 플러스 코드보다 장소 ID를 사용하는 것이 좋습니다. 운전경로를 라우팅하거나 운전할 때 좌표를 사용하면 항상 해당 좌표에 가장 가까운 도로에 지점이 맞춰집니다. 이 도로는 목적지로 빠르고 안전하게 이동할 수 있는 도로가 아니며 사유지의 접근 지점과 가까울 수도 없습니다. 또한 위치를 역 지오코딩할 경우 반환된 주소가 원래 위치와 일치한다는 보장은 없습니다. |
plusCode |
|
bounds |
지오코딩된 장소의 경계. |
featureSizeMeters |
지오코딩된 장소의 크기(미터 단위)입니다. 이는 지오코딩된 위치의 대략적 척도이지만 시맨틱 의미가 아닌 실제 크기입니다. |
placeId |
이 입력에서 지오코딩하는 장소의 PlaceID입니다. 장소 ID에 관한 자세한 내용은 여기를 참고하세요. |
placeTypes[] |
입력이 지오코딩된 장소의 유형입니다. 예를 들면 |
LatLng
위도/경도 쌍을 나타내는 객체로 위도와 경도를 나타내는 double의 쌍으로 표현됩니다. 달리 명시되지 않는 한 이 객체는 WGS84 표준을 준수해야 합니다. 값은 정규화된 범위 내에 있어야 합니다.
JSON 표현 |
---|
{ "latitude": number, "longitude": number } |
필드 | |
---|---|
latitude |
위도입니다. 범위는 [-90.0, +90.0]입니다. |
longitude |
경도입니다. 범위는 [-180.0, +180.0]여야 합니다. |
PlusCode
Plus Code(http://plus.codes)는 두 가지 형식으로 된 위치 참조입니다. 14mx14m (도 중 1/8,000도) 이상을 정의하는 전역 코드와 접두어를 참조 위치로 대체하는 복합 코드입니다.
JSON 표현 |
---|
{ "globalCode": string, "compoundCode": string } |
필드 | |
---|---|
globalCode |
장소의 전역(전체) 코드(예: '9FWM33GV+HQ')는 1/8000 x 1/8000도 영역(~14x14미터)을 나타냅니다. |
compoundCode |
'33GV+HQ, 람베르크, 노르웨이'와 같은 장소의 복합 코드. 글로벌 코드의 접미사를 포함하고 접두사를 참조 항목의 이름이 지정된 이름으로 바꿉니다. |
표시 영역
위도 및 경도 표시 영역. 대각선으로 반대인 low
및 high
지점 두 개로 표현됨 표시 영역은 경계가 포함된 닫힌 영역으로 간주됩니다. 위도 경계의 범위는 -90도 이상 90도 이하여야 하며, 경도 경계의 범위는 -180도 이상 180도 이하여야 합니다. 다양한 경우는 다음과 같습니다.
low
=high
이면 표시 영역이 해당 단일 점으로 구성됩니다.low.longitude
>high.longitude
이면 경도 범위가 반전됩니다 (표시 영역은 경도 180도 표시).low.longitude
= -180도,high.longitude
= 180도인 경우 표시 영역에 모든 경도가 포함됩니다.low.longitude
= 180도 및high.longitude
- -180도인 경우 경도 범위가 비어 있습니다.low.latitude
>high.latitude
이면 위도 범위가 비어 있습니다.
low
과 high
는 모두 채워야 하며 표시된 상자는 위 정의에 명시된 대로 비워 둘 수 없습니다. 표시 영역이 비어 있으면 오류가 발생합니다.
예를 들어 이 표시 영역은 뉴욕시를 완전히 둘러쌉니다.
{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }
JSON 표현 |
---|
{ "low": { object ( |
필드 | |
---|---|
low |
필수 항목입니다. 표시 영역의 낮은 지점입니다. |
high |
필수 항목입니다. 표시 영역의 최고점입니다. |
주소 메타데이터
주소의 메타데이터입니다. Address Validation API에 전송된 모든 주소에는 metadata
가 완전히 입력되지 않을 수도 있습니다.
JSON 표현 |
---|
{ "business": boolean, "poBox": boolean, "residential": boolean } |
필드 | |
---|---|
business |
비즈니스의 주소임을 나타냅니다. 설정하지 않으면 값을 알 수 없음을 나타냅니다. |
poBox |
사서함 주소를 나타냅니다. 설정하지 않으면 값을 알 수 없음을 나타냅니다. |
residential |
거주지 주소입니다. 설정하지 않으면 값을 알 수 없음을 나타냅니다. |
USPS 데이터
주소에 대한 USPS 데이터입니다. Address Validation API에 전송되는 모든 미국 또는 PR 주소에 대해 uspsData
이 완전히 채워지지 않을 수도 있습니다. 응답의 기본 부분으로 uspsData를 활용하는 경우 응답에 백업 주소 필드를 통합하는 것이 좋습니다.
JSON 표현 |
---|
{
"standardizedAddress": {
object ( |
필드 | |
---|---|
standardizedAddress |
USPS 표준화된 주소입니다. |
deliveryPointCode |
2자리 배송 코드 |
deliveryPointCheckDigit |
배송 지점 검사 숫자입니다. 이 번호는 기계에서 스캔한 메일의 delivery_point_barcode 끝에 추가됩니다. delivery_point_barcode, deliveryPointCheckDigit, postal code, ZIP+4를 모두 더하면 10의 배수가 생성됩니다. |
dpvConfirmation |
DPV 확인에 사용할 수 있는 값입니다. 단일 문자를 반환합니다.
|
dpvFootnote |
배송 지점 유효성의 각주입니다. 각주를 동일한 문자열에 묶을 수 있습니다.
|
dpvCmra |
주소가 고객 우편을 받는 사업체 (CMRA)인지 나타냅니다. 단일 문자를 반환합니다.
|
dpvVacant |
빈 장소인가요? 단일 문자를 반환합니다.
|
dpvNoStat |
통계 주소가 없거나 유효한 주소인가요? 통계 주소는 계속 사용 중이지 않거나 USPS가 서비스를 제공하지 않는 주소입니다. 단일 문자를 반환합니다.
|
carrierRoute |
운송업체 경로 코드입니다. 1자리 접두어와 3자리 경로 지정자로 구성된 4자리 코드입니다. 접두사:
|
carrierRouteIndicator |
운송업체 배송비 요율 정렬 표시기입니다. |
ewsNoMatch |
배송 주소는 일치할 수 있지만, EWS 파일에도 일치검색이 곧 제공될 예정이라고 표시됩니다. |
postOfficeCity |
주 우체국 도시입니다. |
postOfficeState |
주 우체국 상태 |
abbreviatedCity |
도시 약칭 |
fipsCountyCode |
FIPS 카운티 코드입니다. |
county |
카운티 이름 |
elotNumber |
향상된 이동선 (eLOT) 번호 |
elotFlag |
eLOT 오름차순/내림차순 (A/D) |
lacsLinkReturnCode |
LACSLink 반환 코드입니다. |
lacsLinkIndicator |
LACSLink 표시기 |
poBoxOnlyPostalCode |
사서함 전용 우편번호입니다. |
suitelinkFootnote |
거리 또는 고층 레코드와 스위트 정보를 일치시킬 각주 비즈니스 이름 일치가 발견되면 보조 번호가 반환됩니다.
|
pmbDesignator |
PMB (Private Mail Box) 단위 지정자입니다. |
pmbNumber |
PMB (Private Mail Box) 번호 |
addressRecordType |
입력 주소와 일치하는 주소 레코드의 유형입니다.
|
defaultAddress |
기본 주소를 찾았지만 더 구체적인 주소가 있음을 나타내는 표시기 |
errorMessage |
USPS 데이터 가져오기 오류 메시지 이는 인위적으로 생성된 주소가 감지되어 USPS 처리가 정지된 경우 채워집니다. 이 오류가 있으면 USPS 데이터 필드가 채워지지 않을 수 있습니다. |
cassProcessed |
요청이 CASS 처리되었음을 나타내는 표시기입니다. |
usps 주소
미국 주소의 USPS 표시.
JSON 표현 |
---|
{ "firstAddressLine": string, "firm": string, "secondAddressLine": string, "urbanization": string, "cityStateZipAddressLine": string, "city": string, "state": string, "zipCode": string, "zipCodeExtension": string } |
필드 | |
---|---|
firstAddressLine |
첫 번째 주소 입력란입니다. |
firm |
회사명 |
secondAddressLine |
두 번째 주소 입력란입니다. |
urbanization |
푸에르토리코 도시화 이름입니다. |
cityStateZipAddressLine |
시/도 + 우편번호 |
city |
도시 이름입니다. |
state |
2자리 상태 코드입니다. |
zipCode |
우편번호(예: 10009) |
zipCodeExtension |
4자리 우편번호 확장자(예: 5023)입니다. |