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ştirilemez. Üst uygulamanın paket adı.
productId

string

Değiştirilemez. Ürünün benzersiz ürün kimliği. Üst 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 ila 40 (dahil) karakter uzunluğunda olmalıdır.
basePlans[]

object (BasePlan)

Bu aboneliğin temel planları. Başka bir teklif geçerli değilse aboneliğin fiyatlarını ve süresini temsil eder.
listings[]

object (SubscriptionListing)

Zorunlu. Bu abonelik için yerelleştirilmiş girişlerin listesi. Üst uygulamanın varsayılan dili için en az bir giriş içermelidir.
archived
(deprecated)

boolean

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

object (SubscriptionTaxAndComplianceSettings)

Vergiler ve kanunlara ve kurallara uygunluk ile ilgili ayrıntılar.
restrictedPaymentCountries

object (RestrictedPaymentCountries)

İsteğe bağlıdır. Bu aboneliğin satın alımının, ilgili ülkedeki kayıtlı ödeme yöntemleriyle kısıtlandığı ülkeler. Boş bırakılırsa ö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ştirilemez. 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 de faturalandırma kitaplığında bu teklif etiketlerini alır.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Google 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.
base_plan_type birleşik alanı. 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 aşağıdakilerden yalnızca biri olabilir:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

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

object (PrepaidBasePlanType)

Temel plan, fatura döneminin sonunda otomatik olarak yenilenmediğinde ayarlanır.
installmentsBasePlanType

object (InstallmentsBasePlanType)

Kullanıcının belirli sayıda ödeme yapmayı taahhüt ettiği taksitli temel 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 aşamada 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 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ştirilemez. ISO 8601 biçiminde belirtilen abonelik dönemi. Kabul edilebilir fatura dönemlerinin listesi için Yardım Merkezi'ne bakın. Temel plan oluşturulduktan sonra süre değiştirilemez.
gracePeriodDuration

string

Aboneliğin ek süresi (ISO 8601 biçiminde belirtilir). Kabul edilebilir değerler gün cinsinden olmalı ve P0D ile 30D ve temel plan fatura döneminden daha az olan değer arasında olmalıdır.

Belirtilmezse fatura 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ıdır. Aboneliğin ISO 8601 biçiminde belirtilen özel hesap askıya alma süresi. Kabul edilebilir değerler gün cinsinden ve P0D ile P60D arasında olmalıdır.

Boş alan, önerilen hesabın askıya alınmasını temsil eder. Bu süre, 60 günden ek süre düşülerek hesaplanır.

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 yüzeylerinde bu temel plana yeniden abone olup olamayacağını belirler. Belirtilmezse varsayılan olarak RESUBSCRIBE_STATE_ACTIVE değerine ayarlanır.
prorationMode

enum (SubscriptionProrationMode)

Temel planın eşit oranda dağıtım modu, bir kullanıcı başka bir temel plandan bu plana geçtiğinde ne olacağını belirler. Belirtilmezse varsayılan olarak CHARGE_ON_NEXT_BILLING_DATE kullanılır.
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 teklif numarası.

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.

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

Eski sürümlerle 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 Belirtilmemiş durum.
RESUBSCRIBE_STATE_ACTIVE Yeniden abone olma özelliği etkin.
RESUBSCRIBE_STATE_INACTIVE Yeniden abone olma özelliği etkin değil.

SubscriptionProrationMode

Temel planları yenilemek için kullanılan eşit oranda dağıtım modu.

Sıralamalar
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Belirtilmemiş mod.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Kullanıcılar, yeni temel planları için mevcut fatura dönemlerinin sonunda ücretlendirilir.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Kullanıcılardan yeni temel planları için hemen ve tam ödeme 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ştirilemez. ISO 8601 biçiminde belirtilen abonelik dönemi. Kabul edilebilir fatura dönemlerinin listesi için Yardım Merkezi'ne bakın. Temel plan oluşturulduktan sonra süre değiştirilemez.
timeExtension

enum (TimeExtension)

Kullanıcıların Google Play yüzeylerinde bu ön ödemeli temel planı uzatıp uzatamayacağı. Belirtilmezse varsayılan olarak TIME_EXTENSION_ACTIVE kullanılır.

TimeExtension

Temel plan süresini uzatma

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

InstallmentsBasePlanType

Kullanıcının belirli sayıda ödeme yapmayı taahhüt ettiği taksitli temel 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ştirilemez. ISO 8601 biçiminde belirtilen abonelik dönemi. Kabul edilebilir fatura dönemlerinin listesi için Yardım Merkezi'ne bakın. Temel plan oluşturulduktan sonra süre değiştirilemez.
committedPaymentsCount

integer

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

enum (RenewalType)

Zorunlu. Değiştirilemez. Yükleme tabanı temel plan yenileme türü. İlk taahhüt döneminin sonundaki davranışı belirler. Yenileme türü, temel plan oluşturulduktan sonra değiştirilemez.
gracePeriodDuration

string

Aboneliğin ek süresi (ISO 8601 biçiminde belirtilir). Kabul edilebilir değerler gün cinsinden olmalı ve P0D ile 30D ve temel plan fatura döneminden daha az olan değer arasında olmalıdır.

Belirtilmezse fatura 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ıdır. Aboneliğin ISO 8601 biçiminde belirtilen özel hesap askıya alma süresi. Kabul edilebilir değerler gün cinsinden ve P0D ile P60D arasında olmalıdır.

Boş alan, önerilen hesabın askıya alınmasını temsil eder. Bu süre, 60 günden ek süre düşülerek hesaplanır.

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 yüzeylerinde bu temel plana yeniden abone olup olamayacağını belirler. Belirtilmezse varsayılan olarak RESUBSCRIBE_STATE_ACTIVE değerine ayarlanır.
prorationMode

enum (SubscriptionProrationMode)

Temel planın eşit oranda dağıtım modu, bir kullanıcı başka bir temel plandan bu plana geçtiğinde ne olacağını belirler. Belirtilmezse varsayılan olarak CHARGE_ON_NEXT_BILLING_DATE kullanılır.

RenewalType

Yükleme tabanı temel plan yenileme türü. İlk taahhüt döneminin sonundaki davranışı belirler. Yenileme türü, temel plan oluşturulduktan sonra değiştirilemez.

Sıralamalar
RENEWAL_TYPE_UNSPECIFIED Belirtilmemiş durum.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT Taahhüt olmadan fatura dönemi süresi boyunca düzenli olarak yenilenir.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT İlk taahhütle aynı süre için 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. Bu yapılandırmanın geçerli olduğu bölge kodu (ISO 3166-1 alfa-2 tarafından tanımlandığı şekilde, ör. "US").
newSubscriberAvailability

boolean

Belirtilen bölgedeki temel planın yeni abonelere sunulup sunulmadığı. Bu değer "false" olarak ayarlanırsa mevcut abonelerin aboneliği iptal edilmez. Belirtilmezse bu değer varsayılan olarak false olur.
price

object (Money)

Temel planın belirtilen bölgedeki fiyatı. Temel plan yeni abonelere sunuluyorsa ayarlanmalıdır. Belirtilen bölgeye bağlı para biriminde ayarlanmalıdır.

OtherRegionsBasePlanConfig

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

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

object (Money)

Zorunlu. Google Play'in kullanıma sunulabileceği yeni konumlarda kullanılacak ABD doları cinsinden fiyat.
eurPrice

object (Money)

Zorunlu. Google 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 bu değer varsayılan olarak false 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. Bu girişin BCP-47 tarafından tanımlanan dili (ör. "en-US").
title

string

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

string

Google 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 sıralı listesi.
description

string

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

Yöntemler

archive
(deprecated)

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

batchGet

 Bir veya daha fazla aboneliği okur.

batchUpdate

 Bir abonelik grubunu günceller.

create

 Yeni bir abonelik oluşturur.

delete

 Aboneliği siler.

get

 Tek bir aboneliği okur.

list

 Belirli bir uygulama kapsamındaki tüm abonelikleri listeler.

patch

 Mevcut bir aboneliği günceller.

Hata kodları

Bu kaynağın işlemleri aşağıdaki HTTP hata kodlarını döndürür:

Hata kodu Neden Açıklama Çözünürlük