Method: validateAddress

Xác thực địa chỉ.

Yêu cầu HTTP

POST https://addressvalidation.googleapis.com/v1:validateAddress

URL sử dụng cú pháp Chuyển mã gRPC.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON
{
  "address": {
    object (PostalAddress)
  },
  "previousResponseId": string,
  "enableUspsCass": boolean,
  "languageOptions": {
    object (LanguageOptions)
  }
}
Các trường
address

object (PostalAddress)

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 addressLines.

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ị languageCode trong địa chỉ nhập được dành riêng để sử dụng trong tương lai và sẽ bị bỏ qua trong hôm nay. Kết quả địa chỉ đã xác thực sẽ được điền dựa trên ngôn ngữ ưu tiên cho địa chỉ đã cung cấp, như được hệ thống xác định.

API xác thực địa chỉ bỏ qua các giá trị trong recipientsorganization. Mọi giá trị trong các trường đó sẽ bị loại bỏ và không được trả về. Vui lòng không đặt các thông số này.

previousResponseId

string

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 responseId vào trường này bằng responseId ngay từ phản hồi đầu tiên trong trình tự xác thực.

enableUspsCass

boolean

Bật chế độ tương thích với USPS CASS. Điều này chỉ ảnh hưởng đến trường google.maps.addressvalidation.v1.ValidationResult.usps_data của google.maps.addressvalidation.v1.ValidationResult. Lưu ý: Đối với các yêu cầu có hỗ trợ CASS của USPS cho địa chỉ ở Puerto Rico, bạn phải cung cấp google.type.PostalAddress.region_code của address là "PR" hoặc google.type.PostalAddress.administrative_area của address phải được cung cấp là "Puerto Rico" (không phân biệt chữ hoa chữ thường) hoặc "PR".

Bạn nên dùng address được hợp thành phần hoặc chỉ định ít nhất 2 google.type.PostalAddress.address_lines, trong đó dòng đầu tiên chứa số và tên đường phố, còn dòng thứ hai chứa thành phố, tiểu bang và mã bưu chính.

languageOptions

object (LanguageOptions)

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.

Nội dung phản hồi

Phản hồi cho yêu cầu xác thực địa chỉ.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON
{
  "result": {
    object (ValidationResult)
  },
  "responseId": string
}
Các trường
result

object (ValidationResult)

Kết quả xác thực địa chỉ.

responseId

string

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.

PostalAddress (Địa chỉ bưu điện)

Đại diện cho địa chỉ bưu chính, ví dụ như địa chỉ giao hàng hoặc thanh toán qua bưu điện. Khi có địa chỉ bưu chính, dịch vụ bưu chính có thể giao hàng đến địa điểm, hộp thư bưu điện hoặc những đơn vị tương tự. Mô hình này không nhằm lập mô hình các vị trí địa lý (đường, thị trấn, núi non).

Trong cách sử dụng thông thường, địa chỉ sẽ được tạo thông qua hoạt động đầu vào của người dùng hoặc từ việc nhập dữ liệu hiện có, tuỳ thuộc vào loại quy trình.

Lời khuyên về việc nhập / chỉnh sửa địa chỉ: – Sử dụng tiện ích địa chỉ có thể quốc tế hoá, chẳng hạn như https://github.com/google/libaddressinput) – Không nên cung cấp cho người dùng các thành phần trên giao diện người dùng để nhập hoặc chỉnh sửa các trường ở bên ngoài quốc gia sử dụng trường đó.

Để được hướng dẫn thêm về cách sử dụng giản đồ này, vui lòng xem: https://support.google.com/business/answer/6397478

Biểu diễn dưới dạng JSON
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
Các trường
revision

integer

Bản sửa đổi giản đồ của PostalAddress. Bất kỳ giá trị nào khác 0 sẽ khiến API trả về lỗi INVALID_ARGUMENT.

regionCode

string

Không bắt buộc. Mã vùng CLDR của quốc gia/vùng của địa chỉ. Hãy truy cập vào https://cldr.unicode.org/https://www.unicode.org/cldr/charts/30/supplemental/Territory_information.html để biết thông tin chi tiết. Ví dụ: "CH" cho Thuỵ Sĩ. Nếu bạn không cung cấp mã vùng, thì mã đó sẽ được suy ra từ địa chỉ. Để có hiệu suất tốt nhất, bạn nên bao gồm mã vùng nếu bạn biết mã. Các vùng không nhất quán hoặc lặp lại có thể dẫn đến hiệu quả hoạt động kém. Ví dụ: nếu addressLines đã bao gồm khu vực đó, đừng cung cấp lại mã vùng trong trường này. 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.

languageCode

string

Mã ngôn ngữ trong địa chỉ nhập được dành riêng để sử dụng trong tương lai và sẽ bị bỏ qua trong ngày hôm nay. API trả về địa chỉ bằng ngôn ngữ thích hợp cho vị trí của địa chỉ đó.

postalCode

string

Không bắt buộc. Mã bưu chính của địa chỉ. Không phải quốc gia nào cũng sử dụng hoặc bắt buộc phải có mã bưu chính. Tuy nhiên, tại những quốc gia sử dụng, mã bưu chính có thể kích hoạt quy trình xác thực bổ sung với các phần khác của địa chỉ (ví dụ: xác thực tiểu bang/mã bưu chính ở Hoa Kỳ).

sortingCode

string

Không bắt buộc. Mã sắp xếp bổ sung, cụ thể theo quốc gia. Thông tin này không được sử dụng ở hầu hết các khu vực. Trong trường hợp sử dụng, giá trị phải là một chuỗi như "CEDEX", có thể theo sau là một số (ví dụ: "CEDEX 7") hoặc chỉ là một số đơn lẻ, đại diện cho "mã khu vực" (Jamaica), "chỉ báo khu vực giao hàng" (Malawi) hoặc "chỉ báo bưu điện" (ví dụ: Bờ Biển Ngà).

administrativeArea

string

Không bắt buộc. Phân khu hành chính cao nhất được dùng cho địa chỉ bưu chính của một quốc gia hoặc khu vực. Ví dụ: đây có thể là một tiểu bang, một tỉnh, một vùng hoặc một tỉnh. Cụ thể, đối với Tây Ban Nha, đây là tỉnh chứ không phải cộng đồng tự trị (ví dụ: "Barcelona" chứ không phải "Catalonia"). Nhiều quốc gia không sử dụng khu vực hành chính trong địa chỉ bưu chính. Ví dụ: ở Thuỵ Sĩ, bạn không nên điền thông tin này.

locality

string

Không bắt buộc. Nói chung là đề cập đến phần thành phố/thị trấn của địa chỉ. Ví dụ: Thành phố ở Hoa Kỳ, thành phố công nghệ thông tin, thị trấn có bưu điện của Vương quốc Anh. Ở những khu vực trên thế giới, nơi các địa phương không được xác định rõ hoặc không phù hợp với cấu trúc này, hãy để trống địa phương và sử dụng addressLines.

sublocality

string

Không bắt buộc. Quận/huyện của địa chỉ. Ví dụ: đó có thể là các khu dân cư, thị xã, quận.

addressLines[]

string

Bắt buộc. Dòng địa chỉ không có cấu trúc mô tả các cấp thấp hơn của một địa chỉ.

Vì các giá trị trong addressLines không có thông tin về loại và đôi khi có thể chứa nhiều giá trị trong một trường duy nhất (ví dụ: "Austin, TX"), nên điều quan trọng là thứ tự dòng phải rõ ràng. Thứ tự của các dòng địa chỉ phải là "thứ tự phong bì" cho quốc gia/khu vực của địa chỉ.

Thành phần trình bày cấu trúc tối thiểu được phép của một địa chỉ bao gồm tất cả thông tin được đặt trong addressLines. Nếu bạn không cung cấp regionCode, thì khu vực này sẽ được suy ra từ các dòng địa chỉ.

Tạo địa chỉ chỉ chứa addressLines và sau đó mã hoá địa lý là cách được đề xuất để xử lý các địa chỉ hoàn toàn không có cấu trúc (thay vì đoán phần nào trong địa chỉ phải là địa phương hoặc khu vực hành chính).

recipients[]

string

Vui lòng tránh đặt trường này. API xác thực địa chỉ hiện không sử dụng tính năng này. Mặc dù tại thời điểm này, API sẽ không từ chối các yêu cầu có nhóm trường này, nhưng thông tin sẽ bị loại bỏ và không được trả về trong phản hồi.

organization

string

Vui lòng tránh đặt trường này. API xác thực địa chỉ hiện không sử dụng tính năng này. Mặc dù tại thời điểm này, API sẽ không từ chối các yêu cầu có nhóm trường này, nhưng thông tin sẽ bị loại bỏ và không được trả về trong phản hồi.

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.

Biểu diễn dưới dạng JSON
{
  "returnEnglishLatinAddress": boolean
}
Các trường
returnEnglishLatinAddress

boolean

Bản xem trước: Trả về một google.maps.addressvalidation.v1.Address bằng tiếng Anh. Hãy xem google.maps.addressvalidation.v1.ValidationResult.english_latin_address để biết chi tiết.

Kết quả xác thực

Kết quả của việc xác thực địa chỉ.

Biểu diễn dưới dạng JSON
{
  "verdict": {
    object (Verdict)
  },
  "address": {
    object (Address)
  },
  "geocode": {
    object (Geocode)
  },
  "metadata": {
    object (AddressMetadata)
  },
  "uspsData": {
    object (UspsData)
  },
  "englishLatinAddress": {
    object (Address)
  }
}
Các trường
verdict

object (Verdict)

Cờ kết quả tổng thể

address

object (Address)

Thông tin về chính địa chỉ đó chứ không phải mã địa lý.

geocode

object (Geocode)

Thông tin về vị trí và địa điểm mà địa chỉ được mã hoá địa lý.

metadata

object (AddressMetadata)

Thông tin khác liên quan đến khả năng gửi. 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ỉ.

uspsData

object (UspsData)

Cờ khả năng phân phối bổ sung do USPS cung cấp. Chỉ được cung cấp ở khu vực USPR.

englishLatinAddress

object (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ờ google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address.

Lưu ý: trường google.maps.addressvalidation.v1.Address.unconfirmed_component_types trong các trường englishLatinAddressgoogle.maps.addressvalidation.v1.AddressComponent.confirmation_level trong englishLatinAddress.address_components không được điền sẵn.

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ý.

Biểu diễn dưới dạng JSON
{
  "inputGranularity": enum (Granularity),
  "validationGranularity": enum (Granularity),
  "geocodeGranularity": enum (Granularity),
  "addressComplete": boolean,
  "hasUnconfirmedComponents": boolean,
  "hasInferredComponents": boolean,
  "hasReplacedComponents": boolean
}
Các trường
inputGranularity

enum (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 validationGranularity dưới đây.

Ví dụ: nếu địa chỉ nhập bao gồm số căn hộ cụ thể, thì inputGranularity ở đây sẽ là SUB_PREMISE. Nếu chúng tôi không so khớp được số căn hộ trong cơ sở dữ liệu hoặc số căn hộ không hợp lệ, thì validationGranularity có thể sẽ là PREMISE hoặc thấp hơn.

validationGranularity

enum (Granularity)

Mức độ chi tiết mà API có thể xác thực đầy đủ địa chỉ. Ví dụ: validationGranularity của PREMISE cho biết rằng hệ thống có thể xác thực tất cả thành phần địa chỉ ở cấp PREMISE trở lên.

Bạn có thể tìm thấy kết quả xác thực thành phần theo địa chỉ trong google.maps.addressvalidation.v1.Address.address_components.

geocodeGranularity

enum (Granularity)

Thông tin về mức độ chi tiết của geocode. Điều này có thể được hiểu là ý nghĩa ngữ nghĩa về mức độ thô hoặc nhỏ của vị trí được mã hoá địa lý.

Điều này đôi khi có thể khác với validationGranularity ở trên. Ví dụ: cơ sở dữ liệu của chúng tôi có thể ghi lại sự tồn tại của số căn hộ nhưng không có vị trí chính xác của căn hộ trong một khu chung cư lớn. Trong trường hợp đó, validationGranularity sẽ là SUB_PREMISE nhưng geocodeGranularity sẽ là PREMISE.

addressComplete

boolean

Đị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 missingComponentTypes, unresolvedTokens hoặc unexpected để biết thêm thông tin chi tiết.

hasUnconfirmedComponents

boolean

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 google.maps.addressvalidation.v1.Address.address_components để biết thông tin chi tiết.

hasInferredComponents

boolean

Í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 google.maps.addressvalidation.v1.Address.address_components để biết thông tin chi tiết.

hasReplacedComponents

boolean

Ít nhất một thành phần địa chỉ đã được thay thế, hãy xem google.maps.addressvalidation.v1.Address.address_components để biết thông tin chi tiết.

Độ 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.

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.

Biểu diễn dưới dạng JSON
{
  "formattedAddress": string,
  "postalAddress": {
    object (PostalAddress)
  },
  "addressComponents": [
    {
      object (AddressComponent)
    }
  ],
  "missingComponentTypes": [
    string
  ],
  "unconfirmedComponentTypes": [
    string
  ],
  "unresolvedTokens": [
    string
  ]
}
Các trường
formattedAddress

string

Đị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ỉ đó.

postalAddress

object (PostalAddress)

Địa chỉ xử lý sau khi xử lý được thể hiện dưới dạng địa chỉ bưu điện.

addressComponents[]

object (AddressComponent)

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.

missingComponentTypes[]

string

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 formattedAddress, postalAddress hoặc addressComponents. Ví dụ: ['street_number', 'route'] cho dữ liệu đầu vào chẳng hạn như "Boulder, Colorado, 80301, USA". Bạn có thể tìm thấy danh sách các loại có thể sử dụng tại đây.

unconfirmedComponentTypes[]

string

Các loại thành phần có trong addressComponents nhưng không thể được xác nhận là chính xác. Trường này được cung cấp để thuận tiện: nội dung của trường tương đương với việc lặp lại thông qua addressComponents để tìm các loại thành phần trong đó confirmationLevel không phải là CONFIRMED hoặc cờ inferred không được đặt thành true. Bạn có thể tìm thấy danh sách các loại có thể sử dụng tại đây.

unresolvedTokens[]

string

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 ["123235253253"] vì không phải là số đường hợp lệ.

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.

Biểu diễn dưới dạng JSON
{
  "componentName": {
    object (ComponentName)
  },
  "componentType": string,
  "confirmationLevel": enum (ConfirmationLevel),
  "inferred": boolean,
  "spellCorrected": boolean,
  "replaced": boolean,
  "unexpected": boolean
}
Các trường
componentName

object (ComponentName)

Tên của thành phần này.

componentType

string

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ó.

confirmationLevel

enum (ConfirmationLevel)

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

boolean

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 đủ.

spellCorrected

boolean

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

boolean

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

boolean

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.

Tên thành phần

Một trình bao bọc cho tên của thành phần.

Biểu diễn dưới dạng JSON
{
  "text": string,
  "languageCode": string
}
Các trường
text

string

Văn bản tên. Ví dụ: "5th Avenue" cho tên đường phố hoặc "1253" cho số nhà.

languageCode

string

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ố.

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ỉ.

Mã địa lý

Chứa thông tin về nơi mà dữ liệu đầu vào được mã hoá địa lý đến.

Biểu diễn dưới dạng JSON
{
  "location": {
    object (LatLng)
  },
  "plusCode": {
    object (PlusCode)
  },
  "bounds": {
    object (Viewport)
  },
  "featureSizeMeters": number,
  "placeId": string,
  "placeTypes": [
    string
  ]
}
Các trường
location

object (LatLng)

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.

plusCode

object (PlusCode)

Mã cộng tương ứng với location.

bounds

object (Viewport)

Các giới hạn của địa điểm được mã hoá địa lý.

featureSizeMeters

number

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.

placeId

string

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.

placeTypes[]

string

(Các) loại địa điểm mà dữ liệu đầu vào được mã hoá địa lý. Ví dụ: ['locality', 'political']. Bạn có thể xem danh sách đầy đủ các loại tại đây.

Vĩ độ và Lĩnh vực

Một đối tượng đại diện cho một cặp vĩ độ/kinh độ. Chuỗi này được biểu thị dưới dạng một cặp đôi để biểu thị độ vĩ độ và độ kinh độ. Trừ phi có quy định khác, đối tượng này phải tuân theo tiêu chuẩn WGS84. Giá trị phải nằm trong phạm vi chuẩn hoá.

Biểu diễn dưới dạng JSON
{
  "latitude": number,
  "longitude": number
}
Các trường
latitude

number

Vĩ độ tính theo độ. Giá trị này phải nằm trong phạm vi [-90.0, +90.0].

longitude

number

Kinh độ tính theo độ. Giá trị này phải nằm trong phạm vi [-180.0, +180.0].

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.

Biểu diễn dưới dạng JSON
{
  "globalCode": string,
  "compoundCode": string
}
Các trường
globalCode

string

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).

compoundCode

string

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.

Khung nhìn

Một khung nhìn kinh độ – vĩ độ, được biểu thị dưới dạng hai đường chéo đối diện với lowhigh điểm. Một khung nhìn được coi là một khu vực đóng, tức là khung nhìn bao gồm ranh giới của khung nhìn. Giới hạn vĩ độ phải nằm trong khoảng từ -90 đến 90 độ và giới hạn kinh độ phải nằm trong khoảng từ -180 đến 180 độ. Nhiều trường hợp bao gồm:

  • Nếu low = high, khung nhìn sẽ bao gồm một điểm duy nhất đó.

  • Nếu low.longitude > high.longitude, thì phạm vi kinh độ sẽ bị đảo ngược (khung nhìn cắt qua đường kinh độ 180 độ).

  • Nếu low.longitude = -180 độ và high.longitude = 180 độ, thì khung nhìn bao gồm tất cả kinh độ.

  • Nếu low.longitude = 180 độ và high.longitude = -180 độ, thì phạm vi kinh độ sẽ trống.

  • Nếu low.latitude > high.latitude, thì phạm vi vĩ độ sẽ trống.

Cả lowhigh đều phải được điền sẵn, đồng thời không được để trống ô được biểu thị (như được chỉ định trong các định nghĩa ở trên). Khung nhìn trống sẽ dẫn đến lỗi.

Ví dụ: khung nhìn này bao quanh đầy đủ Thành phố New York:

{ "thấp": { "vĩ độ": 40.477398, "kinh độ": -74.259087 }, "cao": { "vĩ độ": 40.91618, "kinh độ": -73.70018 } }

Biểu diễn dưới dạng JSON
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Các trường
low

object (LatLng)

Bắt buộc. Điểm thấp của khung nhìn.

high

object (LatLng)

Bắt buộc. Điểm cao của khung nhìn.

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ỉ.

Biểu diễn dưới dạng JSON
{
  "business": boolean,
  "poBox": boolean,
  "residential": boolean
}
Các trường
business

boolean

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.

poBox

boolean

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

boolean

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.

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.

Biểu diễn dưới dạng JSON
{
  "standardizedAddress": {
    object (UspsAddress)
  },
  "deliveryPointCode": string,
  "deliveryPointCheckDigit": string,
  "dpvConfirmation": string,
  "dpvFootnote": string,
  "dpvCmra": string,
  "dpvVacant": string,
  "dpvNoStat": string,
  "carrierRoute": string,
  "carrierRouteIndicator": string,
  "ewsNoMatch": boolean,
  "postOfficeCity": string,
  "postOfficeState": string,
  "abbreviatedCity": string,
  "fipsCountyCode": string,
  "county": string,
  "elotNumber": string,
  "elotFlag": string,
  "lacsLinkReturnCode": string,
  "lacsLinkIndicator": string,
  "poBoxOnlyPostalCode": boolean,
  "suitelinkFootnote": string,
  "pmbDesignator": string,
  "pmbNumber": string,
  "addressRecordType": string,
  "defaultAddress": boolean,
  "errorMessage": string,
  "cassProcessed": boolean
}
Các trường
standardizedAddress

object (UspsAddress)

Địa chỉ được chuẩn hoá USPS.

deliveryPointCode

string

Mã điểm giao hàng gồm 2 chữ số

deliveryPointCheckDigit

string

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ã Delivery_point_barcode, DeliveryPointCheckDigit, mã bưu chính và ZIP+4 lại với nhau, bạn sẽ được một số chia hết cho 10.

dpvConfirmation

string

Các giá trị có thể dùng để xác nhận DPV. Trả về một ký tự đơn.

  • Y: Địa chỉ đã được xác nhận là DPV cho số chính và mọi số phụ.
  • N: DPV không xác nhận được thông tin về số chính và mọi thông tin phụ.
  • S: Địa chỉ đã được xác nhận là DPV chỉ dành cho số điện thoại chính và thông tin về số điện thoại phụ đã có nhưng chưa được xác nhận.
  • D: Địa chỉ đã được xác nhận là DPV chỉ dành cho số điện thoại chính và thiếu thông tin về số điện thoại phụ.
dpvFootnote

string

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.

  • AA: Địa chỉ nhập khớp với tệp ZIP+4
  • A1: Địa chỉ nhập không khớp với tệp ZIP+4
  • BB: Đã khớp với DPV (tất cả các thành phần)
  • CC: Số phụ không khớp (có nhưng không hợp lệ)
  • N1: Địa chỉ nhà cao tầng thiếu số phụ
  • M1: Thiếu số chính
  • M3: Số chính không hợp lệ
  • P1: Thiếu địa chỉ nhập RR hoặc số hộp HC
  • P3: Địa chỉ nhập PO, RR hoặc Số hộp HC không hợp lệ
  • F1: Địa chỉ nhập khớp với địa chỉ quân sự
  • G1: Địa chỉ nhập khớp với địa chỉ giao hàng chung
  • U1: Địa chỉ nhập khớp với một mã bưu chính duy nhất
  • PB: Địa chỉ đầu vào khớp với bản ghi PBSA
  • RR: Địa chỉ đã xác nhận của DPV có thông tin PMB
  • R1: Địa chỉ đã xác nhận của DPV nhưng không có thông tin về PMB
  • R7: Bản ghi R777 hoặc R779 của Carrier Tuyến
dpvCmra

string

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.

  • Y: Địa chỉ này là CMRA
  • N: Địa chỉ không phải là CMRA
dpvVacant

string

Địa điểm này có bỏ trống không? Trả về một ký tự đơn.

  • Y: Địa chỉ bị bỏ trống
  • N: Địa chỉ không bị trống
dpvNoStat

string

Đâ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.

  • Y: Địa chỉ này không hoạt động
  • N: Địa chỉ đang hoạt động
carrierRoute

string

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ố:

  • C: Tuyến đường của hãng vận chuyển (hoặc tuyến đường thành phố)
  • R: Tuyến đường nông thôn
  • H: Tuyến đường hợp đồng trên đường cao tốc
  • B: Khu vực hộp thư bưu điện
  • G: Đơn vị phân phối chung
carrierRouteIndicator

string

Chỉ báo sắp xếp mức phí tuyến đường của hãng vận chuyển.

ewsNoMatch

boolean

Đị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.

postOfficeCity

string

Thành phố của bưu điện chính.

postOfficeState

string

Tiểu bang của bưu điện chính.

abbreviatedCity

string

Thành phố viết tắt.

fipsCountyCode

string

Mã hạt FIPS.

county

string

Tên hạt.

elotNumber

string

Số Tuyến du lịch nâng cao (eLOT).

elotFlag

string

eLOT Cờ tăng dần/Giảm dần (A/D).

poBoxOnlyPostalCode

boolean

Mã bưu chính chỉ Hộp thư bưu điện.

pmbDesignator

string

Người chỉ định đơn vị PMB (Hộp thư riêng).

pmbNumber

string

số PMB (Hộp thư riêng);

addressRecordType

string

Loại bản ghi địa chỉ khớp với địa chỉ nhập.

  • F: FIRM. Đây là mức khớp với Hồ sơ công ty, đây là mức độ khớp tốt nhất hiện có cho một địa chỉ.
  • G: GIAO HÀNG CHUNG. Bản ghi này trùng khớp với bản ghi Gửi chung.
  • H: Toà nhà / căn hộ. Đây là bản ghi trùng khớp với bản ghi của một Toà nhà hoặc Căn hộ.
  • P: HỘP Bưu điện. Địa chỉ này trùng khớp với hộp thư bưu điện.
  • R: ĐƯỜNG ĐI NỀN TẢNG hoặc HỢP ĐỒNG ĐƯỜNG PHỐ: Đây là thông tin trùng khớp với tuyến đường nông thôn hoặc bản ghi Hợp đồng đường cao tốc, cả hai loại bản ghi này đều có thể liên kết với phạm vi Số hộp.
  • S: STREET RECORD: Đây là sự trùng khớp với bản ghi Street có chứa dải số chính hợp lệ.
defaultAddress

boolean

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.

errorMessage

string

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.

cassProcessed

boolean

Chỉ báo cho biết yêu cầu đã được xử lý CASS.

Địa chỉ Usps

USPS đại diện cho một địa chỉ ở Hoa Kỳ.

Biểu diễn dưới dạng JSON
{
  "firstAddressLine": string,
  "firm": string,
  "secondAddressLine": string,
  "urbanization": string,
  "cityStateZipAddressLine": string,
  "city": string,
  "state": string,
  "zipCode": string,
  "zipCodeExtension": string
}
Các trường
firstAddressLine

string

Dòng địa chỉ đầu tiên.

firm

string

Tên công ty.

secondAddressLine

string

Dòng địa chỉ thứ hai.

urbanization

string

Tên khu vực đô thị của Puerto Rico.

cityStateZipAddressLine

string

Thành phố + tiểu bang + mã bưu chính.

city

string

Tên thành phố.

state

string

Mã trạng thái gồm 2 chữ cái.

zipCode

string

Mã bưu chính, ví dụ: 10009.

zipCodeExtension

string

Đuôi mã bưu chính gồm 4 chữ số, ví dụ: 5023.