REST Resource: monetization.subscriptions

Kaynak: Abonelik

Bir uygulama için tek bir abonelik.

JSON gösterimi 
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  },
  "restrictedPaymentCountries": {
    object (RestrictedPaymentCountries)
  }
}
Alanlar
packageName

string

Değişmez. Üst uygulamanın paket adı.
productId

string

Değişmez. Ürünün benzersiz ürün kimliği. Ana uygulama içinde benzersiz olmalıdır. Ürün kimlikleri küçük harfler (a-z), rakamlar (0-9), alt çizgiler (_) ve noktalardan (.) oluşmalıdır. Küçük harf veya rakamla başlamalı ve 1 ile 40 karakter (dahil) arasında olmalıdır.
basePlans[]

object (BasePlan)

Bu abonelik için temel plan grubu. Başka teklifler geçerli değilse aboneliğin fiyatını ve süresini gösterir.
listings[]

object (SubscriptionListing)

Zorunlu. Bu aboneliğin yerelleştirilmiş listelemelerinin listesi. En azından üst uygulamanın varsayılan dili için bir giriş içermelidir.
archived
(deprecated)

boolean

Yalnızca çıkış. Desteği sonlandırıldı: Abonelik arşivleme desteklenmez.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Vergiler ve yasal uygunluk hakkında ayrıntılı bilgi
restrictedPaymentCountries

object (RestrictedPaymentCountries)

İsteğe bağlı. Bu aboneliğin satın alınmasının, ilgili ülkede kayıtlı ödeme yöntemleriyle kısıtlandığı ülkeler. Boşsa ödeme konumu kısıtlaması uygulanmaz.

BasePlan

Abonelik için tek bir temel plan.

JSON gösterimi 
{
  "basePlanId": string,
  "state": enum (State),
  "regionalConfigs": [
    {
      object (RegionalBasePlanConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsBasePlanConfig)
  },

  // Union field base_plan_type can be only one of the following:
  "autoRenewingBasePlanType": {
    object (AutoRenewingBasePlanType)
  },
  "prepaidBasePlanType": {
    object (PrepaidBasePlanType)
  },
  "installmentsBasePlanType": {
    object (InstallmentsBasePlanType)
  }
  // End of list of possible types for union field base_plan_type.
}
Alanlar
basePlanId

string

Zorunlu. Değişmez. Bu temel planın benzersiz tanımlayıcısıdır. Abonelik içinde benzersiz olmalıdır ve RFC-1034'e uygun olmalıdır. Yani bu kimlik yalnızca küçük harf (a-z), rakam (0-9) ve kısa çizgi (-) içerebilir ve en fazla 63 karakter uzunluğunda olabilir.
state

enum (State)

Yalnızca çıkış. Temel planın durumu (ör. etkin olup olmadığı). Taslak ve etkin olmayan temel planlar etkinleştirilebilir veya silinebilir. Etkin temel planlar devre dışı bırakılabilir. Etkin olmayan temel planlar iptal edilebilir. Bu alan, kaynak güncellenerek değiştirilemez. Bunun yerine özel uç noktaları kullanın.
regionalConfigs[]

object (RegionalBasePlanConfig)

Bu temel plan için bölgeye özgü bilgiler.
offerTags[]

object (OfferTag)

Bu temel plan için belirtilen ve faturalandırma kitaplığı üzerinden uygulamaya döndürülen en fazla 20 özel etiketin listesi. Bu temel plana yönelik abonelik teklifleri de faturalandırma kitaplığında bu teklif etiketlerini alır.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Play'in gelecekte kullanıma sunabileceği yeni konumlar için fiyatlandırma bilgileri. Atlanırsa BasePlan, Play'in gelecekte kullanıma sunabileceği yeni konumlarda otomatik olarak kullanılamaz.
Birlik alanı base_plan_type. Bu temel planın türü. Tam olarak bir tane ayarlanmalıdır. Temel plan oluşturulduktan sonra temel plan türü değiştirilemez. base_plan_type yalnızca aşağıdakilerden biri olabilir:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

Temel planın düzenli aralıklarla otomatik olarak yenileneceği zamanı ayarlayın.
prepaidBasePlanType

object (PrepaidBasePlanType)

Base Plan'ın faturalandırma döneminin sonunda otomatik olarak yenilenmemesi durumunda ayarlanır.
installmentsBasePlanType

object (InstallmentsBasePlanType)

Kullanıcının belirli sayıda ödeme yapmayı taahhüt ettiği taksitli planlar için ayarlanır.

Eyalet

Temel planın mevcut durumu.

Sıralamalar
STATE_UNSPECIFIED Belirtilmemiş durum.
DRAFT Temel plan şu anda taslak durumundadır ve etkinleştirilmemiştir. Bu noktada, dosyayı güvenle silebilirsiniz.
ACTIVE Temel plan etkindir ve yeni aboneler tarafından kullanılabilir.
INACTIVE Temel plan etkin değildir ve yalnızca mevcut aboneler tarafından kullanılabilir.

AutoRenewingBasePlanType

Abonelik döneminin sonunda otomatik olarak yenilenen bir temel planı temsil eder.

JSON gösterimi 
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}
Alanlar
billingPeriodDuration

string

Zorunlu. Değişmez. ISO 8601 biçiminde belirtilen abonelik dönemi. Kabul edilen faturalandırma dönemlerinin listesi için yardım merkezine bakın. Temel plan oluşturulduktan sonra süre değiştirilemez.
gracePeriodDuration

string

ISO 8601 biçiminde belirtilen aboneliğin ek süresi. Kabul edilen değerler gün cinsinden olmalı ve P0D ile 30D'nin veya temel plan faturalandırma döneminin hangisi daha kısaysa o değer arasında olmalıdır.

Belirtilmezse faturalandırma dönemine göre varsayılan bir değer kullanılır.

gracePeriodDuration ve accountHoldDuration değerlerinin toplamı P30D ile P60D gün (bu değerler dahil) arasında olmalıdır.
accountHoldDuration

string

İsteğe bağlı. Aboneliğin hesap bekleme süresi (ISO 8601 biçiminde belirtilir). Kabul edilebilir değerler gün cinsinden olmalı ve P0D ile P60D arasında olmalıdır.

Bir değer belirtilmezse varsayılan değer P30D olur.

gracePeriodDuration ve accountHoldDuration değerlerinin toplamı P30D ile P60D gün (bu değerler dahil) arasında olmalıdır.
resubscribeState

enum (ResubscribeState)

Kullanıcıların Google Play platformlarında bu temel plana yeniden abone olup olamayacağını belirtir. Belirtilmezse varsayılan olarak RESUBSCRIBE_STATE_ACTIVE değerini alır.
prorationMode

enum (SubscriptionProrationMode)

Temel planın prorasyon modu, kullanıcı başka bir temel plandan bu plana geçtiğinde ne olacağını belirler. Belirtilmemişse varsayılan olarak CHARGE_ON_NEXT_BILLING_DATE olur.
legacyCompatible

boolean

Yenilenen temel planın geriye dönük uyumlu olup olmadığı.

Geriye dönük uyumlu temel plan, Google Play Faturalandırma Kitaplığı'nın kullanımdan kaldırılan querySkuDetailsAsync() yöntemi tarafından döndürülür.

Belirli bir abonelik için yalnızca bir yenilenen temel plan eski sürümlerle uyumlu olarak işaretlenebilir.
legacyCompatibleSubscriptionOfferId

string

Eski sürümlerle uyumlu abonelik teklifi kimliği.

Geriye dönük uyumlu abonelik fırsatı, Google Play Faturalandırma Kitaplığı'nın kullanımdan kaldırılan querySkuDetailsAsync() yöntemi tarafından döndürülür.

Belirli bir yenilenen temel plan için yalnızca bir abonelik teklifi eski sürümlerle uyumlu olarak işaretlenebilir.

Abonelik teklifinin eski sürümle uyumlu olmaması için bu alanı boş dize olarak ayarlayın.

ResubscribeState

Temel planın yeniden abone olma durumu.

Sıralamalar
RESUBSCRIBE_STATE_UNSPECIFIED Belirtilmemiş durum.
RESUBSCRIBE_STATE_ACTIVE Yeniden abone olma özelliği etkin olmalıdır.
RESUBSCRIBE_STATE_INACTIVE Yeniden abone olma özelliği etkin değil.

SubscriptionProrationMode

Temel planları yenilemek için kullanılan prorasyon modu.

Sıralamalar
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Belirtilmemiş mod.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Kullanıcılardan yeni temel planlarının ücreti, mevcut fatura dönemlerinin sonunda alınır.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Kullanıcılardan yeni temel planlarının ödemesi hemen ve eksiksiz olarak alınır. Mevcut aboneliklerinin kalan süresi, yeni faturalandırma planının süresini uzatmak için kullanılır.

PrepaidBasePlanType

Temel planın sonunda otomatik olarak yenilenmeyen ve kullanıcı tarafından manuel olarak yenilenmesi gereken bir temel planı temsil eder.

JSON gösterimi 
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
Alanlar
billingPeriodDuration

string

Zorunlu. Değişmez. ISO 8601 biçiminde belirtilen abonelik dönemi. Kabul edilen faturalandırma dönemlerinin listesi için yardım merkezine bakın. Temel plan oluşturulduktan sonra süre değiştirilemez.
timeExtension

enum (TimeExtension)

Kullanıcıların Google Play'deki bu ön ödemeli temel planı uzatıp uzatamayacakları. Belirtilmezse varsayılan olarak TIME_EXTENSION_ACTIVE değerine ayarlanır.

TimeExtension

Temel plan süresinin uzatılması.

Sıralamalar
TIME_EXTENSION_UNSPECIFIED Belirtilmemiş durum.
TIME_EXTENSION_ACTIVE Zaman uzatması etkin. Kullanıcıların ön ödemeli planlarına para eklemesine veya planlarını uzatmasına izin verilir.
TIME_EXTENSION_INACTIVE Zaman uzatması etkin değil. Kullanıcılar ön ödemeli planlarına para ekleyemez veya planlarını uzatamaz.

InstallmentsBasePlanType

Kullanıcının belirli sayıda ödeme yapmayı taahhüt ettiği bir taksitli planı temsil eder.

JSON gösterimi 
{
  "billingPeriodDuration": string,
  "committedPaymentsCount": integer,
  "renewalType": enum (RenewalType),
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode)
}
Alanlar
billingPeriodDuration

string

Zorunlu. Değişmez. ISO 8601 biçiminde belirtilen abonelik dönemi. Kabul edilen faturalandırma dönemlerinin listesi için yardım merkezine bakın. Temel plan oluşturulduktan sonra süre değiştirilemez.
committedPaymentsCount

integer

Zorunlu. Değişmez. Kullanıcının taahhüt ettiği ödemelerin sayısı. Temel plan oluşturulduktan sonra değiştirilemez.
renewalType

enum (RenewalType)

Zorunlu. Değişmez. Taksitli temel plan yenileme türü. İlk taahhüt döneminin sonunda davranışı belirler. Temel plan oluşturulduktan sonra yenileme türü değiştirilemez.
gracePeriodDuration

string

ISO 8601 biçiminde belirtilen aboneliğin ek süresi. Kabul edilen değerler gün cinsinden olmalı ve P0D ile 30D'nin veya temel plan faturalandırma döneminin hangisi daha kısaysa o değer arasında olmalıdır.

Belirtilmezse faturalandırma dönemine göre varsayılan bir değer kullanılır.

gracePeriodDuration ve accountHoldDuration değerlerinin toplamı P30D ile P60D gün (bu değerler dahil) arasında olmalıdır.
accountHoldDuration

string

İsteğe bağlı. Aboneliğin hesap bekleme süresi (ISO 8601 biçiminde belirtilir). Kabul edilebilir değerler gün cinsinden olmalı ve P0D ile P60D arasında olmalıdır.

Bir değer belirtilmezse varsayılan değer P30D olur.

gracePeriodDuration ve accountHoldDuration değerlerinin toplamı P30D ile P60D gün (bu değerler dahil) arasında olmalıdır.
resubscribeState

enum (ResubscribeState)

Kullanıcıların Google Play platformlarında bu temel plana yeniden abone olup olamayacağını belirtir. Belirtilmezse varsayılan olarak RESUBSCRIBE_STATE_ACTIVE değerini alır.
prorationMode

enum (SubscriptionProrationMode)

Temel planın prorasyon modu, kullanıcı başka bir temel plandan bu plana geçtiğinde ne olacağını belirler. Belirtilmemişse varsayılan olarak CHARGE_ON_NEXT_BILLING_DATE olur.

RenewalType

Taksitli temel plan yenileme türü. İlk taahhüt döneminin sonunda davranışı belirler. Temel plan oluşturulduktan sonra yenileme türü değiştirilemez.

Sıralamalar
RENEWAL_TYPE_UNSPECIFIED Belirtilmemiş durum.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT Taahhüt olmadan faturalandırma dönemi boyunca düzenli olarak yenilenir.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT İlkiyle aynı süreli taahhütle yenilenir.

RegionalBasePlanConfig

Bir bölgeye özel temel plan yapılandırması.

JSON gösterimi 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}
Alanlar
regionCode

string

Zorunlu. ISO 3166-2 tarafından tanımlandığı üzere bu yapılandırmanın geçerli olduğu bölge kodu (ör. "US").
newSubscriberAvailability

boolean

Belirtilen bölgedeki temel planın yeni aboneler tarafından kullanılıp kullanılamayacağını belirtir. Bu değer false olarak ayarlanırsa mevcut abonelerin abonelikleri iptal edilmez. Bir değer belirtilmezse varsayılan olarak false (yanlış) olur.
price

object (Money)

Belirtilen bölgedeki temel planın fiyatı. Temel plan yeni aboneler tarafından kullanılabiliyorsa ayarlanmalıdır. Belirtilen bölgeye bağlı para biriminde ayarlanmalıdır.

OtherRegionsBasePlanConfig

Play'in kullanıma sunabileceği yeni konumlar için fiyatlandırma bilgileri.

JSON gösterimi 
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "newSubscriberAvailability": boolean
}
Alanlar
usdPrice

object (Money)

Zorunlu. Play'in kullanıma sunabileceği yeni konumlar için kullanılacak ABD doları cinsinden fiyat.
eurPrice

object (Money)

Zorunlu. Play'in kullanıma sunabileceği yeni konumlar için kullanılacak avro cinsinden fiyat.
newSubscriberAvailability

boolean

Temel planın, Play'in kullanıma sunabileceği yeni konumlardaki yeni aboneler tarafından kullanılıp kullanılamayacağını belirtir. Bir değer belirtilmezse varsayılan olarak false (yanlış) olur.

SubscriptionListing

Bir aboneliğin tüketici tarafından görülebilen meta verileri.

JSON gösterimi 
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
Alanlar
languageCode

string

Zorunlu. BCP-47 tarafından tanımlanan bu girişin dili (ör. "en-US").
title

string

Zorunlu. Bu aboneliğin, bu girişin dilinde başlığı. Düz metin.
benefits[]

string

Play Store gibi platformlarda ve geri yükleme akışlarında kullanıcıya bu girişin dilinde gösterilen avantajların listesi. Düz metin. En fazla dört avantajın yer aldığı sıralı liste.
description

string

Bu aboneliğin, girişin dilinde yazılmış açıklaması. Maksimum uzunluk: 80 karakter. Düz metin.

RestrictedPaymentCountries

Bu ürünün satın alınmasının, ilgili ülkede kayıtlı ödeme yöntemleriyle kısıtlandığı ülkeler. Boşsa ödeme konumu kısıtlaması uygulanmaz.

JSON gösterimi 
{
  "regionCodes": [
    string
  ]
}
Alanlar
regionCodes[]

string

Zorunlu. ISO 3166-2 tarafından tanımlandığı üzere ödeme kısıtlamaları uygulanacak bölge kodları (ör. "US").

Yöntemler

archive
(deprecated)

 Desteği sonlandırıldı: Abonelik arşivleme desteklenmez.

batchGet

 Bir veya daha fazla aboneliği okur.

batchUpdate

 Bir grup aboneliği günceller.

create

 Yeni abonelik oluşturur.

delete

 Aboneliği siler.

get

 Tek bir aboneliği okur.

list

 Belirli bir uygulamanın altındaki tüm abonelikleri listeler.

patch

 Mevcut bir aboneliği günceller.