REST Resource: customers

資源:Customer

如果 Google 客戶的帳戶已向經銷商註冊,該客戶的 Google 服務訂閱項目就會由該經銷商管理。客戶會以主要網域名稱和實際地址來描述。

JSON 表示法
{
  "customerId": string,
  "customerDomain": string,
  "postalAddress": {
    object (Address)
  },
  "phoneNumber": string,
  "alternateEmail": string,
  "resourceUiUrl": string,
  "customerDomainVerified": boolean,
  "kind": string,
  "customerType": enum (CustomerType),
  "primaryAdmin": {
    object (PrimaryAdmin)
  }
}
欄位
customerId

string

這個屬性一律會在回應中傳回,做為 Google 產生的專屬 ID。在要求中,這個屬性可以是主要網域,也可以是 Google 產生的專屬 ID。

customerDomain

string

客戶的主網域名稱字串。建立新客戶時,必須提供 customerDomain。新增客戶時,請勿在網域中加入 www 前置字元。

postalAddress

object (Address)

客戶的地址資訊。每個欄位的字元上限為 255 個半形字元。

phoneNumber

string

客戶聯絡電話號碼。開頭必須為「+」,後接國家/地區代碼。電話號碼的其餘部分可以是連續的數字,也可以遵循當地格式慣例,但必須是實際的電話號碼,例如「123」之類的號碼不行。如果無效,系統會靜默略過這個欄位。

alternateEmail

string

與經銷商工具中的「客戶電子郵件」一樣,如果客戶的服務發生異常 (例如服務中斷或安全性問題),系統會使用這個電子郵件地址做為次要聯絡方式。建立新的「網域」客戶時,必須使用這個屬性,且不得與 customerDomain 使用相同的網域。建立「團隊」客戶時,不必使用 alternateEmail 欄位。

resourceUiUrl

string

客戶管理控制台資訊主頁的網址。唯讀網址是由 API 服務產生。如果客戶端應用程式要求客戶在管理控制台中完成工作,就會使用這個值。

customerDomainVerified

boolean

客戶的主網域是否已通過驗證。

kind

string

將資源標示為客戶。值:reseller#customer

customerType

enum (CustomerType)

識別客戶類型。可接受的值包括:

  • domain:暗示已驗證網域的客戶 (預設)。
  • team:暗示已完成電子郵件驗證的客戶。

詳情請參閱「受管理的團隊」。

primaryAdmin

object (PrimaryAdmin)

客戶的第一位管理員詳細資料,適用於團隊客戶。

地址

客戶地址的 JSON 範本。

JSON 表示法
{
  "countryCode": string,
  "kind": string,
  "region": string,
  "addressLine2": string,
  "locality": string,
  "addressLine3": string,
  "postalCode": string,
  "addressLine1": string,
  "organizationName": string,
  "contactName": string
}
欄位
countryCode

string

如需 countryCode 相關資訊,請參閱 ISO 3166 國家/地區代碼元素。確認國家/地區是否核准轉售 Google 產品。建立新客戶時,必須提供這個屬性。

kind

string

將資源識別為客戶地址。值:customers#address

region

string

region 值的範例為加州的 CA。

addressLine2

string

地址的第二行。

locality

string

locality 值的範例為 San Francisco 市。

addressLine3

string

地址的第三行。

postalCode

string

postalCode 的範例是郵遞區號,例如 94043。建立新客戶時,必須提供這個屬性。

addressLine1

string

客戶的實際地址。地址可由一到三行組成。addressline2 和 addressLine3 為選用參數。

organizationName

string

公司名稱或公司部門名稱。此為必要資訊。

contactName

string

客戶聯絡人的姓名。此為必要資訊。

CustomerType

客戶類型

列舉
customerTypeUnspecified 客戶類型不明
domain 擁有網域或網域擁有權的客戶
team 未驗證網域或已驗證電子郵件的客戶

PrimaryAdmin

團隊客戶的主要管理員適用的 JSON 範本

JSON 表示法
{
  "primaryEmail": string
}
欄位
primaryEmail

string

客戶的主要管理員的商業電子郵件地址。

系統會在建立客戶時,將電子郵件驗證連結傳送至這個電子郵件地址。主要管理員可存取客戶的管理控制台,包括邀請和移除使用者,以及管理客戶的管理需求。

方法

get

取得客戶帳戶。

insert

訂購新客戶的帳戶。

patch

更新客戶帳戶的設定。

update

更新客戶帳戶的設定。