REST Resource: subscriptions

משאב: מינוי

תבנית JSON למינוי.

ייצוג JSON 
{
  "customerId": string,
  "subscriptionId": string,
  "skuId": string,
  "creationTime": string,
  "kind": string,
  "seats": {
    object (Seats)
  },
  "renewalSettings": {
    object (RenewalSettings)
  },
  "purchaseOrderId": string,
  "status": string,
  "resourceUiUrl": string,
  "billingMethod": string,
  "suspensionReasons": [
    string
  ],
  "customerDomain": string,
  "dealCode": string,
  "skuName": string,
  "plan": {
    "planName": string,
    "isCommitmentPlan": boolean,
    "commitmentInterval": {
      "startTime": string,
      "endTime": string
    }
  },
  "trialSettings": {
    "isInTrial": boolean,
    "trialEndTime": string
  },
  "transferInfo": {
    "transferabilityExpirationTime": string,
    "minimumTransferableSeats": integer,
    "currentLegacySkuId": string
  }
}
שדות
customerId

string

הנכס הזה תמיד יוחזר בתגובה כמזהה הייחודי ש-Google יצרה. בבקשה, הנכס הזה יכול להיות הדומיין הראשי או המזהה הייחודי ש-Google יצרה.
subscriptionId

string

subscriptionId הוא מזהה המינוי והוא ייחודי לכל לקוח. זהו נכס חובה. subscriptionId משתנה כשמינוי מתעדכן, לכן מומלץ לא להשתמש במזהה הזה כמפתח לנתונים קבועים. צריך להשתמש בsubscriptionId כפי שמתואר באחזור כל המינויים למפיצים.
skuId

string

נכס נדרש. skuId הוא מזהה מערכת ייחודי למק"ט של מוצר שהוקצה ללקוח במינוי. מידע על מוצרים ומק"טים שזמינים בגרסה הזו של ה-API זמין בקטע מזהי מוצר ומק"ט.
creationTime

string (int64 format)

הנכס creationTime הוא התאריך שבו נוצר המינוי. נעשה שימוש בפורמט Epoch באלפיות השנייה. כאן אפשר לראות דוגמה להמרה של Epoch.
kind

string

מזהה את המשאב כמינוי. ערך: reseller#subscription
seats

object (Seats)

זהו נכס חובה. המספר והמגבלה של רישיונות מושב המשתמשים בתוכנית.
renewalSettings

object (RenewalSettings)

הגדרות החידוש של תוכנית ההתחייבות השנתית. למידע מפורט יותר, כדאי לעיין באפשרויות החידוש במרכז העזרה לאדמינים.
purchaseOrderId

string

המאפיין הזה הוא אופציונלי. הפרטים של הזמנת הרכש (PO) מיועדים למפיצים יכולים להשתמש במעקב של החברה שלהם. אם ניתן ערך purchaseOrderId, הוא יופיע בתשובות ה-API ויופיע בחשבונית. בנכס אפשר להזין עד 80 תווים של טקסט פשוט.
status

string

המאפיין הזה הוא אופציונלי.
resourceUiUrl

string

כתובת URL לדף המינויים של הלקוח במסוף Admin. כתובת ה-URL לקריאה בלבד נוצרת על ידי שירות ה-API. השדה הזה משמש אם אפליקציית הלקוח מחייבת את הלקוח להשלים משימה באמצעות הדף 'מינויים' במסוף Admin.
billingMethod

string

שדה לקריאה בלבד שמחזיר את שיטת החיוב הנוכחית של מינוי.
suspensionReasons[]

string

שדה לקריאה בלבד שמכיל את כל הסיבות להשעיה של מינוי בשלב הזה. יכולות להיות כמה סיבות להשעיה של מינוי אחד או יותר, בו-זמנית. STATUS של מינוי הוא SUSPENDED עד להסרת כל ההשעיות שנמצאות בהמתנה.

האפשרויות האפשריות כוללות:

  • PENDING_TOS_ACCEPTANCE – הלקוח לא התחבר ואישר את התנאים וההגבלות של G Suite שנקנו דרך מפיץ.
  • RENEWAL_WITH_TYPE_CANCEL - ההתחייבות של הלקוח הסתיימה והשירות בוטל בסוף התקופה.
  • RESELLER_INITIATED – השעיה ידנית שהופעל על ידי מפיץ.
  • TRIAL_ENDED – תקופת הניסיון של הלקוח הסתיימה בלי שנבחרה תוכנית.
  • OTHER – הלקוח מושעה מסיבה פנימית ב-Google (למשל, ניצול לרעה או מסיבה אחרת).

customerDomain

string

שם הדומיין הראשי של הלקוח
dealCode

string

קוד ש-Google מנפיקה (עד 100 תווים) לתמחור מוזל של תוכניות מנויים. כדי לקבל תעריף מוזל, צריך לכלול את קוד המבצע בבקשות של insert. המאפיין הזה הוא אופציונלי. אם נשאר ריק, חל מחיר רגיל.
skuName

string

שם מוצג חיצוני לקריאה בלבד של מק"ט של מוצר שהוקצה ללקוח במינוי. שמות המק"טים כפופים לשינויים לפי שיקול דעתה של Google. מידע על מוצרים ומק"טים שזמינים בגרסה הזו של ה-API זמין בקטע מזהי מוצר ומק"ט.
plan

object

המאפיין plan הוא חובה. בגרסה הזו של ה-API, התוכניות של G Suite הן התוכנית הגמישה, התוכנית בהתחייבות שנתית והתוכנית לתקופת ניסיון בחינם למשך 30 יום. מידע נוסף על תוכניות התמחור והתשלומים של ה-API זמין במאמר מושגים ב-API.
plan.planName

string

המאפיין planName הוא חובה. זהו שם התוכנית של המינוי. למידע נוסף על תוכניות התמחור והתשלומים של Google, ראו מושגים ב-API.

הערכים האפשריים הם:

  • ANNUAL_MONTHLY_PAY – תוכנית ההתחייבות השנתית בתשלומים חודשיים.
  • ANNUAL_YEARLY_PAY – תוכנית ההתחייבות השנתית עם תשלומים שנתיים
  • FLEXIBLE – התוכנית הגמישה
  • TRIAL — התוכנית של תקופת הניסיון בחינם ל-30 יום. אם לא תוקצה תוכנית תמחור ותשלומים, מינוי לתקופת ניסיון יושעה אחרי היום ה-30 בחינם. התקשרות אל changePlan תקצה תוכנית תמחור ותשלומים לתקופת ניסיון, אבל התוכנית לא תופעל. תוכנית התמחור והתשלומים של תקופת הניסיון תתחיל באופן אוטומטי אחרי היום ה-30 בחינם, או מיד אחרי השיחה אל startPaidService.
  • FREE – התוכנית החינמית היא בלעדית למק"ט של Cloud Identity ולא כרוכה בחיוב.

plan.isCommitmentPlan

boolean

הערך הבוליאני של הנכס isCommitmentPlan מזהה את התוכנית כתוכנית התחייבות שנתית:

  • true – תוכנית המינוי היא תוכנית בהתחייבות שנתית.
  • false – התוכנית היא לא תוכנית בהתחייבות שנתית.
plan.commitmentInterval

object

בגרסה הזו של ה-API, פרק הזמן של תוכנית ההתחייבות השנתית הוא שנה.

plan.commitmentInterval.startTime

string (int64 format)

ערך startTime באלפיות שנייה של תוכנית התחייבות שנתית בפורמט UNIX Epoch. כאן אפשר לראות דוגמה להמרה של Epoch.
plan.commitmentInterval.endTime

string (int64 format)

ערך endTime באלפיות שנייה של תוכנית בהתחייבות שנתית בפורמט UNIX Epoch. כאן אפשר לראות דוגמה להמרה של Epoch.
trialSettings

object

ההתחייבות השנתית של G Suite ותוכניות התמחור והתשלומים הגמישות יכולות להיות בתקופת ניסיון בחינם למשך 30 יום. מידע נוסף זמין במאמר מושגים בנושא API.
trialSettings.isInTrial

boolean

קובע אם תוכנית המינוי נמצאת בתקופת ניסיון בחינם למשך 30 יום או לא:

  • true – התוכנית בתקופת ניסיון.
  • false – התוכנית לא בתקופת ניסיון.
trialSettings.trialEndTime

string (int64 format)

התאריך שבו תקופת הניסיון תסתיים. הערך מופיע באלפיות שנייה לפי פורמט Epoch של UNIX. כאן אפשר לראות דוגמה להמרה של Epoch.
transferInfo

object

מידע שקשור להעברה בלבד של המינוי. מידע נוסף זמין במאמר בנושא אחזור מינויים שניתן להעביר עבור לקוח.
transferInfo.transferabilityExpirationTime

string (int64 format)

המועד שבו יפוג תוקף אסימון ההעברה או הכוונה להעברה. הזמן הוא באלפיות שנייה בפורמט UNIX Epoch.
transferInfo.minimumTransferableSeats

integer

כשמוסיפים מינוי, זהו המספר המינימלי של העמדות הרשום בהזמנת ההעברה למוצר הזה. לדוגמה, אם ללקוח יש 20 משתמשים, המפיץ לא יכול לבצע הזמנת העברה של 15 משתמשים. המינימום הוא 20 מושבים.
transferInfo.currentLegacySkuId

string

skuId של המינוי הנוכחי שקנה דרך מפיץ. השדה הזה מאוכלס רק כשיש ללקוח מינוי עם מק"ט מדור קודם, ומשאב המינוי מאוכלס רק ב-skuId של המק"ט המומלץ להעברה.

מושבים

תבנית JSON למושבי מנויים.

ייצוג JSON 
{
  "numberOfSeats": integer,
  "maximumNumberOfSeats": integer,
  "licensedNumberOfSeats": integer,
  "kind": string
}
שדות
numberOfSeats

integer

זהו נכס חובה והוא בלעדי למינויים עם התוכניות ANNUAL_MONTHLY_PAY ו-ANNUAL_YEARLY_PAY. המאפיין הזה מגדיר את המספר המקסימלי של רישיונות שניתן להקצות למשתמשים במינוי. המפיץ יכול להוסיף עוד רישיונות, אבל לאחר ההגדרה, לא ניתן יהיה להפחית את numberOfSeats עד לחידוש המינוי. החשבונית של המפיץ מבוססת על הערך numberOfSeats, ללא קשר למספר רישיונות המשתמש האלה שהוקצו.

maximumNumberOfSeats

integer

זהו נכס חובה והוא בלעדי למינויים עם תוכניות FLEXIBLE או TRIAL. בנכס הזה מוגדר המספר המקסימלי של משתמשים בעלי רישיון שניתן להשתמש בהם במינוי. אפשר להגדיל את הכמות הזו עד למגבלה המקסימלית שהוגדרה בחוזה של המפיץ. הכמות המינימלית היא המספר הנוכחי של משתמשים בחשבון הלקוח.

licensedNumberOfSeats

integer

שדה לקריאה בלבד שמכיל את המספר הנוכחי של המשתמשים שהוקצה להם רישיון למוצר שהוגדר ב-skuId. הערך בשדה הזה מקביל למספר המשתמשים שהוחזר בעזרת שיטת Enterprise License Manager API: listForProductAndSku.
kind

string

מזהה את המשאב כהגדרה של מושב מינוי. ערך: subscriptions#seats

RenewalSettings

תבנית JSON להגדרות של חידוש מינוי.

ייצוג JSON 
{
  "renewalType": string,
  "kind": string
}
שדות
renewalType

string

הגדרות החידוש של תוכנית ההתחייבות השנתית. למידע מפורט יותר, כדאי לעיין באפשרויות החידוש במרכז העזרה לאדמינים. כשמחדשים מינוי, הנכס renewalType הוא נכס חובה.
kind

string

מזהה את המשאב כהגדרה של חידוש מינוי. ערך: subscriptions#renewalSettings

שיטות

activate

 הפעלת מינוי שהושעה בעבר על ידי המפיץ.

changePlan

 מעדכנים תוכנית מנויים.

changeRenewalSettings

 עדכון הגדרות החידוש של רישיון משתמש.

changeSeats

 מעדכן את ההגדרות של רישיון המשתמש במינוי.

delete

 מבטל, מושעה או מעביר מינוי לתפקיד ישיר.

get

 קבלת מינוי ספציפי.

insert

 יצירה או העברה של מינוי.

list

 רשימות של מינויים שמנוהלים על ידי המפיץ.

startPaidService

 העברה מיידית של מינוי לתקופת ניסיון בחינם למשך 30 יום למינוי לשירות בתשלום.

suspend

 מושעה מינוי פעיל.