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,
  "billingAccountLicenseConfig": string
}
שדות
name

string

אי אפשר לשנות. מזהה. שם המשאב שמוגדר במלואו של הגדרת הרישיון. פורמט: 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, השדה הזה מתעדכן רק כשלקוח מעדכן את הרישיון באופן מפורש (למשל, דרך ממשק המשתמש), ולא מתעדכן על ידי כתיבות שמבוססות על המערכת (צינור מינויים, הפצה של 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".
billingAccountLicenseConfig

string

פלט בלבד. השם של BillingAccountLicenseConfig שממנו הוקצה LicenseConfig הזה, אם השדה הזה מוגדר.

מדינה

מניית מצבי ההגדרה של הרישיון.

טיפוסים בני מנייה (enum)
STATE_UNSPECIFIED ערך ברירת המחדל. הגדרת הרישיון לא קיימת.
ACTIVE הגדרת הרישיון בתוקף ונעשה בה שימוש.
EXPIRED פג התוקף של הגדרת הרישיון.
NOT_STARTED ההגדרה של הרישיון עוד לא התחילה, ותאריך ההתחלה שלה הוא בעתיד.
WITHDRAWN המצב הזה מתרחש כשכל המושבים בהגדרת רישיון משנה הוחזרו אל BillingAccountLicenseConfig שאליה היא משתייכת. דומה לסטטוס EXPIRED.
DEACTIVATING הגדרת הרישיון נמצאת בתקופת חסד. המינוי הסתיים, בגלל סיום מוקדם או בגלל שהגיע לתאריך הסיום שלו, אבל הלקוח שומר על הגישה לזמן מוגבל. הסטטוס משתנה ל-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

אי אפשר לשנות. המזהה של התראה.
enrollState

enum (EnrollState)

חובה. סטטוס ההרשמה של לקוח.
notificationParams

map (key: string, value: string)

זה שינוי אופציונלי. פרמטרים שמשמשים ליצירת מופע של התראה. הנתונים משמשים להתראות שמופעלות כשנרשמים. לא נשמר. * אימיילים למשתמשים חדשים ב-Gemini Business. * אימיילים להזמנת משתמשים ל-Gemini Business.

EnrollState

טיפוס ה-enum של סטטוס ההרשמה להתראה.

טיפוסים בני מנייה (enum)
ENROLL_STATE_UNSPECIFIED ערך ברירת המחדל. משמש לקוחות שלא הגיבו למדיניות ההתראות.
ENROLLED הלקוח רשום למדיניות הזו.
DECLINED הלקוח דחה את המדיניות הזו.

ContactDetails

הפרטים ליצירת קשר שמאוחסנים ברמת המשאב. אם הפרטים ליצירת קשר מופיעים גם ברמת הפרויקט וגם ברמת המשאב, הפרטים ברמת המשאב יבטלו את הפרטים ברמת הפרויקט.

ייצוג ב-JSON 
{
  "emailAddress": string
}
שדות
emailAddress

string

זה שינוי אופציונלי. כתובת האימייל של איש הקשר.

Methods

create

 יוצר LicenseConfig השיטה הזו מיועדת רק ליצירת רישיונות ל-NotebookLM או רישיונות לתקופת ניסיון בחינם של Gemini Enterprise.

get

 הפונקציה מחזירה LicenseConfig.

list

 רשימה של כל ה-LicenseConfig שמשויכים לפרויקט.

patch

 עדכון של LicenseConfig