REST Resource: monetization.subscriptions

Resource: Langganan

Satu langganan untuk aplikasi.

Representasi JSON 
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  }
}
Fields
packageName

string

Tidak dapat diubah. Nama paket aplikasi induk.
productId

string

Tidak dapat diubah. ID produk unik untuk produk. Unik dalam aplikasi induk. ID produk harus terdiri dari huruf kecil (a-z), angka (0-9), garis bawah (_), dan titik (.). ID ini harus dimulai dengan huruf kecil atau angka, dan panjangnya antara 1 dan 40 karakter (inklusif).
basePlans[]

object (BasePlan)

Kumpulan paket dasar untuk langganan ini. Merepresentasikan harga dan durasi langganan jika tidak ada penawaran lain yang berlaku.
listings[]

object (SubscriptionListing)

Wajib. apks.list listingan yang dilokalkan untuk langganan ini. Harus berisi minimal entri untuk bahasa default aplikasi induk.
archived

boolean

Hanya output. Apakah langganan ini diarsipkan. Langganan yang diarsipkan tidak lagi tersedia bagi pelanggan mana pun, tidak dapat diperbarui, dan tidak ditampilkan dalam permintaan daftar kecuali jika tanda flag yang diarsipkan diteruskan.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Detail tentang pajak dan kepatuhan hukum.

Paket Dasar

Satu paket dasar untuk langganan.

Representasi JSON 
{
  "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.
}
Kolom
basePlanId

string

Wajib diisi. Tidak dapat diubah. ID unik paket dasar ini. Harus unik dalam langganan dan sesuai dengan RFC-1034. Artinya, ID ini hanya dapat berisi huruf kecil (a-z), angka (0-9), dan tanda hubung (-), serta paling banyak 63 karakter.
state

enum (State)

Hanya output. Status paket dasar, yaitu apakah paket tersebut aktif atau tidak. Draf dan paket dasar yang tidak aktif dapat diaktifkan atau dihapus. Paket dasar yang aktif dapat dinonaktifkan. Paket dasar yang tidak aktif dapat dibatalkan. Kolom ini tidak dapat diubah dengan mengupdate fasilitas. Gunakan endpoint khusus sebagai gantinya.
regionalConfigs[]

object (RegionalBasePlanConfig)

Informasi khusus wilayah untuk paket dasar ini.
offerTags[]

object (OfferTag)

apks.list dengan maksimal 20 tag kustom yang ditentukan untuk paket dasar ini, dan dikembalikan ke aplikasi melalui library penagihan. Penawaran langganan untuk paket dasar ini juga akan menerima tag penawaran ini di koleksi penagihan.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Informasi harga untuk setiap lokasi baru dapat diluncurkan Play di masa mendatang. Jika dihapus, BasePlan tidak akan tersedia secara otomatis untuk lokasi baru yang akan diluncurkan Play di masa mendatang.
Kolom union base_plan_type. Jenis paket dasar ini. Hanya satu yang harus ditetapkan. base_plan_type hanya dapat berupa salah satu dari berikut:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

Tetapkan kapan paket dasar diperpanjang secara otomatis pada interval reguler.
prepaidBasePlanType

object (PrepaidBasePlanType)

Tetapkan saat paket dasar tidak diperpanjang secara otomatis pada akhir periode penagihan.

Negara bagian

Status paket dasar saat ini.

Enumerasi
STATE_UNSPECIFIED Status tidak ditentukan.
DRAFT Paket dasar saat ini dalam status draf, dan belum diaktifkan. Data dapat dihapus dengan aman pada tahap ini.
ACTIVE Paket dasar aktif dan tersedia untuk pelanggan baru.
INACTIVE Paket dasar tidak aktif dan hanya tersedia untuk pelanggan lama.

JenisPaketPerpanjanganOtomatis

Merupakan paket dasar yang diperpanjang secara otomatis pada akhir periode langganannya.

Representasi JSON 
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}
Kolom
billingPeriodDuration

string

Wajib diisi. Periode langganan, ditentukan dalam format ISO 8601. Untuk mengetahui daftar periode penagihan yang dapat diterima, lihat pusat bantuan.
gracePeriodDuration

string

Masa tenggang langganan, yang ditentukan dalam format ISO 8601. Nilai yang dapat diterima adalah P0D (nol hari), P3D (3 hari), P7D (7 hari), P14D (14 hari), dan P30D (30 hari). Jika tidak ditentukan, nilai default akan digunakan berdasarkan durasi periode berulang.
resubscribeState

enum (ResubscribeState)

Apakah pengguna harus dapat berlangganan lagi ke paket dasar ini di platform Google Play. Jika tidak ditentukan, setelan defaultnya adalah RESUBSCRIBE_State_ACTIVE.
prorationMode

enum (SubscriptionProrationMode)

Mode penghitungan prorata untuk paket dasar menentukan apa yang terjadi jika pengguna beralih ke paket dasar ini dari paket dasar lain. Jika tidak ditentukan, setelan defaultnya adalah CHARGE_ON_NEXT_BILLING_DATE.
legacyCompatible

boolean

Apakah paket dasar yang diperpanjang memiliki kompatibilitas mundur.

Paket dasar yang kompatibel dengan versi sebelumnya akan ditampilkan oleh metode Library Layanan Penagihan Google Play querySkuDetailsAsync() yang tidak digunakan lagi.

Hanya satu paket dasar dengan perpanjangan yang dapat ditandai sebagai kompatibel dengan langganan lama untuk langganan tertentu.
legacyCompatibleSubscriptionOfferId

string

ID penawaran langganan yang kompatibel dengan versi lama.

Penawaran langganan yang kompatibel dengan versi sebelumnya akan ditampilkan oleh metode Library Layanan Penagihan Google Play querySkuDetailsAsync() yang tidak digunakan lagi.

Hanya satu penawaran langganan yang dapat ditandai sebagai kompatibel dengan versi lama untuk paket dasar perpanjangan tertentu.

Jika tidak memiliki penawaran Langganan sebagai kompatibel dengan versi lama, tetapkan kolom ini sebagai string kosong.

Status Langganan Ulang

Status berlangganan ulang paket dasar.

Enumerasi
RESUBSCRIBE_STATE_UNSPECIFIED Status tidak ditentukan.
RESUBSCRIBE_STATE_ACTIVE Berlangganan lagi aktif.
RESUBSCRIBE_STATE_INACTIVE Berlangganan lagi tidak aktif.

SubscriptionProrationMode

Mode penghitungan prorata yang digunakan untuk memperpanjang paket dasar.

Enumerasi
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Mode tidak ditentukan.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Pengguna akan ditagih untuk paket dasar baru pada akhir periode penagihan mereka.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Pengguna akan langsung ditagih untuk paket dasar yang baru dan secara penuh. Semua sisa periode langganan yang sudah ada akan digunakan untuk memperpanjang durasi paket penagihan baru.

Jenis PaketPrabayar

Merepresentasikan paket dasar yang tidak diperpanjang secara otomatis di akhir paket dasar, dan harus diperpanjang secara manual oleh pengguna.

Representasi JSON 
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
Kolom
billingPeriodDuration

string

Wajib diisi. Periode langganan, ditentukan dalam format ISO 8601. Untuk mengetahui daftar periode penagihan yang dapat diterima, lihat pusat bantuan.
timeExtension

enum (TimeExtension)

Apakah pengguna harus dapat memperpanjang paket dasar prabayar ini di platform Google Play. Jika tidak ditentukan, setelan defaultnya adalah TIME_EXTENSION_ACTIVE.

Ekstensi Waktu

Ekstensi waktu paket dasar.

Enumerasi
TIME_EXTENSION_UNSPECIFIED Status tidak ditentukan.
TIME_EXTENSION_ACTIVE Ekstensi waktu aktif. Pengguna diizinkan untuk menambah saldo atau memperpanjang paket prabayar mereka.
TIME_EXTENSION_INACTIVE Ekstensi waktu tidak aktif. Pengguna tidak dapat menambah saldo atau memperpanjang paket prabayar mereka.

RegionalBasePlanConfig

Konfigurasi untuk paket dasar khusus untuk wilayah.

Representasi JSON 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}
Kolom
regionCode

string

Wajib diisi. Kode wilayah yang menjadi tujuan konfigurasi ini, seperti yang ditentukan oleh ISO 3166-2, mis. "US".
newSubscriberAvailability

boolean

Apakah paket dasar di wilayah tertentu tersedia untuk pelanggan baru. Langganan yang sudah ada tidak akan dibatalkan jika nilai ini disetel ke salah (false). Jika tidak ditentukan, setelan defaultnya adalah false.
price

object (Money)

Harga paket dasar di wilayah tertentu. Harus ditetapkan jika paket dasar tersedia untuk pelanggan baru. Harus ditetapkan dalam mata uang yang ditautkan ke wilayah yang ditentukan.

OtherRegionsBasePlanConfig

Informasi harga untuk setiap lokasi baru mungkin diluncurkan di Play.

Representasi JSON 
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "newSubscriberAvailability": boolean
}
Kolom
usdPrice

object (Money)

Wajib diisi. Harga dalam USD untuk digunakan di lokasi baru mana pun yang mungkin diluncurkan Play.
eurPrice

object (Money)

Wajib diisi. Harga dalam EUR untuk digunakan di lokasi baru yang mungkin diluncurkan Play.
newSubscriberAvailability

boolean

Untuk menentukan apakah paket dasar tersedia bagi pelanggan baru di lokasi baru atau tidak. Jika tidak ditentukan, setelan defaultnya adalah false.

ListinganLangganan

Metadata langganan yang terlihat oleh konsumen.

Representasi JSON 
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
Kolom
languageCode

string

Wajib diisi. Bahasa listingan ini, seperti yang didefinisikan oleh BCP-47, mis. "id-ID".
title

string

Wajib diisi. Judul langganan ini dalam bahasa listingan ini. Teks biasa.
benefits[]

string

Daftar manfaat yang ditampilkan kepada pengguna di platform seperti Play Store dan di alur pemulihan dalam bahasa listingan ini. Teks biasa. Daftar yang diurutkan maksimal empat manfaat.
description

string

Deskripsi langganan ini dalam bahasa listingan ini. Panjang maksimum - 80 karakter. Teks biasa.

Metode

archive

 Mengarsipkan langganan.

create

 Membuat langganan baru.

delete

 Menghapus langganan.

get

 Membaca satu langganan.

list

 Mencantumkan semua langganan di bawah aplikasi tertentu.

patch

 Memperbarui langganan yang ada.