Chỉ mục
AddressValidation
(giao diện)Address
(thông báo)AddressComponent
(thông báo)AddressComponent.ConfirmationLevel
(enum)AddressMetadata
(thông báo)ComponentName
(thông báo)Geocode
(thông báo)LanguageOptions
(thông báo)PlusCode
(thông báo)ProvideValidationFeedbackRequest
(thông báo)ProvideValidationFeedbackRequest.ValidationConclusion
(enum)ProvideValidationFeedbackResponse
(thông báo)UspsAddress
(thông báo)UspsData
(thông báo)ValidateAddressRequest
(thông báo)ValidateAddressResponse
(thông báo)ValidationResult
(thông báo)Verdict
(thông báo)Verdict.Granularity
(enum)
Xác thực địa chỉ
Dịch vụ xác thực địa chỉ.
Cung cấp phản hồi xác thực |
---|
Phản hồi về kết quả của chuỗi các lần xác thực. Đây phải là lệnh gọi cuối cùng được thực hiện sau một chuỗi các lệnh gọi xác thực cho cùng một địa chỉ và nên được gọi khi giao dịch kết thúc. Bạn chỉ nên gửi mã này một lần cho một chuỗi |
Xác thực địa chỉ |
---|
Xác thực địa chỉ. |
Address (Địa chỉ)
Chi tiết về địa chỉ sau khi xử lý. Xử lý hậu kỳ bao gồm sửa các phần sai chính tả của địa chỉ, thay thế các phần không chính xác và suy luận các phần bị thiếu.
Các trường | |
---|---|
formatted_address |
Địa chỉ được xử lý sau, được định dạng là địa chỉ một dòng theo quy tắc định dạng địa chỉ của khu vực nơi đặt địa chỉ đó. |
postal_address |
Địa chỉ xử lý sau khi xử lý được thể hiện dưới dạng địa chỉ bưu điện. |
address_components[] |
Danh sách không theo thứ tự. Thành phần địa chỉ riêng lẻ của địa chỉ đã định dạng và sửa, cùng với thông tin xác thực. Thao tác này cung cấp thông tin về trạng thái xác thực của từng thành phần riêng lẻ. Các thành phần của địa chỉ không được sắp xếp theo một cách cụ thể. Đừng đưa ra bất kỳ giả định nào về thứ tự của các thành phần địa chỉ trong danh sách. |
missing_component_types[] |
Loại thành phần dự kiến sẽ xuất hiện trong địa chỉ gửi thư được định dạng chính xác nhưng không được tìm thấy trong dữ liệu đầu vào VÀ không thể suy ra được. Các thành phần thuộc loại này không có trong |
unconfirmed_component_types[] |
Các loại thành phần có trong |
unresolved_tokens[] |
Mọi mã thông báo trong dữ liệu nhập mà không phân giải được. Đây có thể là dữ liệu đầu vào không được nhận dạng là một phần hợp lệ của địa chỉ (ví dụ: trong dữ liệu nhập chẳng hạn như "123235253253 Main St, San Francisco, CA, 94105", mã thông báo chưa được phân giải có thể có dạng |
AddressComponent
Đại diện cho một thành phần địa chỉ, chẳng hạn như đường, thành phố hoặc tiểu bang.
Các trường | |
---|---|
component_name |
Tên của thành phần này. |
component_type |
Loại thành phần địa chỉ. Xem Bảng 2: Các loại bổ sung được dịch vụ Địa điểm trả về để biết danh sách các loại có thể có. |
confirmation_level |
Cho biết mức độ chắc chắn mà chúng tôi có rằng thành phần là chính xác. |
inferred |
Cho biết rằng thành phần này không có trong dữ liệu nhập, nhưng chúng tôi suy luận thành phần đó cho vị trí của địa chỉ và cho rằng thành phần này nên được cung cấp cho một địa chỉ đầy đủ. |
spell_corrected |
Chỉ ra lần sửa lỗi chính tả trong tên thành phần. API không phải lúc nào cũng gắn cờ các thay đổi giữa các biến thể chính tả, chẳng hạn như khi thay đổi "centre" thành "center". Hệ thống cũng không phải lúc nào cũng gắn cờ các lỗi chính tả phổ biến, chẳng hạn như khi thay đổi "Amphitheater Pkwy" thành "Amphitheatre Pkwy". |
replaced |
Cho biết tên của thành phần đã được thay thế bằng một thành phần hoàn toàn khác, ví dụ: một mã bưu chính sai được thay thế bằng một mã đúng với địa chỉ. Đây không phải là thay đổi về mặt thẩm mỹ, thành phần đầu vào đã được thay đổi thành một thành phần khác. |
unexpected |
Cho biết thành phần địa chỉ dự kiến sẽ không xuất hiện trong địa chỉ bưu điện của khu vực đã cho. Chúng tôi chỉ giữ lại dữ liệu này vì đó là một phần của dữ liệu đầu vào. |
Cấp xác nhận
Các giá trị khác nhau có thể có cho các cấp xác nhận.
Enum | |
---|---|
CONFIRMATION_LEVEL_UNSPECIFIED |
Giá trị mặc định. Giá trị này không được sử dụng. |
CONFIRMED |
Chúng tôi có thể xác minh rằng thành phần này tồn tại và hợp lý trong ngữ cảnh của phần còn lại của địa chỉ. |
UNCONFIRMED_BUT_PLAUSIBLE |
Không thể xác nhận thành phần này nhưng có thể chấp nhận được. Ví dụ: số nhà trong một dải số hợp lệ đã biết trên một con phố không xác định số nhà cụ thể. |
UNCONFIRMED_AND_SUSPICIOUS |
Thành phần này chưa được xác nhận và có thể không chính xác. Ví dụ: một vùng lân cận không phù hợp với phần còn lại của địa chỉ. |
Siêu dữ liệu địa chỉ
Siêu dữ liệu cho địa chỉ. metadata
không đảm bảo sẽ được điền đầy đủ cho mọi địa chỉ được gửi đến API xác thực địa chỉ.
Các trường | |
---|---|
business |
Cho biết đây là địa chỉ của một doanh nghiệp. Nếu bạn không đặt chính sách này thì giá trị đó sẽ không xác định. |
po_box |
Cho biết địa chỉ của hộp thư bưu điện. Nếu bạn không đặt chính sách này thì giá trị đó sẽ không xác định. |
residential |
Cho biết đây là địa chỉ của nơi cư trú. Nếu bạn không đặt chính sách này thì giá trị đó sẽ không xác định. |
Tên thành phần
Một trình bao bọc cho tên của thành phần.
Các trường | |
---|---|
text |
Văn bản tên. Ví dụ: "5th Avenue" cho tên đường phố hoặc "1253" cho số nhà. |
language_code |
Mã ngôn ngữ BCP-47. Thuộc tính này sẽ không xuất hiện nếu tên thành phần không liên kết với một ngôn ngữ, chẳng hạn như số đường phố. |
Mã địa lý
Chứa thông tin về nơi mà dữ liệu đầu vào được mã hoá địa lý đến.
Các trường | |
---|---|
location |
Vị trí được mã hoá địa lý của đầu vào. Bạn nên sử dụng mã địa điểm thay vì sử dụng địa chỉ, vĩ độ/kinh độ hoặc mã cộng. Việc sử dụng toạ độ khi định tuyến hoặc tính toán chỉ đường lái xe sẽ luôn dẫn đến việc điểm được bám vào con đường gần nhất với các toạ độ đó. Đây có thể không phải là đường sẽ nhanh chóng hoặc an toàn dẫn đến điểm đến và có thể không gần điểm truy cập vào cơ sở lưu trú. Ngoài ra, khi một vị trí được mã hóa địa lý đảo ngược, chúng tôi không thể đảm bảo rằng địa chỉ trả về sẽ khớp với địa chỉ ban đầu. |
plus_code |
Mã cộng tương ứng với |
bounds |
Các giới hạn của địa điểm được mã hoá địa lý. |
feature_size_meters |
Kích thước của địa điểm được mã hoá địa lý, tính bằng mét. Đây là một phép đo khác về độ thô của vị trí được mã hóa địa lý, nhưng theo kích thước vật lý chứ không phải về ý nghĩa ngữ nghĩa. |
place_id |
Mã địa điểm của nơi nhập mã địa lý này. Để biết thêm thông tin về Mã địa điểm, hãy xem tại đây. |
place_types[] |
(Các) loại địa điểm mà dữ liệu đầu vào được mã hoá địa lý. Ví dụ: |
Tuỳ chọn ngôn ngữ
Bản xem trước: Tính năng này đang ở giai đoạn Xem trước (trước giai đoạn phát hành rộng rãi). Những sản phẩm và tính năng trước giai đoạn phát hành rộng rãi có thể được hỗ trợ hạn chế. Đồng thời, những thay đổi đối với những sản phẩm và tính năng trước giai đoạn phát hành rộng rãi có thể không tương thích với những phiên bản trước giai đoạn phát hành rộng rãi khác. Các Sản phẩm trước giai đoạn phát hành rộng rãi chịu sự điều chỉnh của Điều khoản dịch vụ dành riêng cho Nền tảng Google Maps. Để biết thêm thông tin, hãy xem nội dung mô tả về giai đoạn ra mắt.
Bật Address Validation API (API Xác thực địa chỉ) để đưa thêm thông tin vào phản hồi.
Các trường | |
---|---|
return_english_latin_address |
Bản xem trước: Trả về một |
PlusCode
Mã cộng (http://plus.codes) là một giá trị tham chiếu vị trí có hai định dạng: mã chung xác định hình chữ nhật có kích thước 14mx14m (1/8000 độ) hoặc hình chữ nhật nhỏ hơn và mã phức hợp, thay thế tiền tố bằng vị trí tham chiếu.
Các trường | |
---|---|
global_code |
Mã toàn cầu (đầy đủ) của Địa điểm, chẳng hạn như "9FWM33GV+HQ", biểu thị diện tích 1/8000 x 1/8000 độ (~14 x 14 mét). |
compound_code |
Mã phức hợp của địa điểm, chẳng hạn như "33GV+HQ, Ramberg, Na Uy", chứa hậu tố của mã chung và thay thế tiền tố bằng tên đã định dạng của một thực thể tham chiếu. |
Cung cấp ValidationFeedbackRequest
Yêu cầu gửi phản hồi xác thực.
Các trường | |
---|---|
conclusion |
Bắt buộc. Kết quả của chuỗi các lần thử xác thực. Nếu bạn đặt trường này thành |
response_id |
Bắt buộc. Mã phản hồi của ý kiến phản hồi này. Đây sẽ là [Response_id][google.maps.addressvalidate.v1.ConfirmAddressRequest.response_id] trong phản hồi đầu tiên trong một loạt các lần xác thực địa chỉ. |
Kết luận xác thực
Kết quả cuối cùng có thể có của chuỗi yêu cầu xác thực địa chỉ cần thiết để xác thực một địa chỉ.
Enum | |
---|---|
VALIDATION_CONCLUSION_UNSPECIFIED |
Giá trị này không được sử dụng. Nếu bạn đặt trường ProvideValidationFeedbackRequest.conclusion thành VALIDATION_CONCLUSION_UNSPECIFIED thì hàm INVALID_ARGUMENT sẽ được trả về. |
VALIDATED_VERSION_USED |
Phiên bản của địa chỉ mà API xác thực địa chỉ trả về đã được dùng cho giao dịch này. |
USER_VERSION_USED |
Phiên bản của địa chỉ do người dùng cung cấp đã được sử dụng cho giao dịch |
UNVALIDATED_VERSION_USED |
Một phiên bản của địa chỉ được nhập sau lần xác thực gần đây nhất nhưng chưa được xác thực lại đã được sử dụng cho giao dịch này. |
UNUSED |
Giao dịch đã bị huỷ và địa chỉ không được sử dụng. |
Cung cấp ValidationFeedbackResponse
Loại này không có trường.
Phản hồi cho ý kiến phản hồi về việc xác thực.
Phản hồi sẽ trống nếu phản hồi được gửi thành công.
Địa chỉ Usps
USPS đại diện cho một địa chỉ ở Hoa Kỳ.
Các trường | |
---|---|
first_address_line |
Dòng địa chỉ đầu tiên. |
firm |
Tên công ty. |
second_address_line |
Dòng địa chỉ thứ hai. |
urbanization |
Tên khu vực đô thị của Puerto Rico. |
city_state_zip_address_line |
Thành phố + tiểu bang + mã bưu chính. |
city |
Tên thành phố. |
state |
Mã trạng thái gồm 2 chữ cái. |
zip_code |
Mã bưu chính, ví dụ: 10009. |
zip_code_extension |
Đuôi mã bưu chính gồm 4 chữ số, ví dụ: 5023. |
Dữ liệu USB
Dữ liệu USPS của địa chỉ. Chúng tôi không đảm bảo rằng uspsData
sẽ được điền đầy đủ cho mọi địa chỉ Hoa Kỳ hoặc địa chỉ quan hệ công chúng được gửi đến API xác thực địa chỉ. Bạn nên tích hợp các trường địa chỉ sao lưu vào phản hồi nếu sử dụng USpsData làm phần chính của phản hồi.
Các trường | |
---|---|
standardized_address |
Địa chỉ được chuẩn hoá USPS. |
delivery_point_code |
Mã điểm giao hàng gồm 2 chữ số |
delivery_point_check_digit |
Số kiểm tra của điểm giao hàng. Số này được thêm vào cuối mã giao hàng_point_barcode cho thư được quét bằng máy. Cộng tất cả chữ số của mã vạch giao_hàng, chữ_số_giao_hàng, mã bưu chính và mã ZIP+4 cộng lại sẽ được một số chia hết cho 10. |
dpv_confirmation |
Các giá trị có thể dùng để xác nhận DPV. Trả về một ký tự đơn.
|
dpv_footnote |
Chú thích cuối trang từ tính năng xác thực điểm phân phối. Có thể xâu nhiều chú thích cuối trang với nhau trong cùng một chuỗi.
|
dpv_cmra |
Cho biết địa chỉ đó có phải là CMRA (Đại lý nhận thư thương mại) – một doanh nghiệp tư nhân nhận thư cho khách hàng hay không. Trả về một ký tự đơn.
|
dpv_vacant |
Địa điểm này có bỏ trống không? Trả về một ký tự đơn.
|
dpv_no_stat |
Đây là địa chỉ không có số liệu thống kê hay địa chỉ đang hoạt động? Không có địa chỉ thống kê nào là những địa chỉ không được sử dụng liên tục hoặc là địa chỉ mà USPS không phục vụ. Trả về một ký tự đơn.
|
carrier_route |
Mã tuyến của hãng vận chuyển. Mã 4 ký tự bao gồm tiền tố 1 chữ cái và 3 chữ số cho ký tự chỉ định tuyến đường. Tiền tố:
|
carrier_route_indicator |
Chỉ báo sắp xếp mức phí tuyến đường của hãng vận chuyển. |
ews_no_match |
Địa chỉ gửi có thể khớp nhưng tệp EWS cho biết rằng sẽ sớm có địa chỉ khớp chính xác. |
post_office_city |
Thành phố của bưu điện chính. |
post_office_state |
Tiểu bang của bưu điện chính. |
abbreviated_city |
Thành phố viết tắt. |
fips_county_code |
Mã hạt FIPS. |
county |
Tên hạt. |
elot_number |
Số Tuyến du lịch nâng cao (eLOT). |
elot_flag |
eLOT Cờ tăng dần/Giảm dần (A/D). |
lacs_link_return_code |
Mã trả lại hàng LACSLink. |
lacs_link_indicator |
Chỉ báo LACSLink. |
po_box_only_postal_code |
Mã bưu chính chỉ Hộp thư bưu điện. |
suitelink_footnote |
Chú thích cuối trang từ việc so khớp tên đường phố hoặc bản ghi của các toà nhà cao tầng với thông tin về căn phòng. Nếu tìm thấy tên doanh nghiệp trùng khớp, hệ thống sẽ trả về số điện thoại phụ.
|
pmb_designator |
Người chỉ định đơn vị PMB (Hộp thư riêng). |
pmb_number |
số PMB (Hộp thư riêng); |
address_record_type |
Loại bản ghi địa chỉ khớp với địa chỉ nhập.
|
default_address |
Chỉ báo cho biết đã tìm thấy địa chỉ mặc định, nhưng vẫn có địa chỉ cụ thể hơn. |
error_message |
Thông báo lỗi khi truy xuất dữ liệu USPS. Thông tin này được điền khi quá trình xử lý USPS bị tạm ngưng do phát hiện các địa chỉ được tạo giả tạo. Bạn có thể không điền được các trường dữ liệu USPS khi có lỗi này. |
cass_processed |
Chỉ báo cho biết yêu cầu đã được xử lý CASS. |
ValidationAddressRequest
Yêu cầu xác thực địa chỉ.
Các trường | |
---|---|
address |
Bắt buộc. Địa chỉ đang được xác thực. Bạn nên gửi địa chỉ chưa được định dạng qua Tổng độ dài của các trường trong dữ liệu nhập này không được vượt quá 280 ký tự. Bạn có thể xem các khu vực được hỗ trợ tại đây. Giá trị API xác thực địa chỉ bỏ qua các giá trị trong |
previous_response_id |
Trường này phải để trống đối với yêu cầu xác thực địa chỉ đầu tiên. Nếu cần nhiều yêu cầu hơn để xác thực đầy đủ một địa chỉ (ví dụ: nếu các thay đổi mà người dùng thực hiện sau lần xác thực ban đầu cần được xác thực lại), thì mỗi yêu cầu tiếp theo phải điền sẵn |
enable_usps_cass |
Bật chế độ tương thích với USPS CASS. Điều này chỉ ảnh hưởng đến trường Bạn nên dùng |
language_options |
Không bắt buộc. Bản xem trước: Tính năng này đang ở giai đoạn Xem trước (trước giai đoạn phát hành rộng rãi). Những sản phẩm và tính năng trước giai đoạn phát hành rộng rãi có thể được hỗ trợ hạn chế. Đồng thời, những thay đổi đối với những sản phẩm và tính năng trước giai đoạn phát hành rộng rãi có thể không tương thích với những phiên bản trước giai đoạn phát hành rộng rãi khác. Các Sản phẩm trước giai đoạn phát hành rộng rãi chịu sự điều chỉnh của Điều khoản dịch vụ dành riêng cho Nền tảng Google Maps. Để biết thêm thông tin, hãy xem nội dung mô tả về giai đoạn ra mắt. Bật Address Validation API (API Xác thực địa chỉ) để đưa thêm thông tin vào phản hồi. |
Xác thực địa chỉ phản hồi
Phản hồi cho yêu cầu xác thực địa chỉ.
Các trường | |
---|---|
result |
Kết quả xác thực địa chỉ. |
response_id |
Mã nhận dạng duy nhất (UUID) xác định phản hồi này. Nếu địa chỉ cần được xác thực lại, thì mã nhận dạng duy nhất (UUID) này phải đi kèm với yêu cầu mới. |
Kết quả xác thực
Kết quả của việc xác thực địa chỉ.
Các trường | |
---|---|
verdict |
Cờ kết quả tổng thể |
address |
Thông tin về chính địa chỉ đó chứ không phải mã địa lý. |
geocode |
Thông tin về vị trí và địa điểm mà địa chỉ được mã hoá địa lý. |
metadata |
Thông tin khác liên quan đến khả năng gửi. |
usps_data |
Cờ khả năng phân phối bổ sung do USPS cung cấp. Chỉ được cung cấp ở khu vực |
english_latin_address |
Bản xem trước: Tính năng này đang ở giai đoạn Xem trước (trước giai đoạn phát hành rộng rãi). Những sản phẩm và tính năng trước giai đoạn phát hành rộng rãi có thể được hỗ trợ hạn chế. Đồng thời, những thay đổi đối với những sản phẩm và tính năng trước giai đoạn phát hành rộng rãi có thể không tương thích với những phiên bản trước giai đoạn phát hành rộng rãi khác. Các Sản phẩm trước giai đoạn phát hành rộng rãi chịu sự điều chỉnh của Điều khoản dịch vụ dành riêng cho Nền tảng Google Maps. Để biết thêm thông tin, hãy xem nội dung mô tả về giai đoạn ra mắt. Địa chỉ được dịch sang tiếng Anh. Nếu một phần của địa chỉ không có bản dịch tiếng Anh, dịch vụ sẽ trả về phần đó bằng ngôn ngữ thay thế sử dụng chữ viết Latinh. Hãy xem tại đây để biết nội dung giải thích về cách ngôn ngữ thay thế được chọn. Nếu một phần của địa chỉ không có bất kỳ bản dịch hoặc bản chuyển tự nào trong ngôn ngữ sử dụng hệ thống chữ viết Latinh, thì dịch vụ sẽ trả về phần đó bằng ngôn ngữ địa phương được liên kết với địa chỉ. Bạn đã bật đầu ra này bằng cách sử dụng cờ Lưu ý: trường |
Kết quả
Thông tin tổng quan cấp cao về kết quả xác thực địa chỉ và mã địa lý.
Các trường | |
---|---|
input_granularity |
Mức độ chi tiết của địa chỉ đầu vào. Đây là kết quả của việc phân tích cú pháp địa chỉ đầu vào và không cung cấp bất kỳ tín hiệu xác thực nào. Để biết các tín hiệu xác thực, hãy tham khảo Ví dụ: nếu địa chỉ nhập bao gồm số căn hộ cụ thể, thì |
validation_granularity |
Mức độ chi tiết mà API có thể xác thực đầy đủ địa chỉ. Ví dụ: Bạn có thể tìm thấy kết quả xác thực thành phần theo địa chỉ trong |
geocode_granularity |
Thông tin về mức độ chi tiết của Điều này đôi khi có thể khác với |
address_complete |
Địa chỉ được coi là hoàn chỉnh nếu không có mã thông báo chưa được giải quyết, không có thành phần địa chỉ không mong muốn hoặc bị thiếu. Xem các trường |
has_unconfirmed_components |
Không thể phân loại hoặc xác thực ít nhất một thành phần địa chỉ, hãy xem |
has_inferred_components |
Ít nhất một thành phần địa chỉ được suy ra (được thêm vào) không có trong dữ liệu nhập, hãy xem |
has_replaced_components |
Ít nhất một thành phần địa chỉ đã được thay thế, hãy xem |
Độ chi tiết
Các mức độ chi tiết khác nhau của một địa chỉ hoặc một mã địa lý có thể có. Khi được dùng để cho biết mức độ chi tiết của một địa chỉ, các giá trị này cho biết mức độ chi tiết mà địa chỉ xác định một đích đến gửi thư. Ví dụ: một địa chỉ như "123 Main Street, Redwood City, CA, 94061" xác định PREMISE
, còn địa chỉ như "Redwood City, CA, 94061" xác định LOCALITY
. Tuy nhiên, nếu chúng tôi không thể tìm thấy mã địa lý cho "123 Main Street" tại Redwood City, mã địa lý được trả về có thể có độ chi tiết LOCALITY
mặc dù địa chỉ chi tiết hơn.
Enum | |
---|---|
GRANULARITY_UNSPECIFIED |
Giá trị mặc định. Giá trị này không được sử dụng. |
SUB_PREMISE |
Kết quả dưới mức toà nhà, chẳng hạn như một căn hộ. |
PREMISE |
Kết quả cấp toà nhà. |
PREMISE_PROXIMITY |
Một mã địa lý gần đúng vị trí cấp toà nhà của địa chỉ. |
BLOCK |
Địa chỉ hoặc mã địa lý biểu thị một khối. Chỉ được dùng ở những khu vực có địa chỉ cấp khối, chẳng hạn như Nhật Bản. |
ROUTE |
Mã địa lý hoặc địa chỉ rất chi tiết để xác định tuyến đường, chẳng hạn như đường phố, đường hoặc đường cao tốc. |
OTHER |
Tất cả chi tiết khác được nhóm lại với nhau vì không thể phân phối được. |