REST Resource: monetization.subscriptions

Referensi: Langganan

Satu langganan untuk aplikasi.

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

string

Tidak dapat diubah. Nama paket aplikasi induk.
productId

string

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

object (BasePlan)

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

object (SubscriptionListing)

Wajib. Daftar listingan yang dilokalkan untuk langganan ini. Harus berisi setidaknya entri untuk bahasa default aplikasi induk.
archived
(deprecated)

boolean

Hanya output. Tidak digunakan lagi: pengarsipan langganan tidak didukung.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Detail tentang pajak dan kepatuhan hukum.

BasePlan

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. 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 (-), dan berisi maksimal 63 karakter.
state

enum (State)

Hanya output. Status paket dasar, yaitu apakah paket tersebut aktif. Paket dasar draf dan tidak aktif dapat diaktifkan atau dihapus. Paket dasar aktif dapat dinonaktifkan. Paket dasar yang tidak aktif dapat dibatalkan. Kolom ini tidak dapat diubah dengan memperbarui resource. Gunakan endpoint khusus.
regionalConfigs[]

object (RegionalBasePlanConfig)

Informasi spesifik per wilayah untuk paket dasar ini.
offerTags[]

object (OfferTag)

Daftar hingga 20 tag kustom yang ditentukan untuk paket dasar ini, dan ditampilkan ke aplikasi melalui library penagihan. Penawaran langganan untuk paket dasar ini juga akan menerima tag penawaran ini di library penagihan.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Informasi harga untuk semua lokasi baru yang mungkin diluncurkan oleh Play pada masa mendatang. Jika dihapus, BasePlan tidak akan tersedia secara otomatis untuk lokasi baru yang mungkin diluncurkan oleh Play pada masa mendatang.
Kolom union base_plan_type. Jenis paket dasar ini. Hanya satu yang harus ditetapkan. base_plan_type hanya ada berupa salah satu diantara berikut:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

Tetapkan kapan paket dasar diperpanjang secara otomatis dengan interval yang teratur.
prepaidBasePlanType

object (PrepaidBasePlanType)

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

Negara Bagian

Status paket dasar saat ini.

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

AutoRenewingBasePlanType

Mewakili paket dasar yang otomatis diperpanjang di akhir periode langganannya.

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

string

Wajib. Periode langganan, ditentukan dalam format ISO 8601. Untuk 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.
accountHoldDuration

string

Opsional. Periode penangguhan akun langganan, yang ditentukan dalam format ISO 8601. Nilai yang dapat diterima harus dalam DAYS dan dalam rentang P0D (nol hari) hingga P30D (30 hari). Jika tidak ditentukan, nilai defaultnya adalah P30D (30 hari).
resubscribeState

enum (ResubscribeState)

Apakah pengguna akan dapat berlangganan kembali 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 akan terjadi jika pengguna beralih ke paket ini dari paket dasar lain. Jika tidak ditentukan, setelan defaultnya adalah TAG_ON_NEXT_BILLING_DATE.
legacyCompatible

boolean

Apakah paket dasar yang diperpanjang kompatibel dengan versi lama.

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

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

string

ID penawaran langganan yang kompatibel dengan versi lama.

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

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

Agar tidak memiliki Penawaran langganan sebagai kompatibel dengan versi lama, tetapkan kolom ini sebagai string kosong.

ResubscribeState

Status berlangganan lagi paket dasar.

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

Enum
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Mode belum ditentukan.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Pengguna akan ditagih untuk paket dasar baru di akhir periode penagihan saat ini.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Pengguna akan segera ditagih untuk paket dasar baru mereka secara penuh. Sisa periode langganan yang sudah ada akan digunakan untuk memperpanjang durasi paket penagihan baru.

PrepaidBasePlanType

Mewakili paket dasar yang tidak diperpanjang otomatis pada akhir paket dasar, dan harus diperpanjang secara manual oleh pengguna.

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

string

Wajib. Periode langganan, ditentukan dalam format ISO 8601. Untuk 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. Secara default ke TIME_EXTENSION_ACTIVE jika tidak ditentukan.

TimeExtension

Perpanjangan waktu paket dasar.

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

RegionalBasePlanConfig

Konfigurasi untuk paket dasar khusus untuk suatu wilayah.

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

string

Wajib. Kode wilayah tempat konfigurasi ini berlaku, seperti yang didefinisikan oleh ISO 3166-2, mis. "US".
newSubscriberAvailability

boolean

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

object (Money)

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

OtherRegionsBasePlanConfig

Informasi harga untuk semua lokasi baru yang mungkin akan diluncurkan oleh Play.

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

object (Money)

Wajib. Harga dalam USD yang digunakan untuk semua lokasi baru tempat Google Play mungkin diluncurkan.
eurPrice

object (Money)

Wajib. Harga dalam EUR yang digunakan untuk semua lokasi baru tempat Play mungkin diluncurkan.
newSubscriberAvailability

boolean

Apakah paket dasar tersedia untuk pelanggan baru di lokasi baru tempat Play mungkin diluncurkan. Jika tidak ditentukan, nilai defaultnya adalah salah (false).

SubscriptionListing

Metadata langganan yang terlihat oleh konsumen.

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

string

Wajib. Bahasa listingan ini, seperti yang didefinisikan oleh BCP-47, mis. "en-US".
title

string

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

string

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

string

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

Metode

archive
(deprecated)

 Tidak digunakan lagi: pengarsipan langganan tidak didukung.

batchGet

 Membaca satu atau beberapa langganan.

batchUpdate

 Memperbarui batch langganan.

create

 Membuat langganan baru.

delete

 Menghapus langganan.

get

 Membaca satu langganan.

list

 Mencantumkan semua langganan dalam aplikasi tertentu.

patch

 Memperbarui langganan yang ada.