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,
  "earlyTerminated": boolean,
  "earlyTerminationDate": {
    object (Date)
  },
  "lastUserUpdateTime": string
}
フィールド
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 バンドル用かどうか。
earlyTerminated

boolean

出力専用。定期購入が有効期限より前に終了したかどうかを示す。通常、サブスクリプションが subsv3 から終了すると、パイプラインによって終了します。
earlyTerminationDate

object (Date)

出力専用。定期購入が有効期限より前に終了した日付。
lastUserUpdateTime

string (Timestamp format)

省略可。ユーザーが開始した最新の更新（シート数の変更またはサブスクリプション期間の変更）のタイムスタンプ。updateTime とは異なり、このフィールドは、お客様がライセンスを明示的に更新した場合（UI 経由など）にのみスタンプされ、システム主導の書き込み（サブスクリプション パイプライン、BALC 伝播など）では変更されません。

RFC 3339 を使用します。生成された出力は常に 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 に変換されます。

AlertPolicyResourceConfig

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

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

string

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

object (AlertEnrollment)

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

object (ContactDetails)

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

string

省略可。通知に使用される言語コード
regionCode

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 を作成します。このメソッドは、NotebookLm ライセンスまたは Gemini Enterprise の無料トライアル ライセンスの作成にのみ使用してください。

get

 LicenseConfig を取得します。

list

 プロジェクトに関連付けられているすべての LicenseConfig を一覧表示します。

patch

 LicenseConfig を更新します。