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)
  }
}
שדות
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)

פלט בלבד. התאריך שבו המינוי מסתיים לפני תאריך התפוגה.

מדינה

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

טיפוסים בני מנייה (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.

patch

 עדכון של LicenseConfig