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

אי אפשר לשנות. מזהה. שם המשאב שמוגדר במלואו של הגדרת הרישיון. פורמט: 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".

מדינה

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

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

AlertPolicyResourceConfig

הגדרת ההתראה ברמת המשאב. השימוש ב-AlertPolicyConfig במחבר הנתונים זהה לשימוש ב-UserLicense וב-EngineUserData. אין דרך קלה לבצע מיגרציה.

ייצוג 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)
ENROLL_STATE_UNSPECIFIED ערך ברירת המחדל. משמש לקוחות שלא הגיבו למדיניות ההתראות.
ENROLLED הלקוח רשום למדיניות הזו.
DECLINED הלקוח דחה את המדיניות הזו.

ContactDetails

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

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

string

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

Methods

create

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

get

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

list

 הצגת רשימה של כל LicenseConfig שמשויכים לפרויקט.

patch

 עדכון של LicenseConfig