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)

مطلوب. الوقت الذي تصبح فيه معلومات مجموعة الخطة المشترَكة قديمة لن يتم عرض PlanStatus للتطبيقات بعد هذا الوقت.

يجب أن يكون طابعًا زمنيًا بالتنسيق RFC3339 UTC "Zulu"‎ وبدقّة تصل إلى نانوثانية. مثال: "2014-10-02T15:01:23.045123456Z"
updateTime

string (Timestamp format)

مطلوب. الوقت الذي استرد فيه وكيل خطة البيانات معلومات حالة الخطة من الأنظمة الخلفية. يمكن استخدامها لتحديد مدى حداثة معلومات حالة الخطة.

يجب أن يكون طابعًا زمنيًا بالتنسيق RFC3339 UTC "Zulu"‎ وبدقّة تصل إلى نانوثانية. مثال: "2014-10-02T15:01:23.045123456Z"
title

string

عنوان العقد الذي أبرمه المستخدم مع مشغّل الشبكة سيظهر ذلك في عنوان واجهة المستخدم.

subscriberId

string

معرّف ثابت وفريد في نظام مشغّل شبكة الجوّال لتحديد هوية المستخدم.

accountInfo

object (AccountInfo)

مطلوب للمستخدمين الذين يدفعون مسبقًا. معلومات حول رصيد حساب المستخدم

uiCompatibility

enum (UiCompatibility)

تحدِّد هذه السمة ما إذا كان يمكن عرض PlanStatus للمستخدم في واجهة مستخدم. عند ضبطها على UI_INCOMPATIBLE، يمكن استخدام PlanStatus لإرسال إشعارات إلى المستخدم، ولكن لن يتم استخدامها لعرض معلومات الخطة للمستخدم.

notifications[]

enum (NotificationType)

أنواع الإشعارات التي تم إرسالها إلى المستخدم

planInfoPerClient

object (PlanInfoPerClient)

الخطة

تفاصيل خطة الجوّال الخاصة بالمستخدم، وهي حزمة خدمة الجوّال الأعلى مستوى التي يشتريها المشترك. يمكن أن تكون الخطة بسيطة، مثل "10 غيغابايت من بيانات الجوّال لمدة 30 يومًا"، أو يمكن تعريفها على أنّها مجموعة من المكوّنات (التي نشير إليها باسم وحدات الخطة). على سبيل المثال، تحتوي الخطة 199 من ACME، الموصوفة بأنّها "2 غيغابايت من البيانات، وWhatsApp وWeChat غير محدودان، و1 غيغابايت من Spotify"، على ثلاث وحدات خطة.

تمثيل 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)

حالة خطة المستخدم، مثل نشطة أو غير نشطة وما إلى ذلك

PlanCategory

أنواع فئات الخطط المحتملة

عمليات التعداد
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:23.045123456Z"
overUsagePolicy

enum (OverUsagePolicy)

سياسة الاستخدام المفرط، مثل الحدّ من السرعة

maxRateKbps

string (int64 format)

تمثّل هذه السمة الحد الأقصى لمعدّل البيانات المسموح به في وحدة خطة البيانات هذه بالكيلوبت في الثانية. يتراوح معدّل البيانات الفعلي الذي يتم رصده بين 0 وmaxRateKbps استنادًا إلى ظروف الشبكة. يشير حذف maxRateKbps أو ضبطه على 0 إلى أنّه لن يتم تطبيق أي تقييد على وحدة الخطة هذه.

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)

مطلوب لتلقّي إشعارات بشأن انخفاض الرصيد رصيد الحصة المتبقية بالبايت

TimeQuota

معلومات حصة/رصيد وحدة الخطة المستندة إلى الوقت

تمثيل JSON 
{
  "quotaMinutes": string,
  "remainingMinutes": string
}
الحقول
quotaMinutes

string (int64 format)

حصة الوحدة بالدقائق للخطة المستندة إلى الوقت، مثلاً ‫180 دقيقة

remainingMinutes

string (int64 format)

رصيد الحصة المتبقية بالدقائق للخطة المستندة إلى الوقت، مثل ‫40 دقيقة

BalanceLevel

معلومات غير دقيقة عن رصيد بيانات وحدة الخطة

عمليات التعداد
BALANCE_LEVEL_UNSPECIFIED غير محدد
NO_PLAN ما مِن خطة بيانات
OUT_OF_DATA رصيد البيانات هو صفر.
LOW_QUOTA أن يكون رصيد البيانات (أو الوقت المتبقي) مساويًا أو أقل من %10 إلى %25 من رصيد الحزمة الأصلي (أو الوقت). يجوز لشركات النقل تحديد الحدّ الدقيق لكل حزمة على النحو الذي تراه مناسبًا.
HIGH_QUOTA أن يكون رصيد البيانات (أو الوقت المتبقي) أكثر من %10 إلى %25 من رصيد الحزمة الأصلية (أو الوقت). يجوز لشركات النقل تحديد الحدّ الدقيق لكل حزمة على النحو الذي تراه مناسبًا. رصيد البيانات مرتفع.

PlanModuleTrafficCategory

فئة زيارات وحدة الخطة، والتي تصف مجموعة زيارات التطبيق التي تندرج ضمن وحدة خطة معيّنة.

عمليات التعداد
PLAN_MODULE_TRAFFIC_CATEGORY_UNSPECIFIED غير محدد
GENERIC عام، وينطبق على جميع الزيارات
VIDEO جميع زيارات الفيديو
VIDEO_BROWSING زيارات استكشاف الفيديو (التصفّح)، وتشير إلى جميع زيارات تطبيق الفيديو باستثناء جزء بث الفيديو/الصوت
VIDEO_OFFLINE الزيارات غير الإلكترونية للفيديوهات، وهي مجموع VIDEO_BROWSING والزيارات غير الإلكترونية للفيديوهات/الملفات الصوتية (غير البث المباشر)
MUSIC عدد زيارات تطبيق الموسيقى
GAMING عدد زيارات تطبيقات الألعاب
SOCIAL عدد الزيارات الواردة من التطبيقات الاجتماعية
MESSAGING حركة تبادل الرسائل في تطبيق المراسلة
APP_STORE حركة بيانات متجر التطبيقات، مثل تحديث تطبيق أو تنزيل تطبيق جديد

OverUsagePolicy

سياسة الاستخدام الزائد: ماذا يحدث عندما تنتهي حصة المستخدم؟

عمليات التعداد
OVER_USAGE_POLICY_UNSPECIFIED غير محدد
THROTTLED تم تقييد السرعة.
BLOCKED تم حظر الاتصال.
PAY_AS_YOU_GO الدفع مقابل الاستخدام

PlanState

تعداد يمثّل حالات مختلفة لخطة المستخدم أو وحدة الخطة.

عمليات التعداد
ACTIVE الخطة/وحدة الخطة نشطة ويمكن للمستخدم استخدام البيانات المقدَّمة كجزء من الوحدة.
INACTIVE الخطة/وحدة الخطة غير نشطة، وعلى الرغم من أنّ المستخدم لا يزال لديه الوحدة، لا يمكنه استخدام البيانات التي تشكّل جزءًا من الوحدة. قد يحدث ذلك إذا كانت الوحدة النمطية لا تقدّم البيانات إلا خلال أوقات معيّنة من اليوم أو إذا اشترى المستخدم وحدة نمطية ولكن لم يتم تفعيلها بعد.
EXPIRING_SOON ستنتهي صلاحية الخطة/وحدة الخطة قريبًا. على المتصل اختيار المستوى المناسب لتحديد وقت ضبط هذه القيمة. وهذا يعني تلقائيًا أنّ الخطة نشطة.
NEWLY_ACTIVE تمّ للتوّ تفعيل خطة أو وحدة خطة كانت غير نشطة أو غير متوفّرة سابقًا. يجب استخدام هذه الحالة لفترة قصيرة جدًا بعد وقت التفعيل، وإلا يجب استخدام الحالة ACTIVE بدلاً من ذلك. يجب إرسال إشعارات حالة خطة البيانات التي يتم إرسالها مع وحدات NEWLY_ACTIVE مع فترة TTL قصيرة، لأنّ حالة NEWLY_ACTIVE ستصبح غير دقيقة بسرعة كبيرة.
EXPIRED انتهت صلاحية الخطة أو PlanModule. يؤدي ضبط قيمة التعداد هذه إلى إرسال إشعار بانتهاء صلاحية الخطة.

RefreshPeriod

تمثّل هذه السمة فترة إعادة تحميل، وهي الفترة المنتظمة التي تتم فيها إعادة ضبط وحدة الخطة.

عمليات التعداد
REFRESH_PERIOD_NONE ما مِن فترة إعادة تحميل. يُستخدَم عندما لا تتكرّر وحدة الخطة.
DAILY تتم إعادة ضبط وحدة الخطة كل يوم.
MONTHLY تتم إعادة ضبط وحدة الخطة كل شهر.
BIWEEKLY تتم إعادة ضبط وحدة الخطة كل أسبوعَين.
WEEKLY تتم إعادة ضبط وحدة الخطة كل أسبوع.

AccountInfo

معلومات حول رصيد حساب المستخدم المدفوع مسبقًا

تمثيل 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)

مطلوبة إذا كانت منطبقة. رصيد الحساب المتبقي في حساب المستخدم الذي تمت إضافته من خلال قرض مالي من شركة الاتصالات في حال توفّره، لا يتضمّن الحقل accountBalance هذا الرصيد.

unpaidLoan

object (Money)

تمثّل هذه السمة مبلغ المال المستحق على المستخدم لشركة الاتصالات بسبب القروض النقدية.

accountBalanceStatus

enum (AccountBalanceStatus)

مطلوب. تشير إلى حالة رصيد الحساب. في حال عدم تطابق الوقت validUntil مع الحقل accountBalanceStatus، نستخدم accountBalanceStatus.

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.

AccountBalanceStatus

حالة محفظة المستخدم

عمليات التعداد
VALID رصيد حساب المستخدم صالح ويمكن استخدامه لإجراء عمليات شراء.
INVALID رصيد حساب المستخدم غير صالح ولا يمكن استخدامه بدون إجراء تغييرات على الحساب.

UiCompatibility

تعداد يمثّل ما إذا كان يمكن عرض PlanStatus الذي تتم مشاركته للمستخدم.

عمليات التعداد
UI_COMPATIBILITY_UNSPECIFIED سنفترض تلقائيًا أنّ PlanStatus متوافق مع واجهة المستخدم.
UI_COMPATIBLE تشير إلى أنّ حالة الخطة بأكملها متوافقة مع واجهة المستخدم ويمكن عرض معلومات الخطة للمستخدم.
UI_INCOMPATIBLE يشير إلى أنّ PlanStatus غير متوافق مع واجهة المستخدم. يمكن استخدام الحقول لإرسال إشعارات إلى المستخدم، ولكن لا يمكن استخدامها لعرض معلومات الخطة للمستخدم.

NotificationType

نوع الإشعار الذي يتم إرساله إلى مستخدم إعدادات "خطة بيانات الجوّال"

عمليات التعداد
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

object (YouTube)

معلومات عن الخطط ذات الصلة في YouTube

YouTube

معلومات حول خطة البيانات ذات الصلة بـ YouTube

تمثيل JSON 
{
  "rateLimitedStreaming": {
    object (RateLimitedStreaming)
  }
}
الحقول
rateLimitedStreaming

object (RateLimitedStreaming)

ميزة "البث المتكيّف حسب الخطة" (PAS) في YouTube التي تحدّ من معدل نقل بيانات الفيديو الذي يتم عرضه

RateLimitedStreaming

معلومات عن خطة البيانات تتيح لـ YouTube تحسين تجربة المستخدمين الذين يواجهون قيودًا على سرعة البث

تمثيل JSON 
{
  "maxMediaRateKbps": number
}
الحقول
maxMediaRateKbps

number

معدّل نقل البيانات المتوافق مع YouTube لهذا المستخدم بالكيلوبت في الثانية (آلاف البتات في الثانية)

الطُرق

create

 تتيح لمشغّل شبكة جوّالة (يتم تحديده من خلال رقم النظام المستقل (ASN) الفريد) إضافة إدخال PlanStatus جديد لمستخدم معيّن ليستخدمه عميل معيّن.