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
}
フィールド
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 バンドル用かどうか。

SubscriptionTier

サブスクリプション階層情報。

列挙型
SUBSCRIPTION_TIER_UNSPECIFIED デフォルト値。
SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT 検索 + アシスタントの階層。検索 + アシスタント階層では、VAIS 検索機能、NotebookLM 機能、アシスタント機能にアクセスできます。
SUBSCRIPTION_TIER_NOTEBOOK_LM NotebookLM の階層。NotebookLM は、NotebookLM の機能にのみアクセスできるサブスクリプション ティアです。
SUBSCRIPTION_TIER_FRONTLINE_WORKER 現場スタッフの階層。
SUBSCRIPTION_TIER_AGENTSPACE_STARTER Agentspace Starter Tier。
SUBSCRIPTION_TIER_AGENTSPACE_BUSINESS Agentspace Business ティア。
SUBSCRIPTION_TIER_ENTERPRISE エンタープライズ ティア。
SUBSCRIPTION_TIER_EDU EDU 階層。
SUBSCRIPTION_TIER_EDU_PRO EDU Pro 階層。
SUBSCRIPTION_TIER_EDU_EMERGING EDU 新興市場の階層。
SUBSCRIPTION_TIER_EDU_PRO_EMERGING EDU Pro 新興市場ティア。

状態

ライセンス構成の状態の列挙。

列挙型
STATE_UNSPECIFIED デフォルト値。ライセンス構成が存在しません。
ACTIVE ライセンス構成が有効で、使用されている。
EXPIRED ライセンス構成の有効期限が切れています。
NOT_STARTED ライセンス設定がまだ開始されておらず、開始日が将来の日付になっている。

SubscriptionTerm

サブスクリプション期間。LINT.IfChange

列挙型
SUBSCRIPTION_TERM_UNSPECIFIED デフォルト値。使用しないでください。
SUBSCRIPTION_TERM_ONE_MONTH 1 か月。
SUBSCRIPTION_TERM_ONE_YEAR 1 年間。
SUBSCRIPTION_TERM_THREE_YEARS 3 年間。

AlertPolicyResourceConfig

リソースレベルのアラート構成。使用場所: * UserLicense * EngineUserData データコネクタの AlertPolicyConfig も同じ用途で使用されます。移行を簡単に行う方法がない。

JSON 表現
{
  "alertPolicy": string,
  "alertEnrollments": [
    {
      object (AlertEnrollment)
    }
  ],
  "contactDetails": [
    {
      object (ContactDetails)
    }
  ],
  "languageCode": string
}
フィールド
alertPolicy

string

変更不可。AlertPolicy の完全修飾リソース名。

alertEnrollments[]

object (AlertEnrollment)

省略可。各アラートの登録状態。

contactDetails[]

object (ContactDetails)

省略可。各アラート ポリシーの連絡先情報。

languageCode

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 を作成します

get

LicenseConfig を取得します。

patch

LicenseConfig を更新します