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
|