Package google.maps.addressvalidation.v1

透過集合功能整理內容 你可以依據偏好儲存及分類內容。

string

經後處理的地址，格式為單行地址，並遵循地址所在區域的地址格式規則。

注意：此地址的格式可能與 postal_address 欄位中的地址格式不符。舉例來說，postal_address 一律會以 2 個字母 region_code 代表國家/地區，例如「US」或「NZ」。相較之下，這個欄位會使用較長的國家/地區名稱，例如「USA」或「New Zealand」。

PostalAddress

經後處理的地址，以郵寄地址表示。

AddressComponent

未排序的清單。經過修正的地址格式和修正後的地址，以及驗證資訊。這項資訊會提供個別元件的驗證狀態。

地址元件並未依特定順序排列。請勿對清單中地址元件的順序做出任何假設。

string

在正確格式的郵寄地址中，預期會出現的元件類型，但在輸入內容中找不到，也無法推斷。例如，如果輸入「Boulder, Colorado, 80301, USA」這類資訊，就會顯示 ['street_number', 'route']。如要查看可能的類型清單，請按這裡。

注意：當您認為已提供缺少的元件時，可能會看到缺少的元件類型。舉例來說，如果輸入的地址包含大樓名稱，但沒有門牌號碼，就可能會發生這種情況。在「渋谷区渋谷３丁目　 Shibuya Stream」這個地址中，大樓名稱「Shibuya Stream」的元件類型為 premise，但缺少房號，因此 missing_component_types 會包含 premise。

string

address_components 中出現的元件類型，但無法確認其正確性。這個欄位是為了方便使用者：其內容等同於透過 address_components 迴圈，找出 confirmation_level 不是 CONFIRMED 或 inferred 標記未設為 true 的所有元件類型。如要查看可能的類型清單，請按這裡。

string

輸入內容中無法解析的任何符記。這可能是系統無法辨識為有效地址的輸入內容。舉例來說，如果輸入的內容是「Parcel 0000123123 & 0000456456 Str # Guthrie Center IA 50115 US」，未解析的符記可能會是 ["Parcel", "0000123123", "&", "0000456456"]。

ComponentName

這個元件的名稱。

string

地址元件的類型。如需可能類型的清單，請參閱「表 2：地點介面集服務傳回的其他類型」。

ConfirmationLevel

表示我們對元件正確性的信心程度。

bool

表示該元件並非輸入內容的一部分，但我們已推斷出地址位置，並認為應提供完整地址。

bool

表示修正元件名稱中的拼寫錯誤。API 不一定會標示拼法變化，例如將「centre」改為「center」。而且也不一定會標示常見的拼寫錯誤，例如將「Amphitheater Pkwy」改為「Amphitheatre Pkwy」。

bool

表示元件名稱已替換為完全不同的名稱，例如錯誤的郵遞區號已替換為地址正確的郵遞區號。這不是外觀上的變更，輸入元件已變更為其他元件。

bool

表示在特定區域的郵遞地址中，不應出現的地址元件。我們只會保留該值，因為它是輸入內容的一部分。

bool

表示這是商家地址。如果未設定，則表示值不明。

bool

表示郵政信箱的地址。如果未設定，則表示值不明。

bool

表示這是住家地址。如果未設定，則表示值不明。

string

名稱文字。例如街道名稱「5th Avenue」或門牌號碼「1253」。

string

BCP-47 語言代碼。如果元件名稱與語言無關，例如門牌號碼，就不會顯示這項資訊。

LatLng

輸入內容的地理編碼位置。

建議您使用地點 ID，而非地址、經緯度座標或 Plus Code。在規劃路線或計算行車路線時使用座標，系統一律會將點對齊最接近該座標的道路。這條路可能無法快速或安全地通往目的地，也可能不在房源附近。此外，當位置經過反向地理編碼後，傳回的地址不一定會與原始地址相符。

PlusCode

與 location 相應的 Plus Code。

Viewport

已編碼地點的邊界。

float

經過地理編碼的地點大小，以公尺為單位。這是另一種評估經地理編碼位置粗略程度的方式，但以實際大小而非語義意義為準。

string

這個輸入內容地理編碼的地點 PlaceID。

如要進一步瞭解地點 ID，請參閱這篇文章。

string

輸入內容經地理編碼後的地點類型。例如：['locality', 'political']。如需完整的類型清單，請參閱這篇文章。

bool

預覽：傳回英文的 google.maps.addressvalidation.v1.Address。詳情請參閱 google.maps.addressvalidation.v1.ValidationResult.english_latin_address。

string

地點的全球 (完整) 代碼，例如「9FWM33GV+HQ」，代表 1/8000 度 x 1/8000 度 (約 14 公尺 x 14 公尺) 的面積。

string

地點的複合代碼，例如「33GV+HQ, Ramberg, Norway」，包含全球代碼的後置字串，並將前置字串替換為參照實體的格式化名稱。

ValidationConclusion

必要欄位。驗證嘗試序列的結果。

如果將這個欄位設為 VALIDATION_CONCLUSION_UNSPECIFIED，系統會傳回 INVALID_ARGUMENT 錯誤。

string

必要欄位。這項意見回饋所屬的回覆 ID。這應該是一系列地址驗證嘗試中，第一個回應的 [response_id][google.maps.addressvalidation.v1.ValidateAddressRequest.response_id]。

string

第一行地址。

string

公司名稱。

string

第二個地址行。

string

波多黎各都市化名稱。

string

城市 + 州 + 郵遞區號。

string

城市名稱。

string

2 個字母的州代碼。

string

郵遞區號，例如 10009。

string

4 位數郵遞區號擴充碼，例如 5023。

UspsAddress

USPS 標準格式地址。

string

2 位數交貨地點代碼

string

提貨點檢查碼。這個號碼會加到機器掃描郵件的 delivery_point_barcode 結尾。將 delivery_point_barcode、delivery_point_check_digit、郵遞區號和 ZIP+4 的所有數字加總起來，所得的數字應可被 10 整除。

string

DPV 確認的可能值。傳回單一字元或不傳回任何值。

• N：主要和任何次要號碼資訊無法通過 DPV 確認。
• D：地址僅針對主要號碼通過 DPV 確認，且缺少次要號碼資訊。
• S：地址僅針對主要號碼進行 DPV 確認，次要號碼資訊則未確認。
• Y：主要和所有次要號碼的地址均已通過 DPV 驗證。
• 空白：如果回應不含 dpv_confirmation 值，表示系統並未提交地址進行 DPV 確認。

string

來自交貨點驗證的註腳。多個腳註可連結在同一個字串中。

• AA：輸入與 ZIP+4 檔案相符的地址
• A1：輸入的地址與 ZIP+4 檔案不符
• BB：與 DPV 相符 (所有元件)
• CC：次要號碼不相符，且不屬於必要欄位
• C1：次要號碼不相符，但為必要欄位
• N1：高樓地址缺少次要號碼
• M1：缺少主要號碼
• M3：主號碼無效
• P1：輸入的地址缺少郵政信箱、RR 或 HC 信箱號碼
• P3：輸入的地址 PO、RR 或 HC 信箱號碼無效
• F1：輸入與軍事地址相符的地址
• G1：輸入的地址與一般寄送地址相符
• U1：輸入的地址與專屬郵遞區號相符
• PB：輸入與 PBSA 記錄相符的地址
• RR：DPV 已確認地址，並提供 PMB 資訊
• R1：DPV 確認地址，但未提供 PMB 資訊
• R7：航空公司路線 R777 或 R779 記錄
• IA：已識別通知地址
• TA：捨去結尾的 alpha 後，與主號碼相符

string

指出地址是否為 CMRA (商業郵件收件代理機構)，也就是為客戶收取郵件的私人企業。傳回單一字元。

• Y：地址是 CMRA
• N：地址不是 CMRA

string

這個地點是否有空位？傳回單一字元。

• Y：地址空白
• N：地址並非空屋

string

這是無統計資料地址還是有效地址？無統計資料的地址是指未持續有人居住的地址，或 USPS 未提供服務的地址。傳回單一字元。

• Y：地址未啟用
• N：地址有效

int32

表示 NoStat 類型。以 int 型別傳回原因代碼。

• 1：IDA (內部投遞地址)：未直接從 USPS 收到郵件的地址，但會傳送至提供服務的投遞地址。
• 2：CDS - 尚未可送達的地址。舉例來說，新分區已確定地塊和主要號碼，但尚未有可供入住的建築物。
• 3：衝突 - 實際上未通過 DPV 確認的地址。
• 4：CMZ (大學、軍事和其他類型) - 美國郵政署已納入資料的郵遞區編號 + 4 記錄。
• 5：一般 - 表示地址未收到郵件，且這些地址不會計入可能送達的郵件。
• 6：需要次要資訊 - 地址需要次要資訊。

string

標記表示郵件已送達網站上的單一收件匣。傳回單一字元。

• Y：郵件會送至網站上的單一收件匣。
• N：郵件並未送達網站上的單一收件者。

string

表示郵件未送達街道地址。傳回單一字元。

• Y：郵件未送達街道地址。
• N：郵件會送到街道地址。

string

此標記表示郵件並非在每週的每一天送達。傳回單一字元。

• Y：郵件並非每週每天都會送達。
• N：沒有郵件傳送時間表，無法確認郵件並非每週的每一天都會送達。

int32

整數，用於識別未放送日。您可以使用位元標記進行查詢：0x40 – 週日為非送達日 0x20 – 週一為非送達日 0x10 – 週二為非送達日 0x08 – 週三為非送達日 0x04 – 週四為非送達日 0x02 – 週五為非送達日 0x01 – 週六為非送達日

string

標記表示門可供存取，但基於安全考量，包裹不會留在門口。傳回單一字元。

• Y：基於安全考量，系統不會保留套件。
• N：沒有任何跡象顯示包裝盒不會因安全考量而留下。

string

表示地址已比對至 PBSA 記錄。傳回單一字元。

• Y：地址與 PBSA 記錄相符。
• N：地址與 PBSA 記錄不符。

string

此標記表示 USPS 無法敲門遞送郵件的地址。傳回單一字元。

• Y：無法開門。
• N：沒有任何標示表示無法進入房間。

string

表示該地址適用多個 DPV 傳回碼。傳回單一字元。

• Y：主要和所有次要號碼的地址均已通過 DPV 驗證。
• N：主要和任何次要號碼資訊無法通過 DPV 確認。
• S：系統只針對主要號碼確認地址 DPV，次要號碼資訊存在但未確認，或是主要號碼的單一尾碼遭到捨棄，導致 DPV 比對失敗，因此需要次要資訊。
• D：地址僅針對主要號碼通過 DPV 確認，且缺少次要號碼資訊。
• R：地址已確認，但指派給虛設路線 R777 和 R779，且未提供 USPS 運送服務。

string

運送公司路線代碼。四個字元的代碼，包含一個英文字母前置字串和三位數路線標記。

前置字串：

• C：運輸公司路線 (或城市路線)
• R：偏遠地區路線
• H：高速公路合約路線
• B：郵政信箱欄位
• G：一般運送單位

string

貨運公司路線費率排序指標。

bool

雖然運送地址可比對，但 EWS 檔案指出，不久後就會提供完全比對的結果。

string

主要郵局所在城市。

string

主要郵局狀態。

string

城市縮寫。

string

FIPS 縣/郡代碼。

string

郡/縣名稱。

string

強化航線 (eLOT) 編號。

string

eLOT 遞增/遞減旗標 (A/D)。

string

LACSLink 傳回碼。

string

LACSLink 指示燈。

bool

郵政信箱郵遞區號。

string

街道或高樓記錄與套房資訊比對後產生的附註。如果找到符合的商家名稱，系統會傳回次要號碼。

• A：SuiteLink 記錄相符，商家地址已改善。
• 00：未找到相符項目，商家地址未改善。

string

PMB (Private Mail Box) 單位指標。

string

PMB (Private Mail Box) 號碼

string

與輸入地址相符的地址記錄類型。

• F：FIRM。這是與「確實記錄」的比對結果，這是地址可用的最精確比對結果。
• G：一般運送。這項資訊與一般寄送記錄相符。
• H：建築物 / 公寓。這項資料與「建築物」或「公寓」記錄相符。
• P：郵政信箱。這是與郵政信箱的比對結果。
• R：RURAL ROUTE 或 HIGHWAY CONTRACT：這項屬性會與 Rural Route 或 Highway Contract 記錄相符，兩者都可能有相關聯的 Box Number 範圍。
• S：街道記錄：這是與含有有效主要號碼範圍的街道記錄相符。

bool

表示已找到預設地址，但有更具體的地址。

string

USPS 資料擷取錯誤訊息。系統偵測到人為建立的地址，因此 USPS 處理作業會暫停，這時就會填入這個值。

發生此錯誤時，系統可能不會填入 USPS 資料欄位。

bool

表示要求已由 CASS 處理的指標。

PostalAddress

必要欄位。正在驗證的地址。未經格式化的地址應透過 address_lines 提交。

此輸入內容中欄位的總長度不得超過 280 個字元。

如要查看支援的區域，請按這裡。

輸入位址中的 language_code 值是預留給日後使用，目前會遭到忽略。系統會根據指定地址的偏好語言，填入經過驗證的地址結果。

Address Validation API 會忽略 recipients 和 organization 中的值。系統會捨棄這些欄位中的所有值，不會傳回。請勿設定。

string

在第一次要求驗證地址時，這個欄位必須留空。如果需要更多要求才能完整驗證單一地址 (例如，如果使用者在初始驗證後所做的變更需要重新驗證)，則每個後續要求都必須在這個欄位中填入驗證序列中第一個回應的 response_id。

bool

啟用 USPS CASS 相容模式。這項變更只會影響 google.maps.addressvalidation.v1.ValidationResult 的 google.maps.addressvalidation.v1.ValidationResult.usps_data 欄位。注意：如果是針對波多黎各地址提出的 USPS CASS 啟用要求，address 的 google.type.PostalAddress.region_code 必須提供為「PR」，或是 address 的 google.type.PostalAddress.administrative_area 必須提供為「Puerto Rico」(不區分大小寫) 或「PR」。

建議您使用元件化 address，或者至少指定兩個 google.type.PostalAddress.address_lines，第一行包含門牌號碼和名稱，第二行則包含城市、州和郵遞區號。

LanguageOptions

選用設定。預先發布版：這項功能目前處於預先發布階段，也就是正式發布前的版本。正式發布前的產品和功能僅提供有限支援，且正式發布前產品和功能的變更可能與其他正式發布前版本不相容。正式發布前產品/功能受到《Google 地圖平台服務專屬條款》規範。詳情請參閱推出階段說明。

讓 Address Validation API 在回應中加入其他資訊。

string

選用設定。用於計費的 Autocomplete 工作階段識別字串。必須是安全的 base64 字串，且長度不得超過 36 個 ASCII 字元。否則會傳回 INVALID_ARGUMENT 錯誤。

工作階段會在使用者提出自動完成查詢時開始，並在使用者選取地點並發出對地點詳細資料或地址驗證的呼叫時結束。每個工作階段可以包含多個 Autocomplete 查詢，並且後續會有一個 Place Details 或 Address Validation 要求。在單一工作階段中，每項要求使用的憑證都必須屬於同一個 Google Cloud 控制台專案。工作階段結束後，符記就會失效；您的應用程式必須為每個工作階段產生新的符記。如果省略 sessionToken 參數或重複使用工作階段符記，系統會視為未提供工作階段符記，並針對工作階段收費 (每個要求分別收費)。

注意：Address Validation 只能用於使用 Autocomplete (新版) API 的工作階段，而非 Autocomplete API。詳情請參閱 https://developers.google.com/maps/documentation/places/web-service/session-pricing。

ValidationResult

地址驗證結果。

string

用於識別此回應的 UUID。如果地址需要重新驗證，則必須在新的要求中附上這個 UUID。

Verdict

整體判定結果標記

Address

地址本身的資訊，而非地理編碼。

Geocode

地址地理編碼的所在位置和地點資訊。

AddressMetadata

其他與可送達性相關的資訊。metadata 不保證會為每個傳送至 Address Validation API 的地址完整填入資料。

UspsData

美國郵政署提供的額外送達標記。僅提供 US 和 PR 區域。

Address

預先發布版：這項功能目前處於預先發布階段，也就是正式發布前的版本。正式發布前的產品和功能僅提供有限支援，且正式發布前產品和功能的變更可能與其他正式發布前版本不相容。正式發布前產品/功能受到《Google 地圖平台服務專屬條款》規範。詳情請參閱推出階段說明。

已翻譯成英文的地址。

翻譯的地址無法用於 API 輸入。服務會提供這些選項，方便使用者以母語確認或否認原先提供的地址是否有效。

如果部分地址沒有英文翻譯，服務會以使用拉丁字母的其他語言傳回該部分。如要瞭解系統如何選取替代語言，請參閱這篇文章。如果部分地址沒有使用拉丁字母的語言翻譯或轉寫，服務會以與地址相關聯的當地語言傳回該部分。

使用 google.maps.addressvalidation.v1.LanguageOptions.return_english_latin_address 旗標啟用這項輸出內容。

注意：english_latin_address 中的 google.maps.addressvalidation.v1.Address.unconfirmed_component_types 欄位和 english_latin_address.address_components 中的 google.maps.addressvalidation.v1.AddressComponent.confirmation_level 欄位未填入任何內容。

Granularity

輸入地址的精細程度。這是剖析輸入地址的結果，不會提供任何驗證信號。如需驗證信號，請參閱下方的 validation_granularity。

舉例來說，如果輸入的地址包含特定公寓號碼，這裡的 input_granularity 就會是 SUB_PREMISE。如果我們無法在資料庫中比對公寓號碼，或是公寓號碼無效，validation_granularity 可能會是 PREMISE 或以下。

Granularity

API 可完整驗證地址的精細程度。舉例來說，如果 validation_granularity 為 PREMISE，表示可驗證所有位於 PREMISE 或更粗略層級的地址元件。

您可以在 google.maps.addressvalidation.v1.Address.address_components 中查看每個地址元件的驗證結果。

Granularity

geocode 的精細程度資訊。這可視為地理編碼位置的語意意義，表示地點的精確程度。

這可能與上述 validation_granularity 不同。舉例來說，我們的資料庫可能會記錄公寓號碼，但沒有公寓在大型公寓大廈內的確切位置。在這種情況下，validation_granularity 會是 SUB_PREMISE，但 geocode_granularity 會是 PREMISE。

bool

如果沒有未解析的符記、不含意外或遺漏的地址元件，則系統會視為完整地址。如果未設定，表示值為 false。詳情請參閱 missing_component_types、unresolved_tokens 或 unexpected 欄位。

bool

至少有一個地址元件無法分類或驗證，詳情請參閱 google.maps.addressvalidation.v1.Address.address_components。

bool

系統推斷 (新增) 了至少一個未在輸入內容中的地址元件，詳情請參閱 google.maps.addressvalidation.v1.Address.address_components。

bool

至少有一個地址元件遭到取代，詳情請參閱 google.maps.addressvalidation.v1.Address.address_components。