REST Resource: operators.clients.users.planStatus

משאב: PlanStatus

PlanStatus מכיל פרטים של כל חבילת השירות לנייד ברמה העליונה שהמשתמש רכש.

ייצוג JSON 
{
  "name": string,
  "plans": [
    {
      object (Plan)
    }
  ],
  "languageCode": string,
  "expireTime": string,
  "updateTime": string,
  "title": string,
  "subscriberId": string,
  "accountInfo": {
    object (AccountInfo)
  },
  "uiCompatibility": enum (UiCompatibility),
  "notifications": [
    enum (NotificationType)
  ],
  "planInfoPerClient": {
    object (PlanInfoPerClient)
  }
}
שדות
name

string

שם המשאב של PlanStatus בפורמט הבא: operators/{asn_id}/planStatuses/{userKey}. המערכת מתעלמת מהשם בזמן יצירת רשומה ב-PlanStatus.

plans[]

object (Plan)

רשימת התוכניות שבבעלות המשתמש הזה.

languageCode

string

חובה. קוד השפה BCP-47, למשל "en-US" או "sr-Latn". מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

expireTime

string (Timestamp format)

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

חותמת זמן בפורמט RFC3339 UTC "Zulu" בדיוק של ננו-שניות. דוגמה: "2014-10-02T15:01:23.045123456Z"
updateTime

string (Timestamp format)

חובה. הזמן שבו הנציג של תוכנית הנתונים (DPA) החזיר מידע על סטטוס התוכנית ממערכות בקצה העורפי. אפשר להשתמש במידע הזה כדי לקבוע את מידת העדכניות של פרטי הסטטוס של התוכנית.

חותמת זמן בפורמט RFC3339 UTC "Zulu" בדיוק של ננו-שניות. דוגמה: "2014-10-02T15:01:23.045123456Z"
title

string

שם החוזה של המשתמש עם המפעיל. המידע הזה יופיע בכותרת של ממשק המשתמש.

subscriberId

string

מזהה יציב וייחודי במערכת הספק כדי לזהות את המשתמש.

accountInfo

object (AccountInfo)

חובה למשתמשים בתשלום מראש. מידע על היתרה בחשבון משתמש.

uiCompatibility

enum (UiCompatibility)

המדיניות הזו קובעת אם אפשר להציג למשתמש את סטטוס התוכנית בממשק משתמש. אם המדיניות מוגדרת כ-UI_INCOMPATIBLE, אפשר להשתמש בסטטוס התוכנית כדי לשלוח התראות למשתמש, אבל לא כדי להציג את פרטי התוכנית למשתמש.

notifications[]

enum (NotificationType)

סוגי ההתראות שנשלחו למשתמש.

planInfoPerClient

object (PlanInfoPerClient)

לדף התוכנית

פרטים על חבילת הגלישה של המשתמש לנייד, שהיא חבילת השירותים ברמה העליונה שמנויים רוכשים. התוכנית יכולה להיות פשוטה כמו "10 GB נתונים סלולריים למשך 30 ימים; ניתן להגדיר אותה כאוסף של רכיבים (אנחנו מכנים מודולים של תוכניות). לדוגמה, תוכנית ACME מספר 199, מתוארת כנתונים של "2GB, WhatsApp ללא הגבלה + הצ'אט ללא הגבלה ו- 1GB Spot&&; ומכילה שלושה מודולים של תוכנית.

ייצוג JSON 
{
  "planName": string,
  "planId": string,
  "planCategory": enum (PlanCategory),
  "expirationTime": string,
  "planModules": [
    {
      object (PlanModule)
    }
  ],
  "planState": enum (PlanState)
}
שדות
planName

string

שם התוכנית לנייד של המשתמש.

planId

string

חובה. מזהה התוכנית, שמשמש להתייחס לתוכנית במהלך מבצעים וכו'.

planCategory

enum (PlanCategory)

תוכנית בתשלום מראש או בתשלום מראש.

expirationTime

string (Timestamp format)

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

חותמת זמן בפורמט RFC3339 UTC "Zulu" בדיוק של ננו-שניות. דוגמה: "2014-10-02T15:01:23.045123456Z"
planModules[]

object (PlanModule)

מידע מפורט על מודולי התוכנית (תוכניות משנה).

planState

enum (PlanState)

מצב תוכנית המשתמשים, כגון: פעילה, לא פעילה וכו'

קטגוריית התוכנית

סוגי קטגוריות אפשריים של התוכנית.

Enums
PLAN_CATEGORY_UNSPECIFIED לא צוין.
PREPAID תוכנית בתשלום מראש.
POSTPAID תוכנית בתשלום מראש.

מודול של Studio

מידע על כל מודול של תוכנית נתונים (או תוכנית משנה) בתוך תוכנית.

ייצוג JSON 
{
  "coarseBalanceLevel": enum (BalanceLevel),
  "trafficCategories": [
    enum (PlanModuleTrafficCategory)
  ],
  "expirationTime": string,
  "overUsagePolicy": enum (OverUsagePolicy),
  "maxRateKbps": string,
  "description": string,
  "moduleName": string,
  "usedBytes": string,
  "planModuleState": enum (PlanState),
  "refreshPeriod": enum (RefreshPeriod),

  // Union field balance can be only one of the following:
  "byteBalance": {
    object (ByteQuota)
  },
  "timeBalance": {
    object (TimeQuota)
  }
  // End of list of possible types for union field balance.
}
שדות
coarseBalanceLevel

enum (BalanceLevel)

מידע כללי על יתרה.

trafficCategories[]

enum (PlanModuleTrafficCategory)

רשימה של קטגוריות תנועה שיחויבו מול מודול זה של התוכנית.

expirationTime

string (Timestamp format)

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

חותמת זמן בפורמט RFC3339 UTC "Zulu" בדיוק של ננו-שניות. דוגמה: "2014-10-02T15:01:23.045123456Z"
overUsagePolicy

enum (OverUsagePolicy)

בהתאם למדיניות השימוש, לדוגמה, ויסות נתונים.

maxRateKbps

string (int64 format)

קצב הנתונים המקסימלי המותר על ידי מודול התוכנית הזה ב-Kbps. שיעור הנתונים בפועל שמוצג הוא בין 0 ל-maxRateKbps בהתאם לתנאי הרשת. השמטת ה-maxRateKbps או הגדרת הערך שלו ל-0 פירושה שלא מתבצעת ויסות נתונים (throttle) במודול התוכנית.

description

string

חובה. התיאור של מודול התוכנית, עשוי להיות מוצג למשתמש ואמור להיות קרוב לתיאור השוק של מודול התוכנית.

moduleName

string

חובה. השם של מודול התוכנית.

usedBytes

string (int64 format)

המספר הכולל של בייטים שהמשתמש השתמש במודול התוכנית הזה.

planModuleState

enum (PlanState)

המצב של מודול התוכנית, כגון: פעיל, לא פעיל וכו'.

refreshPeriod

enum (RefreshPeriod)

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

שדה איחוד balance. חובה. פרטי היתרה של מודול התוכנית צריכים להיות אחד מאלה: בייט_balance, time_balance, coarse_balance_level. balance יכול להיות רק אחד מאלה:
byteBalance

object (ByteQuota)

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

timeBalance

object (TimeQuota)

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

ביטקוטה

פרטי מכסה/יתרה של מודול תוכנית המבוססת על בייטים.

ייצוג JSON 
{
  "quotaBytes": string,
  "remainingBytes": string
}
שדות
quotaBytes

string (int64 format)

מכסת מודול בבייטים. בתוכניות ללא הגבלה, יש להגדיר את הערך 2^63 - 1 (9223372036854775807).

remainingBytes

string (int64 format)

נדרש עבור התראות על יתרה נמוכה. יתרת המכסה שנותרה בבייטים.

זמן Quota

מידע על המכסה/היתרה של מודול התוכנית המבוססת על זמן.

ייצוג JSON 
{
  "quotaMinutes": string,
  "remainingMinutes": string
}
שדות
quotaMinutes

string (int64 format)

מכסת יחידות בדקות של תוכנית מבוססת זמן, למשל 180 דקות.

remainingMinutes

string (int64 format)

יתרת המכסה של דקות בדקות עבור תוכנית מבוססת זמן, למשל, 40 דקות.

רמת האיזון

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

Enums
BALANCE_LEVEL_UNSPECIFIED לא צוין.
NO_PLAN אין תוכנית נתונים.
OUT_OF_DATA היתרה בנתונים היא אפס.
LOW_QUOTA יתרת הנתונים (או הזמן שנותר) שווה או קטן מ-10-25% מהיתרה המקורית (או הזמן). הספקים עשויים לקבוע את הסף המדויק לכל חבילה לפי הצורך.
HIGH_QUOTA יתרת הנתונים (או הזמן שנותר) היא יותר מ-10-25% מהיתרה המקורית (או הזמן). הספקים עשויים לקבוע את הסף המדויק לכל חבילה לפי הצורך. היתרה בחבילת הגלישה גבוהה.

קטגורייתמודול ה-PlanmoduleTraffic

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

Enums
PLAN_MODULE_TRAFFIC_CATEGORY_UNSPECIFIED לא צוין.
GENERIC כללי, חל על כל התנועה.
VIDEO כל התנועה ממודעות הווידאו.
VIDEO_BROWSING תנועה מסוג וידאו (עיון)
VIDEO_OFFLINE תנועה אופליין בווידאו, שהיא הסכום של VIDEO_BROWSING והתנועה של וידאו/אודיו אופליין (ללא סטרימינג).
MUSIC תנועה באפליקציות מוזיקה.
GAMING תנועה באפליקציות של משחקים.
SOCIAL תנועה ברשתות חברתיות.
MESSAGING תנועה באפליקציה להעברת הודעות.
APP_STORE תנועה בחנות האפליקציות, כמו עדכון או הורדה של אפליקציה חדשה.

מדיניות שימוש יתר

במהלך מדיניות שימוש: מה קורה כשמשתמש אוזלת במסגרת המכסה.

Enums
OVER_USAGE_POLICY_UNSPECIFIED לא צוין.
THROTTLED ויסות מהירות.
BLOCKED החיבור נחסם.
PAY_AS_YOU_GO תשלום על שימוש.

תכנון מדינה

Enum מייצג את המצבים השונים של מודול התוכנית/התוכנית של המשתמש.

Enums
ACTIVE התוכנית/PlanModule פעילות והמשתמש יכול להשתמש בנתונים המוצעים כחלק מהמודול.
INACTIVE מודול התוכנית או התוכנית לא פעיל, וכל עוד למשתמש יש את המודול, הוא לא יכול להשתמש בנתונים שהם חלק מהמודול. מצב כזה עשוי לקרות אם המודול מציע נתונים רק בשעות מסוימות ביום או אם המשתמש רכש מודול, אבל הוא עדיין לא הופעל.
EXPIRING_SOON תוקף התוכנית/PlanModule עומד לפוג בקרוב. המתקשר צריך לבחור את הרמה המתאימה כדי לקבוע מתי להגדיר את הערך הזה. פירוש הדבר הוא שהתוכנית פעילה.
NEWLY_ACTIVE תוכנית/PlanModule שלא היו פעילים בעבר או שהופעלו עכשיו. יש להשתמש במצב הזה רק למשך זמן קצר מאוד לאחר זמן ההפעלה, אחרת יש להשתמש במצב ACTIVE (פעיל). התראות סטטוס של תוכנית נתונים שנשלחות עם מודולים של NEWLY_ACTIVE יישלחו עם TTL קצר, כי הסטטוס NEWLY_ACTIVE יהפוך למהיר מאוד.
EXPIRED תוקף התוכנית או התוכנית פג. הגדרת הערך 'enum' הזה מפעילה התראה על פקיעת תוקף התוכנית.

תקופת הרענון

מייצג תקופת רענון, המרווח הרגיל שבו מודול התוכנית מתאפס.

Enums
REFRESH_PERIOD_NONE אין תקופת רענון. משתמשים בהם כאשר מודול התוכנית אינו חוזר.
DAILY מודול התוכנית מתאפס מדי יום.
MONTHLY מודול התוכנית מתאפס מדי חודש.
BIWEEKLY מודול התוכנית מתאפס כל שבועיים.
WEEKLY מודול התוכנית מתאפס מדי שבוע.

פרטי חשבון

מידע על היתרה בחשבון של משתמש בתשלום מראש.

ייצוג JSON 
{
  "accountBalance": {
    object (Money)
  },
  "loanBalance": {
    object (Money)
  },
  "unpaidLoan": {
    object (Money)
  },
  "accountBalanceStatus": enum (AccountBalanceStatus),
  "validUntil": string,
  "payAsYouGoCharge": {
    object (Money)
  },
  "accountTopUp": {
    object (Money)
  }
}
שדות
accountBalance

object (Money)

חובה. היתרה בחשבון החשבון.

loanBalance

object (Money)

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

unpaidLoan

object (Money)

סכום הכסף שהמשתמש חייב בחברת האשראי בגלל הלוואות כספיות.

accountBalanceStatus

enum (AccountBalanceStatus)

חובה. מציין את סטטוס היתרה בחשבון. במקרה של חוסר התאמה בין השדה validUntil ו-accountיתרהStatus, אנחנו משתמשים ב-accountיתרהStatus.

validUntil

string (Timestamp format)

חובה. הזמן עד שיתרת החשבון תקפה. השדה הזה ישמש להצגה של &&מירכאות; לא חוקי ב-

חותמת זמן בפורמט RFC3339 UTC "Zulu" בדיוק של ננו-שניות. דוגמה: "2014-10-02T15:01:23.045123456Z"
payAsYouGoCharge

object (Money)

סכום הכסף שהמשתמש הוציא על ידי שימוש בתוכנית בתשלום לפי מצבך. אם הספק הזה מאוכלס על ידי הספק כשמשתפים את פרטי החשבון עם GTAF, המשתמש ב-GTAF ינסה לשלוח התראה למשתמש על כך שהוא משקיע כסף תוך כדי תנועה.

accountTopUp

object (Money)

נדרש כדי להוסיף כסף לחשבון. סכום הכסף שהמשתמש הוסיף ליתרה בחשבון. אם הספק הזה מאוכלס על ידי הספק כשמשתפים את פרטי החשבון עם GTAF, המשתמש ב-GTAF ינסה לשלוח התראה למשתמש על כך שהחשבון שלו נוסף.

כסף

הוא מייצג סכום כסף בסוג המטבע שלו.

ייצוג JSON 
{
  "currencyCode": string,
  "units": string,
  "nanos": number
}
שדות
currencyCode

string

קוד מטבע בן 3 אותיות המוגדר בתקן ISO 4217.

units

string (int64 format)

כל היחידות של הסכום. לדוגמה: אם currencyCode הוא "USD", יחידה אחת היא דולר אחד של ארה"ב.

nanos

number

מספר יחידות הננו (10^-9) של הסכום. הערך חייב להיות בין -999,999,999 ל- +999,999,999 כולל. אם הערך בעמודה units הוא חיובי, הערך nanos חייב להיות חיובי או אפס. אם units הוא אפס, nanos יכולה להיות חיובית, אפס או שלילית. אם הערך units שלילי, הערך nanos חייב להיות שלילי או אפס. לדוגמה, $1.75 מיוצג בתור units=-1 ו-nanos=-750,000,000.

סטטוס יתרה בחשבון

הסטטוס של ארנק המשתמש.

Enums
VALID היתרה בחשבון משתמש חוקית וניתן להשתמש בה לביצוע רכישות.
INVALID היתרה בחשבון משתמש אינה חוקית ולא ניתן להשתמש בה בלי לבצע שינויים בחשבון.

תאימות לתקנים

Enum מייצג אם ניתן להציג למשתמש את סטטוס התוכנית המשותף.

Enums
UI_COMPATIBILITY_UNSPECIFIED כברירת מחדל, נצא מנקודת הנחה שסטטוס התוכנית תואם לממשק המשתמש.
UI_COMPATIBLE מציין שכל סטטוס התוכנית תואם לממשק המשתמש, וניתן להציג את פרטי התוכנית למשתמש.
UI_INCOMPATIBLE מציין ש-PlanStatus לא תואם לממשק המשתמש. ניתן להשתמש בשדות לשליחת התראות למשתמש, אבל לא ניתן להציג בפניו מידע על התוכניות.

סוג הודעה

סוג ההודעה שתישלח למשתמשים בהגדרות של חבילת הגלישה.

Enums
NOTIFICATION_UNDEFINED סוג ז'אנר ההתראות לא ידוע
NOTIFICATION_LOW_BALANCE_WARNING התראה שמזהירה משתמשים לגבי יתרה נמוכה
NOTIFICATION_DATA_EXPIRATION_WARNING התראה המזהירה את המשתמשים שתוקף חבילת הגלישה עומד לפוג
NOTIFICATION_OUT_OF_DATA הודעה על כך שאזלו הנתונים
NOTIFICATION_PLAN_ACTIVATION התראה על כך שתוכנית שנרכשה של משתמש פעילה
NOTIFICATION_PAY_AS_YOU_GO התראה על כך שאתם משלמים על נתונים לפי תשלום.
NOTIFICATION_ACCOUNT_TOP_UP הודעה על כך שהמשתמש שדרג את היתרה בחשבון.
NOTIFICATION_DATA_EXPIRED הודעה למשתמשים על כך שתוקף חבילת הגלישה שלהם פג.

תוכנית InfoInfoPerClient

מידע על תוכנית הנתונים שרלוונטיים ללקוח Google מסוים.

ייצוג JSON 
{
  "youtube": {
    object (YouTube)
  }
}
שדות
youtube

object (YouTube)

מידע על התוכנית הקשורה ל-YouTube.

YouTube

מידע על תוכנית הנתונים שרלוונטיים ל-YouTube.

ייצוג JSON 
{
  "rateLimitedStreaming": {
    object (RateLimitedStreaming)
  }
}
שדות
rateLimitedStreaming

object (RateLimitedStreaming)

תכונה של סטרימינג בשידור חי (PAS) של YouTube – תוכנית שמגבילה את קצב העברת הנתונים של סרטון.

דירוג מוגבל

מידע על חבילת גלישה כדי לאפשר ל-YouTube לשפר את חוויית המשתמש בסטרימינג בקצב מוגבל.

ייצוג JSON 
{
  "maxMediaRateKbps": number
}
שדות
maxMediaRateKbps

number

קצב העברת הנתונים של YouTube שנתמך עבור המשתמש הזה ביחידות kbps (1000' ביטים לשנייה).

שיטות

create

 מאפשרת למפעיל נייד (שמזוהה לפי מספר המערכת האוטונומית הייחודי שלו (ASN) להוסיף ערך חדש של StatusStatus עבור המשתמש.