Package google.type

索引

日期

代表完整或部分日曆的日期，例如生日。您可在其他位置指定日期和時間，或沒有其他選擇。日期以公曆為相對於公曆。可能代表下列其中一種：

  • 完整日期，具有非零的年、月和日值
  • 月值和日值，包含零年，例如週年紀念日
  • 只有年，月和日值為零
  • 年和月份值，零天，例如信用卡到期日

相關類型為 google.type.TimeOfDay 和 google.protobuf.Timestamp。

欄位
year

int32

日期的年份。必須為 1 到 9999，或是 0 才能指定不含年份的日期。
month

int32

一年中的月份。必須為 1 到 12 或 0，才能指定不含月份和日的年份。
day

int32

一個月中的第幾天。值必須介於 1 到 31 之間，且為該年和月份計算而得；設為 0 可以只指定年份，也可以只指定年份和月份，但日期可不算。

DayOfWeek

代表星期幾。

列舉
DAY_OF_WEEK_UNSPECIFIED 未指定星期幾。
MONDAY 週一
TUESDAY 週二
WEDNESDAY 星期三
THURSDAY 週四
FRIDAY 星期五
SATURDAY Saturday (週六)
SUNDAY 星期日

LatLng

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

欄位
latitude

double

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

double

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

Money

表示金額與貨幣類型。

欄位
currency_code

string

ISO 4217 定義的貨幣代碼 (由三個字母組成)。
units

int64

金額的整數單位。舉例來說，如果 currencyCode 是 "USD"，則 1 單位為 1 美元。
nanos

int32

金額的十億分之一 (10^-9) 單位數量。這個值必須介於 -999,999,999 和 +999,999,999 (含) 之間。如果 units 為正數，nanos 必須為正數或零。如果 units 為零，nanos 可以是正數、零或負數。如果 units 為負數，nanos 必須為負數或零。舉例來說，$-1.75 的表示法為 units=-1，nanos=-750,000,000。

PostalAddress

表示郵寄地址，如郵政快遞或付款地址。如果是郵寄地址，郵政服務可將貨品寄送到場所、郵政信箱或類似位置。此表示法並不適用於建立地理位置 (街道、鄉鎮或山區) 的模型。

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

地址輸入/編輯的建議：- 使用支援 i18n 的地址小工具 (例如 https://github.com/google/libaddressinput)：在使用該欄位的國家/地區之外，不應向使用者顯示 UI 元素來輸入或編輯欄位。

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

欄位
revision

int32

PostalAddress 的結構定義修訂版本。這個欄位的值必須設為 0，即代表最新的修訂版本。

所有新的修訂版本都必須能夠與舊的修訂版本回溯相容。
region_code

string

必要欄位。地址所在國家/地區的 CLDR 地區代碼。這個代碼絕非透過推測而得出，並且是由使用者自行確保該值正確無誤。詳情請參閱 http://cldr.unicode.org/ 和 http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html。例如：瑞士的地區代碼為「CH」。
language_code

string

選用設定。這個地址內容的 BCP-47 語言代碼 (如果已知)。通常是輸入表單的 UI 語言，或是符合地址的國家/地區所用的其中一個語言，或是使用音譯的對應項目。這個欄位可能會影響某些國家/地區的格式設定，但是不會影響資料的正確性，也絕不會影響任何驗證或其他非格式的相關作業。

如果不知道這個值為何，則應省略該值 (而非指定可能不正確的預設值)。

例如：「zh-Hant」、「ja」、「ja-Latn」、「en」。
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_language 讓地址更明確 (例如「ja」表示由大到小的排序，而「ja-Latn」或「en」則表示由小到大)。如此一來，您便可以根據語言來選取明確度最高的地址行。

地址允許的最小結構表示法是包含一個 region_code，並將其餘所有資訊放置在 address_lines 中。您可以在幾乎不使用地理定位的情况下，設定這類地址的格式，但至少在地址局部解析完畢之前，您無法對地址的任何組成部分進行語意推論。

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

string

選用設定。地址的收件人。在某些情況下，這個欄位可能會包含多行資訊。舉例來說，此欄位可能包含「代收者」資訊。
organization

string

選用設定。地址中的機構名稱。

TimeOfDay

代表一天中的時間。日期和時區並不需要指定，或是在其他位置上指定。API 可選擇允許閏秒。相關類型為 google.type.Date 和 google.protobuf.Timestamp。

欄位
hours

int32

時段，採用 24 小時格式。值應介於 0 到 23 之間。API 可選擇允許使用「24:00:00」這類的值來表示營業打烊時間等情況。
minutes

int32

一天內的分鐘。值必須介於 0 到 59 之間。
seconds

int32

當下時間的秒數。正常情況下，值必須介於 0 到 59 之間。如果 API 允許閏秒，則可允許值為 60。
nanos

int32

秒數的小數，以奈秒為單位。值必須介於 0 到 999,999,999 之間。