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

Sabit. Üst uygulamanın paket adı.
productId

string

Sabit. Ürünün benzersiz ürün kimliği. Üst uygulamada benzersizdir. Ürün kimlikleri küçük harf (a-z), rakam (0-9), alt çizgi (_) ve noktadan (.) oluşmalıdır. Küçük harfle veya rakamla başlamalı ve 1 ila 40 (dahil) karakter uzunluğunda olmalıdır.
basePlans[]

object (BasePlan)

Bu aboneliğe yönelik temel plan grubu. Başka bir teklifin geçerli olmadığı durumlarda aboneliğin fiyatlarını ve süresini gösterir.
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ış. Kullanımdan kaldırıldı: Abonelik arşivleme desteklenmiyor.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

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

object (RestrictedPaymentCountries)

İsteğe bağlı. Bu aboneliği satın almanın, ilgili ülkede kayıtlı ödeme yöntemleriyle sınırlı olduğu ü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. Sabit. Bu temel planın benzersiz tanımlayıcısıdır. Abonelik dahilinde benzersiz olmalı ve RFC-1034 ile uyumlu 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 karakterden oluşabilir.
state

enum (State)

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

object (RegionalBasePlanConfig)

Bu temel plan için bölgeye özel 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 plandaki abonelik teklifleri, bu teklif etiketlerini faturalandırma kitaplığında da alır.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Play'in gelecekte kullanıma sunabileceği yeni konumlar için fiyatlandırma bilgileri. Aksi takdirde BasePlan, Play'in gelecekte kullanıma sunulacağı 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. base_plan_type şunlardan 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ın, fatura döneminin sonunda otomatik olarak yenilenmeyeceğini belirtin.
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 durumunda ve etkinleştirilmedi. Bu noktada verileriniz güvenli bir şekilde silinebilir.
ACTIVE Temel plan etkin ve yeni aboneler tarafından kullanılabilir.
INACTIVE Temel plan etkin değil ve yalnızca mevcut aboneler tarafından kullanılabilir.

AutoRenewingBasePlanType

Abonelik döneminin sonunda otomatik olarak yenilenen 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. ISO 8601 biçiminde belirtilen abonelik süresi. Kabul edilebilir fatura dönemlerinin listesi için yardım merkezine göz atın.
gracePeriodDuration

string

Aboneliğin ek süre süresi (ISO 8601 biçiminde). Kabul edilebilir değerler P0D (sıfır gün), P3D (3 gün), P7D (7 gün), P14D (14 gün) ve P30D'dir (30 gün). Belirtilmezse yinelenen dönem süresine göre varsayılan bir değer kullanılır.
accountHoldDuration

string

İsteğe bağlı. Aboneliğin hesap askıya alma süresi (ISO 8601 biçiminde belirtilir). Kabul edilebilir değerler DAYS aralığında ve P0D (sıfır gün) ile P30D (30 gün) aralığında olmalıdır. Belirtilmezse varsayılan değer P30D (30 gün) olur.
resubscribeState

enum (ResubscribeState)

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

enum (SubscriptionProrationMode)

Temel plandaki bölüştürme modu, bir kullanıcı başka bir temel plandan bu plana geçiş yaptığında ne olacağını belirler. Belirtilmemişse varsayılan olarak CHARGE_ON_NEXT_BILLING_DATE değerini alı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 uyumlu olarak işaretlenebilir.
legacyCompatibleSubscriptionOfferId

string

Eski sürümlerle uyumlu olan abonelik teklif 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ümle uyumlu olarak işaretlenebilir.

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

ResubscribeState

Temel plan yeniden abone olma durumu.

Sıralamalar
RESUBSCRIBE_STATE_UNSPECIFIED Belirtilmemiş durum.
RESUBSCRIBE_STATE_ACTIVE Yeniden abone olma etkin.
RESUBSCRIBE_STATE_INACTIVE Yeniden abone olma etkin değil.

SubscriptionProrationMode

Temel planları yenilemek için kullanılan kullanım payı 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 ödemesi mevcut fatura dönemlerinin sonunda alınır.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Kullanıcılardan yeni temel planları için hemen ve eksiksiz ödeme alınır. Mevcut aboneliğinde kalan tüm dönemler, 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. ISO 8601 biçiminde belirtilen abonelik süresi. Kabul edilebilir fatura dönemlerinin listesi için yardım merkezine göz atın.
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 değerine ayarlanır.

TimeExtension

Temel planın süre uzantısı.

Sıralamalar
TIME_EXTENSION_UNSPECIFIED Belirtilmemiş durum.
TIME_EXTENSION_ACTIVE Zaman uzantısı etkin. Kullanıcılar ön ödemeli planlarına para ekleyebilir veya planlarını uzatabilirler.
TIME_EXTENSION_INACTIVE Zaman uzantısı etkin değil. Kullanıcılar ön ödemeli planlarına para ekleyemez veya planlarını uzatamazlar.

InstallmentsBasePlanType

Kullanıcının belirli sayıda ödeme yapmayı taahhüt ettiği taksitli temel planını 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. ISO 8601 biçiminde belirtilen abonelik süresi. Kabul edilebilir fatura dönemlerinin listesi için yardım merkezine göz atın.
committedPaymentsCount

integer

Zorunlu. Kullanıcının taahhüt ettiği ödeme sayısı.
renewalType

enum (RenewalType)

Zorunlu. Taksitli temel plan yenileme türü. İlk taahhüdün sonundaki davranışı belirler.
gracePeriodDuration

string

Aboneliğin ek süre süresi (ISO 8601 biçiminde). Kabul edilebilir değerler P0D (sıfır gün), P3D (3 gün), P7D (7 gün), P14D (14 gün) ve P30D'dir (30 gün). Belirtilmezse yinelenen dönem süresine göre varsayılan bir değer kullanılır.
accountHoldDuration

string

İsteğe bağlı. Aboneliğin hesap askıya alma süresi. Özel olarak gün cinsinden ve ISO 8601 biçiminde belirtilir. Kabul edilebilir değerler P0D (sıfır gün) ile P30D (30 gün) arasındadır. Belirtilmezse varsayılan değer P30D (30 gün) olur.
resubscribeState

enum (ResubscribeState)

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

enum (SubscriptionProrationMode)

Temel plandaki bölüştürme modu, bir kullanıcı başka bir temel plandan bu plana geçiş yaptığında ne olacağını belirler. Belirtilmemişse varsayılan olarak CHARGE_ON_NEXT_BILLING_DATE değerini alır.

RenewalType

Taksitli temel plan yenileme türü. İlk taahhüdün sonundaki davranışı belirler.

Sıralamalar
RENEWAL_TYPE_UNSPECIFIED Belirtilmemiş durum.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT Taahhüt olmaksızın, fatura dönemi boyunca düzenli olarak yenilenir.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT İlkiyle aynı süre taahhüdüyle yenilenir.

RegionalBasePlanConfig

Belirli 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 ile tanımlanan şekilde 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ılabilir olup olmadığı. Bu değer false olarak ayarlanırsa mevcut abonelerin abonelikleri iptal edilmez. Bir ayar belirtilmezse varsayılan olarak false (yanlış) değerini alır.
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

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. Play'in kullanıma sunulacağı tüm yeni konumlarda kullanılacak ABD doları cinsinden fiyat.
eurPrice

object (Money)

Zorunlu. Play'in kullanıma sunulacağı yeni konumlarda kullanılacak avro cinsinden fiyattır.
newSubscriberAvailability

boolean

Play'in kullanıma sunulacağı yeni konumlarda temel planın yeni abonelere sunulup sunulmayacağı. Bir ayar belirtilmezse varsayılan olarak false (yanlış) değerini alı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. Bu listenin BCP-47 tarafından tanımlanan dili, ör. "tr-TR".
title

string

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

string

Bu girişin dilinde, Play Store gibi platformlarda ve geri yükleme akışlarında kullanıcıya 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 karakter. Düz metin.

RestrictedPaymentCountries

Bu ürünü satın almanın, ilgili ülkede kayıtlı ödeme yöntemleriyle sınırlı olduğu ülkeler. Boş bırakılırsa ödeme konumu kısıtlaması uygulanmaz.

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

string

Zorunlu. ISO 3166-2 ile tanımlanan şekilde ödeme kısıtlamaları uygulanacak bölge kodları (ör. "US".

Yöntemler

archive
(deprecated)

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

batchGet

 Bir veya daha fazla abonelik okur.

batchUpdate

 Abonelik grubunu günceller.

create

 Yeni bir abonelik oluşturur.

delete

 Aboneliği siler.

get

 Tek bir aboneliği okur.

list

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

patch

 Mevcut bir aboneliği günceller.