Package google.type

索引

LatLng

代表經緯度組合的物件。以一對雙精準數表示經度度數和緯度度數。除非另有指定,否則這個物件必須符合 WGS84 標準。此外,值必須在正規化範圍內。

欄位
latitude

double

緯度度數,必須介於 [-90.0, +90.0] 的範圍之間。

longitude

double

經度度數,必須介於 [-180.0, +180.0] 的範圍之間。

PostalAddress

表示郵寄地址,如郵政快遞或付款地址。如果是郵寄地址,郵政服務可將貨品寄送到場所、郵政信箱或類似位置。郵寄地址不適用於模擬道路、鄉鎮或山區等地理位置。

在一般使用情況下,系統會根據處理作業的類型,以使用者輸入或匯入現有資料的方式來建立地址。

輸入或編輯地址時的建議:

  • 使用支援國際化的地址小工具,例如 https://github.com/google/libaddressinput
  • 在使用該欄位的國家/地區以外的位置上,不應向使用者顯示用於輸入或編輯欄位的 UI 元素。

如要進一步瞭解如何使用這個結構定義,請參閱:https://support.google.com/business/answer/6397478

欄位
revision

int32

PostalAddress 的結構定義修訂版本。任何值若不是 0,都會導致 API 傳回 INVALID_ARGUMENT 錯誤。

region_code

string

(選用步驟) 地址所在國家/地區的 CLDR 地區代碼。詳情請參閱 https://cldr.unicode.org/https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html。例如:瑞士的地區代碼為「CH」。如果未提供區域代碼,系統會根據地址推斷。為獲得最佳效能,建議您加入區域代碼 (如果您知道的話)。區域不一致或重複會導致成效不佳,舉例來說,如果 address_lines 已包含區域,請勿在這個欄位中再次提供區域代碼。如需支援的地區,請參閱常見問題

language_code

string

輸入地址中的語言代碼是保留供日後使用,目前會遭到忽略。API 會以地址所在地的適當語言傳回地址。

postal_code

string

(選用步驟) 地址的郵遞區號。並非所有國家/地區都使用郵遞區號或要求必須填寫郵遞區號,不過在使用郵遞區號時,可能會對地址其他部分觸發額外的驗證作業 (例如美國對州/郵遞區號的驗證)。

sorting_code

string

(選用步驟) 國家/地區專屬的其他分類代碼。大多數國家/地區並不使用這個代碼。在使用該屬性時,其值為「CEDEX」之類的字串,可選擇加上數字 (例如「CEDEX 7」),或只使用數字,代表「部門代碼」(牙買加)、「送達區域指標」(馬拉威) 或「郵局指標」(象牙海岸)。

administrative_area

string

(選用步驟) 最高行政區,用於國家/地區的郵遞地址。例如,此值可以是州、省或縣。以西班牙為例來具體說明,此欄位的值為省,而非自治區 (例如「巴塞隆納」省,而不是「加泰隆尼亞」自治區)。許多國家/地區的郵寄地址並沒有使用行政區。例如,在瑞士,這個欄位應該留空不填。

locality

string

(選用步驟) 一般是指地址的縣市/鄉鎮部分。例如:美國城市、義大利市鎮、英國郵鎮。如為未明確定義縣市或其縣市不適用此結構的地區,請將 locality 留白,改用 address_lines

sublocality

string

(選用步驟) 地址的縣市以下行政區,例如社區、自治市鎮和區等。

address_lines[]

string

必要欄位。非結構化的地址行,說明地址的低層級項目。

由於 address_lines 中的值不會有類型資訊,而且有時在單一欄位中可能會包含多個值 (例如「Austin, TX」),因此地址行的順序務必要明確。地址行的順序應為該地址所在國家/地區的「信封書寫順序」。

地址允許的最小結構表示法是包含所有資訊放置在 address_lines 中。如果未提供 region_code,系統會根據地址列推斷區域。

如要處理完全非結構化的地址,我們建議您只建立包含 address_lines 的地址,並使用地理定位來進行 (而非猜測地址的哪些部分應該是縣市還是行政區)。

recipients[]

string

請勿設定此欄位。Address Validation API 目前不會使用這項功能。雖然目前 API 不會拒絕含有此欄位的請求,但系統會捨棄該資訊,不會在回應中傳回。

organization

string

請勿設定此欄位。Address Validation API 目前不會使用這項功能。雖然目前 API 不會拒絕含有此欄位的請求,但系統會捨棄該資訊,不會在回應中傳回。