索引
AddressValidation
(介面)Address
(訊息)AddressComponent
(訊息)AddressComponent.ConfirmationLevel
(列舉)AddressMetadata
(訊息)ComponentName
(訊息)Geocode
(訊息)LanguageOptions
(訊息)PlusCode
(訊息)ProvideValidationFeedbackRequest
(訊息)ProvideValidationFeedbackRequest.ValidationConclusion
(列舉)ProvideValidationFeedbackResponse
(訊息)UspsAddress
(訊息)UspsData
(訊息)ValidateAddressRequest
(訊息)ValidateAddressResponse
(訊息)ValidationResult
(訊息)Verdict
(訊息)Verdict.Granularity
(列舉)
AddressValidation
用於驗證地址的服務。
ProvideValidationFeedback |
---|
針對驗證嘗試序列的結果提供意見。這是對相同地址進行一系列驗證呼叫之後發出的最後一次呼叫,應在交易完成時呼叫。請依照 |
ValidateAddress |
---|
驗證地址。 |
地址
處理後地址的詳細資料。後續處理包括修正地址中錯字的部分、替換不正確的部分,以及推斷缺漏的部分。
欄位 | |
---|---|
formatted_address |
依地址所在區域的地址格式規則後處理的地址,格式為單行地址。 |
postal_address |
後處理地址,以郵寄地址表示。 |
address_components[] |
未排序的清單。格式化地址的個別地址元件和驗證資訊。以便瞭解個別元件的驗證狀態。 地址元件不依特定順序排列。請勿假設清單中地址元件的順序。 |
missing_component_types[] |
應該出現在郵寄地址正確的郵寄地址中,「而且」無法推斷出類型的元件類型。 |
unconfirmed_component_types[] |
|
unresolved_tokens[] |
輸入裝置中無法解析的任何符記。例如,系統無法識別這個輸入內容是地址的有效部分 (例如輸入如「123235253253 Main St, San Francisco, CA, 94105」這類的輸入值),則未解析的符記看起來可能像 |
AddressComponent
代表地址元件,例如街道、城市或州/省。
欄位 | |
---|---|
component_name |
元件的名稱。 |
component_type |
地址元件的類型。如需可能的類型清單,請參閱「表 2:地點介面集服務傳回的其他類型」。 |
confirmation_level |
表示我們確定元件正確無誤。 |
inferred |
表示輸入元件並非輸入內容的一部分,但我們根據地址位置推論此元件,且認為應提供完整的地址。 |
spell_corrected |
表示元件名稱中拼字有誤的修正。API 不一定會將拼字變體的不同變更標記出來,例如將「centre」變更為「center」時。這項功能有時也會標記常見的錯別字,例如將「Amphitheater Pkwy」變更為「Amphitheatre Pkwy」(英式開機車) 中。 |
replaced |
表示元件名稱已由完全不同的名稱取代,例如將錯誤的郵遞區號替換成地址正確的郵遞區號。這不是外觀的變更,而是輸入元件已變更。 |
unexpected |
表示指定區域的郵寄地址中沒有地址元件。我們只保留了因為內容為輸入內容的一部分。 |
ConfirmationLevel
確認等級的不同可能值。
列舉 | |
---|---|
CONFIRMATION_LEVEL_UNSPECIFIED |
預設值。未使用這個值。 |
CONFIRMED |
我們能夠確認這個元件確實存在,且在地址的其他部分具有意義。 |
UNCONFIRMED_BUT_PLAUSIBLE |
無法確認這個元件,但元件可能存在。例如街道中已知有效號碼範圍中的門牌號碼,且該號碼未知數。 |
UNCONFIRMED_AND_SUSPICIOUS |
這個元件未經確認,可能有誤。例如與地址其餘部分不符的社區。 |
AddressMetadata
地址的中繼資料。我們不保證會針對傳送至 Address Validation API 的每個地址填入 metadata
。
欄位 | |
---|---|
business |
表示這是商家的地址。如未設定,則表示值不明。 |
po_box |
表示郵政信箱的地址。如未設定,則表示值不明。 |
residential |
表示這是居住地址。如未設定,則表示值不明。 |
ComponentName
元件名稱的包裝函式。
欄位 | |
---|---|
text |
名稱文字。例如「5th Avenue」代表街道名稱,「1253」代表門牌號碼。 |
language_code |
BCP-47 語言代碼。如果元件名稱與語言 (例如門牌號碼) 沒有關聯,就不會顯示這個屬性。 |
Geocode
內含輸入地理編碼目的地的地點相關資訊。
欄位 | |
---|---|
location |
輸入內容的地理編碼位置。 比起使用地址、經緯度座標或加號,更建議使用地點 ID。使用座標來規劃行車路線或計算行車路線時,一律都會與最接近這些座標的道路對齊。這類道路不一定是即將或安全地導向目的地的道路,而且可能不在房源的存取點附近。此外,執行反向地理編碼時,我們也無法保證傳回的地址會與原始地址相符。 |
plus_code |
與 |
bounds |
地理編碼地點的邊界。 |
feature_size_meters |
地理編碼地點的大小 (以公尺為單位)。對於地理編碼位置的粗略性,這是另一種測量方式,但是以實際大小而非語意含義。 |
place_id |
此輸入地理編碼目的地地點的 PlaceID。 如要進一步瞭解地點 ID,請參閱這篇文章。 |
place_types[] |
輸入進行地理編碼的地點類型。例如: |
LanguageOptions
預先發布版:這項功能目前處於預先發布階段,也就是正式發布前的版本。正式發布前的產品和功能僅提供有限支援,且正式發布前產品和功能的變更可能與其他正式發布前版本不相容。正式發布前產品/功能受到《Google 地圖平台服務專屬條款》規範。詳情請參閱推出階段說明。
啟用 Address Validation API,在回應中加入其他資訊。
欄位 | |
---|---|
return_english_latin_address |
預覽:以英文傳回 |
PlusCode
Plus code (http://plus.codes) 是一種位置參照,格式有兩種:定義 14mx14m (度數 1/8000 度) 或小矩形代碼,以及複合代碼,將前置字串替換為參考位置。
欄位 | |
---|---|
global_code |
地點的全球 (完整) 代碼,例如「9FWM33GV+HQ」,代表 1/8000 x 1/8000 度角 (約 14 x 14 公尺)。 |
compound_code |
地點的複合代碼 (例如「33GV+HQ, Ramberg, Norway」) 包含全域代碼後置字串,並將前置字串替換成參照實體的格式化名稱。 |
ProvideValidationFeedbackRequest
傳送驗證意見回饋的要求。
欄位 | |
---|---|
conclusion |
必要欄位。驗證嘗試序列的結果。 如果將這個欄位設為 |
response_id |
必要欄位。意見回饋適用的回應 ID。這應該是一系列地址驗證嘗試中第一個回應的 [response_id][google.maps.addressvalidation.v1.ValidateAddressRequest.response_id]。 |
ValidationConclusion
驗證地址所需的地址驗證要求序列的最終結果。
列舉 | |
---|---|
VALIDATION_CONCLUSION_UNSPECIFIED |
未使用這個值。如果將 ProvideValidationFeedbackRequest.conclusion 欄位設為 VALIDATION_CONCLUSION_UNSPECIFIED ,系統會傳回 INVALID_ARGUMENT 錯誤。 |
VALIDATED_VERSION_USED |
Address Validation API 傳回的地址版本用於交易。 |
USER_VERSION_USED |
使用者在交易中提供的地址版本 |
UNVALIDATED_VERSION_USED |
上次驗證後輸入的地址版本,但未重新驗證後進行交易。 |
UNUSED |
交易已放棄,未使用地址。 |
ProvideValidationFeedbackResponse
這個類型沒有任何欄位。
驗證意見回饋的回應。
如果意見回饋成功傳送,回應會沒有任何內容。
UspsAddress
USPS 表示法。
欄位 | |
---|---|
first_address_line |
第一行地址。 |
firm |
公司名稱。 |
second_address_line |
第二行地址 |
urbanization |
波多黎各都市化名稱。 |
city_state_zip_address_line |
城市 + 州/省 + 郵遞區號。 |
city |
城市名稱。 |
state |
由 2 個英文字母組成的州碼。 |
zip_code |
郵遞區號,例如 10009。 |
zip_code_extension |
4 位數郵遞區號額外資訊,例如 5023。 |
UspsData
地址的 USPS 資料。我們不保證會為每個傳送至 Address Validation API 的美國或 PR 位址完整填入 uspsData
。如果您使用 uspsData 做為回應的主要部分,建議您在回應中整合備用地址欄位。
欄位 | |
---|---|
standardized_address |
USPS 標準化位址。 |
delivery_point_code |
2 位數寄送點代碼 |
delivery_point_check_digit |
寄送點檢查碼。這個號碼會加入用於自動掃描郵件,在 Delivery_point_barcode 末端所加上的號碼。將 send_point_barcode、delivery_point_check_digit、郵遞區號和 ZIP+4 的所有數字相加後,將得到可以用 10 除盡的數字。 |
dpv_confirmation |
DPV 確認要求的可能值。會傳回單一字元或未傳回任何值。
|
dpv_footnote |
運送點驗證的註腳。多個註腳可能會出現在同一個字串中。
|
dpv_cmra |
指出地址是否為 CMRA (商用郵件接收代理商),這是供客戶接收郵件的私人企業。傳回單一字元。
|
dpv_vacant |
這裡不開放嗎?傳回單一字元。
|
dpv_no_stat |
這是否為沒有統計資料的地址或有效的地址?沒有統計資料地址,即非持續佔據的地址或 USPS 不提供服務的位址。傳回單一字元。
|
dpv_no_stat_reason_code |
表示 NoStat 類型。以 int 傳回原因代碼。
|
dpv_drop |
這個標記表示郵件已傳送至某個網站上單一可接收的郵件。傳回單一字元。
|
dpv_throwback |
表示郵件未傳送至街道地址。傳回單一字元。
|
dpv_non_delivery_days |
這個標記表示郵件未在同一週內每天傳送。傳回單一字元。
|
dpv_non_delivery_days_values |
識別未送達天數的整數。可以使用位元旗標進行審核:0x40 - 星期日是非放送日 0x20 – 星期一是 0x08 未放送日。星期三是非放送日 0x04 – 星期三是非放送日 0x04 – 星期四是非放送日 0x02 – 星期四是非放送日。 |
dpv_no_secure_location |
這個標記表示門外有無障礙,但出於安全考量,系統不會留下包裹。傳回單一字元。
|
dpv_pbsa |
表示地址與 PBSA 記錄相符。傳回單一字元。
|
dpv_door_not_accessible |
旗標用於表示 USPS 無法親自寄門郵件的地址。傳回單一字元。
|
dpv_enhanced_delivery_code |
表示地址的有效 DPV 傳回代碼。傳回單一字元。
|
carrier_route |
貨運公司路線代碼。由 1 個字母前置字元和 3 位數路線指示器所組成的四個字元代碼。 前置字串:
|
carrier_route_indicator |
貨運公司路線費率排序指標。 |
ews_no_match |
寄送地址可以比對,不過 EWS 檔案表示很快就會取得完全相符的地址。 |
post_office_city |
主要郵局城市。 |
post_office_state |
主要的郵局狀態。 |
abbreviated_city |
縮寫城市。 |
fips_county_code |
FIPS 縣市代碼。 |
county |
郡/縣名稱。 |
elot_number |
加強行業 (eLOT) 編號。 |
elot_flag |
eLOT 遞增/遞減標記 (A/D)。 |
lacs_link_return_code |
LACSLink 傳回代碼。 |
lacs_link_indicator |
LACSLink 指標。 |
po_box_only_postal_code |
郵政信箱僅包含郵遞區號。 |
suitelink_footnote |
這些註腳包括將街道或高樓層記錄與套房資訊進行比對的註腳。如果系統找到商家名稱相符,就會傳回次要號碼。
|
pmb_designator |
PMB (私人信箱) 單元設計人員。 |
pmb_number |
PMB (私人信箱) 號碼; |
address_record_type |
與輸入地址相符的地址記錄類型。
|
default_address |
這個指標代表已找到預設地址,但存在更明確的地址。 |
error_message |
USPS 資料擷取的錯誤訊息。如果因為偵測到人工建立地址而暫停 USPS 處理作業,系統就會填入這項資訊。 發生這個錯誤時,系統可能不會填入 USPS 資料欄位。 |
cass_processed |
表示要求已處理 CASS 處理的指標。 |
ValidateAddressRequest
驗證地址的要求。
欄位 | |
---|---|
address |
必要欄位。要驗證的地址。未設定格式的地址應透過 這項輸入欄位中的欄位總長度不得超過 280 個半形字元。 支援的地區請參閱這裡。 輸入地址中的 Address Validation API 會忽略 |
previous_response_id |
首次地址驗證要求時,這個欄位必須留空。如果需要更多要求才能完整驗證單一地址 (例如,若使用者在初始驗證後所做的變更需要重新驗證),則每個後續要求都必須在驗證序列中第一個回應內,將 |
enable_usps_cass |
啟用 USPS CASS 相容模式。這項操作只會影響 建議您使用元件化的 |
language_options |
選用設定。預先發布版:這項功能目前處於預先發布階段,也就是正式發布前的版本。正式發布前的產品和功能僅提供有限支援,且正式發布前產品和功能的變更可能與其他正式發布前版本不相容。正式發布前產品/功能受到《Google 地圖平台服務專屬條款》規範。詳情請參閱推出階段說明。 啟用 Address Validation API,在回應中加入其他資訊。 |
session_token |
選用設定。用於識別計費 Autocomplete 工作階段的字串。必須是網址和檔案名稱安全 Base64 字串,長度上限為 36 個 ASCII 字元。否則系統會傳回 INVALID_UNIT 錯誤。 工作階段從使用者提出 Autocomplete 查詢時起算,直到使用者選取地點,並呼叫 Place Details 或 Address Validation 時結束。每個工作階段可包含多個 Autocomplete 查詢,後面接著一個 Place Details 或 Address Validation 要求。工作階段內每個要求使用的憑證,必須隸屬於同一個 Google Cloud 控制台專案。工作階段結束後,符記就會失效;應用程式必須為每個工作階段產生新的符記。如果省略 注意:Address Validation 僅適用於搭配 Autocomplete (New) API 的工作階段,而非 Autocomplete API。詳情請參閱 https://developers.google.com/maps/documentation/places/web-service/session-pricing。 |
ValidateAddressResponse
地址驗證要求的回應。
欄位 | |
---|---|
result |
地址驗證的結果。 |
response_id |
用於識別此回應的 UUID。如果地址需要重新驗證,這個 UUID「必須」隨新要求一併驗證。 |
ValidationResult
驗證地址的結果。
欄位 | |
---|---|
verdict |
整體判定結果標記 |
address |
地址本身 (而非地理編碼) 的資訊。 |
geocode |
取得地址地理編碼的位置和地點的相關資訊。 |
metadata |
與交付功能有關的其他資訊。我們不保證會針對傳送至 Address Validation API 的每個地址填入 |
usps_data |
USPS 提供的額外傳送性旗標。僅在 |
english_latin_address |
預先發布版:這項功能目前處於預先發布階段,也就是正式發布前的版本。正式發布前的產品和功能僅提供有限支援,且正式發布前產品和功能的變更可能與其他正式發布前版本不相容。正式發布前產品/功能受到《Google 地圖平台服務專屬條款》規範。詳情請參閱推出階段說明。 地址已翻譯成英文。 翻譯的地址無法做為 API 輸入內容重複使用。此服務會提供這些 API,讓使用者能使用其母語,確認或拒絕原先提供的地址驗證。 如果地址的一部分未提供英文翻譯,服務會以拉丁字母系統的替代語言傳回該部分地址。如需瞭解如何選擇替代語言,請參閱這裡的說明。如果地址其中一部分沒有使用拉丁字母語言之翻譯或音譯,服務會以與地址相關聯的當地語言傳回該部分。 使用 注意: |
評斷
地址驗證結果和地理編碼的概要總覽。
欄位 | |
---|---|
input_granularity |
輸入位址的精細程度。也就是剖析輸入地址的結果,並不會提供任何驗證信號。如要瞭解驗證信號,請參閱下方的 舉例來說,如果輸入的地址含有特定公寓號碼,則這裡的 |
validation_granularity |
API 可完整「驗證」validate地址的目標精細程度。舉例來說,如果 每個地址元件的驗證結果可在 |
geocode_granularity |
這有時會與上方的 |
address_complete |
如果沒有未解析的權杖、沒有非預期或遺漏的地址元件,系統會將地址視為「完整」。如未設定,則表示值為 |
has_unconfirmed_components |
至少有一個地址元件無法分類或驗證,詳情請參閱 |
has_inferred_components |
系統判定至少有一個地址元件不是輸入的內容所推測 (已新增),詳情請參閱 |
has_replaced_components |
至少一個地址元件已被取代,詳情請參閱 |
精細程度
地址或地理編碼的各種精細程度。用來表示「地址」的精細程度時,這些值代表地址識別郵件目的地的精細程度。例如,「123 Main Street, Redwood City, CA, 94061」這類地址可識別 PREMISE
,而「Redwood City, CA, 94061」則代表 LOCALITY
。不過,如果我們無法在紅木市找到「123 Main Street」的地理編碼,則傳回的地理編碼可能會是 LOCALITY
的精細度。
列舉 | |
---|---|
GRANULARITY_UNSPECIFIED |
預設值。未使用這個值。 |
SUB_PREMISE |
位於建築物等級下方的結果,例如公寓。 |
PREMISE |
建築物層級結果。 |
PREMISE_PROXIMITY |
推估地址的建築物層級位置的地理編碼。 |
BLOCK |
地址或地理編碼會指出一個區塊。只用於具有區塊層級定址的區域,例如日本。 |
ROUTE |
地理編碼或地址的精細程度是路線,例如街道、道路或高速公路。 |
OTHER |
其餘的精細程度則會聚集在一起,因為這類項目無法傳送。 |