REST Resource: projects.locations.licenseConfigs

Recurso: LicenseConfig

Informações sobre as licenças dos usuários.

Representação 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
}
Campos
name

string

Imutável. Identificador. O nome do recurso totalmente qualificado da configuração de licença. Formato: projects/{project}/locations/{location}/licenseConfigs/{licenseConfig}

licenseCount

string (int64 format)

Obrigatório. Número de licenças compradas.

subscriptionTier

enum (SubscriptionTier)

Obrigatório. Informações sobre o nível de assinatura da configuração de licença.

state

enum (State)

Apenas saída. O estado da configuração de licença.

autoRenew

boolean

Opcional. Indica se a configuração de licença precisa ser renovada automaticamente quando atingir a data de término.

startDate

object (Date)

Obrigatório. A data de início.

endDate

object (Date)

Opcional. A data de término planejada.

subscriptionTerm

enum (SubscriptionTerm)

Obrigatório. Prazo da assinatura.

freeTrial

boolean

Opcional. Indica se a configuração de licença é para teste sem custo financeiro.

geminiBundle

boolean

Apenas saída. Indica se a configuração de licença é para o pacote do Gemini.

earlyTerminated

boolean

Apenas saída. Indicação de se a assinatura foi encerrada antes da data de validade. Geralmente, ela é encerrada pelo pipeline quando a assinatura é encerrada no subsv3.

earlyTerminationDate

object (Date)

Apenas saída. A data em que a assinatura é encerrada antes da data de validade.

lastUserUpdateTime

string (Timestamp format)

Opcional. Timestamp da atualização mais recente iniciada pelo usuário (mudança na contagem de licenças ou no prazo da assinatura). Ao contrário de updateTime, esse campo só é marcado quando um cliente atualiza explicitamente a licença (por exemplo, pela UI) e não é afetado por gravações orientadas pelo sistema (pipeline de assinatura, propagação do BALC etc.).

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de Z, outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Estado

Enumeração do estado da configuração de licença.

Tipos enumerados
STATE_UNSPECIFIED Valor padrão. A configuração de licença não existe.
ACTIVE A configuração de licença está em vigor e sendo usada.
EXPIRED A configuração de licença expirou.
NOT_STARTED A configuração de licença ainda não começou, e a data de início está no futuro.
WITHDRAWN Isso ocorre quando uma configuração de sublicença devolve todas as licenças à BillingAccountLicenseConfig a que pertence. Semelhante a EXPIRED.
DEACTIVATING A configuração de licença é encerrada antes da data de validade e está sendo desativada. O cliente ainda terá acesso nesse estado. Ela será convertida para EXPIRED após o período de desativação terminar (14 dias) ou quando a data de término for atingida, o que ocorrer primeiro.

SubscriptionTerm

Prazo da assinatura.

Tipos enumerados
SUBSCRIPTION_TERM_UNSPECIFIED Valor padrão, não use.
SUBSCRIPTION_TERM_ONE_MONTH 1 mês.
SUBSCRIPTION_TERM_ONE_YEAR 1 ano.
SUBSCRIPTION_TERM_THREE_YEARS 3 anos.
SUBSCRIPTION_TERM_CUSTOM Prazo personalizado. É necessário definir a data de término.

Métodos

create

Cria uma LicenseConfig. Esse método só pode ser usado para criar licenças do NotebookLM ou licenças de teste sem custo financeiro do Gemini Enterprise.

get

Recebe uma LicenseConfig.

list

Lista todas as LicenseConfigs associadas ao projeto.

patch

Atualiza a LicenseConfig