REST Resource: accounts

資源:帳戶

帳戶是商家地點的容器。如果您是商家唯一的管理者,可以使用個人 Google 帳戶。如要與多位使用者共同管理地點,請建立商家帳戶

JSON 表示法
{
  "name": string,
  "accountName": string,
  "primaryOwner": string,
  "type": enum (AccountType),
  "role": enum (AccountRole),
  "verificationState": enum (VerificationState),
  "vettedState": enum (VettedState),
  "accountNumber": string,
  "permissionLevel": enum (PermissionLevel),
  "organizationInfo": {
    object (OrganizationInfo)
  }
}
欄位
name

string

無法變更。資源名稱,格式為 accounts/{account_id}

accountName

string

必要欄位。帳戶名稱。就 PERSONAL 類型的帳戶而言,這是使用者帳戶的姓名。

primaryOwner

string

必要欄位。僅限輸入。帳戶的資源名稱,將是所建立帳戶的主要擁有者。格式應為 accounts/{account_id}

type

enum (AccountType)

必要欄位。包含帳戶類型。無法使用這個 API 建立 PERSONAL 和 Organization 類型的帳戶。

role

enum (AccountRole)

僅供輸出。指定這個帳戶的 AccountRole。

verificationState

enum (VerificationState)

僅供輸出。通過驗證後,日後建立的地點就會自動連結至 Google 地圖,而 Google+ 專頁不需經過審核即可建立。

vettedState

enum (VettedState)

僅供輸出。表示帳戶是否已經過 Google 審查。已通過審查的帳戶可以透過 VETTED_PARTNER 方法驗證地點。

accountNumber

string

僅供輸出。帳戶參考號碼 (如有提供)。

permissionLevel

enum (PermissionLevel)

僅供輸出。指定使用者對這個帳戶的權限層級。

organizationInfo

object (OrganizationInfo)

僅供輸出。機構的其他資訊。系統只會為機構帳戶填入這項資訊。

AccountType

表示屬於個人/使用者帳戶或企業帳戶。

列舉
ACCOUNT_TYPE_UNSPECIFIED 未指定。
PERSONAL 使用者帳戶。
LOCATION_GROUP 一組地點。詳情請參閱說明中心文章
USER_GROUP 使用者群組,用於將機構員工區隔成不同群組。詳情請參閱說明中心文章
ORGANIZATION 代表公司的機構。詳情請參閱說明中心文章

AccountRole

指出已驗證使用者對這個帳戶的存取層級。詳情請參閱說明中心文章

列舉
ACCOUNT_ROLE_UNSPECIFIED 未指定。
PRIMARY_OWNER 這位使用者是這個帳戶的主要擁有者。
OWNER 帳戶的使用者擁有者。
MANAGER 使用者可以管理這個帳戶。
SITE_MANAGER 使用者可以管理帳戶的部分功能組合,

VerificationState

表示帳戶的驗證狀態。

列舉
VERIFICATION_STATE_UNSPECIFIED 未指定。
VERIFIED 已驗證帳戶。
UNVERIFIED 帳戶未經驗證,也未提出驗證要求。
VERIFICATION_REQUESTED 帳戶尚未驗證,但已提出驗證要求。

VettedState

表示帳戶的審核狀態。

列舉
VETTED_STATE_UNSPECIFIED 未指定
NOT_VETTED 該帳戶未經過 Google 審查。
VETTED 帳戶已通過 Google 審查,處於有效狀態。系統會自動審查能直接存取通過審查的群組帳戶。
INVALID 帳戶已通過審核,但狀態無效。帳戶的運作方式會與未通過審查的帳戶搭配運作。

PermissionLevel

指出已驗證使用者對這個帳戶的存取層級。

列舉
PERMISSION_LEVEL_UNSPECIFIED 未指定。
OWNER_LEVEL 使用者俱備擁有者層級權限。
MEMBER_LEVEL 使用者擁有成員層級權限。

OrganizationInfo

為機構儲存的其他資訊。

JSON 表示法
{
  "registeredDomain": string,
  "address": {
    object (PostalAddress)
  },
  "phoneNumber": string
}
欄位
registeredDomain

string

僅供輸出。帳戶的註冊網域。

address

object (PostalAddress)

僅供輸出。帳戶的郵寄地址。

phoneNumber

string

僅供輸出。機構聯絡電話。

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

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

方法

create

在指定父項底下以指定名稱和類型建立帳戶。

get

取得指定帳戶。

list

列出已驗證使用者的所有帳戶。

patch

更新指定的商家帳戶。