Hiểu phản hồi cơ bản về việc xác thực địa chỉ

Lưu ý: Tài liệu này mô tả các thành phần cơ bản của việc xác thực địa chỉ cho một địa chỉ có chất lượng cao. Để được hướng dẫn cách làm việc với tình huống địa chỉ trong thế giới thực và xây dựng logic xung quanh các câu trả lời phức tạp hơn, hãy xem phần Xây dựng logic xác thực.

API xác thực địa chỉ cung cấp nội dung phản hồi dưới dạng JSON đối tượng chứa hai thuộc tính cấp cao nhất:

• result, một đối tượng thuộc loại 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"
}

Tài liệu này tập trung vào đối tượng result. Để biết thông tin về responseID, hãy xem bài viết Xử lý các địa chỉ đã cập nhật.

Thuộc tính verdict

Lưu ý quan trọng: Sử dụng thuộc tính verdict để nhận bản tóm tắt cơ sở về chất lượng của địa chỉ.

Thuộc tính verdict tóm tắt kết quả xác thực địa chỉ và phải là thuộc tính đầu tiên cần đánh giá khi xây dựng logic kiểm tra địa chỉ. Tài sản có thể trả về nhiều trường, tuỳ thuộc vào chất lượng của địa chỉ đầu ra. Ví dụ: nội dung sau đây cho thấy thuộc tính verdict của một địa chỉ có chất lượng tốt, trả về 4 trường cho yêu cầu cụ thể này:

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

Các phần sau đây tóm tắt tất cả các trường trong thuộc tính verdict.

Xem phần Kết quả trong hướng dẫn tham khảo.

Độ chi tiết của địa chỉ

Mức độ chi tiết của địa chỉ đề cập đến mức độ chi tiết được dùng để xác định tính cụ thể của một địa chỉ hoặc mã địa lý. Đặc điểm về địa chỉ trong Phản hồi của validationGranularity là tín hiệu quan trọng để cho biết một địa chỉ có thể giao hàng.

Thuộc tính verdict trả về các tín hiệu về độ chi tiết sau đây:

• inputGranularity – Mô tả mức độ chi tiết được ghi lại từ địa chỉ được gửi đến Address Validation API. Mức độ chi tiết của địa chỉ trong yêu cầu ảnh hưởng đến mức độ chi tiết của địa chỉ trong phản hồi xác thực. Ví dụ: địa chỉ có inputGranularity dưới PREMISE thường không dẫn đến validationGranularity đến cấp PREMISE.
• validationGranularity — Mức độ chi tiết mà API xác thực địa chỉ có thể xác thực đầy đủ địa chỉ. Trong hầu hết các trường hợp, mức độ chi tiết là PREMISE hoặc SUB_PREMISE cho biết địa chỉ chất lượng có khả năng phân phối được.
• geocodeGranularity – Mô tả mức độ chi tiết của mã địa lý liên kết với địa chỉ. Ví dụ: bản ghi của Google có thể cho biết sự tồn tại của số căn hộ, nhưng không phải là vị trí chính xác của số đó một căn hộ cụ thể trong một tổ hợp chung cư lớn. Trong trường hợp đó, validationGranularity là SUB_PREMISE nhưng geocodeGranularityisPREMISE`.

Xem Độ chi tiết trong hướng dẫn tham khảo.

Tính đầy đủ của địa chỉ

Kết quả trả về thuộc tính addressComplete dưới dạng tín hiệu cho địa chỉ chất lượng cao, nghĩa là cụ thể là không bị thiếu địa chỉ nào, thành phần chưa được giải quyết hoặc không mong muốn:

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

Khi địa chỉ thiếu thành phần, chưa được giải quyết hoặc không mong muốn, trường này được đặt thành false.

Lưu ý: Khi thuộc tính addressComplete không xuất hiện trong kết quả sau khi kiểm tra thủ công, giá trị của thuộc tính này sẽ là sai. Tuỳ thuộc vào chương trình của bạn bạn sẽ truy vấn kết quả về sự hiện diện của addressComplete thuộc tính hoặc truy vấn trực tiếp thuộc tính đó. Hãy xem phần Chất lượng địa chỉ bên dưới để biết ví dụ.

Xem addressComplete trong phần Kết quả và Địa chỉ trong hướng dẫn tham khảo.

Chất lượng địa chỉ

Một số trường có thể cho biết các vấn đề về thành phần địa chỉ hoặc các điều chỉnh đối với các thành phần đó, chẳng hạn như thành phần địa chỉ bị thiếu hoặc được suy luận. Để Ví dụ: thuộc tính verdict sau đây cho biết một địa chỉ chưa được xác nhận thành phần và trường addressComplete bị thiếu:

"verdict": {
    "inputGranularity": "PREMISE",
    "validationGranularity": "OTHER",
    "geocodeGranularity": "OTHER",
    "hasUnconfirmedComponents": true,
    "hasInferredComponents": true
}

Xem phần Kết quả trong hướng dẫn tham khảo.

Các thuộc tính address và addressComponent

Lưu ý quan trọng: Hãy sử dụng thuộc tính address để có được định dạng địa chỉ. Sử dụng thành phần phụ addressComponent để điều tra lỗi và cung cấp thông tin về những lỗi đó cho khách hàng. Tuy nhiên, đừng tạo để dựa vào mức độ xác nhận cụ thể cho các thành phần địa chỉ. Hãy xem phần Tạo logic xác thực để biết hướng dẫn tích hợp.

Thuộc tính address cung cấp định dạng cho địa chỉ đã xử lý được cung cấp trong yêu cầu, cùng với bản tóm tắt cấp thành phần của địa chỉ, bao gồm cả các phần bị sai chính tả của địa chỉ, các phần bị thay thế không chính xác và các phần bị thiếu được suy luận.

Hãy xem Address trong hướng dẫn tham khảo.

Thuộc tính addressComponent là một thành phần phụ của address, cung cấp danh sách chi tiết các phần tử hoặc thành phần của địa chỉ mà API Xác thực địa chỉ đã xử lý. API xác định từng thành phần cung cấp theo tên, loại và mức độ xác nhận.

Xem addressComponent trong hướng dẫn tham khảo.

Thuộc tính geocode

Lưu ý quan trọng: Hãy sử dụng thuộc tính geocode để thuận tiện cho việc lấy mã địa lý hoặc mã địa điểm khi logic của bạn trước đây được gọi là API mã hoá địa lý.

Thuộc tính geocode cho biết vị trí được mã hoá địa lý liên kết với địa chỉ đầu vào. Thuộc tính này cung cấp thông tin chi tiết về chính vị trí đó, chẳng hạn như mã địa điểm.

Xem Geocode trong hướng dẫn tham khảo.

Thuộc tính metadata

Lưu ý quan trọng: Sử dụng thuộc tính metadata để xác định loại tài sản liên kết với địa chỉ: nhà ở, hộp thư bưu điện hoặc doanh nghiệp.

Thuộc tính này có thể không được điền sẵn cho mọi địa chỉ do Address Validation API xử lý, nhưng cho biết địa chỉ đó thuộc loại nhà ở, doanh nghiệp hay hộp thư bưu điện.

Xem phạm vi của Address Validation API và tài liệu tham khảo cho Address metadata.

Thuộc tính uspsData

Lưu ý quan trọng: Sử dụng thuộc tính uspsData để nhận mức độ tin cậy về việc phân phối và các thông tin chi tiết khác của USPS về địa chỉ ở Hoa Kỳ.

Thuộc tính này cung cấp thông tin hữu ích cho địa chỉ bưu chính ở Hoa Kỳ. Tuy nhiên, nó không đảm bảo sẽ được điền đầy đủ cho mọi địa chỉ được xác thực dịch vụ. Do đó, bạn không nên coi thuộc tính này là duy nhất có nghĩa là xác thực địa chỉ, nhưng thay vào đó hãy kiểm tra verdict và address.

Xem phần Xử lý địa chỉ ở Hoa Kỳ và tài liệu tham khảo về UspsData.