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)
  }
}
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 da 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 de término planejada.

subscriptionTerm

enum (SubscriptionTerm)

Obrigatório. Vigência da assinatura.

freeTrial

boolean

Opcional. Indica se a configuração de licença é para um teste sem custos financeiros.

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 expiração.

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 sublicença devolve todos os assentos para a BillingAccountLicenseConfig a que pertence. Semelhante a EXPIRED.
DEACTIVATING A configuração de licença é encerrada antes da data de expiração e está sendo desativada. O cliente ainda terá acesso nesse estado. Ele será convertido para "EXPIRADO" após o término do período de desativação (14 dias) ou quando a data de término for atingida, o que ocorrer primeiro.

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 de 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 de 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

A enumeração do status de inscrição 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

As informações de contato armazenadas no nível do recurso. Se os níveis do projeto e do recurso forem preenchidos, as informações de contato do recurso vão substituir as 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 licenças de teste sem custos financeiros do Gemini Enterprise.

get

Recebe um LicenseConfig.

patch

Atualiza o LicenseConfig.