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

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 แต่อยู่ใน geocodeGranularityisPREMISE
โปรดดู รายละเอียด ในคู่มืออ้างอิง

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

ผลการตรวจสอบจะแสดงพร็อพเพอร์ตี้ 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 ระบุตําแหน่งที่มีการเข้ารหัสภูมิศาสตร์ซึ่งเชื่อมโยงกับที่อยู่ป้อน พร็อพเพอร์ตี้นี้ให้รายละเอียดเกี่ยวกับสถานที่ตั้ง เช่น รหัสสถานที่

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

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

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

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

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

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

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