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)
  }
}
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 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 abonelikle ilgili temel plan grubu. Başka teklif yoksa 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.

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)
  }
  // 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 içinde 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 halindeki 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 ö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 fırsat etiketlerini faturalandırma kitaplığına da alır.

otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Play'in yeni konumlarla ilgili fiyatlandırma bilgileri ileride kullanıma sunulabilir. Atlanırsa Temel Plan, Play'in gelecekte kullanıma sunacağı yeni konumlarda otomatik olarak kullanılamayacaktır.

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 düzenli aralıklarla otomatik olarak yenileneceği zamanı ayarlayın.

prepaidBasePlanType

object (PrepaidBasePlanType)

Temel planın, fatura döneminin sonunda otomatik olarak yenilenmediği zamanı ayarlayın.

Eyalet

Temel planın mevcut durumu.

Sıralamalar
STATE_UNSPECIFIED Belirtilmemiş durum.
DRAFT Temel plan şu anda taslak durumunda ve etkinleştirilmedi. Bu aşamada verileri güvenle silebilirsiniz.
ACTIVE Temel plan etkin 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. Abonelik süresi, ISO 8601 biçiminde belirtilir. Kabul edilebilir fatura dönemlerinin listesi için yardım merkezine bakın.

gracePeriodDuration

string

Aboneliğin ek yayınlanma süresi, ISO 8601 biçiminde belirtilir. 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 hesabı askıya alma süresi (ISO 8601 biçiminde belirtilir). Kabul edilebilir değerler DAYS içinde olmalı ve P0D (sıfır gün) - P30D (30 gün) aralığında olmalıdır. Herhangi bir değer belirtilmediyse varsayılan değer P30D'dir (30 gün).

resubscribeState

enum (ResubscribeState)

Kullanıcıların Google Play yüzeylerinde bu temel plana yeniden abone olup olmayacağı. Belirtilmezse varsayılan olarak RESUBSCRIBE_STATE_ACTIVE olur.

prorationMode

enum (SubscriptionProrationMode)

Temel planın kullanıma oranlı ücretlendirme modu, kullanıcı başka bir temel plandan bu plana geçiş yaptığında ne olacağını belirler. Belirtilmemesi halinde varsayılan olarak CHARGE_ON_NEXT_BILLING_DATE değeri 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ümle uyumlu" olarak işaretlenebilir.

legacyCompatibleSubscriptionOfferId

string

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

Abonelik teklifinin eski sürümle uyumlu olarak 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ıma oranlama modu.

Sıralamalar
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Belirtilmemiş mod.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Kullanıcılardan mevcut fatura dönemlerinin sonunda yeni temel planlarının ödemesi alınır.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Kullanıcılar yeni temel planlarının ödemesi anında ve tam olarak alınır. Mevcut aboneliğin kalan süreleri, 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. Abonelik süresi, ISO 8601 biçiminde belirtilir. Kabul edilebilir fatura dönemlerinin listesi için yardım merkezine bakın.

timeExtension

enum (TimeExtension)

Kullanıcıların Google Play yüzeylerinde bu ön ödemeli temel plan süresini uzatıp uzatamayacağı Belirtilmezse varsayılan olarak TIME_EXTENSION_ACTIVE değerine ayarlanır.

TimeExtension

Temel planın süre uzatılması.

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ın süresini uzatabilir.
TIME_EXTENSION_INACTIVE Zaman uzantısı etkin değil. Kullanıcılar ön ödemeli planlarına para ekleyemez veya planlarının süresini uzatamaz.

RegionalBasePlanConfig

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

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 abonelere sunulup sunulmayacağı. Bu değer false olarak ayarlanırsa mevcut abonelerin abonelikleri iptal edilmez. Belirtilmezse varsayılan olarak false (yanlış) değerini alır.

price

object (Money)

Temel planın belirtilen bölgedeki fiyatıdır. 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 sunacağı 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 sunulacağı yeni konumlarda kullanılacak ABD doları cinsinden fiyat.

eurPrice

object (Money)

Zorunlu. Play'in kullanıma sunulacağı yeni konumlarda kullanılacak avro cinsinden fiyat.

newSubscriberAvailability

boolean

Temel planın Play'in kullanıma sunulabileceği yeni konumlardaki yeni abonelere sunulup sunulmayacağı. Belirtilmezse varsayılan olarak false (yanlış) değerini alır.

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ımlandığı şekilde dili, ör. "en-US".

title

string

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

benefits[]

string

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

Yöntemler

archive
(deprecated)

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

batchGet

Bir veya daha fazla aboneliği okur.

batchUpdate

Abonelik grubunu günceller.

create

Yeni bir abonelik oluşturur.

delete

Bir 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.