REST Resource: projects.locations.licenseConfigs

資源:LicenseConfig

使用者的授權相關資訊。

JSON 表示法
{
  "name": string,
  "licenseCount": string,
  "subscriptionTier": enum (SubscriptionTier),
  "state": enum (State),
  "autoRenew": boolean,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "subscriptionTerm": enum (SubscriptionTerm),
  "freeTrial": boolean,
  "alertPolicyResourceConfig": {
    object (AlertPolicyResourceConfig)
  },
  "geminiBundle": boolean,
  "earlyTerminated": boolean,
  "earlyTerminationDate": {
    object (Date)
  },
  "lastUserUpdateTime": string,
  "billingAccountLicenseConfig": string
}
欄位
name

string

不可變動。ID。授權設定的完整資源名稱。格式:projects/{project}/locations/{location}/licenseConfigs/{licenseConfig}

licenseCount

string (int64 format)

這是必要旗標,購買的授權數量。

subscriptionTier

enum (SubscriptionTier)

這是必要旗標,授權設定的訂閱級別資訊。

state

enum (State)

僅供輸出。授權設定的狀態。

autoRenew

boolean

選用。授權設定是否應在到期時自動續約。

startDate

object (Date)

這是必要旗標,開始日期。

endDate

object (Date)

選用。預定結束日期。

subscriptionTerm

enum (SubscriptionTerm)

這是必要旗標,訂閱方案約期。

freeTrial

boolean

選用。授權設定是否適用於免費試用。

alertPolicyResourceConfig

object (AlertPolicyResourceConfig)

選用。這項授權設定的警告政策設定。

geminiBundle

boolean

僅供輸出。授權設定是否適用於 Gemini 套裝組合。

earlyTerminated

boolean

僅供輸出。指出訂閱方案是否在到期日前終止。一旦訂閱項目從 subsv3 終止,管道通常就會終止這項作業。

earlyTerminationDate

object (Date)

僅供輸出。訂閱方案在到期日前終止的日期。

lastUserUpdateTime

string (Timestamp format)

選用。最近一次使用者發起的更新時間戳記 (座位數變更或訂閱方案期限變更)。與 updateTime 不同,這個欄位只會在客戶明確更新授權時 (例如透過使用者介面) 蓋上時間戳記,系統驅動的寫入作業 (訂閱管道、BALC 傳播等) 則不會觸及這個欄位。

使用 RFC 3339,產生的輸出內容一律會經過 Z 正規化,並使用 0、3、6 或 9 個小數位數,也接受「Z」以外的偏移量。範例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

billingAccountLicenseConfig

string

僅供輸出。如果已設定這個欄位,則為指派這個 LicenseConfig 的 BillingAccountLicenseConfig 名稱。

狀態

授權設定狀態列舉。

列舉
STATE_UNSPECIFIED 預設值。授權設定不存在。
ACTIVE 授權設定有效且正在使用中。
EXPIRED 授權設定已過期。
NOT_STARTED 授權設定尚未開始,且開始日期為未來的時間。
WITHDRAWN 也就是子授權設定已將所有席位退回所屬的 BillingAccountLicenseConfig。與「已過期」類似。
DEACTIVATING 授權設定處於寬限期。訂閱方案已終止 (提前終止或到期),但客戶仍可在一段時間內存取。寬限期結束後,就會變成「已過期」。

AlertPolicyResourceConfig

資源層級的快訊設定。適用於:* UserLicense * EngineUserData 資料連接器中的 AlertPolicyConfig 用途相同。無法輕鬆遷移。

JSON 表示法
{
  "alertPolicy": string,
  "alertEnrollments": [
    {
      object (AlertEnrollment)
    }
  ],
  "contactDetails": [
    {
      object (ContactDetails)
    }
  ],
  "languageCode": string,
  "regionCode": string
}
欄位
alertPolicy

string

不可變動。AlertPolicy 的完整資源名稱。

alertEnrollments[]

object (AlertEnrollment)

選用。每項快訊的註冊狀態。

contactDetails[]

object (ContactDetails)

選用。每項警告政策的聯絡資料。

languageCode

string

選用。用於通知的語言代碼

regionCode

string

選用。訂閱警告政策的使用者所用的區域代碼。

AlertEnrollment

快訊註冊狀態。

JSON 表示法
{
  "alertId": string,
  "enrollState": enum (EnrollState),
  "notificationParams": {
    string: string,
    ...
  }
}
欄位
alertId

string

不可變動。快訊的 ID。

enrollState

enum (EnrollState)

這是必要旗標,顧客的註冊狀態。

notificationParams

map (key: string, value: string)

選用。用來例項化通知的參數。用於註冊時觸發的通知。不會儲存。* Gemini Business 歡迎電子郵件。* Gemini Business 使用者邀請電子郵件。

EnrollState

警報的註冊狀態列舉。

列舉
ENROLL_STATE_UNSPECIFIED 預設值。適用於未回應快訊政策的客戶。
ENROLLED 客戶已註冊這項政策。
DECLINED 客戶拒絕這項政策。

ContactDetails

聯絡資訊儲存在資源層級。如果專案層級和資源層級都填寫了聯絡資訊,系統會優先採用資源層級的聯絡資訊。

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

string

選用。聯絡人的電子郵件地址。

方法

create

建立 LicenseConfig。這個方法只能用於建立 NotebookLM 授權或 Gemini Enterprise 免費試用授權。

get

取得 LicenseConfig。

list

列出與專案相關聯的所有 LicenseConfig。

patch

更新 LicenseConfig