REST Resource: subscriptions

משאב: Subscription

תבנית 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. לדוגמה של ממיר עידנים
kind

string

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

object (Seats)

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

object (RenewalSettings)

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

string

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

string

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

string

כתובת ה-URL לדף Subscriptions (מינויים) של הלקוח במסוף Admin. כתובת ה-URL לקריאה בלבד נוצרת על ידי שירות ה-API. האפשרות הזו משמשת אם באפליקציית הלקוח שלכם הלקוח צריך להשלים משימה באמצעות הדף Subscriptions (מינויים) במסוף 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. לדוגמה של ממיר עידנים
plan.commitmentInterval.endTime

string (int64 format)

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

object

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

boolean

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

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

string (int64 format)

התאריך שבו מסתיימת תקופת הניסיון. הערך הוא במילי-שניות לפי פורמט 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

Methods

activate

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

changePlan

 עדכון של תוכנית מינויים.

changeRenewalSettings

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

changeSeats

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

delete

 ביטול, השהיה או העברה של מינוי ל-Direct.

get

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

insert

 יצירת מינוי או העברת מינוי.

list

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

startPaidService

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

suspend

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