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

תוכנית התחייבות שנתית'sstartTime באלפיות שנייה באמצעות פורמט UNIX Epoch. רואים דוגמה ממיר Epoch.
plan.commitmentInterval.endTime

string (int64 format)

תוכנית התחייבות שנתית'sendTime באלפיות שנייה באמצעות פורמט UNIX Epoch. רואים דוגמה ממיר Epoch.
trialSettings

object

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

boolean

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

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

string (int64 format)

התאריך שבו תקופת הניסיון מסתיימת. הערך הוא באלפיות שנייה בפורמט UNIX Epoch. רואים דוגמה ממיר 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. הערך בשדה הזה זהה למספר המספרי של המשתמשים שמוחזרים בשיטת ה-API של מנהל הרישיונות לארגונים: listForProductAndSku.
kind

string

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

הגדרות חידוש

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

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

string

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

string

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

שיטות

activate

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

changePlan

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

changeRenewalSettings

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

changeSeats

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

delete

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

get

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

insert

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

list

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

startPaidService

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

suspend

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