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)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 trình tự 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à phải được gọi sau khi giao dịch kết thúc. Bạn chỉ nên gửi địa chỉ này một lần cho chuỗi yêu cầu |
Xác thực địa chỉ |
---|
Xác thực địa chỉ. |
Address (Địa chỉ)
Thông tin chi tiết về địa chỉ được phân tích cú pháp từ thông tin nhập vào.
Các trường | |
---|---|
formatted_address |
Địa chỉ đã sửa, được định dạng là địa chỉ một dòng tuân theo quy tắc định dạng địa chỉ của khu vực có địa chỉ đó. |
postal_address |
Địa chỉ đã xác thực là địa chỉ gửi thư. |
address_components[] |
Danh sách không theo thứ tự. Các thành phần địa chỉ riêng lẻ của địa chỉ được định dạng và sửa, cùng với thông tin xác thực. Điều này cung cấp thông tin về trạng thái xác thực của các thành phần riêng lẻ. Các thành phần địa chỉ không được sắp xếp theo cách cụ thể. Đừng giả định về thứ tự của các thành phần địa chỉ trong danh sách. |
missing_component_types[] |
Những loại thành phần dự kiến có trong địa chỉ gửi thư được định dạng chính xác nhưng không thể tìm thấy trong dữ liệu đầu vào VÀ không thể dự đoán đượ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[] |
Bất kỳ mã thông báo nào trong dữ liệu đầu vào không thể 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 đầu vào như "123235253253 Main St, San Francisco, CA, 94105", các mã thông báo chưa được phân giải có thể trông giống như |
Thành phần địa chỉ
Biểu thị một thành phần địa chỉ, chẳng hạn như đường phố, thành phố hoặc tiểu bang.
Các trường | |
---|---|
component_name |
Tên cho 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 mà dịch vụ Địa điểm trả về để biết danh sách các loại có thể áp dụng. |
confirmation_level |
Cho biết mức độ chắc chắn mà chúng tôi có để đảm bảo rằng thành phần này là chính xác. |
inferred |
Cho biết rằng thành phần không phải là một phần của thông tin đầu vào, nhưng chúng tôi dự đoán thành phần đó ở vị trí địa chỉ và tin rằng thành phần này nên được cung cấp cho một địa chỉ đầy đủ. |
spell_corrected |
Cho biết cách viết chính tả của tên thành phần bị sửa theo một cách nhỏ, ví dụ: bằng cách chuyển đổi hai ký tự xuất hiện theo thứ tự không chính xác. Điều này cho thấy một thay đổi thẩm mỹ. |
replaced |
Cho biết tên của thành phần đã được thay thế bằng một tên hoàn toàn khác, ví dụ như một mã bưu chính sai được thay thế bằng một mã chính xác cho địa chỉ. Đây không phải là một thay đổi 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ỉ không có khả năng xuất hiện trong địa chỉ bưu điện cho khu vực nhất định. 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 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à có ý nghĩa 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 thành phần này hợp lý. Ví dụ: số nhà trong phạm vi số hợp lệ đã biết trên phố mà số nhà cụ thể không được biết. |
UNCONFIRMED_AND_SUSPICIOUS |
Thành phần này không được xác nhận và có thể không chính xác. Ví dụ: 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ỉ. Chúng tôi không đảm bảo rằng metadata
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 rằng đâ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ì tức là giá trị 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ì tức là giá trị không xác định. |
residential |
Cho biết rằng đây là địa chỉ cư trú. Nếu bạn không đặt chính sách này, thì tức là giá trị không xác định. |
Tên thành phần
Trình bao bọc tên cho thành phần.
Các trường | |
---|---|
text |
Văn bản tên. Ví dụ: "5th Avenue" cho tên đường hoặc "1253" cho số nhà. |
language_code |
Mã ngôn ngữ BCP-47. Điều 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ố nhà. |
Mã địa lý
Chứa thông tin về địa điểm chứa dữ liệu được mã hoá địa lý.
Các trường | |
---|---|
location |
Vị trí được mã hoá địa lý của đầu vào. Ưu tiên sử dụng mã địa điểm hơn là sử dụng địa chỉ, toạ độ 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 điểm được bám vào đường gần nhất với các toạ độ đó. Đây có thể không phải là đường sẽ dẫn tới điểm đến một cách nhanh chóng hoặc an toà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ý ngược, không có gì đảm bảo rằng địa chỉ trả về sẽ khớp với địa chỉ gốc. |
plus_code |
Plus code tương ứng với |
bounds |
Giới hạn của địa điểm được mã hóa địa lý. |
feature_size_meters |
Kích thước của địa điểm được mã hóa địa lý, tính bằng mét. Đây là thước đo khác về độ nhám của vị trí được mã hóa địa lý, nhưng về kích thước thực tế chứ không phải về mặt ngữ nghĩa. |
place_id |
PlaceID của địa điểm mà mục nhập này mã hoá địa lý. Để 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à đầu vào đã mã hoá địa lý. Ví dụ: |
Mã cộng
Plus code (http://plus.codes) là tham chiếu vị trí có hai định dạng: mã toàn cục xác định hình chữ nhật 14mx14m (1/8000 của độ) hoặc 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", đại diện cho khu vực 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ã toàn cầu và thay thế tiền tố bằng tên được định dạng của thực thể tham chiếu. |
Cung cấp Xác thực phản hồi yêu cầu
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 trình tự xác thực. Nếu bạn đặt trường này thành |
response_id |
Bắt buộc. Mã của phản hồi mà phản hồi này được gửi tới. Đây phải là [response_id][google.maps.addressvalidateation.v1.AuthenticationAddressRequest.response_id] trong phản hồi đầu tiên trong một loạt 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 đị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 , hệ thống sẽ trả về lỗi INVALID_ARGUMENT . |
VALIDATED_VERSION_USED |
Phiên bản địa chỉ mà API Xác thực địa chỉ trả về đã được dùng cho giao dịch. |
USER_VERSION_USED |
Phiên bản địa chỉ do người dùng cung cấp được dùng cho giao dịch |
UNVALIDATED_VERSION_USED |
Phiên bản của địa chỉ đã được nhập sau lần xác thực gần nhất nhưng không được xác thực lại đã được sử dụng cho giao dịch. |
UNUSED |
Giao dịch đã bị bỏ qua và địa chỉ không được sử dụng. |
Cung cấp phản hồi xác thực
Phản hồi cho phản hồi xác thực.
Phản hồi 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 đô thị 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 |
Mã bưu chính 4 chữ số, ví dụ: 5023. |
Dataps
Dữ liệu của USPS cho đị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 PR đượ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 trong 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ỉ 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. Mã số này được thêm vào cuối mã Delivery_point_barcode cho thư được quét cơ học. Kết hợp tất cả các chữ số của mã item_point_barcode,delivery_point_check_letter, mã bưu chính và ZIP+4 sẽ tạo ra một số chia hết cho 10. |
dpv_confirmation |
Các giá trị có thể có để xác nhận DPV. Trả về một ký tự.
|
dpv_footnote |
Các chú thích cuối trang từ xác thực điểm phân phối. Nhiều chú thích cuối trang có thể được xâu chuỗi với nhau trong cùng một chuỗi.
|
dpv_cmra |
Cho biết địa chỉ có phải là CMRA (Cơ quan nhận thư thương mại) hay không – một doanh nghiệp tư nhân nhận thư cho khách hàng. Trả về một ký tự.
|
dpv_vacant |
Địa điểm này có trống không? Trả về một ký tự.
|
dpv_no_stat |
Đây không phải là địa chỉ số liệu thống kê hay địa chỉ đang hoạt động? Không có địa chỉ trạng thái nào là địa chỉ không liên tục có người lưu trú hoặc địa chỉ mà USPS không phục vụ. Trả về một ký tự.
|
carrier_route |
Mã tuyến của nhà mạng. Mã bốn ký tự bao gồm một tiền tố chữ cái và một mã chỉ định tuyến đường gồm ba chữ số. Tiền tố:
|
carrier_route_indicator |
Chỉ báo sắp xếp cước phí của hãng vận chuyển. |
ews_no_match |
Địa chỉ giao hàng có thể khớp, nhưng tệp FOLDER chỉ ra rằng địa chỉ này sẽ sớm khớp chính xác. |
post_office_city |
Bưu điện chính của thành phố. |
post_office_state |
Tiểu bang chính của bưu điện. |
abbreviated_city |
Thành phố viết tắt. |
fips_county_code |
Mã hạt FIPS. |
county |
Tên hạt. |
elot_number |
Số Chuyến đi nâng cao (eLOT). |
elot_flag |
eLOT Tăng/giảm cờ (A/D). |
lacs_link_return_code |
Mã trả về LACSLink. |
lacs_link_indicator |
Chỉ báo LACSLink. |
po_box_only_postal_code |
Chỉ mã bưu chính của PO Box. |
suitelink_footnote |
Chú thích cuối trang phù hợp với thông tin đường phố hoặc toà nhà cao tầng. Nếu tìm thấy tên doanh nghiệp trùng khớp, hệ thống sẽ trả về số phụ.
|
pmb_designator |
Nhà 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 một địa chỉ mặc định đã được tìm thấy, nhưng còn có địa chỉ cụ thể hơn. |
error_message |
Thông báo lỗi khi truy xuất dữ liệu USPS. Quy trình này được điền sẵ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. Các trường dữ liệu USPS có thể không được điền sẵn 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 phải gửi các đị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ể tìm thấy các khu vực được hỗ trợ trong phần Câu hỏi thường gặp. 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 cho yêu cầu xác thực địa chỉ đầu tiên. Nếu cần thêm nhiều yêu cầu để xác thực đầy đủ một địa chỉ (ví dụ: nếu những thay đổi mà người dùng thực hiện sau khi xác thực lại lần đầu cần được xác thực lại), thì mỗi yêu cầu tiếp theo phải điề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 sử dụng |
Xác thực địa chỉ phản hồi
Phản hồi cho một 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 |
UUID xác định phản hồi này. Nếu cần xác thực lại địa chỉ, thì UUID này phải đi kèm với yêu cầu mới. |
Xác thực kết quả
Kết quả xác thực địa chỉ.
Các trường | |
---|---|
verdict |
Cờ kết quả chung |
address |
Thông tin về chính địa chỉ đó thay vì mã hoá địa lý. |
geocode |
Thông tin về vị trí và địa điểm mà địa chỉ được mã hóa địa lý. |
metadata |
Thông tin khác liên quan đến việc cung cấp nội dung. Chúng tôi không đảm bảo rằng |
usps_data |
Cờ về khả năng phân phối bổ sung do USPS cung cấp. Chỉ được cung cấp ở khu vực |
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ỉ nhập và không cung cấp bất kỳ tín hiệu xác thực nào. Đối với 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 hoàn toàn địa chỉ. Ví dụ: Bạn có thể tìm thấy kết quả xác thực mỗi thành phần của địa chỉ trong |
geocode_granularity |
Thông tin về độ 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ỉ lạ hoặc bị thiếu. Xem các trường |
has_unconfirmed_components |
Không thể phân loại hay 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 dự đoán (đã thêm) không có trong mục 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 chi tiết khác nhau mà địa chỉ hoặc mã địa lý có thể có. Khi dùng để chỉ báo mức độ chi tiết cho một địa chỉ, các giá trị này cho biết mức độ chi tiết mà địa chỉ nhận dạng đích đến gửi thư. Ví dụ: địa chỉ như "123 Main Street, Redwood City, CA, 94061" xác định PREMISE
trong khi một cái gì đó 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ột mã địa lý cho "123 Main Street" ở Thành phố Redwood, 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 cấp toà nhà, chẳng hạn như căn hộ. |
PREMISE |
Kết quả cấp toà nhà. |
PREMISE_PROXIMITY |
Một mã địa lý phải rất gần với vị trí của địa chỉ ở cấp toà nhà. Chỉ dùng cho mã địa lý và không dùng cho địa chỉ. |
BLOCK |
Địa chỉ hoặc mã địa lý biểu thị một khối. Chỉ được sử 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ỉ chi tiết để định tuyến, chẳng hạn như đường phố, đường phố hoặc đường cao tốc. |
OTHER |
Tất cả các chi tiết khác được nhóm lại với nhau vì không thể phân phối cùng lúc. |