- Resource: PlanStatus
- ייצוג JSON
- תוכנית
- PlanCategory
- PlanModule
- ByteQuota
- TimeQuota
- BalanceLevel
- PlanModuleTrafficCategory
- OverUsagePolicy
- PlanState
- RefreshPeriod
- AccountInfo
- Money
- AccountBalanceStatus
- UiCompatibility
- NotificationType
- PlanInfoPerClient
- YouTube
- RateLimitedStreaming
- AndroidSystemInfo
- CellularInfo
- ConnectionType
- Meteredness
- CpidState
- שיטות
משאב: PlanStatus
השדה PlanStatus מכיל פרטים על כל חבילת שירותים ניידים ברמה העליונה שמשתמש רכש.
ייצוג ב-JSON | |
---|---|
{ "name": string, "plans": [ { object ( |
שדות | |
---|---|
name |
שם המשאב של PlanStatus בפורמט הבא: |
plans[] |
רשימת התוכניות שנמצאות בבעלות המשתמש. |
languageCode |
חובה. קוד השפה בפורמט BCP-47, כמו en-US או sr-Latn. מידע נוסף זמין בכתובת http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. |
expireTime |
חובה. השעה שבה המידע על קבוצת התוכנית המשותפת הופך ללא עדכני. הערך PlanStatus לא יועבר לאפליקציות אחרי התאריך הזה. שעת התפוגה חייבת להיות בעתיד. חותמת זמן בפורמט RFC3339 UTC 'Zulu', עם רזולוציה של ננו-שנייה ועד תשע ספרות אחרי הנקודה העשרונית. דוגמאות: |
updateTime |
חובה. השעה שבה סוכן חבילת הגלישה (DPA) אחזר את פרטי סטטוס החבילה ממערכות העורף. השדה הזה יכול לשמש כדי לקבוע עד כמה המידע על סטטוס התוכנית עדכני. זמן העדכון חייב להיות בעבר, אבל לא לפני יותר מ-30 ימים. חותמת זמן בפורמט RFC3339 UTC 'Zulu', עם רזולוציה של ננו-שנייה ועד תשע ספרות אחרי הנקודה העשרונית. דוגמאות: |
title |
השם של החוזה שיש למשתמש עם המפעיל. השם הזה יוצג בכותרת של ממשק המשתמש. |
subscriberId |
מזהה ייחודי ויציב במערכת של הספק לזיהוי המשתמש. |
accountInfo |
שדה חובה למשתמשים במינוי בתשלום מראש. מידע על היתרה בחשבון המשתמש. |
uiCompatibility |
ההגדרה קובעת אם אפשר להציג למשתמש את PlanStatus בממשק משתמש. אם הערך הוא UI_INCOMPATIBLE, אפשר להשתמש ב-PlanStatus לשליחת התראות למשתמש, אבל לא להצגת פרטי התוכנית למשתמש. |
notifications[] |
מכיל את רשימת סוגי ההתראות שנשלחו למשתמש על ידי GTAF. מערכת GTAF מתעלמת מהשדה הזה אם הוא מאוכלס על ידי המתקשר. |
planInfoPerClient |
מידע על תוכנית נתונים שרלוונטי ללקוח מסוים של Google. |
cpidState |
הסטטוס של מזהה הלקוח המשויך לסטטוס המינוי הזה. |
תוכנית
פרטים על התוכנית הסלולרית של המשתמש, שהיא חבילת השירותים הסלולריים ברמה העליונה שהמנוי רוכש. התוכנית יכולה להיות פשוטה כמו '10GB של נתונים לנייד למשך 30 ימים', או שהיא יכולה להיות מוגדרת כקבוצה של רכיבים (שאנחנו קוראים להם מודולים של תוכנית). לדוגמה, תוכנית ACME 199, שמתוארת כ'נתונים בנפח 2GB, וואטסאפ ללא הגבלה + WeChat ללא הגבלה ו-Spotify בנפח 1GB', מכילה שלושה מודולים של תוכנית.
ייצוג ב-JSON | |
---|---|
{ "planName": string, "planId": string, "planCategory": enum ( |
שדות | |
---|---|
planName |
השם של התוכנית לנייד של המשתמש. |
planId |
חובה. מזהה התוכנית, שמשמש להפניה לתוכנית במהלך מבצעים וכו'. |
planCategory |
מינוי בתשלום מראש או מינוי שמשלמים עליו בסוף התקופה. |
expirationTime |
חובה. כשתוקף התוכנית יפוג. ברוב התוכניות, התאריך הזה צריך להיות שווה לתאריך התפוגה המאוחר ביותר מבין כל מודולי התוכנית. בתוכניות שבהן מכסת המודולים מתעדכנת באופן תקופתי, צריך לציין את זמן התפוגה הכולל של התוכנית, כלומר את הזמן שבו המודולים בתוכנית מפסיקים להתעדכן. אם התוכנית לא פגה, צריך להשמיט את השדה הזה. חותמת זמן בפורמט RFC3339 UTC 'Zulu', עם רזולוציה של ננו-שנייה ועד תשע ספרות אחרי הנקודה העשרונית. דוגמאות: |
planModules[] |
מידע מפורט על מודולים של תוכניות (תוכניות משנה). |
planState |
מצב התוכנית של המשתמש, למשל פעילה, לא פעילה וכו'. |
PlanCategory
סוגים אפשריים של קטגוריות תוכניות.
טיפוסים בני מנייה (enum) | |
---|---|
PLAN_CATEGORY_UNSPECIFIED |
לא צוין. |
PREPAID |
מינוי בתשלום מראש. |
POSTPAID |
תוכנית משולמת בדיעבד (postpaid). |
PlanModule
פרטים של כל מודול (או תת-תוכנית) של תוכנית נתונים בתוך תוכנית.
ייצוג ב-JSON | |
---|---|
{ "coarseBalanceLevel": enum ( |
שדות | ||
---|---|---|
coarseBalanceLevel |
מידע משוער על היתרה. |
|
trafficCategories[] |
רשימה של קטגוריות התנועה שיחויבו במסגרת מודול התוכנית הזה. |
|
expirationTime |
חובה. זמן תפוגה ספציפי למודול של תוכנית. במודולים של תוכניות עם מכסת שימוש שמתעדכנת מעת לעת, זהו הזמן של עדכון המודול הבא. אם מודול התוכנית לא פג תוקף, אין להוסיף את השדה הזה. חותמת זמן בפורמט RFC3339 UTC 'Zulu', עם רזולוציה של ננו-שנייה ועד תשע ספרות אחרי הנקודה העשרונית. דוגמאות: |
|
overUsagePolicy |
חריגה ממדיניות השימוש, למשל, הגבלת קצב העברת הנתונים. |
|
maxRateKbps |
קצב הנתונים המקסימלי שמותר לפי מודול התוכנית הזה, ביחידות של Kbps. קצב הנתונים בפועל שנצפה הוא בין 0 לבין maxRateKbps, בהתאם לתנאי הרשת. אם לא מציינים את הערך maxRateKbps או מגדירים אותו ל-0, לא מתבצעת הגבלת רוחב פס עבור מודול התוכנית הזה. |
|
description |
חובה. תיאור מודול התוכנית, עשוי להיות מוצג למשתמש וצריך להיות דומה לתיאור השוק של מודול התוכנית הזה. |
|
moduleName |
חובה. שם מודול התוכנית. |
|
usedBytes |
המספר הכולל של בייטים שהמשתמש ניצל מהמודול הזה בתוכנית. |
|
planModuleState |
הסטטוס של מודול התוכנית, למשל פעיל, לא פעיל וכו'. |
|
refreshPeriod |
תקופת הרענון של מודול התוכנית הזה, או REFRESH_PERIOD_NONE אם מודול התוכנית לא מרענן את המכסה שלו. מודולים של תוכניות שמאפסים את המכסה יעשו זאת פעם אחת בכל תקופת איפוס. |
|
שדה איחוד balance . חובה. פרטי היתרה במודול התוכנית, צריכים להיות אחד מהערכים הבאים: byte_balance, time_balance, coarse_balance_level. הערך balance יכול להיות רק אחד מהבאים: |
||
byteBalance |
פרטי היתרה של מודול בתוכנית מבוססת-בייט. במודולים שמתעדכנים באופן תקופתי, השדה הזה מייצג את יתרת הבייטים לכל תקופת עדכון. |
|
timeBalance |
מידע על היתרה במודול של מינוי מבוסס-זמן. במודולים שמתעדכנים מעת לעת, השדה הזה מייצג את היתרה של הזמן לכל תקופת רענון. |
ByteQuota
מידע על מכסת המודול או היתרה בתוכנית שמבוססת על בייט.
ייצוג ב-JSON | |
---|---|
{ "quotaBytes": string, "remainingBytes": string } |
שדות | |
---|---|
quotaBytes |
מכסת המודול בבייטים. בתוכניות ללא הגבלה, צריך להגדיר את הערך הזה ל-2^63 - 1 (9223372036854775807). |
remainingBytes |
נדרש לקבלת התראות על יתרה נמוכה. יתרת המכסה בבייטים. |
TimeQuota
מידע על מכסת המודול או היתרה בתוכנית שמבוססת על זמן.
ייצוג ב-JSON | |
---|---|
{ "quotaMinutes": string, "remainingMinutes": string } |
שדות | |
---|---|
quotaMinutes |
מכסת המודול בדקות למינוי מבוסס-זמן, למשל: 180 דקות. |
remainingMinutes |
יתרת המכסה בדקות בחבילה מבוססת-זמן, למשל: 40 דקות. |
BalanceLevel
מידע משוער על היתרה במודול התוכנית.
טיפוסים בני מנייה (enum) | |
---|---|
BALANCE_LEVEL_UNSPECIFIED |
לא צוין. |
NO_PLAN |
אין תוכנית גלישה. |
OUT_OF_DATA |
היתרה בחבילת הגלישה היא אפס. |
LOW_QUOTA |
יתרת הנתונים (או הזמן שנותר) שווה ל-10% עד 25% מהיתרה המקורית של החבילה (או הזמן המקורי), או קטנה ממנה. חברות התובלה יכולות לקבוע את הסכום המדויק של כל חבילה לפי שיקול דעתן. |
HIGH_QUOTA |
יתרת הנתונים (או הזמן שנותר) גדולה מ-10% עד 25% מהיתרה המקורית של החבילה (או הזמן). חברות התובלה יכולות לקבוע את הסכום המדויק של כל חבילה לפי שיקול דעתן. היתרה בחבילת הגלישה גבוהה. |
PlanModuleTrafficCategory
קטגוריית התנועה של מודול התוכנית, שמתארת את קבוצת התנועה של האפליקציה שמשויכת למודול תוכנית מסוים.
טיפוסים בני מנייה (enum) | |
---|---|
PLAN_MODULE_TRAFFIC_CATEGORY_UNSPECIFIED |
לא צוין. |
GENERIC |
כללי, חל על כל התנועה. |
VIDEO |
כל התנועה בסרטונים. |
VIDEO_BROWSING |
תנועה של גילוי סרטונים (גלישה), שמתייחסת לכל התנועה באפליקציות של סרטונים, לא כולל החלק של סטרימינג של וידאו או אודיו. |
VIDEO_OFFLINE |
תנועה של סרטונים במצב אופליין, שהיא הסכום של VIDEO_BROWSING ותנועה של סרטונים או אודיו במצב אופליין (לא סטרימינג). |
MUSIC |
תנועה באפליקציית המוזיקה. |
GAMING |
תנועה באפליקציות גיימינג. |
SOCIAL |
תנועה מאפליקציות חברתיות. |
MESSAGING |
תנועה באפליקציה להעברת הודעות. |
APP_STORE |
תנועה בחנות האפליקציות, כמו עדכון או הורדה של אפליקציה חדשה. |
OverUsagePolicy
מדיניות חריגה מהשימוש: מה קורה כשנגמרת למשתמש המכסה.
טיפוסים בני מנייה (enum) | |
---|---|
OVER_USAGE_POLICY_UNSPECIFIED |
לא צוין. |
THROTTLED |
המהירות מוגבלת. |
BLOCKED |
החיבור חסום. |
PAY_AS_YOU_GO |
משלמים לפי השימוש. |
PlanState
סוג Enum שמייצג מצבים שונים של תוכנית או מודול בתוכנית של משתמש.
טיפוסים בני מנייה (enum) | |
---|---|
ACTIVE |
המודול Plan/PlanModule פעיל והמשתמש יכול להשתמש בנתונים שמוצעים כחלק מהמודול. |
INACTIVE |
התוכנית או מודול התוכנית לא פעילים, ולמרות שהמודול עדיין זמין למשתמש, הוא לא יכול להשתמש בנתונים שכלולים בו. מצב כזה יכול לקרות אם המודול מציע נתונים רק בשעות מסוימות ביום או אם המשתמש רכש מודול אבל הוא עדיין לא הופעל. |
EXPIRING_SOON |
התוקף של Plan/PlanModule עומד לפוג בקרוב. המתקשר צריך לבחור את הרמה המתאימה כדי לקבוע מתי להגדיר את הערך הזה. זה אומר שהתוכנית פעילה. |
NEWLY_ACTIVE |
תוכנית או מודול תוכנית שהיו לא פעילים או לא קיימים הופעלו עכשיו. המצב הזה צריך לשמש רק לתקופה קצרה מאוד אחרי זמן ההפעלה, אחרת צריך להשתמש במצב ACTIVE. התראות על סטטוס חבילת נתונים שנשלחות עם מודולים בסטטוס NEWLY_ACTIVE צריכות להישלח עם TTL קצר, כי הסטטוס הזה הופך ללא מדויק מהר מאוד. |
EXPIRED |
פג התוקף של Plan או PlanModule. הגדרת ערך ה-enum הזה מפעילה התראה על תוכנית שפג תוקפה. |
RefreshPeriod
מייצג תקופת רענון, המרווח הקבוע שבו מודול של תוכנית מתאפס.
טיפוסים בני מנייה (enum) | |
---|---|
REFRESH_PERIOD_NONE |
אין תקופת רענון. המאפיין הזה משמש כשהמודול של התוכנית לא חוזר על עצמו. |
DAILY |
מודול התוכנית מתאפס כל יום. |
MONTHLY |
מודול התוכנית מתאפס בכל חודש. |
BIWEEKLY |
מודול התוכנית מתאפס כל שבועיים. |
WEEKLY |
מודול התוכנית מתאפס מדי שבוע. |
AccountInfo
מידע על יתרת החשבון של משתמשים שמשלמים מראש.
ייצוג ב-JSON | |
---|---|
{ "accountBalance": { object ( |
שדות | |
---|---|
accountBalance |
חובה. היתרה בחשבון המשתמש. |
loanBalance |
חובה אם רלוונטי. היתרה בחשבון המשתמש שנוספה באמצעות הלוואה כספית מהספק. אם השדה accountBalance קיים, הוא לא כולל את היתרה הזו. |
unpaidLoan |
סכום הכסף שהמשתמש חייב לספק בגלל הלוואות כספיות. |
accountBalanceStatus |
חובה. מציין את הסטטוס של היתרה בחשבון. במקרה של חוסר התאמה בין השדה validUntil לבין השדה accountBalanceStatus, אנחנו משתמשים ב-accountBalanceStatus. |
validUntil |
חובה. הזמן שעד אליו יתרת החשבון בתוקף. השדה הזה ישמש להצגת ההודעה 'לא תקף ב חותמת זמן בפורמט RFC3339 UTC 'Zulu', עם רזולוציה של ננו-שנייה ועד תשע ספרות אחרי הנקודה העשרונית. דוגמאות: |
payAsYouGoCharge |
סכום הכסף שהמשתמש הוציא על שימוש בתוכנית במצב של תשלום לפי שימוש. אם הספק מאכלס את השדה הזה כשהוא משתף את פרטי החשבון עם GTAF, GTAF ינסה לשלוח למשתמש הודעה שמציינת שהוא מוציא כסף במצב של תשלום לפי שימוש. |
accountTopUp |
נדרש כדי לקבל התראה על טעינת יתרה בחשבון. סכום הכסף שהמשתמש הוסיף ליתרה בחשבון שלו. אם השדה הזה מאוכלס על ידי הספק כשמשתפים את פרטי החשבון עם GTAF, GTAF ינסה לשלוח למשתמש הודעה על כך שהיתרה בחשבון שלו גדלה. |
כסף
מייצג סכום כסף עם סוג המטבע.
ייצוג ב-JSON | |
---|---|
{ "currencyCode": string, "units": string, "nanos": integer } |
שדות | |
---|---|
currencyCode |
קוד המטבע בן 3 האותיות שמוגדר בתקן ISO 4217. |
units |
מספר היחידות השלמות של הסכום. לדוגמה, אם הערך של |
nanos |
מספר יחידות הננו (10^-9) של הסכום. הערך חייב להיות בין -999,999,999 ל- +999,999,999, כולל. אם הערך של |
AccountBalanceStatus
הסטטוס של הארנק של המשתמש.
טיפוסים בני מנייה (enum) | |
---|---|
VALID |
היתרה בחשבון המשתמש תקפה ואפשר להשתמש בה לביצוע רכישות. |
INVALID |
היתרה בחשבון המשתמש לא תקינה ואי אפשר להשתמש בה בלי לבצע שינויים בחשבון. |
UiCompatibility
סוג enum שמייצג אם אפשר להציג למשתמש את PlanStatus שמשותף.
טיפוסים בני מנייה (enum) | |
---|---|
UI_COMPATIBILITY_UNSPECIFIED |
כברירת מחדל, נניח שהערך של PlanStatus הוא UI compatible. |
UI_COMPATIBLE |
מציין שכל PlanStatus תואם לממשק המשתמש ושאפשר להציג את פרטי התוכנית למשתמש. |
UI_INCOMPATIBLE |
מציין שהערך של PlanStatus לא תואם לממשק המשתמש. אפשר להשתמש בשדות כדי לשלוח התראות למשתמש, אבל אי אפשר להשתמש בהם כדי להציג למשתמש מידע על התוכנית. |
NotificationType
סוג ההתראה שנשלחת למשתמש בהגדרות של חבילת גלישה.
טיפוסים בני מנייה (enum) | |
---|---|
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 |
התראה שמיידעת את המשתמש שפג התוקף של חבילת הגלישה שלו. |
PlanInfoPerClient
מידע על תוכנית נתונים שרלוונטי ללקוח מסוים של Google.
ייצוג ב-JSON | |
---|---|
{ "youtube": { object ( |
שדות | |
---|---|
youtube |
מידע על תוכניות שקשורות ל-YouTube. |
androidSystemInfo |
מידע על התוכנית שרלוונטי למערכת Android. |
YouTube
מידע על תוכנית נתונים שרלוונטי ל-YouTube.
ייצוג ב-JSON | |
---|---|
{
"rateLimitedStreaming": {
object ( |
שדות | |
---|---|
rateLimitedStreaming |
תכונת הזרמת תוכן עם מודעות לתוכנית (PAS) של YouTube, שמגבילה את קצב העברת הנתונים של הסרטון שמועבר. |
RateLimitedStreaming
מידע על תוכנית הנתונים כדי לאפשר ל-YouTube לשפר את חוויית המשתמש של סטרימינג עם הגבלת קצב.
ייצוג ב-JSON | |
---|---|
{ "maxMediaRateKbps": integer } |
שדות | |
---|---|
maxMediaRateKbps |
קצב העברת הנתונים ב-YouTube שנתמך עבור המשתמש הזה ב-kbps (אלפי סיביות לשנייה). |
AndroidSystemInfo
מידע על תוכנית נתונים שרלוונטי לכל מערכת Android.
ייצוג ב-JSON | |
---|---|
{
"cellularInfo": [
{
object ( |
שדות | |
---|---|
cellularInfo[] |
מידע סלולרי לכל סוג חיבור. לדוגמה, תהיה הודעת cellularInfo אחת לכל סוג חיבור, כמו 4G, 5G וכו'. |
CellularInfo
מידע על חיבור סלולרי שהתוכנית מציעה למשתמש.
ייצוג ב-JSON | |
---|---|
{ "connectionType": enum ( |
שדות | |
---|---|
connectionType |
סוג החיבור שהמפעיל מספק למשתמש. |
meteredness |
מצב התשלום לפי שימוש בתוכנית של המשתמש. |
ConnectionType
סוג החיבור: 2G, 3G, 4G
טיפוסים בני מנייה (enum) | |
---|---|
CONNECTION_TYPE_UNSPECIFIED |
לא צוין. |
CONNECTION_2_G |
2G. |
CONNECTION_3_G |
3G. |
CONNECTION_4_G |
4G. |
CONNECTION_5_G |
5G. |
CONNECTION_ALL |
כל הסוגים. |
מכסת מאמרים בחינם
סוג התוכנית שיש למשתמש
טיפוסים בני מנייה (enum) | |
---|---|
METEREDNESS_UNSPECIFIED |
ל-GTAF אין מידע על מצב התשלום של התוכנית של המשתמש. |
METEREDNESS_UNMETERED |
המשתמש רשום לתוכנית ללא הגבלת נפח אחסון. |
METEREDNESS_METERED |
המשתמש רשום לתוכנית עם תשלום לפי שימוש. |
CpidState
ערך enum של חברת התובלה שמייצג את מצב ה-CPID.
טיפוסים בני מנייה (enum) | |
---|---|
CPID_STATE_UNSPECIFIED |
הסטטוס של מזהה ה-CPID לא צוין. המערכת מתייחסת לזה כאילו ה-CPID תקין. |
CPID_INVALIDATED |
מזהה ה-CPID לא תקף, והלקוח צריך לאחזר מזהה CPID חדש מנקודת הקצה של מזהה ה-CPID. |
Methods |
|
---|---|
|
מאפשר למפעיל סלולרי (שמזוהה באמצעות מספר מערכת אוטונומית (ASN) ייחודי) להוסיף רשומה חדשה של PlanStatus למשתמש, לשימוש על ידי לקוח מסוים. |