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

string

Imutável. Identificador. O nome totalmente qualificado do recurso 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 da assinatura para a 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 deve 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 prevista de término.
subscriptionTerm

enum (SubscriptionTerm)

Obrigatório. Vigência da assinatura.
freeTrial

boolean

Opcional. Se a configuração de licença é para um teste sem custo financeiro.
alertPolicyResourceConfig

object (AlertPolicyResourceConfig)

Opcional. A configuração da política de alertas para esta configuração de licença.
geminiBundle

boolean

Apenas saída. 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. Isso geralmente é encerrado 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. Carimbo de data/hora da atualização mais recente iniciada pelo usuário (mudança na contagem de assentos ou no período 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".
billingAccountLicenseConfig

string

Apenas saída. O nome do BillingAccountLicenseConfig de que este LicenseConfig é atribuído, se este campo estiver definido.

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 da licença está em vigor e sendo usada.
EXPIRED A configuração da licença expirou.
NOT_STARTED A configuração de licença ainda não começou, e a data de início é no futuro.
WITHDRAWN Isso acontece quando uma configuração de licença secundária devolve todos os assentos para a BillingAccountLicenseConfig a que pertence. Semelhante a EXPIRED.
DEACTIVATING A configuração da licença está em um período de carência. A assinatura foi encerrada, seja por rescisão antecipada ou por ter chegado à data de término, mas o cliente mantém o acesso por um período limitado. Ele passa a ser "EXPIRADO" quando o período de carência termina.

AlertPolicyResourceConfig

A configuração de alerta no nível do recurso. Usado em: * UserLicense * EngineUserData O AlertPolicyConfig no conector de dados tem o mesmo uso. Não há uma maneira fácil de migrar.

Representação JSON 
{
  "alertPolicy": string,
  "alertEnrollments": [
    {
      object (AlertEnrollment)
    }
  ],
  "contactDetails": [
    {
      object (ContactDetails)
    }
  ],
  "languageCode": string,
  "regionCode": string
}
Campos
alertPolicy

string

Imutável. O nome totalmente qualificado do recurso AlertPolicy.
alertEnrollments[]

object (AlertEnrollment)

Opcional. O estado de inscrição de cada alerta.
contactDetails[]

object (ContactDetails)

Opcional. Os detalhes de contato de cada política de alertas.
languageCode

string

Opcional. O código do idioma usado para notificações.
regionCode

string

Opcional. O código da região do usuário que assinou a política de alertas.

AlertEnrollment

O status da inscrição do alerta.

Representação JSON 
{
  "alertId": string,
  "enrollState": enum (EnrollState),
  "notificationParams": {
    string: string,
    ...
  }
}
Campos
alertId

string

Imutável. O ID de um alerta.
enrollState

enum (EnrollState)

Obrigatório. O status de inscrição de um cliente.
notificationParams

map (key: string, value: string)

Opcional. Parâmetros usados para instanciar uma notificação. Usado para notificações acionadas quando registradas. Não armazenado. * E-mails de boas-vindas do Gemini Business. * E-mails de convite para usuários do Gemini Business.

EnrollState

O tipo enumerado do status de registro do alerta.

Tipos enumerados
ENROLL_STATE_UNSPECIFIED Valor padrão. Usado para clientes que não responderam à política de alertas.
ENROLLED O cliente está inscrito nessa política.
DECLINED O cliente recusou esta política.

ContactDetails

Os dados de contato armazenados no nível do recurso. Se os níveis de projeto e de recurso forem preenchidos, os dados de contato do recurso vão substituir os do projeto.

Representação JSON 
{
  "emailAddress": string
}
Campos
emailAddress

string

Opcional. O endereço de e-mail do contato.

Métodos

create

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

get

 Recebe um LicenseConfig.

list

 Lista todos os LicenseConfigs associados ao projeto.

patch

 Atualiza o LicenseConfig