Address Validation API มีเนื้อหาการตอบกลับในรูปแบบ JSON ที่มีพร็อพเพอร์ตี้ระดับบนสุด 2 รายการ ได้แก่
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
ซึ่งระบุ
รายละเอียดขององค์ประกอบ หรือส่วนประกอบของที่อยู่ที่
API การตรวจสอบที่อยู่ได้รับการประมวลผลแล้ว API จะระบุคอมโพเนนต์แต่ละรายการ
จะแสดงตามชื่อ ประเภท และระดับการยืนยัน
โปรดดู addressComponent ในคู่มืออ้างอิง |
พร็อพเพอร์ตี้ geocode
คุณสมบัติ geocode
ระบุตำแหน่งที่มีรหัสพิกัดภูมิศาสตร์ที่เชื่อมโยงกับอินพุต
ที่อยู่ ที่พักนี้จะให้รายละเอียดเกี่ยวกับตัวสถานที่ตั้ง เช่น
รหัสสถานที่
ดู Geocode ในคู่มืออ้างอิง |
พร็อพเพอร์ตี้ metadata
พร็อพเพอร์ตี้นี้อาจไม่ได้ป้อนข้อมูลให้กับทุกที่อยู่ที่ประมวลผลโดย Address Validation API แต่หากที่อยู่เป็นประเภทที่พักอาศัย ธุรกิจ หรือตู้ ปณ.
ดูความครอบคลุมของ Address Validation API และข้อมูลอ้างอิงสำหรับ Address metadata
|
พร็อพเพอร์ตี้ uspsData
พร็อพเพอร์ตี้นี้ให้ข้อมูลที่เป็นประโยชน์สำหรับที่อยู่ไปรษณีย์ในสหรัฐอเมริกา
อย่างไรก็ตาม เราไม่รับประกันว่าจะมีการใส่ข้อมูลที่สมบูรณ์สำหรับทุกที่อยู่ที่ตรวจสอบความถูกต้อง
บริการ ด้วยเหตุนี้ คุณจึงไม่ควรพึ่งพาพร็อพเพอร์ตี้นี้เป็น
วิธีเดียวคือการตรวจสอบที่อยู่ แต่ควรตรวจสอบ verdict
และ
address
เช่นกัน
โปรดดูหัวข้อจัดการที่อยู่ในสหรัฐอเมริกาและข้อมูลอ้างอิงสำหรับ UspsData
|