AddressValidation class
google.maps.addressValidation.AddressValidation
class
用於存取 AddressValidation API 的靜態類別。
撥打 const {AddressValidation} = await google.maps.importLibrary("addressValidation") 即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
靜態方法 | |
|---|---|
fetchAddressValidation |
fetchAddressValidation(request)參數：
傳回值：
Promise<AddressValidation> |
屬性 | |
|---|---|
address |
類型：
Address optional地址本身的相關資訊，而非地理編碼。 |
geocode |
類型：
Geocode optional地址地理編碼後的位置和地點相關資訊。 |
metadata |
類型：
AddressMetadata optional其他與送達率相關的資訊。我們無法保證系統會為傳送至 Address Validation API 的每個地址完整填入 metadata。 |
responseId |
類型：
string optional這個回應的 UUID。如果地址需要重新驗證，新要求必須附上這個 UUID。 |
uspsData |
類型：
USPSData optional美國郵政署提供的額外遞送狀態旗標。僅在 US 和 PR 地區提供。 |
verdict |
類型：
Verdict optional整體判定結果標記 |
方法 | |
|---|---|
toJSON |
toJSON()參數：無
傳回值：
Object將 AddressValidation 類別轉換為具有相同屬性的 JSON 物件。 |
AddressValidationRequest 介面
google.maps.addressValidation.AddressValidationRequest
介面
AddressValidation.fetchAddressValidation 的要求介面。
屬性 | |
|---|---|
address |
正在驗證地址。如要提交未格式化的地址，請透過 PostalAddress.addressLines 進行。 |
placeAutocompleteElement optional |
類型：
PlaceAutocompleteElement optional如果使用 PlaceAutocompleteElement，請在此處加入，將 AddressValidation API 呼叫與自動完成工作階段符記連結。 |
previousResponseId optional |
類型：
string optional首次提出地址驗證要求時，請勿設定這個欄位。如要完整驗證單一地址，可能需要提出多項要求 (例如，使用者在初始驗證後所做的變更需要重新驗證)，則後續每項要求都必須填入驗證序列中第一個回應的 AddressValidation.responseId。 |
sessionToken optional |
類型：
AutocompleteSessionToken optional用於識別自動完成工作階段的符記，以利計費。 |
uspsCASSEnabled optional |
類型：
boolean optional啟用與 USPS CASS 相容的模式。這只會影響 AddressValidation 的 AddressValidation.uspsData 欄位。注意：如果要求 USPS CASS 驗證波多黎各的地址， 的 必須為「PR」，或 的 必須為「Puerto Rico」(不區分大小寫) 或「PR」。PostalAddress.regionCodeaddressaddressPostalAddress.administrativeArea |
Address class
google.maps.addressValidation.Address
class
後續處理地址的詳細資料。後續處理包括修正地址中拼錯的部分、替換錯誤的部分，以及推斷遺漏的部分。
撥打 const {Address} = await google.maps.importLibrary("addressValidation") 即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
屬性 | |
|---|---|
components |
類型：
Array<AddressComponent>格式化及修正後地址的個別地址元件，以及驗證資訊。這會提供個別元件的驗證狀態資訊。 |
formattedAddress |
類型：
string optional後續處理的地址，格式為單行地址，並遵循地址所在區域的地址格式規則。 |
missingComponentTypes |
類型：
Array<string>格式正確的郵寄地址應包含的元件類型，但輸入內容中沒有，且無法推斷。這類元件不會出現在 formatted_address、postal_address 或 address_components 中。舉例來說，如果輸入「Boulder, Colorado, 80301, USA」，系統可能會顯示 ['street_number', 'route']。如要查看可能類型清單，請按這裡。 |
postalAddress |
類型：
PostalAddress optional後續處理的地址，以郵寄地址表示。 |
unconfirmedComponentTypes |
類型：
Array<string>address_components 中存在但無法確認是否正確的元件類型。提供這個欄位是為了方便起見，其內容等同於疊代 address_components，找出 AddressComponent.confirmationLevel 不是 ConfirmationLevel.CONFIRMED 或 AddressComponent.inferred 旗標未設為 true 的所有元件類型。如要查看可能類型清單，請按這裡。 |
unresolvedTokens |
類型：
Array<string>輸入中無法解析的任何權杖。這可能是系統無法辨識為有效地址部分的輸入內容 (例如在「123235253253 Main St, San Francisco, CA, 94105」這類輸入內容中，未解析的權杖可能看起來像 ["123235253253"]，因為這不像有效的門牌號碼)。 |
AddressComponent class
google.maps.addressValidation.AddressComponent
class
代表地址的單一元件 (例如街道名稱、城市)。
撥打 const {AddressComponent} = await google.maps.importLibrary("addressValidation") 即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
屬性 | |
|---|---|
componentName |
類型：
string optional元件名稱文字。例如街道名稱「5th Avenue」或門牌號碼「1253」， |
componentNameLanguageCode |
類型：
string optionalBCP-47 語言代碼。如果元件名稱未與語言建立關聯 (例如門牌號碼)，就不會顯示這項資訊。 |
componentType |
類型：
string optional地址元件的類型。如需可能類型的清單，請參閱「表 2：地點介面集服務傳回的其他類型」。 |
confirmationLevel |
類型：
ConfirmationLevel optional表示元件正確的確定程度。 |
inferred |
類型：
boolean如果為 true，表示這個元件並非輸入內容的一部分，而是根據地址位置推斷而來。建議加入這個元件，以提供完整地址。 |
replaced |
類型：
boolean表示元件名稱已完全變更。例如，將錯誤的郵遞區號換成地址的正確郵遞區號。這不是外觀變更，而是輸入元件已改用其他元件。 |
spellCorrected |
類型：
boolean指出元件名稱中的錯字修正。API 不一定會標示拼字變體之間的變更，例如「centre」變更為「center」。 |
unexpected |
類型：
boolean如果設為 true，表示指定區域的郵寄地址不應包含這個元件。系統保留這項資訊，只是因為這是輸入內容的一部分。 |
AddressMetadata class
google.maps.addressValidation.AddressMetadata
class
地址的中繼資料。我們無法保證傳送至 Address Validation API 的每個地址都會完整填入 AddressMetadata。
撥打 const {AddressMetadata} = await google.maps.importLibrary("addressValidation") 即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
屬性 | |
|---|---|
business |
類型：
boolean |
poBox |
類型：
boolean |
residential |
類型：
boolean |
ConfirmationLevel 常數
google.maps.addressValidation.ConfirmationLevel
常數
可能的值不同，代表元件正確的確定程度。
撥打 const {ConfirmationLevel} = await google.maps.importLibrary("addressValidation") 即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
常數 | |
|---|---|
CONFIRMED |
|
UNCONFIRMED_AND_SUSPICIOUS |
|
UNCONFIRMED_BUT_PLAUSIBLE |
|
Geocode class
google.maps.addressValidation.Geocode
class
包含輸入內容經過地理編碼後的地點相關資訊。
撥打 const {Geocode} = await google.maps.importLibrary("addressValidation") 即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
屬性 | |
|---|---|
bounds |
類型：
LatLngBounds optional地理編碼地點的界線。 |
featureSizeMeters |
類型：
number optional以公尺為單位，表示經過地理編碼的地點大小。這是另一種粗略的地理編碼位置測量方式，但以實際大小而非語意意義表示。 |
location |
類型：
LatLngAltitude optional輸入內容的地理編碼位置。 |
placeId |
類型：
string optional經過地理編碼的地點 ID。建議使用 Place，而非地址、經緯度座標或 Plus Code。使用座標規劃路線或計算行車路線時，系統一律會將該點對應到最接近這些座標的道路。這條路可能無法快速或安全地抵達目的地，也可能不在房源的入口附近。此外，當位置經過反向地理編碼時，我們無法保證傳回的地址與原始地址相符。 |
placeTypes |
類型：
Array<string>輸入內容經過地理編碼後對應的地點類型。例如： ['locality', 'political']。如需完整清單，請參閱 Geocoding API 說明文件。 |
plusCode |
類型：
PlusCode optional與 location 對應的 Plus Code。 |
方法 | |
|---|---|
fetchPlace |
fetchPlace()參數：無
傳回值：無
傳回這個地理編碼的地點表示法。如要取得完整的地點詳細資料，請呼叫 place.fetchFields()。 |
精細程度 常數
google.maps.addressValidation.Granularity
常數
地址或地理編碼可擁有的各種精細程度。如果用來表示地址的精細程度，這些值會指出地址識別郵寄目的地的精細程度。舉例來說，「123 Main Street, Redwood City, CA, 94061」這類地址會識別 PREMISE，而「Redwood City, CA, 94061」這類地址則會識別 LOCALITY。不過，如果我們無法在紅木城找到「123 Main Street」的地理編碼，即使地址更精細，傳回的地理編碼可能仍為 LOCALITY 粒度。
撥打 const {Granularity} = await google.maps.importLibrary("addressValidation") 即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
常數 | |
|---|---|
BLOCK |
地址或地理編碼表示街區。僅適用於有街區層級地址的地區，例如日本。 |
OTHER |
所有其他細微程度，這些程度會歸類在一起，因為無法提供。 |
PREMISE |
建築物層級結果。 |
PREMISE_PROXIMITY |
可估算地址建築物層級位置的地理代碼。 |
ROUTE |
地理編碼或地址的精細程度可達路線，例如街道、道路或高速公路。 |
SUB_PREMISE |
建築物以下層級的結果，例如公寓。 |
PossibleNextAction 常數
google.maps.addressValidation.PossibleNextAction
常數
提供 API 回應的解讀摘要，協助您判斷後續可能採取的行動。這個欄位是從 API 回應中的其他欄位衍生而來，不應視為地址準確度或可送達性的保證。
撥打 const {PossibleNextAction} = await google.maps.importLibrary("addressValidation") 即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
常數 | |
|---|---|
ACCEPT |
API 回應不含可保證其他 PossibleNextAction 值的信號。您可以考慮使用後續處理的地址，不必再提示顧客，但這無法保證地址有效，且地址可能仍包含修正內容。您有責任根據自己的風險評估，決定是否要提示顧客以及提示方式。 |
CONFIRM |
API 回應中的一或多個欄位指出後續處理的地址可能存在小問題，例如 postal_code 地址元件為 replaced。請顧客檢查地址，有助於提升地址品質。 |
CONFIRM_ADD_SUBPREMISES |
API 回應指出後續處理的地址可能缺少子場所。提示顧客檢查地址並考慮新增單位號碼，有助於提升地址品質。後續處理的地址也可能存在其他小問題。注意：這個列舉值只能針對美國地址傳回。 |
FIX |
API 回應的一或多個欄位指出後續處理的地址可能存在問題，例如 verdict.validation_granularity 為 OTHER。提示顧客編輯地址有助於提升地址品質。 |
USPSAddress class
google.maps.addressValidation.USPSAddress
class
美國地址的 USPS 表示法。
撥打 const {USPSAddress} = await google.maps.importLibrary("addressValidation") 即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
屬性 | |
|---|---|
city |
類型：
string optional城市名稱。 |
cityStateZipAddressLine |
類型：
string optional地址行，包含城市、州/省和郵遞區號。 |
firm |
類型：
string optional公司名稱。 |
firstAddressLine |
類型：
string optional地址的第一行。 |
secondAddressLine |
類型：
string optional地址的第二行。 |
state |
類型：
string optional由 2 個英文字母組成的州/省代碼。 |
urbanization |
類型：
string optional波多黎各的都市化名稱。 |
zipCode |
類型：
string optional郵遞區號，例如「10009」。 |
zipCodeExtension |
類型：
string optional4 位數的郵遞區號額外資訊，例如「5023」。 |
USPSData class
google.maps.addressValidation.USPSData
class
地址的 USPS 資料。對於傳送至 Address Validation API 的每個美國或波多黎各地址，我們無法保證 USPSData 會完整填入。如果使用 uspsData 做為回應的主要部分，建議在回應中整合備份地址欄位。
撥打 const {USPSData} = await google.maps.importLibrary("addressValidation") 即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
屬性 | |
|---|---|
abbreviatedCity |
類型：
string optional縮寫的城市名稱。 |
addressRecordType |
類型：
string optional與輸入地址相符的地址記錄類型。 |
carrierRoute |
類型：
string optional貨運公司路線代碼。由四個字元組成的代碼，包含一個字母前置字元和三個數字的路徑指定符。 |
carrierRouteIndicator |
類型：
string optional貨運路線費率排序指標。 |
cassProcessed |
類型：
boolean要求已透過 CASS 處理的指標。 |
county |
類型：
string optional郡/縣名稱。 |
deliveryPointCheckDigit |
類型：
string optional投遞點檢查碼。以機械掃描郵件時，這個數字會加到 delivery_point_barcode 的結尾。將 delivery_point_barcode、delivery_point_check_digit、郵遞區號和 ZIP+4 的所有數字加總，得出的數字應可被 10 整除。 |
deliveryPointCode |
類型：
string optional2 位數的送達地點代碼。 |
dpvCMRA |
類型：
string optional指出地址是否為 CMRA (商業郵件接收機構)，即為客戶接收郵件的私人企業。傳回單一字元。 |
dpvConfirmation |
類型：
string optionalDPV 確認的可能值。傳回單一字元或不傳回任何值。 |
dpvDoorNotAccessible |
類型：
string optional如果郵政服務人員無法敲門遞送郵件，就會標示地址。傳回單一字元。 |
dpvDrop |
類型：
string optional旗標表示郵件已送達該地點的單一收件處。傳回單一字元。 |
dpvEnhancedDeliveryCode |
類型：
string optional表示地址有多個有效的 DPV 傳回代碼。傳回單一字元。 |
dpvFootnote |
類型：
string optional交貨地點驗證的註腳。同一字串中可能會串連多個註腳。 |
dpvNonDeliveryDays |
類型：
string optional此標記表示郵件不會在一週的每一天送達。傳回單一字元。 |
dpvNonDeliveryDaysValues |
類型：
number optional識別未送達天數的整數。可以使用位元旗標查詢：0x40 - 週日為非送貨日 0x20 - 週一為非送貨日 0x10 - 週二為非送貨日 0x08 - 週三為非送貨日 0x04 - 週四為非送貨日 0x02 - 週五為非送貨日 0x01 - 週六為非送貨日 |
dpvNoSecureLocation |
類型：
string optional旗標表示門戶可供進入，但基於安全考量，我們不會將包裹放在門口。傳回單一字元。 |
dpvNoStat |
類型：
string optional指出地址是否為無統計資料地址或有效地址。無狀態地址是指非持續佔用的地址，或是美國郵政署不提供服務的地址。傳回單一字元。 |
dpvNoStatReasonCode |
類型：
number optional指出 NoStat 類型。以 int 形式傳回原因代碼。 |
dpvPBSA |
類型：
string optional表示地址與 PBSA 記錄相符。傳回單一字元。 |
dpvThrowback |
類型：
string optional表示郵件未送達街道地址。傳回單一字元。 |
dpvVacant |
類型：
string optional指出地址是否為空屋。傳回單一字元。 |
elotFlag |
類型：
string optionaleLOT 遞增/遞減旗標 (A/D)。 |
elotNumber |
類型：
string optional強化旅遊路線 (eLOT) 編號。 |
errorMessage |
類型：
string optional擷取 USPS 資料時發生錯誤。如果系統偵測到人為建立的地址，導致 USPS 處理作業暫停，就會填入這項資訊。 |
fipsCountyCode |
類型：
string optionalFIPS 郡/縣代碼。 |
hasDefaultAddress |
類型：
boolean指標：系統找到預設地址，但有更明確的地址。 |
hasNoEWSMatch |
類型：
boolean遞送地址相符，但 EWS 檔案指出不久後就會提供完全相符的結果。 |
lacsLinkIndicator |
類型：
string optionalLACSLink 指標。 |
lacsLinkReturnCode |
類型：
string optionalLACSLink 傳回碼。 |
pmbDesignator |
類型：
string optionalPMB (Private Mail Box) 單位指定器。 |
pmbNumber |
類型：
string optionalPMB (私人信箱) 號碼。 |
poBoxOnlyPostalCode |
類型：
boolean郵政信箱的郵遞區號。 |
postOfficeCity |
類型：
string optional主要郵局城市。 |
postOfficeState |
類型：
string optional主要郵局所在州別。 |
standardizedAddress |
類型：
USPSAddress optionalUSPS 標準格式地址。 |
suiteLinkFootnote |
類型：
string optional將街道或高樓大廈記錄與套房資訊相符時產生的附註。如果找到相符的商家名稱，系統會傳回次要號碼。 |
Verdict class
google.maps.addressValidation.Verdict
class
表示所提供地址的後續處理地址。
撥打 const {Verdict} = await google.maps.importLibrary("addressValidation") 即可存取。
請參閱「Maps JavaScript API 中的程式庫」。
屬性 | |
|---|---|
addressComplete |
類型：
boolean如果沒有未解決的權杖，也沒有非預期或缺少的地址元件，即視為完整地址。如未設定，表示值為 false。詳情請參閱 Address.missingComponentTypes、Address.unresolvedTokens 或 AddressComponent.unexpected 欄位。 |
geocodeGranularity |
類型：
Granularity optionalGeocode的精細程度相關資訊。這可以理解為地理編碼位置的粗略或精細程度的語意意義。 |
hasInferredComponents |
類型：
boolean系統推斷 (即新增) 至少一個輸入中沒有的地址元件，詳情請參閱 AddressComponent。 |
hasReplacedComponents |
類型：
boolean optional至少有一個地址元件遭到取代 - 詳情請參閱 AddressComponent。 |
hasUnconfirmedComponents |
類型：
boolean至少有一個地址元件無法分類或驗證，詳情請參閱 AddressComponent。 |
inputGranularity |
類型：
Granularity optional輸入地址的精細程度。這是剖析輸入地址的結果，不會提供任何驗證信號。如需驗證信號，請參閱 validationGranularity。 |
possibleNextAction |
類型：
PossibleNextAction optional根據 API 回應中的其他欄位，可能採取的後續動作。如需詳細資訊，請參閱 PossibleNextAction。 |
validationGranularity |
類型：
Granularity optionalAPI 可完整驗證地址的精細程度。舉例來說， validationGranularity 為 PREMISE 表示可以驗證 PREMISE 層級和更廣泛的所有地址元件。 |