- ทรัพยากร: PlanStatus
- เมธอด
ทรัพยากร: 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 |
ต้องระบุ เวลาที่ข้อมูลกลุ่มแผนที่ใช้ร่วมกันล้าสมัย สถานะ "การวางแผน" จะไม่แสดงไปยังแอปพลิเคชันหลังจากเวลานี้ การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่แม่นยำเป็นหน่วยนาโนวินาที ตัวอย่าง: |
updateTime |
ต้องระบุ เวลาที่ Agent แพ็กเกจข้อมูล (DPA) ดึงข้อมูลสถานะแพ็กเกจจากระบบแบ็กเอนด์ ซึ่งใช้เพื่อระบุข้อมูลสถานะของแผนได้ไม่นาน การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่แม่นยำเป็นหน่วยนาโนวินาที ตัวอย่าง: |
title |
ชื่อสัญญาที่ผู้ใช้ดําเนินการกับโอเปอเรเตอร์ ข้อมูลนี้จะแสดงในส่วนหัว UI |
subscriberId |
ตัวระบุคงที่ที่ไม่ซ้ํากันในระบบของผู้ให้บริการเพื่อระบุผู้ใช้ |
accountInfo |
ต้องระบุสําหรับผู้ใช้แบบชําระล่วงหน้า ข้อมูลเกี่ยวกับยอดคงเหลือในบัญชีผู้ใช้ |
uiCompatibility |
กําหนดว่าจะแสดงสถานะแพ็กเกจแก่ผู้ใช้ในอินเทอร์เฟซผู้ใช้หรือไม่ เมื่อตั้งค่าเป็น UI_INCOMPATIBLE คุณสามารถใช้ PlanStatus เพื่อส่งการแจ้งเตือนถึงผู้ใช้ แต่จะไม่ใช้สําหรับแสดงข้อมูลแผนแก่ผู้ใช้ |
notifications[] |
ประเภทของการแจ้งเตือนที่ส่งถึงผู้ใช้ |
planInfoPerClient |
|
แผน
รายละเอียดของแผนอุปกรณ์เคลื่อนที่ของผู้ใช้ ซึ่งเป็นแพ็กเกจบริการมือถือระดับบนสุดที่สมาชิกซื้อ แผนอาจเป็นแบบเรียบง่ายได้เหมือน "อินเทอร์เน็ตมือถือ 10 GB เป็นเวลา 30 วัน&; หรืออาจหมายถึงคอลเล็กชันของคอมโพเนนต์ (ซึ่งเราเรียกว่าโมดูลโมดูล) ตัวอย่างเช่น แผน ACME 199 อธิบายว่าเป็น "ข้อมูล 2GB, WhatsApp ไม่จํากัด + Wechat แบบไม่จํากัด และ 1GB spotify" มีโมดูลแผน 3 รายการ
การแสดง JSON | |
---|---|
{ "planName": string, "planId": string, "planCategory": enum ( |
ช่อง | |
---|---|
planName |
ชื่อแพ็กเกจอินเทอร์เน็ตของผู้ใช้ |
planId |
ต้องระบุ ตัวระบุแพ็กเกจ ซึ่งใช้อ้างอิงถึงแพ็กเกจระหว่างข้อเสนอ ฯลฯ |
planCategory |
แพ็กเกจแบบชําระเงินล่วงหน้าหรือแบบชําระเงินภายหลัง |
expirationTime |
ต้องระบุ เมื่อแพ็กเกจนี้หมดอายุ สําหรับแผนส่วนใหญ่ ค่านี้ควรเท่ากับระยะเวลาสูงสุดของโมดูลแผนทั้งหมด สําหรับแพ็กเกจที่รีเฟรชโควต้าของโมดูลเป็นระยะ เวลาดังกล่าวควรเป็นเวลาหมดอายุของแพ็กเกจโดยรวม ซึ่งก็คือเวลาที่โมดูลแพ็กเกจจะหยุดรีเฟรช ช่องนี้ไม่ควรถูกตัดออกหากแพ็กเกจไม่มีวันหมดอายุ การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่แม่นยำเป็นหน่วยนาโนวินาที ตัวอย่าง: |
planModules[] |
ข้อมูลโมดูลแผนโดยละเอียด (แผนย่อย) |
planState |
สถานะของแผนผู้ใช้ เช่น ใช้งานอยู่ ไม่ใช้งาน ฯลฯ |
หมวดหมู่ของแผน
ประเภทหมวดหมู่แพ็กเกจที่เป็นไปได้
Enum | |
---|---|
PLAN_CATEGORY_UNSPECIFIED |
ไม่ระบุ |
PREPAID |
แพ็กเกจชําระล่วงหน้า |
POSTPAID |
แพ็กเกจแบบชําระเงินภายหลัง |
โมดูลแผน
ข้อมูลของโมดูลแพ็กเกจอินเทอร์เน็ตแต่ละรายการ (หรือแพ็กเกจย่อย) ภายในแพ็กเกจ
การแสดง JSON | |
---|---|
{ "coarseBalanceLevel": enum ( |
ช่อง | ||
---|---|---|
coarseBalanceLevel |
ข้อมูลยอดคงเหลือคร่าวๆ |
|
trafficCategories[] |
รายการหมวดหมู่การเข้าชมที่จะถูกเรียกเก็บเงินตามโมดูลแผนนี้ |
|
expirationTime |
ต้องระบุ เวลาหมดอายุของโมดูลแผน สําหรับโมดูลแพ็กเกจที่มีโควต้าซึ่งจะรีเฟรชเป็นระยะ นี่คือเวลาของการรีเฟรชโมดูลถัดไป ช่องนี้ไม่ควรถูกตัดออกหากแพ็กเกจไม่มีวันหมดอายุ การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่แม่นยำเป็นหน่วยนาโนวินาที ตัวอย่าง: |
|
overUsagePolicy |
นโยบายการใช้งานที่มากเกินไป เช่น การควบคุม |
|
maxRateKbps |
อัตราข้อมูลสูงสุดที่โมดูลแพ็กเกจนี้อนุญาตในหน่วย Kbps อัตราข้อมูลจริงที่พบอยู่ระหว่าง 0 ถึง maxRateKbps ขึ้นอยู่กับเงื่อนไขของเครือข่าย การตัด maxRateKbps หรือตั้งค่าเป็น 0 หมายความว่าไม่มีการควบคุมสําหรับโมดูลแพ็กเกจนี้ |
|
description |
ต้องระบุ คําอธิบายโมดูลของแผนอาจแสดงต่อผู้ใช้และควรอยู่ใกล้กับคําอธิบายตลาดของโมดูลแผนนี้ |
|
moduleName |
ต้องระบุ ชื่อของโมดูลแผน |
|
usedBytes |
จํานวนไบต์ทั้งหมดที่ใช้โดยผู้ใช้จากโมดูลแผนนี้ |
|
planModuleState |
สถานะของโมดูลแผน เช่น ใช้งานอยู่ ไม่ได้ใช้งาน ฯลฯ |
|
refreshPeriod |
ระยะเวลาการรีเฟรชของโมดูลแผนนี้ หรือ REFRESH_PERIOD_NONE หากโมดูลแผนไม่รีเฟรชโควต้า ระบบจะคํานวณโมดูลแพ็กเกจที่รีเฟรชโควต้าทุกๆ ช่วงเวลาการรีเฟรช |
|
ช่อง Union balance ต้องระบุ ข้อมูลยอดคงเหลือในโมดูลแพ็กเกจควรเป็นหนึ่งในค่า bytes_balance, time_balance, coarse_balance_level balance ต้องเป็นอย่างใดอย่างหนึ่งต่อไปนี้เท่านั้น |
||
byteBalance |
ไบต์ตามข้อมูลยอดคงเหลือในโมดูลของแผน สําหรับโมดูลที่จะรีเฟรชเป็นระยะๆ ช่องนี้จะแสดงยอดคงเหลือของไบต์ต่อระยะเวลาการรีเฟรช |
|
timeBalance |
ข้อมูลยอดคงเหลือในโมดูลของแผนตามเวลา สําหรับโมดูลที่มีการรีเฟรชเป็นระยะๆ ช่องนี้จะแสดงยอดคงเหลือของเวลาต่อระยะเวลาการรีเฟรช |
โควต้า
ไบต์ตามโควต้าโควต้า/โมดูลโมดูลตามแพ็กเกจ
การแสดง JSON | |
---|---|
{ "quotaBytes": string, "remainingBytes": string } |
ช่อง | |
---|---|
quotaBytes |
โควต้าโมดูลในหน่วยไบต์ สําหรับแพ็กเกจแบบไม่จํากัด ควรตั้งค่าเป็น 2^63 - 1 (9223372036854775807) |
remainingBytes |
ต้องระบุสําหรับการแจ้งเตือนยอดคงเหลือต่ํา ยอดเงินคงเหลือในโควต้าในหน่วยไบต์ |
โควต้าเวลา
ข้อมูลโควต้า/ยอดคงเหลือของโมดูลแพ็กเกจตามเวลา
การแสดง JSON | |
---|---|
{ "quotaMinutes": string, "remainingMinutes": string } |
ช่อง | |
---|---|
quotaMinutes |
โควต้าโมดูลในหน่วยนาทีสําหรับแพ็กเกจที่อิงตามเวลา เช่น 180 นาที |
remainingMinutes |
ยอดเงินคงเหลือในโควต้าในหน่วยนาทีสําหรับแพ็กเกจที่อิงตามเวลา เช่น 40 นาที |
ระดับความสมดุล
ข้อมูลยอดคงเหลือของโมดูลแผนคร่าวๆ
Enum | |
---|---|
BALANCE_LEVEL_UNSPECIFIED |
ไม่ระบุ |
NO_PLAN |
ไม่มีแผนข้อมูล |
OUT_OF_DATA |
ยอดคงเหลือเป็น 0 |
LOW_QUOTA |
อินเทอร์เน็ตคงเหลือ (หรือเวลาที่เหลือ) เท่ากับหรือน้อยกว่า 10-25% ของยอดคงเหลือแพ็กเดิม (หรือเวลา) ผู้ให้บริการอาจพิจารณาเกณฑ์ที่แน่นอนสําหรับแต่ละแพ็กตามที่ได้เห็นสมควร |
HIGH_QUOTA |
ยอดคงเหลือของข้อมูล (หรือเวลาเหลือ) มากกว่า 10-25% ของยอดคงเหลือแพ็กเดิม (หรือเวลา) ผู้ให้บริการอาจพิจารณาเกณฑ์ที่แน่นอนสําหรับแต่ละแพ็กตามที่ได้เห็นสมควร ข้อมูลมีปริมาณสูง |
หมวดหมู่การจราจรของข้อมูลแผน
หมวดหมู่การเข้าชมโมดูลแผน ซึ่งอธิบายชุดการรับส่งข้อมูลของแอปพลิเคชันที่ตรงกับโมดูลของแผนที่เฉพาะเจาะจง
Enum | |
---|---|
PLAN_MODULE_TRAFFIC_CATEGORY_UNSPECIFIED |
ไม่ระบุ |
GENERIC |
ทั่วไป ใช้กับการเข้าชมทั้งหมด |
VIDEO |
การเข้าชมวิดีโอทั้งหมด |
VIDEO_BROWSING |
การเข้าชม Video Discovery (การเรียกดู) ซึ่งหมายถึงการเข้าชมแอปวิดีโอทั้งหมดยกเว้นส่วนการสตรีมวิดีโอ/เสียง |
VIDEO_OFFLINE |
การเข้าชมวิดีโอแบบออฟไลน์ ซึ่งก็คือผลรวมของวิดีโอ VIDEO_BROWSING และการเข้าชมวิดีโอ/เสียงแบบออฟไลน์ (ไม่ใช่สตรีมมิง) |
MUSIC |
การเข้าชมแอปเพลง |
GAMING |
การเข้าชมแอปเกม |
SOCIAL |
การเข้าชมแอปโซเชียล |
MESSAGING |
การรับส่งข้อมูลของแอปรับส่งข้อความ |
APP_STORE |
การเข้าชม App Store เช่น การอัปเดตหรือดาวน์โหลดแอปใหม่ |
นโยบายการใช้มากเกินไป
นโยบายการใช้งานสูงกว่า: สิ่งที่จะเกิดขึ้นเมื่อผู้ใช้ใช้โควต้าหมดแล้ว
Enum | |
---|---|
OVER_USAGE_POLICY_UNSPECIFIED |
ไม่ระบุ |
THROTTLED |
มีการควบคุมความเร็ว |
BLOCKED |
การเชื่อมต่อถูกบล็อก |
PAY_AS_YOU_GO |
จ่ายต่อการใช้งาน |
สถานะแผน
จํานวนสถานะต่างๆ ของโมดูลแผน/แผนของผู้ใช้
Enum | |
---|---|
ACTIVE |
Plan/PlanModule ทํางานอยู่และผู้ใช้สามารถใช้ข้อมูลที่นําเสนอในโมดูลได้ |
INACTIVE |
โมดูล Plan/Plan จะไม่ทํางานและแม้ว่าผู้ใช้จะยังมีโมดูลนั้นอยู่ แต่ผู้ใช้จะไม่สามารถใช้ข้อมูลที่เป็นส่วนหนึ่งของโมดูลได้ กรณีนี้อาจเกิดขึ้นหากโมดูลมีเฉพาะข้อมูลในบางช่วงเวลาของวันหรือหากผู้ใช้ซื้อโมดูลแต่ยังไม่ได้เปิดใช้งาน |
EXPIRING_SOON |
แพ็กเกจ/PlanModule จะหมดอายุเร็วๆ นี้ ผู้โทรควรเลือกระดับที่เหมาะสมในการพิจารณาว่าจะกําหนดค่านี้เมื่อใด ซึ่งหมายความว่าแพ็กเกจนั้นจะทํางานอยู่โดยอัตโนมัติ |
NEWLY_ACTIVE |
เพิ่งเปิดใช้งาน Plan/PlanModule ที่อยู่ในสถานะไม่ใช้งานหรือไม่มีอยู่จริงก่อนหน้านี้ สถานะนี้ควรใช้เป็นระยะเวลาสั้นๆ หลังเวลาเปิดใช้งานเท่านั้น มิเช่นนั้น ควรแสดงสถานะ "ใช้งานอยู่" แทน การแจ้งเตือนสถานะแพ็กเกจข้อมูลที่ส่งด้วยโมดูล NEWLY_ACTIVE ควรส่งโดยใช้ TTL แบบสั้น เนื่องจากสถานะ NEWLY_ACTIVE จะกลายเป็นไม่ถูกต้องอย่างรวดเร็ว |
EXPIRED |
Plan/PlanModule หมดอายุแล้ว การตั้งค่า Enum นี้จะเรียกการแจ้งเตือนว่าแพ็กเกจหมดอายุ |
ระยะเวลาการรีเฟรช
แสดงระยะเวลาการรีเฟรช ซึ่งเป็นระยะเวลาปกติที่โมดูลแพ็กเกจจะรีเซ็ต
Enum | |
---|---|
REFRESH_PERIOD_NONE |
ไม่มีระยะเวลาการรีเฟรช ใช้เมื่อโมดูลแผนไม่เกิดซ้ํา |
DAILY |
โมดูลแพ็กเกจจะรีเซ็ตทุกวัน |
MONTHLY |
โมดูลแพ็กเกจจะรีเซ็ตทุกเดือน |
BIWEEKLY |
โมดูลแพ็กเกจจะรีเซ็ตทุก 2 สัปดาห์ |
WEEKLY |
โมดูลแพ็กเกจจะรีเซ็ตทุกสัปดาห์ |
ข้อมูลบัญชี
ข้อมูลเกี่ยวกับเงินคงเหลือล่วงหน้าของผู้ใช้
การแสดง JSON | |
---|---|
{ "accountBalance": { object ( |
ช่อง | |
---|---|
accountBalance |
ต้องระบุ เงินคงเหลือในบัญชีผู้ใช้ |
loanBalance |
ต้องระบุ (หากมี) เงินคงเหลือในบัญชีผู้ใช้ที่เพิ่มโดยเงินกู้จากผู้ให้บริการ หากมี ช่อง accountBalance จะไม่รวมยอดคงเหลือนี้ |
unpaidLoan |
จํานวนเงินที่ผู้ใช้ค้างชําระผ่านผู้ให้บริการเนื่องจากมีเงินกู้ |
accountBalanceStatus |
ต้องระบุ ระบุสถานะของเงินคงเหลือ ในกรณีที่ช่อง timeUntil กับ accountBalanceStatus ไม่ตรงกัน เราจะใช้ accountBalanceStatus |
validUntil |
ต้องระบุ เวลาที่ยอดเงินในบัญชีถูกต้อง ช่องนี้จะใช้เพื่อแสดง "ไม่ถูกต้องใน การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่แม่นยำเป็นหน่วยนาโนวินาที ตัวอย่าง: |
payAsYouGoCharge |
จํานวนเงินที่ผู้ใช้ใช้จ่ายโดยใช้แพ็กเกจแบบชําระเงินเมื่อเปลี่ยนไปใช้ หากช่องนี้มีข้อมูลจากผู้ให้บริการขนส่งเมื่อแชร์ข้อมูลบัญชีกับ GTAF ระบบ GTAF จะพยายามส่งการแจ้งเตือนถึงผู้ใช้เพื่อแจ้งว่าผู้ใช้กําลังเสียค่าใช้จ่ายในสถานะตามที่คุณไป |
accountTopUp |
จําเป็นสําหรับการแจ้งเตือนเติมเงินในบัญชี จํานวนเงินที่ผู้ใช้เพิ่มลงในยอดคงเหลือในบัญชี หากช่องนี้เติมข้อมูลโดยผู้ให้บริการเมื่อแชร์ข้อมูลบัญชีกับ GTAF ระบบ GTAF จะพยายามส่งการแจ้งเตือนถึงผู้ใช้เพื่อแจ้งว่าบัญชีได้รับการเติมเงินแล้ว |
ค่าเงิน
หมายถึงจํานวนเงินด้วยประเภทสกุลเงิน
การแสดง JSON | |
---|---|
{ "currencyCode": string, "units": string, "nanos": number } |
ช่อง | |
---|---|
currencyCode |
รหัสสกุลเงิน 3 ตัวอักษรที่กําหนดไว้ใน ISO 4217 |
units |
จํานวนหน่วยทั้งหมดของจํานวน เช่น หาก |
nanos |
จํานวนหน่วยนาโน (10^-9) ของจํานวน ค่าต้องอยู่ระหว่าง -999,999,999 ถึง +999,999,999 หาก |
สถานะยอดคงเหลือในบัญชี
สถานะของกระเป๋าสตางค์ผู้ใช้
Enum | |
---|---|
VALID |
ยอดคงเหลือในบัญชีผู้ใช้ถูกต้อง และสามารถใช้สั่งซื้อได้ |
INVALID |
ยอดคงเหลือในบัญชีผู้ใช้ไม่ถูกต้องและไม่สามารถใช้ได้หากไม่ได้ทําการเปลี่ยนแปลงบัญชี |
ความเข้ากันได้กับ UI
แจกแจงว่าจะแสดง PlanStatus ที่แชร์ให้ผู้ใช้เห็นได้หรือไม่
Enum | |
---|---|
UI_COMPATIBILITY_UNSPECIFIED |
โดยค่าเริ่มต้น เราจะถือว่า PlanStatus ทํางานกับ UI ได้ |
UI_COMPATIBLE |
ระบุว่าแพ็กเกจทั้งหมดเข้ากันได้กับ UI และข้อมูลแพ็กเกจสามารถแสดงต่อผู้ใช้ได้ |
UI_INCOMPATIBLE |
ระบุว่า PlanStatus ไม่ใช่ความเข้ากันได้ของ UI ช่องสามารถใช้เพื่อส่งการแจ้งเตือนถึงผู้ใช้ แต่ไม่สามารถใช้เพื่อแสดงข้อมูลแผนแก่ผู้ใช้ |
ประเภทการแจ้งเตือน
ประเภทของการแจ้งเตือนที่ส่งถึงผู้ใช้การตั้งค่าแพ็กเกจอินเทอร์เน็ตมือถือ
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 |
การแจ้งเตือนเพื่อแจ้งให้ผู้ใช้ทราบว่าแพ็กเกจอินเทอร์เน็ตหมดอายุแล้ว |
ข้อมูลไคลเอ็นต์ของแผน
ข้อมูลแพ็กเกจที่เกี่ยวข้องกับไคลเอ็นต์ของ Google
การแสดง JSON | |
---|---|
{
"youtube": {
object ( |
ช่อง | |
---|---|
youtube |
ข้อมูลแพ็กเกจที่เกี่ยวข้องกับ YouTube |
YouTube
ข้อมูลแพ็กเกจที่เกี่ยวข้องกับ YouTube
การแสดง JSON | |
---|---|
{
"rateLimitedStreaming": {
object ( |
ช่อง | |
---|---|
rateLimitedStreaming |
ฟีเจอร์สตรีมมิงของ YouTube Plan (PAS) ที่จํากัดอัตราบิตของวิดีโอที่กําลังจะแสดง |
สตรีมมิงแบบจํากัดราคา
ข้อมูลแพ็กเกจข้อมูลเพื่อให้ YouTube ปรับปรุงประสบการณ์การใช้งานสตรีมมิงแบบจํากัดอัตราของผู้ใช้
การแสดง JSON | |
---|---|
{ "maxMediaRateKbps": number } |
ช่อง | |
---|---|
maxMediaRateKbps |
อัตราบิตของ YouTube ที่สนับสนุนสําหรับผู้ใช้รายนี้ในหน่วย kbps (1,000' บิตต่อวินาที) |
เมธอด |
|
---|---|
|
อนุญาตให้ผู้ให้บริการมือถือ (ระบุด้วยหมายเลขระบบเครือข่ายอัตโนมัติ (ASN) ที่ไม่ซ้ํากัน) เพิ่มแผน PlanStatus ใหม่เพื่อให้ลูกค้าใช้งานไคลเอ็นต์นั้นๆ |