REST Resource: accounts.businessInfo

資源：BusinessInfo

BusinessInfo 訊息包含商家業務的必要資訊。

這則訊息會擷取實體地址、客服聯絡人和區域專屬 ID 等重要商家詳細資料。

JSON 表示法 
{
  "name": string,
  "address": {
    object (PostalAddress)
  },
  "phone": {
    object (PhoneNumber)
  },
  "phoneVerificationState": enum (PhoneVerificationState),
  "customerService": {
    object (CustomerService)
  },
  "koreanBusinessRegistrationNumber": string
}
欄位
name

string

ID。商家資訊的資源名稱。格式：accounts/{account}/businessInfo
address

object (PostalAddress)

選用設定。商家地址。僅支援 regionCode、addressLines、postalCode、administrativeArea 和 locality 欄位。系統會忽略所有其他欄位。
phone

object (PhoneNumber)

僅供輸出。商家的電話號碼。
phoneVerificationState

enum (PhoneVerificationState)

僅供輸出。商家電話驗證狀態。
customerService

object (CustomerService)

選用設定。商家的客戶服務。
koreanBusinessRegistrationNumber

string

選用設定。10 位數的韓國商業登記號碼，以連字號分隔，格式為：XXX-XX-XXXXX。

PostalAddress

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

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

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

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

JSON 表示法 
{
  "revision": integer,
  "regionCode": string,
  "languageCode": string,
  "postalCode": string,
  "sortingCode": string,
  "administrativeArea": string,
  "locality": string,
  "sublocality": string,
  "addressLines": [
    string
  ],
  "recipients": [
    string
  ],
  "organization": string
}
欄位
revision

integer

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

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

string

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

string

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

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

例如：「zh-Hant」、「ja」、「ja-Latn」、「en」。
postalCode

string

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

string

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

string

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

string

選用設定。一般是指地址的縣市/鄉鎮部分。例如：美國城市、義大利市鎮、英國郵鎮。如為未明確定義縣市或其縣市不適用此結構的地區，請將 locality 留白，改用 addressLines。
sublocality

string

選用設定。地址的縣市以下行政區，例如社區、自治市鎮和區等。
addressLines[]

string

非結構化的地址行，說明地址的低層級項目。

由於 addressLines 中的值不會有類型資訊，而且有時在單一欄位中可能會包含多個值 (例如「Austin, TX」)，因此地址行的順序務必要明確。地址行的順序應為該地址所在國家/地區的「信封書寫順序」。在信封書寫順序可能不盡相同的地區 (例如日本)，可使用 address_language 讓地址更明確 (例如「ja」表示由大到小的排序，而「ja-Latn」或「en」則表示由小到大)。如此一來，您便可以根據語言來選取明確度最高的地址行。

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

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

string

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

string

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

PhoneNumber

代表電話號碼的物件，適合作為 API 電報格式。

以下是這項表示法：

  • 不應用於電話號碼的語言代碼特定格式，例如「+1 (650) 253-0000 ext. 123」

  • 並非針對高效儲存空間而設計

  • 可能不適合用於撥號 - 應使用專用程式庫 (請參閱參考資料) 剖析號碼

如要對此號碼執行有意義的操作，例如為各種用途設定格式，請先將其轉換為 i18n.phonenumbers.PhoneNumber 物件。

例如，在 Java 中，這會是：

com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); }

參考資料：- https://github.com/google/libphonenumber

JSON 表示法 
{
  "extension": string,

  // Union field kind can be only one of the following:
  "e164Number": string,
  "shortCode": {
    object (ShortCode)
  }
  // End of list of possible types for union field kind.
}
欄位
extension

string

電話號碼的副號。ITU 的建議中並未標準化擴充功能，但已將其定義為一連串數字，長度上限為 40 位數。除了數字之外，這裡可能會儲存其他撥號字元，例如「,」(表示等待) 或「#」。

請注意，目前沒有任何地區使用含有短碼的擴充功能，因此這個欄位通常只會與 E.164 號碼一起設定。這項資訊會與 E.164 號碼分開保管，以便日後新增短碼擴充功能。
聯集欄位 kind。必要欄位。可以是一般號碼或簡碼。未來可能會在下方的 oneof 中新增欄位，因此如果用戶端所對應的任何欄位都未設定，就應忽略該電話號碼。kind 只能是下列其中一項：
e164Number

string

電話號碼，以開頭加號 ('+') 表示，後面接著採用放寬版 ITU E.164 格式的電話號碼，其中包含國家/地區撥打代碼 (1 到 3 位數) 和訂閱者號碼，不含額外的空格或格式設定。例如： - 正確："+15552220123" - 錯誤："+1 (555) 222-01234 x123"。

ITU E.164 格式規定後者最多只能有 12 位數，但實際上並非所有國家/地區都遵守這項規定，因此我們在這裡放寬限制。不允許僅限國內使用的電話號碼。

參考資料：- https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164。- https://en.wikipedia.org/wiki/List_of_country_calling_codes
shortCode

object (ShortCode)

短碼。

參考資料：- https://en.wikipedia.org/wiki/Short_code

ShortCode

代表短碼的物件，短碼通常比一般電話號碼短得多，可用於 MMS 和 SMS 系統中的訊息，以及縮寫撥號 (例如「傳送簡訊至 611，查看你的方案剩餘分鐘數」。)

短碼僅限於特定區域使用，無法撥打國際電話，也就是說，同一個短碼可能會出現在不同區域，且使用方式和價格各異，即使這些區域使用相同的國家/地區撥打代碼 (例如美國和加拿大) 也是如此。

JSON 表示法 
{
  "regionCode": string,
  "number": string
}
欄位
regionCode

string

必要欄位。可撥打這個短碼的地區的 BCP-47 區域代碼，例如「US」和「BB」。

參考資料：- http://www.unicode.org/reports/tr35/#unicode_region_subtag
number

string

必要欄位。短碼的數字，不含開頭的加號 ('+') 或國家/地區撥號代碼。例如「611」。

PhoneVerificationState

電話驗證狀態。

列舉
PHONE_VERIFICATION_STATE_UNSPECIFIED 預設值。此值未使用。
PHONE_VERIFICATION_STATE_VERIFIED 電話已驗證。
PHONE_VERIFICATION_STATE_UNVERIFIED 手機未經過驗證

CustomerService

客戶服務資訊。

JSON 表示法 
{
  "uri": string,
  "email": string,
  "phone": {
    object (PhoneNumber)
  }
}
欄位
uri

string

選用設定。可找到客戶服務的 URI。
email

string

選用設定。可用於聯絡客戶服務的電子郵件地址。
phone

object (PhoneNumber)

選用設定。可撥打至客戶服務團隊的電話號碼。

方法

getBusinessInfo

 擷取帳戶的商家資訊。

updateBusinessInfo

 更新帳戶的商家資訊。