ทำความเข้าใจคำตอบในการตรวจสอบความถูกต้องของที่อยู่พื้นฐาน

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

ดูVerdictในคู่มืออ้างอิง

รายละเอียดของที่อยู่

รายละเอียดที่อยู่หมายถึงระดับของรายละเอียดที่ใช้พิจารณาความเฉพาะเจาะจงของที่อยู่หรือรหัสพิกัดภูมิศาสตร์ ความจำเพาะของที่อยู่ในการตอบกลับ validationGranularity เป็นสัญญาณสำคัญที่บ่งบอกว่าที่อยู่ดังกล่าวจะแสดงผลได้หรือไม่

พร็อพเพอร์ตี้ verdict จะแสดงผลสัญญาณรายละเอียดต่อไปนี้

  • inputGranularity — อธิบายระดับของรายละเอียดที่บันทึกจากที่อยู่ซึ่งส่งไปยัง Address Validation API ระดับรายละเอียดที่อยู่ในคำขอจะส่งผลต่อระดับรายละเอียดที่อยู่ในการตอบกลับการตรวจสอบ ตัวอย่างเช่น โดยทั่วไปแล้ว ที่อยู่ที่มีinputGranularityต่ำกว่าPREMISEจะไม่ส่งผลให้มีvalidationGranularityถึงPREMISE
  • validationGranularity — ระดับความละเอียดที่ Address Validation API สามารถตรวจสอบที่อยู่ได้อย่างเต็มที่ ในกรณีส่วนใหญ่ ระดับความละเอียด PREMISE หรือ SUB_PREMISE บ่งบอกถึงที่อยู่คุณภาพที่มีโอกาสนำส่งได้
  • geocodeGranularity — อธิบายระดับรายละเอียดของรหัสพิกัดทางภูมิศาสตร์ที่เชื่อมโยงกับที่อยู่ เช่น บันทึกของ Google อาจระบุถึงหมายเลขอพาร์ตเมนต์ แต่ไม่ใช่ตําแหน่งที่แน่นอนของอพาร์ตเมนต์นั้นภายในอาคารอพาร์ตเมนต์ขนาดใหญ่ ในกรณีนี้ validationGranularity คือ SUB_PREMISE แต่ geocodeGranularityisPREMISE`
ดูความละเอียดในคู่มืออ้างอิง

ความสมบูรณ์ของที่อยู่

ผลการตรวจสอบจะแสดงพร็อพเพอร์ตี้ addressComplete เป็นสัญญาณสำหรับที่อยู่คุณภาพสูง ซึ่งหมายความว่าไม่มีคอมโพเนนต์ที่ขาดหายไป ไม่ได้รับการแก้ไข หรือที่ไม่คาดคิด

"verdict": {
    "inputGranularity": "PREMISE",
    "validationGranularity": "PREMISE",
    "geocodeGranularity": "PREMISE",
    "addressComplete": true
}

เมื่อที่อยู่ขาดองค์ประกอบ ไม่สามารถแก้ไขได้ หรือมีองค์ประกอบที่ไม่คาดคิด ระบบจะตั้งค่าช่องเป็น false

ดู addressComplete ในส่วนVerdictและที่อยู่ในคู่มืออ้างอิง

คุณภาพของที่อยู่

ช่องที่เป็นไปได้บางช่องจะบ่งบอกถึงปัญหาเกี่ยวกับองค์ประกอบที่อยู่ หรือการปรับองค์ประกอบที่อยู่ เช่น องค์ประกอบที่อยู่ที่อิงตามข้อมูลที่มีอยู่หรือขาดหายไป ตัวอย่างเช่น พร็อพเพอร์ตี้ verdict ต่อไปนี้ระบุที่อยู่ที่มีคอมโพเนนต์ที่ยังไม่ยืนยันและช่อง addressComplete ขาดหายไป

"verdict": {
    "inputGranularity": "PREMISE",
    "validationGranularity": "OTHER",
    "geocodeGranularity": "OTHER",
    "hasUnconfirmedComponents": true,
    "hasInferredComponents": true
}
ดูVerdictในคู่มืออ้างอิง

พร็อพเพอร์ตี้ address และ addressComponent

พร็อพเพอร์ตี้ address จัดรูปแบบที่อยู่ที่ได้รับการประมวลผลซึ่งระบุไว้ในคําขอ พร้อมกับข้อมูลสรุประดับคอมโพเนนต์ของที่อยู่ ซึ่งรวมถึงส่วนที่สะกดผิด ส่วนที่แทนที่ซึ่งไม่ถูกต้อง และส่วนที่หายไปซึ่งอนุมาน

ดู Address ในคู่มืออ้างอิง

พร็อพเพอร์ตี้ addressComponent เป็นคอมโพเนนต์ย่อยของ address ซึ่งแสดงรายการองค์ประกอบหรือคอมโพเนนต์ของที่อยู่โดยละเอียดที่ Address Validation API ประมวลผล API จะระบุช่องคอมโพเนนต์แต่ละช่องตามชื่อ ประเภท และระดับการยืนยัน

ดู addressComponent ในคู่มืออ้างอิง

พร็อพเพอร์ตี้ geocode

พร็อพเพอร์ตี้ geocode ระบุตําแหน่งที่มีการเข้ารหัสภูมิศาสตร์ซึ่งเชื่อมโยงกับที่อยู่ป้อน พร็อพเพอร์ตี้นี้ให้รายละเอียดเกี่ยวกับสถานที่ตั้ง เช่น รหัสสถานที่

ดู Geocode ในคู่มืออ้างอิง

พร็อพเพอร์ตี้ metadata

ระบบอาจไม่ป้อนข้อมูลพร็อพเพอร์ตี้นี้สำหรับที่อยู่ทุกรายการที่ Address Validation API ประมวลผล แต่ระบุได้ว่าที่อยู่นั้นเป็นประเภทที่พักอาศัย ธุรกิจ หรือตู้ ปณ.

ดูความครอบคลุมของ Address Validation API และข้อมูลอ้างอิงสำหรับ Address metadata

พร็อพเพอร์ตี้ uspsData

พร็อพเพอร์ตี้นี้ให้ข้อมูลที่เป็นประโยชน์สำหรับที่อยู่ไปรษณีย์ของสหรัฐอเมริกา อย่างไรก็ตาม เราไม่รับประกันว่าจะมีการเติมข้อมูลไปยังที่อยู่ทั้งหมดที่บริการตรวจสอบ คุณจึงไม่ควรใช้พร็อพเพอร์ตี้นี้เพียงอย่างเดียวในการตรวจสอบที่อยู่ แต่ให้ตรวจสอบ verdict และ address ด้วย

โปรดดูจัดการที่อยู่ของสหรัฐอเมริกาและข้อมูลอ้างอิงสำหรับ UspsData
ก่อนหน้า
ส่งคําขอตรวจสอบที่อยู่
ถัดไป
สร้างตรรกะการตรวจสอบความถูกต้อง