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

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,
  "possibleNextAction": "ACCEPT"
}

ส่วนต่อไปนี้จะสรุปช่องทั้งหมดในพร็อพเพอร์ตี้ verdict

ดูคำตัดสินในคู่มืออ้างอิง

การดำเนินการถัดไปที่เป็นไปได้

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

ความละเอียดของที่อยู่

ความละเอียดของที่อยู่หมายถึงระดับรายละเอียดที่ใช้ในการกำหนด ความเฉพาะเจาะจงของที่อยู่หรือรหัสพิกัดภูมิศาสตร์ ความเฉพาะเจาะจงของที่อยู่ใน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,
    "possibleNextAction": "ACCEPT"
}

เมื่อที่อยู่มีคอมโพเนนต์ที่ขาดหายไป แก้ไขไม่ได้ หรือไม่คาดคิด ระบบจะตั้งค่าฟิลด์เป็น 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