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. Üst uygulamada 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 uzunluğu 1 ile 40 karakter (ikisi de dahil) arasında olmalıdır.
basePlans[]

object (BasePlan)

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

object (SubscriptionListing)

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

boolean

Yalnızca çıkış. Kullanımdan kaldırıldı: Abonelik arşivleme desteklenmez.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Vergiler ve yasal uygunlukla ilgili ayrıntılar.
restrictedPaymentCountries

object (RestrictedPaymentCountries)

İsteğe bağlıdır. Bu aboneliğin satın alınmasının, aynı ülkede kayıtlı ödeme yöntemleriyle sınırlandırıldığı ülkeler. Boş bırakılırsa ödeme konumu kısıtlaması uygulanmaz.

BasePlan

Bir 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ı. Abonelik içinde benzersiz olmalı 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 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 planla ilgili bölgeye özgü bilgiler.
offerTags[]

object (OfferTag)

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

object (OtherRegionsBasePlanConfig)

Play'in gelecekte kullanıma sunabileceği yeni konumlarla ilgili fiyatlandırma bilgileri. Belirtilmezse BasePlan, Play'in gelecekte kullanıma sunabileceği yeni konumlarda otomatik olarak kullanılamaz.
Birleştirme alanı base_plan_type. Bu temel planın türü. Tam olarak bir tane ayarlanmalıdır. Temel plan türü, temel plan oluşturulduktan sonra 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)

Faturalandırma döneminin sonunda temel planın otomatik olarak yenilenmediği zaman 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 Durum belirtilmemiş.
DRAFT Temel plan şu anda taslak durumundadır ve etkinleştirilmemiştir. Bu noktada güvenle silinebilir.
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 süresinin 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 edilebilir fatura dönemlerinin listesi için yardım merkezine bakın. Temel plan oluşturulduktan sonra süre değiştirilemez.
gracePeriodDuration

string

Aboneliğin ISO 8601 biçiminde belirtilen ek süre. Kabul edilebilir değerler gün cinsinden olmalı ve P0D ile 30D ve temel plan faturalandırma dönemi arasındaki daha küçük 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ünleri (bu değerler dahil) arasında olmalıdır.
accountHoldDuration

string

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

Belirtilmezse varsayılan değer P30D'dir.

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

enum (ResubscribeState)

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

enum (SubscriptionProrationMode)

Temel planın orantılı ödeme modu, kullanıcının başka bir temel plandan bu plana geçiş yaptığında ne olacağını belirler. Belirtilmezse 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ümle uyumlu abonelik teklifi kimliği.

Geriye dönük uyumlu abonelik teklifi, 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.

Eski sürümle uyumlu abonelik teklifi olmaması için bu alanı boş dize olarak ayarlayın.

ResubscribeState

Temel planın yeniden abone olma durumu.

Sıralamalar
RESUBSCRIBE_STATE_UNSPECIFIED Durum belirtilmemiş.
RESUBSCRIBE_STATE_ACTIVE Yeniden abone olma özelliği etkin olmalıdır.
RESUBSCRIBE_STATE_INACTIVE Yeniden abone olma özelliği devre dışı.

SubscriptionProrationMode

Temel planları yenilemek için kullanılan orantılı ödeme modu.

Sıralamalar
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Belirtilmemiş mod.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Kullanıcıların yeni temel plan ödemesi mevcut fatura dönemlerinin sonunda alınır.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Kullanıcılardan yeni temel planlarının ücreti hemen ve tam 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 edilebilir fatura 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 bu ön ödemeli temel planın süresini Google Play yüzeylerinde uzatıp uzatamayacağı. Belirtilmezse varsayılan olarak TIME_EXTENSION_ACTIVE değerine ayarlanır.

TimeExtension

Temel plan süresini uzatma

Sıralamalar
TIME_EXTENSION_UNSPECIFIED Durum belirtilmemiş.
TIME_EXTENSION_ACTIVE Süre uzatımı etkin. Kullanıcıların ön ödemeli planlarına para eklemesine veya planlarını uzatmasına izin verilir.
TIME_EXTENSION_INACTIVE Süre uzatma 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 taksitli temel planı ifade 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 edilebilir fatura 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 yapmayı taahhüt ettiği ödeme sayısı. Temel plan oluşturulduktan sonra değiştirilemez.
renewalType

enum (RenewalType)

Zorunlu. Değişmez. Taksitli ödeme temel planı yenileme türü. İlk taahhüt süresinin sonundaki davranışı belirler. Yenileme türü, temel plan oluşturulduktan sonra değiştirilemez.
gracePeriodDuration

string

Aboneliğin ISO 8601 biçiminde belirtilen ek süre. Kabul edilebilir değerler gün cinsinden olmalı ve P0D ile 30D ve temel plan faturalandırma dönemi arasındaki daha küçük 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ünleri (bu değerler dahil) arasında olmalıdır.
accountHoldDuration

string

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

Belirtilmezse varsayılan değer P30D'dir.

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

enum (ResubscribeState)

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

enum (SubscriptionProrationMode)

Temel planın orantılı ödeme modu, kullanıcının başka bir temel plandan bu plana geçiş yaptığında ne olacağını belirler. Belirtilmezse varsayılan olarak CHARGE_ON_NEXT_BILLING_DATE olur.

RenewalType

Taksitli ödeme temel planı yenileme türü. İlk taahhüt süresinin sonundaki davranışı belirler. Yenileme türü, temel plan oluşturulduktan sonra değiştirilemez.

Sıralamalar
RENEWAL_TYPE_UNSPECIFIED Durum belirtilmemiş.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT Taahhüt olmadan fatura dönemi süresince düzenli olarak yenilenir.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT İlk taahhütle aynı süreyle yenilenir.

RegionalBasePlanConfig

Bir bölgeye özgü temel plan yapılandırması.

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

string

Zorunlu. Bu yapılandırmanın geçerli olduğu bölge kodu (ISO 3166-2'de tanımlandığı gibi), örneğin "US".
newSubscriberAvailability

boolean

Belirtilen bölgedeki temel planın yeni aboneler tarafından kullanılıp kullanılamayacağı. Bu değer yanlış olarak ayarlanırsa mevcut abonelerin abonelikleri iptal edilmez. Belirtilmezse varsayılan olarak false (yanlış) değeri kullanılır.
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 sunulabileceği yeni konumlarla ilgili 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 sunulabileceği yeni konumlar için kullanılacak avro cinsinden fiyat.
newSubscriberAvailability

boolean

Temel planın, Play'in kullanıma sunulabileceği yeni konumlardaki yeni aboneler tarafından kullanılıp kullanılamayacağı Belirtilmezse varsayılan olarak false (yanlış) değeri kullanılır.

SubscriptionListing

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 şekilde bu girişin dili (ör. "en-US").
title

string

Zorunlu. Bu aboneliğin, bu girişin dilindeki 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 avantajdan oluşan sıralı liste.
description

string

Bu aboneliğin, bu girişin dilindeki açıklaması. Maksimum uzunluk 80 karakterdir. Düz metin.

Yöntemler

archive
(deprecated)

 Kullanımdan kaldırıldı: Abonelik arşivleme desteklenmez.

batchGet

 Bir veya daha fazla aboneliği okur.

batchUpdate

 Bir grup aboneliği günceller.

create

 Yeni bir abonelik oluşturur.

delete

 Aboneliği siler.

get

 Tek bir aboneliği okur.

list

 Belirli bir uygulamadaki tüm abonelikleri listeler.

patch

 Mevcut bir aboneliği günceller.