REST Resource: operators.clients.users.planStatus

Kaynak: PlanStatus

Plan Durumu, bir kullanıcının satın aldığı tüm üst düzey mobil hizmet paketinin ayrıntılarını içerir.

JSON gösterimi 
{
  "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)
  }
}
Alanlar
name

string

PlanDurumu'nun şu biçimdeki kaynak adı: operators/{asn_id}/planStatuses/{userKey}. PlanStatus girişi oluşturulurken ad yok sayılır.

plans[]

object (Plan)

Bu kullanıcının sahip olduğu planların listesi.

languageCode

string

Zorunlu. BCP-47 dil kodu (ör. &en; ABD-veya “sr-Latn”) Daha fazla bilgi için http://www.unicode.org/reports/tr35/#Unicode_locale_identifier adresine bakın.

expireTime

string (Timestamp format)

Zorunlu. Paylaşılan plan grubu bilgilerinin güncelliğini yitirme zamanı. Plan Durumu, bu tarihten sonra uygulamalara sunulmaz.

RFC3339 UTC "Zulu" biçiminde bir zaman damgası (nanosaniyeye kadar doğru). Örnek: "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Zorunlu. Veri planı aracısının (DPA), plan durumu bilgilerini arka uç sistemlerinden aldığı zaman. Plan durumu bilgilerinin ne kadar güncel olduğunu belirlemek için kullanılabilir.

RFC3339 UTC "Zulu" biçiminde bir zaman damgası (nanosaniyeye kadar doğru). Örnek: "2014-10-02T15:01:23.045123456Z".
title

string

Kullanıcının operatörle yaptığı sözleşmenin başlığı. Bu, kullanıcı arayüzü başlığında gösterilir.

subscriberId

string

Kullanıcıyı tanımlamak için operatör sisteminde bulunan benzersiz kararlı tanımlayıcı.

accountInfo

object (AccountInfo)

Ön ödemeli kullanıcılar için gereklidir. Kullanıcı hesabı bakiyesiyle ilgili bilgiler.

uiCompatibility

enum (UiCompatibility)

PlanStatus'un kullanıcıya kullanıcı arayüzünde gösterilip gösterilmeyeceğini belirler. Plan_UI.UI_INCOMPATIBLE olarak ayarlandığında, kullanıcıya bildirim göndermek için PlanDurumu'nu kullanabilir ancak plan bilgilerini kullanıcıya göstermek için kullanılmaz.

notifications[]

enum (NotificationType)

Kullanıcıya gönderilen bildirimlerin türleri.

planInfoPerClient

object (PlanInfoPerClient)

Planlama

Kullanıcının satın aldığı en üst düzey mobil hizmet paketi olan kullanıcının mobil planının ayrıntıları. Plan, 30 gün için "10 GB mobil veri" kadar basit olabileceği gibi bileşen koleksiyonu olarak da (plan modülleri olarak adlandırılır) tanımlanabilir. Örneğin, 2 GB'lık veri, sınırsız WhatsApp + sınırsız Wechat ve 1 GB spotify" olarak tanımlanan ACME planı 199, üç plan modülünü içerir.

JSON gösterimi 
{
  "planName": string,
  "planId": string,
  "planCategory": enum (PlanCategory),
  "expirationTime": string,
  "planModules": [
    {
      object (PlanModule)
    }
  ],
  "planState": enum (PlanState)
}
Alanlar
planName

string

Kullanıcının mobil planının adı.

planId

string

Zorunlu. Fırsatlar sırasında planı belirtmek için kullanılan plan tanımlayıcısı.

planCategory

enum (PlanCategory)

Ön ödemeli veya faturalı plan.

expirationTime

string (Timestamp format)

Zorunlu. Bu planın süresi dolduğunda. Çoğu plan için bu, tüm plan modülüne özel tüm geçerlilik bitiş tarihlerine eşit olmalıdır. Modül kotasını düzenli olarak yenileyen planlar için planın sona erme zamanı (plan modüllerinin yenilenmeyi durdurduğu zaman) olmalıdır. Planın süresi dolmuyorsa bu alan atlanmalıdır.

RFC3339 UTC "Zulu" biçiminde bir zaman damgası (nanosaniyeye kadar doğru). Örnek: "2014-10-02T15:01:23.045123456Z".
planModules[]

object (PlanModule)

Ayrıntılı plan modülleri (alt planlar) bilgileri.

planState

enum (PlanState)

Kullanıcı planının durumu (ör. etkin, etkin değil vb.)

PlanKategori

Olası plan kategorisi türleri.

Sıralamalar
PLAN_CATEGORY_UNSPECIFIED Belirtilmedi.
PREPAID Ön ödemeli plan.
POSTPAID Sonradan ödemeli plan.

PlanModülü

Bir plan içindeki her veri planı modülü (veya alt planı) hakkında bilgi.

JSON gösterimi 
{
  "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.
}
Alanlar
coarseBalanceLevel

enum (BalanceLevel)

Kaba bakiye bilgileri.

trafficCategories[]

enum (PlanModuleTrafficCategory)

Bu plan modülü için ücret alınacak trafik kategorilerinin listesi.

expirationTime

string (Timestamp format)

Zorunlu. Plan modülünün son kullanma tarihi. Düzenli olarak yenilenen kotaya sahip plan modüllerinde bir sonraki modül yenileme zamanıdır. Planın süresi dolmuyorsa bu alan atlanmalıdır.

RFC3339 UTC "Zulu" biçiminde bir zaman damgası (nanosaniyeye kadar doğru). Örnek: "2014-10-02T15:01:23.045123456Z".
overUsagePolicy

enum (OverUsagePolicy)

Kullanım politikası aşıldı (ör. kısıtlanmış).

maxRateKbps

string (int64 format)

Bu plan modülünün izin verdiği maksimum veri hızı Kb/sn.dir. Gözlemlenen gerçek veri hızı, ağ koşullarına bağlı olarak 0 ile maxRateKb/sn arasındadır. maxRateKbps değerini atlamak veya 0 olarak ayarlamak, bu plan modülü için hiçbir kısıtlama uygulanmayacağını gösterir.

description

string

Zorunlu. Plan modülü açıklaması, kullanıcıya gösterilebilir ve bu plan modülünün pazar açıklamasına yakın olmalıdır.

moduleName

string

Zorunlu. Plan modülünün adı.

usedBytes

string (int64 format)

Bu plan modülünde kullanıcı tarafından kullanılan toplam bayt sayısı.

planModuleState

enum (PlanState)

Plan modülünün durumu (ör. etkin, etkin değil vb.)

refreshPeriod

enum (RefreshPeriod)

Bu plan modülünün yenileme dönemi veya plan modülü kotasını yenilemediyse REFRESH_PERIOD_NONE. Kotanın yenilendiği plan modülleri, her yenileme döneminde bunu yapar.

Birlik alanı balance. Zorunlu. Plan modülü bakiye bilgileri şunlardan biri olmalıdır: bayt_balansı, zaman_Bakiyesi, genel_düzey_seviyesi. balance aşağıdakilerden yalnızca biri olabilir:
byteBalance

object (ByteQuota)

Bayt tabanlı plan modülü bakiye bilgileri. Bu alan, düzenli olarak yenilenen modüller için yenileme dönemi başına bayt bakiyesini temsil eder.

timeBalance

object (TimeQuota)

Zamana dayalı plan modülü bakiye bilgileri. Bu alan, düzenli olarak yenilenen modüller için yenileme dönemi başına zaman bakiyesini temsil eder.

Bayt Kotası

Bayt tabanlı plan modülü kota/denge bilgileri.

JSON gösterimi 
{
  "quotaBytes": string,
  "remainingBytes": string
}
Alanlar
quotaBytes

string (int64 format)

Bayt cinsinden modül kotası. Sınırsız planlarda bu, 2^63 - 1 (9223372036854775807) olarak ayarlanmalıdır.

remainingBytes

string (int64 format)

Düşük bakiye bildirimleri için gereklidir. Bayt olarak kalan kota bakiyesi.

Zaman Kotası

Zamana dayalı plan modülü kota/denge bilgileri.

JSON gösterimi 
{
  "quotaMinutes": string,
  "remainingMinutes": string
}
Alanlar
quotaMinutes

string (int64 format)

Zamana dayalı plan için dakika cinsinden modül kotası, ör. 180 dakika.

remainingMinutes

string (int64 format)

Zamana dayalı plan için dakika cinsinden kalan kota bakiyesi (ör. 40 dakika.

Denge Düzeyi

Genel plan modülü veri bakiyesi bilgileri.

Sıralamalar
BALANCE_LEVEL_UNSPECIFIED Belirtilmedi.
NO_PLAN Veri planı yok.
OUT_OF_DATA Veri bakiyesi sıfır.
LOW_QUOTA Veri bakiyesi (veya kalan süre) orijinal paket bakiyesinin (veya sürenin) %10-25'ine eşit ya da daha az. Kargo şirketleri, uygun gördükleri şekilde her paketin tam eşiğini belirleyebilir.
HIGH_QUOTA Veri bakiyesi (veya kalan süre), orijinal paket bakiyesinin (veya süresinin) %10-25'inden fazla. Kargo şirketleri, uygun gördükleri şekilde her paketin tam eşiğini belirleyebilir. Veri bakiyesi yüksek.

PlanModülTrafikKategorisi

Belirli bir plan modülüne denk gelen uygulama trafiği grubunu tanımlayan plan modülü trafik kategorisi.

Sıralamalar
PLAN_MODULE_TRAFFIC_CATEGORY_UNSPECIFIED Belirtilmedi.
GENERIC Genel, tüm trafik için geçerlidir.
VIDEO Tüm video trafiği.
VIDEO_BROWSING Video keşfi (tarama) trafiği. Bu, video/ses akışı kısmı hariç tüm video uygulaması trafiği anlamına gelir.
VIDEO_OFFLINE Video çevrimdışı trafiği; VIDEO_BROWSING çevrimdışı videonun ve sesin (yayın dışı) trafiği toplamı.
MUSIC Müzik uygulaması trafiği.
GAMING Oyun uygulaması trafiği.
SOCIAL Sosyal uygulama trafiği.
MESSAGING Mesajlaşma uygulaması trafiği.
APP_STORE Uygulama mağazası trafiği (ör. yeni bir uygulamanın güncellenmesi veya indirilmesi).

Fazla Kullanım Politikası

Kullanım politikası: Kullanıcı kotayı aştığında ne olur?

Sıralamalar
OVER_USAGE_POLICY_UNSPECIFIED Belirtilmedi.
THROTTLED Hız kısıtlanır.
BLOCKED Bağlantı engellendi.
PAY_AS_YOU_GO Kullanım başına ödeme.

PlanDurumu

Kullanıcının plan/plan modülünün farklı durumunu gösteren enum.

Sıralamalar
ACTIVE Plan/PlanModül etkin ve kullanıcı, modül kapsamında sunulan verileri kullanabilir.
INACTIVE Plan/Plan Modülü etkin değildir ve kullanıcı, modüle sahip olduğu halde modülün parçası olan verileri kullanamaz. Modül yalnızca günün belirli saatlerinde veri sunuyorsa veya kullanıcı bir modül satın aldıysa ancak henüz etkinleştirilmediyse bu durum gerçekleşebilir.
EXPIRING_SOON Plan/PlanModül yakında sona erecek. Arayan, bu değerin ne zaman ayarlanacağını belirlemek için uygun düzeyi seçmelidir. Bu, otomatik olarak planınızın etkin olduğu anlamına gelir.
NEWLY_ACTIVE Önceden etkin olmayan veya mevcut olmayan Plan/PlanModül az önce etkinleştirildi. Bu durum, etkinleştirme tarihinden sonra çok kısa bir süre boyunca kullanılmalıdır; aksi takdirde ETKİN durum kullanılmalıdır. NEWLY_ACTIVE durumu çok kısa sürede yanlış olacağı için, NEWLY_ACTIVE modülleriyle gönderilen veri planı durum bildirimleri, kısa bir TTL ile gönderilmelidir.
EXPIRED Plan/PlanModül'ün geçerlilik süresi doldu. Bu sıralama değerini ayarlamak, planın süresi dolmuş bir bildirimi tetikler.

Yenileme Süresi

Bir plan modülünün sıfırlandığı normal aralık olan yenileme dönemini temsil eder.

Sıralamalar
REFRESH_PERIOD_NONE Yenileme dönemi yok. Plan modülü yinelenmediğinde kullanılır.
DAILY Plan modülü her gün sıfırlanır.
MONTHLY Plan modülü her ay sıfırlanır.
BIWEEKLY Plan modülü iki haftada bir sıfırlanır.
WEEKLY Plan modülü her hafta sıfırlanır.

Hesap Bilgileri

Ön ödemeli kullanıcının hesap bakiyesiyle ilgili bilgiler.

JSON gösterimi 
{
  "accountBalance": {
    object (Money)
  },
  "loanBalance": {
    object (Money)
  },
  "unpaidLoan": {
    object (Money)
  },
  "accountBalanceStatus": enum (AccountBalanceStatus),
  "validUntil": string,
  "payAsYouGoCharge": {
    object (Money)
  },
  "accountTopUp": {
    object (Money)
  }
}
Alanlar
accountBalance

object (Money)

Zorunlu. Kullanıcı hesabında kalan hesap bakiyesi.

loanBalance

object (Money)

Geçerliyse zorunludur. Operatör tarafından parasal kredi ile eklenen kullanıcı hesabında kalan hesap bakiyesi. Varsa accountBalance alanı bu bakiyeyi içermez.

unpaidLoan

object (Money)

Kullanıcının parasal kredi nedeniyle operatöre borçlu olduğu para tutarı.

accountBalanceStatus

enum (AccountBalanceStatus)

Zorunlu. Hesap bakiyesinin durumunu belirtir. validUntil time ve accountBalanceStatus alanı arasında uyuşmazlık olması durumunda accountBalanceStatus kullanılır.

validUntil

string (Timestamp format)

Zorunlu. Hesap bakiyesinin geçerli olduğu süredir. Bu alan, kullanıcının hesap bakiyesinde

RFC3339 UTC "Zulu" biçiminde bir zaman damgası (nanosaniyeye kadar doğru). Örnek: "2014-10-02T15:01:23.045123456Z".
payAsYouGoCharge

object (Money)

Kullandıkça öde durumunda planı kullanarak kullanıcının harcadığı para tutarı. Bu alan, hesap bilgileri GTAF ile paylaşılırken operatör tarafından doldurulursa GTAF, kullanıcıya kullandıkça öde durumunda para harcadığını belirten bir bildirim göndermeyi dener.

accountTopUp

object (Money)

Hesap ekleme bildirimi için zorunludur. Kullanıcının hesap bakiyesine eklediği para tutarı. Bu alan, hesap bilgileri GTAF ile paylaşılırken operatör tarafından doldurulursa GTAF, kullanıcıya hesabına para eklendiğini belirten bir bildirim göndermeyi dener.

Money

Para birimi türüyle para tutarını temsil eder.

JSON gösterimi 
{
  "currencyCode": string,
  "units": string,
  "nanos": number
}
Alanlar
currencyCode

string

ISO 4217'de tanımlanan 3 harfli para birimi kodu.

units

string (int64 format)

Tutarın tümü. Örneğin currencyCode, "USD" ise 1 birim 1 ABD dolarıdır.

nanos

number

Miktarın nano (10^-9) birimlerinin sayısı. Değer, -999.999.999 ile +999.999.999 (dahil) arasında olmalıdır. units pozitifse nanos pozitif veya sıfır olmalıdır. units sıfır ise nanos pozitif, sıfır veya negatif olabilir. units negatifse nanos negatif veya sıfır olmalıdır. Örneğin $-1,75,units=-1 ve nanos=-750.000.000 olarak gösterilir.

Hesap Bakiyesi Durumu

Kullanıcı cüzdanının durumu.

Sıralamalar
VALID Kullanıcı hesabı bakiyesi geçerlidir ve satın alma işlemi yapmak için kullanılabilir.
INVALID Kullanıcı hesabı bakiyesi geçersiz ve hesapta değişiklik yapılmadan kullanılamaz.

Kullanıcı Uyumluluğu

Paylaşılan PlanDurumu'nun kullanıcıya gösterilip gösterilemeyeceğini ifade eden enum.

Sıralamalar
UI_COMPATIBILITY_UNSPECIFIED Varsayılan olarak, PlanStat'ın kullanıcı arayüzüyle uyumlu olduğu varsayılır.
UI_COMPATIBLE Tüm PlanStat'ın kullanıcı arayüzüyle uyumlu olduğunu ve plan bilgilerinin kullanıcıya gösterilebileceğini belirtir.
UI_INCOMPATIBLE PlanStatus'un kullanıcı arayüzüyle uyumlu olmadığını gösterir. Alanlar, kullanıcıya bildirim göndermek için kullanılabilir ancak kullanıcıya plan bilgilerini göstermek için kullanılamaz.

BildirimTürü

Mobil Veri Planı ayarlarının kullanıcısına gönderilen bildirimin türü.

Sıralamalar
NOTIFICATION_UNDEFINED Bilinmeyen bildirim türü türü
NOTIFICATION_LOW_BALANCE_WARNING Kullanıcıları düşük bakiye konusunda uyaran bildirim
NOTIFICATION_DATA_EXPIRATION_WARNING Kullanıcıları veri planının süresinin dolacağı konusunda uyaran bildirim
NOTIFICATION_OUT_OF_DATA Kullanıcıların verilerinin bittiğine dair bildirim
NOTIFICATION_PLAN_ACTIVATION Bir kullanıcının satın aldığı planın artık etkin olduğuna dair bildirim
NOTIFICATION_PAY_AS_YOU_GO Kullandıkça öde durumundaki kullanıcılar için veri için ödeme yaptıklarını bildiren bildirim.
NOTIFICATION_ACCOUNT_TOP_UP Kullanıcıya hesap bakiyesine para eklediğine dair bir bildirim.
NOTIFICATION_DATA_EXPIRED Kullanıcıya veri planının süresinin dolduğunu belirten bir bildirim.

Plan Bilgisi İstemci Başına

Belirli bir Google istemcisiyle ilgili veri planı bilgileri.

JSON gösterimi 
{
  "youtube": {
    object (YouTube)
  }
}
Alanlar
youtube

object (YouTube)

YouTube ilgili plan bilgileri.

YouTube

YouTube ile ilgili veri planı bilgileri.

JSON gösterimi 
{
  "rateLimitedStreaming": {
    object (RateLimitedStreaming)
  }
}
Alanlar
rateLimitedStreaming

object (RateLimitedStreaming)

Sunulan videonun bit hızını sınırlayan YouTube Planına Duyarlı Akış (PAS) özelliği.

Oran Sınırlı Akış

YouTube'un sınırlı hızda akış kullanıcı deneyimini iyileştirmesini sağlayan veri planı bilgileri.

JSON gösterimi 
{
  "maxMediaRateKbps": number
}
Alanlar
maxMediaRateKbps

number

Bu kullanıcı için kb/sn (YouTube'da 1000'sn) desteklenen YouTube bit hızı.

Yöntemler

create

 Mobil operatörün (benzersiz Otonom Sistem Numarası (ASN) ile tanımlanır), belirli bir istemci tarafından kullanılacak bir kullanıcı için yeni PlanStatus girişi eklemesine izin verir.