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)
  },
  "cpidState": enum (CpidState)
}
زمینه های
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)

ضروری. زمانی که اطلاعات گروه طرح مشترک قدیمی می شود. PlanStatus پس از این زمان به برنامه ها ارائه نمی شود. زمان انقضا باید در آینده باشد.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

updateTime

string ( Timestamp format)

ضروری. زمانی که عامل طرح داده (DPA) اطلاعات وضعیت طرح را از سیستم های پشتیبان دریافت کرد. می تواند برای تعیین میزان اخیر اطلاعات وضعیت طرح استفاده شود. زمان به‌روزرسانی باید در گذشته باشد اما نمی‌تواند بیش از 30 روز از آن گذشته باشد.

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

title

string

عنوان قراردادی که کاربر با اپراتور دارد. این در هدر UI نشان داده خواهد شد.

subscriberId

string

شناسه ثابت منحصر به فرد در سیستم حامل برای شناسایی کاربر.

accountInfo

object ( AccountInfo )

برای کاربران پیش پرداخت مورد نیاز است. اطلاعات مربوط به موجودی حساب کاربری

uiCompatibility

enum ( UiCompatibility )

تعیین می کند که آیا PlanStatus می تواند در یک رابط کاربری به کاربر نشان داده شود. وقتی روی UI_INCOMPATIBLE تنظیم شود، PlanStatus می تواند برای ارسال اعلان ها به کاربر استفاده شود، اما برای نمایش اطلاعات طرح به کاربر استفاده نخواهد شد.

notifications[]

enum ( NotificationType )

شامل لیستی از انواع اعلان های ارسال شده توسط GTAF برای کاربر است. GTAF این قسمت را در صورتی که توسط تماس گیرنده پر شده باشد نادیده می گیرد.

planInfoPerClient

object ( PlanInfoPerClient )

اطلاعات طرح داده مربوط به یک مشتری خاص Google.

cpidState

enum ( CpidState )

وضعیت CPID مربوط به وضعیت این طرح.

طرح

جزئیات طرح تلفن همراه کاربر، که بسته خدمات تلفن همراه سطح بالایی است که مشترک خریداری می کند. این طرح می تواند به سادگی «10 گیگابایت داده تلفن همراه برای 30 روز» باشد یا می تواند به عنوان مجموعه ای از مؤلفه ها (که ما از آنها به عنوان ماژول های طرح یاد می کنیم) تعریف شود. به عنوان مثال، ACME plan 199 که به عنوان «داده 2 گیگابایتی، واتساپ نامحدود + ویچت نامحدود و 1 گیگابایت اسپاتیفای» توصیف شده است، شامل سه ماژول طرح است.

نمایندگی 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:23Z" و "2014-10-02T15:01:23.045123456Z" .

planModules[]

object ( PlanModule )

اطلاعات ماژول های طرح تفصیلی (طرح های فرعی).

planState

enum ( PlanState )

وضعیت طرح کاربری به عنوان مثال فعال، غیرفعال و غیره

دسته بندی پلان

انواع دسته بندی طرح ممکن

Enums
PLAN_CATEGORY_UNSPECIFIED نامشخص
PREPAID طرح پیش پرداخت
POSTPAID طرح پس پرداخت.

PlanModule

اطلاعات هر ماژول طرح داده (یا طرح فرعی) در داخل یک طرح.

نمایندگی 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:23Z" و "2014-10-02T15:01:23.045123456Z" .

overUsagePolicy

enum ( OverUsagePolicy )

سیاست استفاده بیش از حد، به عنوان مثال، دریچه گاز.

maxRateKbps

string ( int64 format)

حداکثر سرعت داده مجاز توسط این ماژول طرح در کیلوبیت بر ثانیه. نرخ واقعی داده مشاهده شده بین 0 و maxRateKbps بسته به شرایط شبکه است. حذف maxRateKbps یا تنظیم آن بر روی 0 نشان می‌دهد که قرار نیست برای این ماژول پلان throttling انجام شود.

description

string

ضروری. توضیحات ماژول پلان، ممکن است برای کاربر ظاهر شود و باید به توضیحات بازار این ماژول پلان نزدیک باشد.

moduleName

string

ضروری. نام ماژول پلان

usedBytes

string ( int64 format)

تعداد کل بایت های استفاده شده توسط کاربر از این ماژول طرح.

planModuleState

enum ( PlanState )

وضعیت ماژول طرح به عنوان مثال فعال، غیر فعال و غیره.

refreshPeriod

enum ( RefreshPeriod )

دوره بازخوانی این ماژول طرح، یا REFRESH_PERIOD_NONE اگر ماژول طرح سهمیه خود را بازخوانی نکرد. ماژول‌هایی را برنامه‌ریزی کنید که سهمیه را تازه‌سازی کنند، این کار را یک بار در هر دوره تازه‌سازی انجام می‌دهند.

balance میدان اتحادیه ضروری. اطلاعات موجودی ماژول پلان، باید یکی از موارد زیر باشد: byte_balance، time_balance، coarse_balance_level. balance فقط می تواند یکی از موارد زیر باشد:
byteBalance

object ( ByteQuota )

اطلاعات موجودی ماژول طرح مبتنی بر بایت. برای ماژول هایی که به صورت دوره ای بازخوانی می کنند، این فیلد موجودی بایت در هر دوره تازه سازی را نشان می دهد.

timeBalance

object ( TimeQuota )

اطلاعات تعادل ماژول برنامه مبتنی بر زمان. برای ماژول هایی که به صورت دوره ای بازخوانی می کنند، این فیلد تعادل زمانی در هر دوره تازه سازی را نشان می دهد.

ByteQuota

اطلاعات سهمیه/تعادل ماژول طرح مبتنی بر بایت.

نمایندگی JSON
{
  "quotaBytes": string,
  "remainingBytes": string
}
زمینه های
quotaBytes

string ( int64 format)

سهمیه ماژول در بایت برای طرح های نامحدود، این باید روی 2^63 - 1 (9223372036854775807) تنظیم شود.

remainingBytes

string ( int64 format)

برای اعلان‌های موجودی کم لازم است. باقی مانده سهمیه در بایت.

سهمیه زمانی

اطلاعات سهمیه/موازنه ماژول بر اساس زمان.

نمایندگی 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٪ از موجودی بسته اصلی (یا زمان) است. حاملان ممکن است آستانه دقیق هر بسته را که مناسب بدانند تعیین کنند. تعادل داده ها بالاست.

PlanModuleTrafficCategory

دسته ترافیک ماژول پلان، که مجموعه ای از ترافیک برنامه را توصیف می کند که در یک ماژول طرح خاص قرار می گیرد.

Enums
PLAN_MODULE_TRAFFIC_CATEGORY_UNSPECIFIED نامشخص
GENERIC عمومی، برای همه ترافیک اعمال می شود.
VIDEO تمام ترافیک ویدیویی
VIDEO_BROWSING ترافیک کشف ویدیو (مرور)، که به تمام ترافیک برنامه های ویدیویی به استثنای بخش پخش ویدیو/صوت اشاره دارد.
VIDEO_OFFLINE ترافیک آفلاین ویدیو، که مجموع ترافیک VIDEO_BROWSING و ویدیو/صوت آفلاین (غیر جریانی) است.
MUSIC ترافیک اپلیکیشن های موسیقی
GAMING ترافیک اپلیکیشن های بازی
SOCIAL ترافیک اپلیکیشن های اجتماعی
MESSAGING ترافیک برنامه پیام رسانی
APP_STORE ترافیک فروشگاه برنامه، مانند به‌روزرسانی یا دانلود یک برنامه جدید.

OverUsagePolicy

خط مشی استفاده بیش از حد: وقتی سهمیه کاربر تمام شود چه اتفاقی می افتد.

Enums
OVER_USAGE_POLICY_UNSPECIFIED نامشخص
THROTTLED سرعت کاهش یافته است.
BLOCKED اتصال مسدود شده است.
PAY_AS_YOU_GO پرداخت به ازای استفاده

PlanState

Enum نشان دهنده وضعیت های مختلف ماژول طرح/طرح کاربر.

Enums
ACTIVE Plan/PlanModule فعال است و کاربر می تواند از داده های ارائه شده به عنوان بخشی از ماژول استفاده کند.
INACTIVE ماژول Plan/Plan غیرفعال است و تا زمانی که کاربر هنوز ماژول را دارد، کاربر نمی تواند از داده هایی که بخشی از ماژول است استفاده کند. اگر ماژول فقط در زمان‌های خاصی از روز داده‌ها را ارائه دهد یا اگر کاربر ماژولی را خریداری کرده باشد اما هنوز فعال نشده باشد، ممکن است این اتفاق بیفتد.
EXPIRING_SOON Plan/PlanModule به زودی منقضی می شود. تماس گیرنده باید سطح مناسبی را برای تعیین زمان تنظیم این مقدار انتخاب کند. این به طور خودکار به این معنی است که طرح فعال است.
NEWLY_ACTIVE Plan/PlanModule که قبلاً غیرفعال یا وجود نداشت، به تازگی فعال شده است. این حالت فقط باید برای مدت بسیار کوتاهی پس از زمان فعال سازی استفاده شود، در غیر این صورت باید از حالت ACTIVE به جای آن استفاده شود. اعلان‌های وضعیت طرح داده ارسال شده با ماژول‌های NEWLY_ACTIVE باید با یک TTL کوتاه ارسال شوند، زیرا وضعیت NEWLY_ACTIVE خیلی سریع نادرست می‌شود.
EXPIRED Plan/PlanModule منقضی شده است. تنظیم این مقدار enum یک اعلان منقضی شده طرح را راه‌اندازی می‌کند.

Refresh Period

نشان دهنده یک دوره تازه سازی، فاصله زمانی منظمی است که در آن یک ماژول پلان بازنشانی می شود.

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 time و قسمت accountBalanceStatus، از accountBalanceStatus استفاده می کنیم.

validUntil

string ( Timestamp format)

ضروری. زمانی که مانده حساب اعتبار دارد. این فیلد برای نشان دادن "Invalid in" استفاده خواهد شد

مهر زمانی در قالب RFC3339 UTC "Zulu"، با وضوح نانوثانیه و حداکثر نه رقم کسری. مثال‌ها: "2014-10-02T15:01:23Z" و "2014-10-02T15:01:23.045123456Z" .

payAsYouGoCharge

object ( Money )

مقدار پولی که کاربر با استفاده از طرح در حالت پرداخت هزینه کرده است. اگر هنگام اشتراک‌گذاری اطلاعات حساب با GTAF، این فیلد توسط شرکت مخابراتی پر شود، GTAF سعی می‌کند اعلانی را برای کاربر ارسال کند که نشان می‌دهد در حال خرج کردن پول در حالت پرداخت در حین حرکت است.

accountTopUp

object ( Money )

برای اطلاع رسانی شارژ حساب مورد نیاز است. مقدار پولی که کاربر به موجودی حساب خود اضافه کرده است. اگر این فیلد توسط شرکت مخابراتی هنگام اشتراک‌گذاری اطلاعات حساب با GTAF پر شود، GTAF سعی می‌کند اعلانی را برای کاربر ارسال کند که نشان می‌دهد حسابش شارژ شده است.

پول

مقداری پول را با نوع ارز آن نشان می دهد.

نمایندگی JSON
{
  "currencyCode": string,
  "units": string,
  "nanos": integer
}
زمینه های
currencyCode

string

کد ارز 3 حرفی تعریف شده در ISO 4217.

units

string ( int64 format)

کل واحدهای مقدار. به عنوان مثال، اگر currencyCode "USD" باشد، 1 واحد یک دلار آمریکا است.

nanos

integer

تعداد نانو (10^-9) واحد مقدار. مقدار باید بین -999,999,999 و +999,999,999 باشد. اگر units مثبت باشد، nanos باید مثبت یا صفر باشد. اگر units صفر باشد، nanos می تواند مثبت، صفر یا منفی باشد. اگر units منفی باشد، nanos باید منفی یا صفر باشد. به عنوان مثال 1.75-$ به صورت units =-1 و نانو = nanos نشان داده می شود.

وضعیت موجودی حساب

وضعیت کیف پول کاربر

Enums
VALID موجودی حساب کاربری معتبر است و می توان از آن برای خرید استفاده کرد.
INVALID موجودی حساب کاربری نامعتبر است و بدون ایجاد تغییرات در حساب قابل استفاده نیست.

UiCompatibility

Enum نشان می دهد که آیا PlanStatus در حال اشتراک گذاری می تواند به کاربر نشان داده شود.

Enums
UI_COMPATIBILITY_UNSPECIFIED به طور پیش فرض فرض می کنیم که PlanStatus با رابط کاربری سازگار است.
UI_COMPATIBLE نشان می دهد که کل PlanStatus با UI سازگار است و اطلاعات طرح را می توان به کاربر نشان داد.
UI_INCOMPATIBLE نشان می دهد که PlanStatus با رابط کاربری سازگار نیست. از فیلدها می توان برای ارسال اعلان به کاربر استفاده کرد اما نمی توان از آنها برای نمایش اطلاعات طرح به کاربر استفاده کرد.

نوع اعلان

نوع اعلان ارسال شده به کاربر تنظیمات Mobile Data Plan.

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 اعلانی که به کاربر اطلاع می‌دهد که طرح داده‌اش منقضی شده است.

PlanInfoPerClient

اطلاعات طرح داده مربوط به یک مشتری خاص Google.

نمایندگی JSON
{
  "youtube": {
    object (YouTube)
  },
  "androidSystemInfo": {
    object (AndroidSystemInfo)
  }
}
زمینه های
youtube

object ( YouTube )

اطلاعات طرح مربوط به YouTube.

androidSystemInfo

object ( AndroidSystemInfo )

اطلاعات برنامه مربوط به سیستم Android.

یوتیوب

اطلاعات طرح داده مربوط به YouTube.

نمایندگی JSON
{
  "rateLimitedStreaming": {
    object (RateLimitedStreaming)
  }
}
زمینه های
rateLimitedStreaming

object ( RateLimitedStreaming )

ویژگی YouTube Plan Aware Streaming (PAS) که نرخ بیت ارسالی ویدیو را محدود می‌کند.

RateLimitedStreaming

اطلاعات طرح داده برای فعال کردن YouTube برای بهبود تجربه کاربر پخش با نرخ محدود.

نمایندگی JSON
{
  "maxMediaRateKbps": integer
}
زمینه های
maxMediaRateKbps

integer

نرخ بیت YouTube برای این کاربر در کیلوبیت بر ثانیه (1000 بیت در ثانیه) پشتیبانی می شود.

Android SystemInfo

اطلاعات طرح داده مربوط به کل سیستم اندروید.

نمایندگی JSON
{
  "cellularInfo": [
    {
      object (CellularInfo)
    }
  ]
}
زمینه های
cellularInfo[]

object ( CellularInfo )

اطلاعات سلولی در هر نوع اتصال. به عنوان مثال، یک پیام cellularInfo برای هر نوع اتصال مانند 4G، 5G و غیره وجود خواهد داشت.

CellularInfo

اطلاعاتی در مورد اتصال سلولی که این طرح به کاربر ارائه می دهد.

نمایندگی JSON
{
  "connectionType": enum (ConnectionType),
  "meteredness": enum (Meteredness)
}
زمینه های
connectionType

enum ( ConnectionType )

نوع اتصالی که اپراتور به کاربر ارائه می دهد.

meteredness

enum ( Meteredness )

وضعیت اندازه گیری طرح کاربری.

نوع اتصال

نوع اتصال: 2G، 3G، 4G

Enums
CONNECTION_TYPE_UNSPECIFIED نامشخص
CONNECTION_2_G 2G.
CONNECTION_3_G 3G.
CONNECTION_4_G 4G.
CONNECTION_5_G 5G
CONNECTION_ALL همه انواع.

اندازه گیری

نوع طرحی که کاربر دارد

Enums
METEREDNESS_UNSPECIFIED GTAF از وضعیت اندازه‌گیری طرح کاربری اطلاعی ندارد.
METEREDNESS_UNMETERED کاربر در یک طرح بدون اندازه گیری قرار دارد.
METEREDNESS_METERED کاربر در یک طرح اندازه گیری شده است.

CpidState

یک عدد برای حامل برای نشان دادن وضعیت CPID.

Enums
CPID_STATE_UNSPECIFIED وضعیت CPID نامشخص است. به این صورت رفتار می شود که گویی CPID معتبر است.
CPID_INVALIDATED CPID نامعتبر است و مشتری باید یک CPID جدید از نقطه پایانی CPID واکشی کند.

مواد و روش ها

create

 به یک اپراتور تلفن همراه (که با شماره سیستم مستقل خود (ASN) مشخص می شود) اجازه می دهد تا ورودی PlanStatus جدیدی را برای کاربر اضافه کند تا توسط یک کلاینت خاص استفاده شود.