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,
  "geminiBundle": boolean,
  "earlyTerminated": boolean,
  "earlyTerminationDate": {
    object (Date)
  },
  "lastUserUpdateTime": string
}
字段
name

string

不可变。标识符。许可配置的完全限定资源名称。格式: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

可选。许可配置是否支持免费试用。

geminiBundle

boolean

仅限输出。许可配置是否适用于 Gemini 软件包。

earlyTerminated

boolean

仅限输出。指明订阅是否在到期日期之前终止。一旦订阅从 subsv3 终止,管道通常会终止此订阅。

earlyTerminationDate

object (Date)

仅限输出。订阅在到期日期之前终止的日期。

lastUserUpdateTime

string (Timestamp format)

可选。最近一次用户发起的更新(席位数量变更或订阅期变更)的时间戳。与 updateTime 不同,此字段仅在客户明确更新许可(例如通过界面)时盖上时间戳,并且不受系统驱动的写入(订阅管道、BALC 传播等)的影响。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z""2014-10-02T15:01:23+05:30"

状态

许可配置状态枚举。

枚举
STATE_UNSPECIFIED 默认值。许可配置不存在。
ACTIVE 许可配置有效且正在使用中。
EXPIRED 许可配置已过期。
NOT_STARTED 许可配置尚未开始,且其开始日期是将来的日期。
WITHDRAWN 当子许可配置将其所有席位返回给其所属的 BillingAccountLicenseConfig 时,就会出现这种情况。与 EXPIRED 类似。
DEACTIVATING 许可配置在到期日期之前终止,并且正在停用。客户在此状态下仍可访问。停用期结束后(14 天)或达到结束日期时(以先发生者为准),它将转换为 EXPIRED。

SubscriptionTerm

订阅期。

枚举
SUBSCRIPTION_TERM_UNSPECIFIED 默认值,请勿使用。
SUBSCRIPTION_TERM_ONE_MONTH 1 个月。
SUBSCRIPTION_TERM_ONE_YEAR 1 年。
SUBSCRIPTION_TERM_THREE_YEARS 3 年。
SUBSCRIPTION_TERM_CUSTOM 自定义期限。必须设置 endDate。

方法

create

创建 LicenseConfig。此方法仅应用于创建 NotebookLm 许可或 Gemini Enterprise 免费试用许可。

get

获取 LicenseConfig

list

列出与项目关联的所有 LicenseConfig

patch

更新 LicenseConfig