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

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 — ระดับรายละเอียดที่ 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