- Tài nguyên: PlanStatus
- Biểu diễn dưới dạng JSON
- Lập kế hoạch
- PlanCategory
- PlanModule
- ByteQuota
- TimeQuota
- BalanceLevel
- PlanModuleTrafficCategory
- OverUsagePolicy
- PlanState
- RefreshPeriod
- AccountInfo
- Tiền
- AccountBalanceStatus
- UiCompatibility
- NotificationType
- PlanInfoPerClient
- YouTube
- RateLimitedStreaming
- AndroidSystemInfo
- CellularInfo
- ConnectionType
- Tính đo lường
- CpidState
- Phương thức
Tài nguyên: PlanStatus
PlanStatus chứa thông tin chi tiết về tất cả gói dịch vụ di động cấp cao nhất mà người dùng đã mua.
Biểu diễn dưới dạng JSON | |
---|---|
{ "name": string, "plans": [ { object ( |
Trường | |
---|---|
name |
Tên tài nguyên của PlanStatus ở định dạng sau: |
plans[] |
Danh sách các gói mà người dùng này sở hữu. |
languageCode |
Bắt buộc. Mã ngôn ngữ BCP-47, chẳng hạn như "en-US" hoặc "sr-Latn". Để biết thêm thông tin, hãy xem http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. |
expireTime |
Bắt buộc. Thời điểm thông tin nhóm kế hoạch dùng chung trở nên lỗi thời. PlanStatus sẽ không được phân phát cho các ứng dụng sau thời gian này. Thời gian hết hạn phải là thời gian trong tương lai. Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, có độ phân giải nano giây và tối đa 9 chữ số thập phân. Ví dụ: |
updateTime |
Bắt buộc. Thời điểm mà tác nhân gói dữ liệu (DPA) tìm nạp thông tin trạng thái gói từ các hệ thống phụ trợ. Có thể dùng để xác định mức độ mới của thông tin về trạng thái kế hoạch. Thời gian cập nhật phải là thời gian trong quá khứ nhưng không được quá 30 ngày. Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, có độ phân giải nano giây và tối đa 9 chữ số thập phân. Ví dụ: |
title |
Tiêu đề của hợp đồng mà người dùng có với nhà mạng. Thông tin này sẽ xuất hiện trong tiêu đề giao diện người dùng. |
subscriberId |
Giá trị nhận dạng duy nhất và cố định trong hệ thống của hãng vận chuyển để xác định người dùng. |
accountInfo |
Bắt buộc đối với người dùng trả trước. Thông tin về số dư tài khoản người dùng. |
uiCompatibility |
Xác định xem người dùng có thể thấy PlanStatus trong giao diện người dùng hay không. Khi được đặt thành UI_INCOMPATIBLE, PlanStatus có thể dùng để gửi thông báo cho người dùng nhưng sẽ không dùng để cho người dùng thấy thông tin về gói. |
notifications[] |
Chứa danh sách các loại thông báo mà GTAF gửi cho người dùng. GTAF bỏ qua trường này nếu người gọi điền sẵn. |
planInfoPerClient |
Thông tin về gói dữ liệu liên quan đến một ứng dụng Google cụ thể. |
cpidState |
Trạng thái của CPID được liên kết với trạng thái kế hoạch này. |
Lập kế hoạch
Thông tin chi tiết về gói di động của người dùng, đây là gói dịch vụ di động cấp cao nhất mà người đăng ký mua. Gói có thể đơn giản như "10 GB dữ liệu di động trong 30 ngày" hoặc có thể được xác định là một tập hợp các thành phần (mà chúng tôi gọi là mô-đun gói). Ví dụ: Gói ACME 199 có nội dung mô tả là "2GB dữ liệu, không giới hạn whatsapp + không giới hạn wechat và 1GB spotify" có 3 mô-đun gói.
Biểu diễn dưới dạng JSON | |
---|---|
{ "planName": string, "planId": string, "planCategory": enum ( |
Trường | |
---|---|
planName |
Tên gói di động của người dùng. |
planId |
Bắt buộc. Mã nhận dạng gói, dùng để tham chiếu đến gói trong các ưu đãi, v.v. |
planCategory |
Gói trả trước hoặc trả sau. |
expirationTime |
Bắt buộc. Khi gói này hết hạn. Đối với hầu hết các kế hoạch, thời gian này phải bằng thời gian hết hạn tối đa của tất cả các mô-đun kế hoạch cụ thể. Đối với những gói có hạn mức mô-đun được làm mới định kỳ, đây phải là thời gian hết hạn chung của gói, tức là thời gian mà các mô-đun của gói ngừng làm mới. Bạn nên bỏ qua trường này nếu kế hoạch không hết hạn. Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, có độ phân giải nano giây và tối đa 9 chữ số thập phân. Ví dụ: |
planModules[] |
Thông tin chi tiết về các mô-đun kế hoạch (kế hoạch phụ). |
planState |
Trạng thái của gói người dùng, ví dụ: đang hoạt động, không hoạt động, v.v. |
PlanCategory
Các loại danh mục kế hoạch có thể có.
Enum | |
---|---|
PLAN_CATEGORY_UNSPECIFIED |
Không xác định. |
PREPAID |
Gói trả trước. |
POSTPAID |
Gói trả sau. |
PlanModule
Thông tin của từng mô-đun gói dữ liệu (hoặc gói con) trong một gói.
Biểu diễn dưới dạng JSON | |
---|---|
{ "coarseBalanceLevel": enum ( |
Trường | ||
---|---|---|
coarseBalanceLevel |
Thông tin số dư chưa xử lý. |
|
trafficCategories[] |
Danh sách các danh mục lưu lượng truy cập sẽ được tính phí theo mô-đun kế hoạch này. |
|
expirationTime |
Bắt buộc. Thời gian hết hạn cụ thể của mô-đun kế hoạch. Đối với các mô-đun kế hoạch có hạn mức được làm mới định kỳ, đây là thời gian làm mới mô-đun tiếp theo. Bạn nên bỏ qua trường này nếu mô-đun kế hoạch không hết hạn. Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, có độ phân giải nano giây và tối đa 9 chữ số thập phân. Ví dụ: |
|
overUsagePolicy |
Chính sách sử dụng quá mức, ví dụ: bị điều tiết. |
|
maxRateKbps |
Tốc độ dữ liệu tối đa mà mô-đun kế hoạch này cho phép tính bằng Kbps. Tốc độ dữ liệu thực tế quan sát được nằm trong khoảng từ 0 đến maxRateKbps, tuỳ thuộc vào tình trạng mạng. Nếu bạn bỏ qua maxRateKbps hoặc đặt giá trị này thành 0, tức là không có hoạt động điều tiết nào được thực hiện cho mô-đun kế hoạch này. |
|
description |
Bắt buộc. Nội dung mô tả về mô-đun kế hoạch, có thể xuất hiện cho người dùng và phải gần giống với nội dung mô tả về mô-đun kế hoạch này trên thị trường. |
|
moduleName |
Bắt buộc. Tên của mô-đun kế hoạch. |
|
usedBytes |
Tổng số byte mà người dùng đã sử dụng trong mô-đun gói này. |
|
planModuleState |
Trạng thái của mô-đun kế hoạch, ví dụ: đang hoạt động, không hoạt động, v.v. |
|
refreshPeriod |
Khoảng thời gian làm mới của mô-đun kế hoạch này hoặc REFRESH_PERIOD_NONE nếu mô-đun kế hoạch không làm mới hạn mức. Các mô-đun kế hoạch làm mới hạn mức sẽ làm như vậy một lần trong mỗi khoảng thời gian làm mới. |
|
Trường nhóm balance . Bắt buộc. Thông tin về số dư của mô-đun gói, phải là một trong những thông tin sau: byte_balance, time_balance, coarse_balance_level. balance chỉ có thể là một trong những trạng thái sau: |
||
byteBalance |
Thông tin về số dư của mô-đun gói dựa trên số byte. Đối với những mô-đun được làm mới định kỳ, trường này biểu thị số dư byte cho mỗi khoảng thời gian làm mới. |
|
timeBalance |
Thông tin về số dư của mô-đun gói dựa trên thời gian. Đối với những mô-đun làm mới định kỳ, trường này thể hiện số dư thời gian cho mỗi kỳ làm mới. |
ByteQuota
Thông tin về hạn mức/số dư của mô-đun gói dựa trên số byte.
Biểu diễn dưới dạng JSON | |
---|---|
{ "quotaBytes": string, "remainingBytes": string } |
Trường | |
---|---|
quotaBytes |
Định mức mô-đun tính bằng byte. Đối với gói không giới hạn, bạn nên đặt giá trị này thành 2^63 – 1 (9223372036854775807). |
remainingBytes |
Bắt buộc đối với thông báo số dư thấp. Số dư hạn mức còn lại theo byte. |
TimeQuota
Thông tin về hạn mức/số dư của gói theo thời gian.
Biểu diễn dưới dạng JSON | |
---|---|
{ "quotaMinutes": string, "remainingMinutes": string } |
Trường | |
---|---|
quotaMinutes |
Định mức mô-đun tính theo phút đối với gói dựa trên thời gian, ví dụ: 180 phút. |
remainingMinutes |
Số dư hạn mức còn lại tính bằng phút đối với gói dựa trên thời gian, ví dụ: 40 phút. |
BalanceLevel
Thông tin về số dư dữ liệu của mô-đun gói chưa xử lý.
Enum | |
---|---|
BALANCE_LEVEL_UNSPECIFIED |
Không xác định. |
NO_PLAN |
Không có gói dữ liệu. |
OUT_OF_DATA |
Số dư dữ liệu bằng 0. |
LOW_QUOTA |
Số dư dữ liệu (hoặc thời gian còn lại) bằng hoặc ít hơn 10-25% số dư (hoặc thời gian) ban đầu của gói. Các hãng vận chuyển CÓ THỂ xác định ngưỡng chính xác cho từng gói hàng nếu họ cho là phù hợp. |
HIGH_QUOTA |
Số dư dữ liệu (hoặc thời gian còn lại) lớn hơn 10-25% số dư (hoặc thời gian) ban đầu của gói. Các hãng vận chuyển CÓ THỂ xác định ngưỡng chính xác cho từng gói hàng nếu họ cho là phù hợp. Dung lượng dữ liệu còn lại lớn. |
PlanModuleTrafficCategory
Danh mục lưu lượng truy cập mô-đun kế hoạch, mô tả tập hợp lưu lượng truy cập ứng dụng thuộc một mô-đun kế hoạch cụ thể.
Enum | |
---|---|
PLAN_MODULE_TRAFFIC_CATEGORY_UNSPECIFIED |
Không xác định. |
GENERIC |
Chung, áp dụng cho tất cả lưu lượng truy cập. |
VIDEO |
Tất cả lưu lượng truy cập vào video. |
VIDEO_BROWSING |
Lưu lượng truy cập khám phá video (duyệt xem), tức là tất cả lưu lượng truy cập trên ứng dụng video, ngoại trừ phần phát trực tuyến video/âm thanh. |
VIDEO_OFFLINE |
Lưu lượng truy cập video khi không có mạng, là tổng của lưu lượng truy cập VIDEO_BROWSING và lưu lượng truy cập video/âm thanh khi không có mạng (không phải lưu lượng truy cập phát trực tuyến). |
MUSIC |
Lưu lượng truy cập vào ứng dụng âm nhạc. |
GAMING |
Lưu lượng truy cập của ứng dụng trò chơi. |
SOCIAL |
Lưu lượng truy cập từ ứng dụng mạng xã hội. |
MESSAGING |
Lưu lượng truy cập của ứng dụng nhắn tin. |
APP_STORE |
Lưu lượng truy cập vào cửa hàng ứng dụng, chẳng hạn như cập nhật hoặc tải một ứng dụng mới xuống. |
OverUsagePolicy
Chính sách sử dụng quá mức: điều gì xảy ra khi người dùng hết hạn mức.
Enum | |
---|---|
OVER_USAGE_POLICY_UNSPECIFIED |
Không xác định. |
THROTTLED |
Tốc độ bị hạn chế. |
BLOCKED |
Kết nối bị chặn. |
PAY_AS_YOU_GO |
Thanh toán theo mức sử dụng. |
PlanState
Liệt kê các trạng thái khác nhau của gói/mô-đun gói của người dùng.
Enum | |
---|---|
ACTIVE |
Plan/PlanModule đang hoạt động và người dùng có thể sử dụng dữ liệu được cung cấp trong mô-đun. |
INACTIVE |
Gói/Mô-đun gói không hoạt động và mặc dù người dùng vẫn có mô-đun, nhưng họ không thể sử dụng dữ liệu thuộc mô-đun đó. Điều này có thể xảy ra nếu mô-đun chỉ cung cấp dữ liệu vào một số thời điểm nhất định trong ngày hoặc nếu người dùng đã mua mô-đun nhưng chưa kích hoạt. |
EXPIRING_SOON |
Plan/PlanModule sắp hết hạn. Người gọi nên chọn cấp độ phù hợp để xác định thời điểm đặt giá trị này. Điều này có nghĩa là gói đó đang hoạt động. |
NEWLY_ACTIVE |
Plan/PlanModule vừa được kích hoạt (trước đây không hoạt động hoặc không tồn tại). Trạng thái này chỉ nên được dùng trong một khoảng thời gian rất ngắn sau thời gian kích hoạt, nếu không, bạn nên dùng trạng thái ĐANG HOẠT ĐỘNG. Thông báo về trạng thái gói dữ liệu được gửi bằng các mô-đun NEWLY_ACTIVE phải được gửi bằng TTL ngắn, vì trạng thái NEWLY_ACTIVE sẽ nhanh chóng trở nên không chính xác. |
EXPIRED |
Gói/PlanModule đã hết hạn. Việc đặt giá trị enum này sẽ kích hoạt thông báo gói đã hết hạn. |
RefreshPeriod
Biểu thị khoảng thời gian làm mới, khoảng thời gian định kỳ mà một mô-đun kế hoạch được đặt lại.
Enum | |
---|---|
REFRESH_PERIOD_NONE |
Không có khoảng thời gian làm mới. Được dùng khi mô-đun gói không định kỳ. |
DAILY |
Mỗi ngày, mô-đun kế hoạch sẽ được đặt lại. |
MONTHLY |
Mô-đun kế hoạch sẽ được đặt lại mỗi tháng. |
BIWEEKLY |
Mô-đun kế hoạch sẽ được đặt lại sau mỗi hai tuần. |
WEEKLY |
Mô-đun kế hoạch sẽ được đặt lại mỗi tuần. |
AccountInfo
Thông tin về số dư tài khoản của người dùng trả trước.
Biểu diễn dưới dạng JSON | |
---|---|
{ "accountBalance": { object ( |
Trường | |
---|---|
accountBalance |
Bắt buộc. Số dư tài khoản còn lại trong tài khoản người dùng. |
loanBalance |
Bắt buộc nếu áp dụng. Số dư tài khoản còn lại trong tài khoản người dùng do nhà mạng cho vay tiền. Nếu có, trường accountBalance sẽ không bao gồm số dư này. |
unpaidLoan |
Số tiền mà người dùng nợ hãng vận chuyển do các khoản vay bằng tiền. |
accountBalanceStatus |
Bắt buộc. Cho biết trạng thái của số dư tài khoản. Trong trường hợp có sự khác biệt giữa thời gian validUntil và trường accountBalanceStatus, chúng tôi sẽ sử dụng accountBalanceStatus. |
validUntil |
Bắt buộc. Thời gian mà số dư tài khoản có hiệu lực. Trường này sẽ được dùng để cho người dùng thấy thông báo "Không hợp lệ ở Dấu thời gian ở định dạng "Zulu" RFC3339 UTC, có độ phân giải nano giây và tối đa 9 chữ số thập phân. Ví dụ: |
payAsYouGoCharge |
Số tiền mà người dùng đã chi tiêu khi sử dụng gói ở trạng thái trả theo mức dùng. Nếu hãng vận chuyển điền sẵn thông tin vào trường này khi chia sẻ thông tin tài khoản với GTAF, thì GTAF sẽ cố gắng gửi thông báo cho người dùng biết rằng họ đang chi tiêu tiền ở một tiểu bang có hình thức thanh toán trả trước. |
accountTopUp |
Bắt buộc đối với thông báo nạp tiền vào tài khoản. Số tiền mà người dùng đã nạp vào số dư tài khoản của họ. Nếu hãng vận chuyển điền sẵn thông tin vào trường này khi chia sẻ thông tin tài khoản với GTAF, thì GTAF sẽ cố gắng gửi thông báo cho người dùng để cho biết tài khoản của họ đã được nạp tiền. |
Tiền
Biểu thị một số tiền cùng với loại đơn vị tiền tệ.
Biểu diễn dưới dạng JSON | |
---|---|
{ "currencyCode": string, "units": string, "nanos": integer } |
Trường | |
---|---|
currencyCode |
Mã tiền tệ gồm 3 chữ cái được xác định trong ISO 4217. |
units |
Đơn vị số nguyên của số tiền. Ví dụ: nếu |
nanos |
Số lượng đơn vị nano (10^-9) của số tiền. Giá trị phải nằm trong khoảng từ -999.999.999 đến +999.999.999 (bao gồm). Nếu |
AccountBalanceStatus
Trạng thái của ví người dùng.
Enum | |
---|---|
VALID |
Số dư trong tài khoản người dùng là hợp lệ và có thể dùng để mua hàng. |
INVALID |
Số dư tài khoản người dùng không hợp lệ và không thể sử dụng nếu không thực hiện thay đổi đối với tài khoản. |
UiCompatibility
Liệt kê đại diện cho việc người dùng có thể xem PlanStatus đang được chia sẻ hay không.
Enum | |
---|---|
UI_COMPATIBILITY_UNSPECIFIED |
Theo mặc định, chúng tôi sẽ giả định rằng PlanStatus tương thích với giao diện người dùng. |
UI_COMPATIBLE |
Cho biết toàn bộ PlanStatus đều tương thích với giao diện người dùng và thông tin về gói có thể được hiển thị cho người dùng. |
UI_INCOMPATIBLE |
Cho biết PlanStatus không tương thích với giao diện người dùng. Bạn có thể dùng các trường này để gửi thông báo cho người dùng nhưng không thể dùng để cho người dùng xem thông tin về kế hoạch. |
NotificationType
Loại thông báo được gửi cho người dùng chế độ cài đặt Gói dữ liệu di động.
Enum | |
---|---|
NOTIFICATION_UNDEFINED |
Loại thể loại thông báo không xác định |
NOTIFICATION_LOW_BALANCE_WARNING |
Thông báo cảnh báo người dùng về số dư thấp |
NOTIFICATION_DATA_EXPIRATION_WARNING |
Thông báo cảnh báo người dùng rằng gói dữ liệu sắp hết hạn |
NOTIFICATION_OUT_OF_DATA |
Thông báo cho người dùng biết rằng họ đã hết dữ liệu |
NOTIFICATION_PLAN_ACTIVATION |
Thông báo cho biết gói mà người dùng đã mua hiện đang hoạt động |
NOTIFICATION_PAY_AS_YOU_GO |
Thông báo cho người dùng biết rằng họ đang trả tiền cho dữ liệu ở trạng thái trả theo mức dùng. |
NOTIFICATION_ACCOUNT_TOP_UP |
Thông báo cho người dùng biết rằng họ đã nạp tiền vào số dư tài khoản. |
NOTIFICATION_DATA_EXPIRED |
Thông báo cho người dùng biết rằng gói dữ liệu của họ đã hết hạn. |
PlanInfoPerClient
Thông tin về gói dữ liệu liên quan đến một ứng dụng Google cụ thể.
Biểu diễn dưới dạng JSON | |
---|---|
{ "youtube": { object ( |
Trường | |
---|---|
youtube |
Thông tin liên quan đến gói YouTube. |
androidSystemInfo |
Thông tin về gói có liên quan đến Hệ thống Android. |
YouTube
Thông tin về gói dữ liệu liên quan đến YouTube.
Biểu diễn dưới dạng JSON | |
---|---|
{
"rateLimitedStreaming": {
object ( |
Trường | |
---|---|
rateLimitedStreaming |
Tính năng Phát trực tuyến theo gói (PAS) của YouTube giúp giới hạn tốc độ bit của video được phân phối. |
RateLimitedStreaming
Thông tin về gói dữ liệu để YouTube có thể nâng cao trải nghiệm phát trực tuyến cho người dùng bị giới hạn tốc độ.
Biểu diễn dưới dạng JSON | |
---|---|
{ "maxMediaRateKbps": integer } |
Trường | |
---|---|
maxMediaRateKbps |
Tốc độ bit của YouTube mà người dùng này được hỗ trợ, tính bằng kbps (hàng nghìn bit mỗi giây). |
AndroidSystemInfo
Thông tin về gói dữ liệu liên quan đến toàn bộ hệ thống Android.
Biểu diễn dưới dạng JSON | |
---|---|
{
"cellularInfo": [
{
object ( |
Trường | |
---|---|
cellularInfo[] |
Thông tin di động theo từng loại kết nối. Ví dụ: sẽ có một thông báo cellularInfo cho mỗi loại kết nối như 4G, 5G, v.v. |
CellularInfo
Thông tin về kết nối di động mà gói này cung cấp cho người dùng.
Biểu diễn dưới dạng JSON | |
---|---|
{ "connectionType": enum ( |
Trường | |
---|---|
connectionType |
Loại kết nối mà nhà mạng cung cấp cho người dùng. |
meteredness |
Trạng thái tính phí theo mức sử dụng của gói người dùng. |
ConnectionType
Loại kết nối: 2G, 3G, 4G
Enum | |
---|---|
CONNECTION_TYPE_UNSPECIFIED |
Không xác định. |
CONNECTION_2_G |
2G. |
CONNECTION_3_G |
3G. |
CONNECTION_4_G |
4G. |
CONNECTION_5_G |
5G. |
CONNECTION_ALL |
Tất cả các loại. |
Đo lường
Loại gói mà người dùng có
Enum | |
---|---|
METEREDNESS_UNSPECIFIED |
GTAF không biết trạng thái sử dụng dữ liệu có đo lường của gói người dùng. |
METEREDNESS_UNMETERED |
Người dùng đang sử dụng gói không giới hạn. |
METEREDNESS_METERED |
Người dùng đang sử dụng gói có tính phí theo mức sử dụng. |
CpidState
Một enum cho nhà mạng để biểu thị trạng thái CPID.
Enum | |
---|---|
CPID_STATE_UNSPECIFIED |
Trạng thái của CPID không được chỉ định. Hệ thống sẽ coi như CPID hợp lệ. |
CPID_INVALIDATED |
CPID không hợp lệ và ứng dụng phải tìm nạp CPID mới từ điểm cuối CPID. |
Phương thức |
|
---|---|
|
Cho phép nhà mạng di động (được xác định bằng Số hệ thống tự trị (ASN) duy nhất) thêm mục PlanStatus mới cho người dùng để một ứng dụng cụ thể sử dụng. |