REST Resource: monetization.subscriptions.basePlans.offers

Referensi: SubscriptionOffer

Satu penawaran sementara

Representasi JSON
{
  "packageName": string,
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "state": enum (State),
  "phases": [
    {
      object (SubscriptionOfferPhase)
    }
  ],
  "targeting": {
    object (SubscriptionOfferTargeting)
  },
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferConfig)
  },
  "offerTags": [
    {
      object (OfferTag)
    }
  ]
}
Kolom
packageName

string

Wajib. Tidak dapat diubah. Nama paket aplikasi tempat langganan induk berada.

productId

string

Wajib. Tidak dapat diubah. ID langganan induk yang memiliki penawaran ini.

basePlanId

string

Wajib. Tidak dapat diubah. ID paket dasar yang merupakan ekstensi penawaran ini.

offerId

string

Wajib. Tidak dapat diubah. ID unik penawaran langganan ini. Harus unik dalam paket dasar.

state

enum (State)

Hanya output. Status saat ini untuk penawaran ini. Dapat diubah menggunakan tindakan Aktifkan dan Nonaktifkan. Catatan: status paket dasar akan menggantikan status ini, sehingga penawaran aktif mungkin tidak tersedia jika paket dasar tidak aktif.

phases[]

object (SubscriptionOfferPhase)

Wajib. Fase penawaran langganan ini. Harus berisi minimal satu entri dan maksimal lima entri. Pengguna akan selalu menerima semua fase ini dalam urutan yang telah ditentukan. Fase tidak dapat ditambahkan, dihapus, atau disusun ulang setelah pembuatan awal.

targeting

object (SubscriptionOfferTargeting)

Persyaratan yang harus dipenuhi pengguna agar memenuhi syarat untuk penawaran ini. Mewakili persyaratan yang akan dievaluasi Play untuk memutuskan apakah penawaran harus ditampilkan. Developer dapat memfilter sendiri penawaran ini lebih lanjut.

regionalConfigs[]

object (RegionalSubscriptionOfferConfig)

Wajib. Konfigurasi spesifik per wilayah untuk penawaran ini. Harus berisi minimal satu entri.

otherRegionsConfig

object (OtherRegionsSubscriptionOfferConfig)

Konfigurasi untuk setiap lokasi baru yang mungkin diluncurkan Play di masa mendatang.

offerTags[]

object (OfferTag)

Mencantumkan hingga 20 tag kustom yang ditentukan untuk penawaran ini, dan ditampilkan ke aplikasi melalui library penagihan.

Negara Bagian

Status penawaran langganan saat ini.

Enum
STATE_UNSPECIFIED Nilai default, tidak boleh digunakan.
DRAFT Penawaran langganan tidak dan tidak pernah tersedia untuk pengguna.
ACTIVE Penawaran langganan tersedia untuk pengguna baru dan lama.
INACTIVE Penawaran langganan tidak tersedia untuk pengguna baru. Pengguna lama akan tetap memiliki akses.

SubscriptionOfferPhase

Satu fase penawaran langganan.

Representasi JSON
{
  "recurrenceCount": integer,
  "duration": string,
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferPhaseConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferPhaseConfig)
  }
}
Kolom
recurrenceCount

integer

Wajib. Frekuensi fase ini berulang. Jika fase penawaran ini tidak gratis, setiap pengulangan akan menagih pengguna dengan harga fase penawaran ini.

duration

string

Wajib. Durasi pengulangan tunggal fase ini. Ditentukan dalam format ISO 8601.

regionalConfigs[]

object (RegionalSubscriptionOfferPhaseConfig)

Wajib. Konfigurasi spesifik per wilayah dari fase penawaran ini. Daftar ini harus berisi satu entri untuk setiap wilayah yang penawaran langganannya memiliki konfigurasi regional.

otherRegionsConfig

object (OtherRegionsSubscriptionOfferPhaseConfig)

Informasi harga untuk setiap lokasi baru tempat Play mungkin diluncurkan.

RegionalSubscriptionOfferPhaseConfig

Konfigurasi untuk satu fase penawaran langganan di satu wilayah.

Representasi JSON
{
  "regionCode": string,

  // Union field price_override can be only one of the following:
  "price": {
    object (Money)
  },
  "relativeDiscount": number,
  "absoluteDiscount": {
    object (Money)
  },
  "free": {
    object
  }
  // End of list of possible types for union field price_override.
}
Kolom
regionCode

string

Wajib. Tidak dapat diubah. Region tempat konfigurasi ini diterapkan.

Kolom union price_override. Penggantian harga fase ini. Wajib. price_override hanya ada berupa salah satu diantara berikut:
price

object (Money)

Harga mutlak yang dibayarkan pengguna untuk fase penawaran ini. Harga tidak boleh lebih kecil dari harga minimum yang diizinkan untuk wilayah ini.

relativeDiscount

number

Bagian dari harga paket dasar yang diprorata selama durasi fase yang dibayarkan pengguna untuk fase penawaran ini. Misalnya, jika harga paket dasar untuk wilayah ini adalah $12 untuk periode 1 tahun, maka diskon 50% untuk fase durasi 3 bulan akan sesuai dengan harga $1,50. Diskon harus ditentukan sebagai pecahan yang benar-benar lebih besar dari 0 dan benar-benar lebih kecil dari 1. Harga hasil akan dibulatkan ke unit terdekat yang dapat ditagih (mis. sen untuk USD). Diskon relatif dianggap tidak valid jika harga diskon ternyata lebih kecil daripada harga minimum yang diizinkan di wilayah ini.

absoluteDiscount

object (Money)

Jumlah absolut uang yang dikurangi dari harga paket dasar yang diprorata selama durasi fase yang dibayarkan pengguna untuk fase penawaran ini. Misalnya, jika harga paket dasar untuk wilayah ini adalah $12 untuk periode 1 tahun, maka diskon absolut $1 untuk fase durasi 3 bulan akan sesuai dengan harga $2. Harga hasil tidak boleh lebih kecil dari harga minimum yang diizinkan untuk wilayah ini.

free

object

Tetapkan untuk menentukan penawaran ini gratis.

OtherRegionsSubscriptionOfferPhaseConfig

Konfigurasi untuk setiap lokasi baru yang mungkin diluncurkan Play untuk satu fase penawaran.

Representasi JSON
{

  // Union field price_override can be only one of the following:
  "otherRegionsPrices": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "relativeDiscount": number,
  "absoluteDiscounts": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "free": {
    object
  }
  // End of list of possible types for union field price_override.
}
Kolom
Kolom union price_override. Penggantian harga fase ini. Wajib. price_override hanya ada berupa salah satu diantara berikut:
otherRegionsPrices

object (OtherRegionsSubscriptionOfferPhasePrices)

Harga mutlak yang dibayarkan pengguna untuk fase penawaran ini. Harga tidak boleh lebih kecil dari harga minimum yang diizinkan untuk lokasi baru yang boleh diluncurkan Play.

relativeDiscount

number

Bagian dari harga paket dasar yang diprorata selama durasi fase yang dibayarkan pengguna untuk fase penawaran ini. Misalnya, jika harga paket dasar untuk wilayah ini adalah $12 untuk periode 1 tahun, maka diskon 50% untuk fase durasi 3 bulan akan sesuai dengan harga $1,50. Diskon harus ditentukan sebagai pecahan yang benar-benar lebih besar dari 0 dan benar-benar lebih kecil dari 1. Harga hasil akan dibulatkan ke unit terdekat yang dapat ditagih (mis. sen untuk USD). Diskon relatif dianggap tidak valid jika harga diskon ternyata lebih kecil daripada harga minimum yang diizinkan di lokasi baru tempat Play diluncurkan.

absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

Jumlah absolut uang yang dikurangi dari harga paket dasar yang diprorata selama durasi fase yang dibayarkan pengguna untuk fase penawaran ini. Misalnya, jika harga paket dasar untuk wilayah ini adalah $12 untuk periode 1 tahun, maka diskon absolut $1 untuk fase durasi 3 bulan akan sesuai dengan harga $2. Harga yang dihasilkan tidak boleh lebih kecil dari harga minimum yang diizinkan untuk lokasi baru yang boleh diluncurkan Play.

free

object

Tetapkan untuk menentukan penawaran ini gratis.

OtherRegionsSubscriptionOfferPhasePrices

Informasi harga untuk setiap lokasi baru tempat Play mungkin diluncurkan.

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

object (Money)

Wajib. Harga dalam USD yang dapat digunakan untuk semua lokasi baru tempat Play diluncurkan.

eurPrice

object (Money)

Wajib. Harga dalam EUR untuk digunakan di lokasi baru tempat Play diluncurkan.

SubscriptionOfferTargeting

Menentukan aturan yang harus dipenuhi pengguna untuk menerima penawaran ini.

Representasi JSON
{

  // Union field rule can be only one of the following:
  "acquisitionRule": {
    object (AcquisitionTargetingRule)
  },
  "upgradeRule": {
    object (UpgradeTargetingRule)
  }
  // End of list of possible types for union field rule.
}
Kolom
Kolom union rule. Biarkan kosong untuk kelayakan penawaran yang ditentukan developer. rule hanya ada berupa salah satu diantara berikut:
acquisitionRule

object (AcquisitionTargetingRule)

Aturan penargetan penawaran untuk akuisisi pengguna baru.

upgradeRule

object (UpgradeTargetingRule)

Aturan penargetan penawaran untuk mengupgrade paket pengguna yang sudah ada.

AcquisitionTargetingRule

Mewakili aturan penargetan bentuk: Pengguna tidak pernah memiliki {scope} sebelumnya.

Representasi JSON
{
  "scope": {
    object (TargetingRuleScope)
  }
}
Kolom
scope

object (TargetingRuleScope)

Wajib. Cakupan langganan yang dipertimbangkan aturan ini. Hanya izinkan "langganan ini" dan "langganan apa pun dalam aplikasi".

TargetingRuleScope

Menentukan cakupan langganan yang dapat dicocokkan oleh aturan penargetan untuk menargetkan penawaran kepada pengguna berdasarkan hak sebelumnya atau saat ini.

Representasi JSON
{

  // Union field scope can be only one of the following:
  "thisSubscription": {
    object
  },
  "anySubscriptionInApp": {
    object
  },
  "specificSubscriptionInApp": string
  // End of list of possible types for union field scope.
}
Kolom

Kolom union scope.

scope hanya dapat berupa salah satu dari berikut:

thisSubscription

object

Cakupan aturan penargetan saat ini adalah langganan tempat penawaran ini ditentukan.

anySubscriptionInApp

object

Cakupan aturan penargetan saat ini adalah langganan apa pun di aplikasi induk.

specificSubscriptionInApp

string

Cakupan aturan penargetan saat ini adalah langganan dengan ID langganan yang telah ditentukan. Harus berupa langganan dalam aplikasi induk yang sama.

UpgradeTargetingRule

Merepresentasikan aturan penargetan formulir: Pengguna saat ini memiliki {scope} [dengan periode penagihan {billing_period}].

Representasi JSON
{
  "oncePerUser": boolean,
  "scope": {
    object (TargetingRuleScope)
  },
  "billingPeriodDuration": string
}
Kolom
oncePerUser

boolean

Batasi penawaran ini hanya satu kali per pengguna. Jika disetel ke benar (true), pengguna tidak akan dapat lagi memenuhi syarat untuk penawaran ini jika mereka pernah berlangganan penawaran ini.

scope

object (TargetingRuleScope)

Wajib. Cakupan langganan yang dipertimbangkan aturan ini. Hanya izinkan "langganan ini" dan "langganan spesifik dalam aplikasi".

billingPeriodDuration

string

Durasi periode penagihan tertentu, yang ditentukan dalam format ISO 8601, yang saat ini harus diikuti pengguna agar memenuhi syarat untuk aturan ini. Jika tidak ditentukan, pengguna yang berlangganan ke periode penagihan akan dicocokkan.

RegionalSubscriptionOfferConfig

Konfigurasi untuk penawaran langganan di satu wilayah.

Representasi JSON
{
  "regionCode": string,
  "newSubscriberAvailability": boolean
}
Kolom
regionCode

string

Wajib. Tidak dapat diubah. Kode wilayah tempat konfigurasi ini diterapkan, seperti yang didefinisikan oleh ISO 3166-2, mis. "US".

newSubscriberAvailability

boolean

Apakah penawaran langganan di wilayah yang ditentukan tersedia untuk pelanggan baru atau tidak. Langganan yang sudah ada tidak akan dibatalkan jika nilai ini disetel ke false. Jika tidak ditentukan, nilai ini akan ditetapkan secara default ke salah (false).

OtherRegionsSubscriptionOfferConfig

Konfigurasi untuk setiap lokasi baru yang dapat diluncurkan Play sesuai dengan yang ditentukan pada penawaran langganan.

Representasi JSON
{
  "otherRegionsNewSubscriberAvailability": boolean
}
Kolom
otherRegionsNewSubscriberAvailability

boolean

Apakah penawaran langganan di lokasi baru Play mungkin diluncurkan di masa mendatang. Jika tidak ditentukan, nilai ini akan ditetapkan secara default ke salah (false).

Metode

activate

Mengaktifkan penawaran langganan.

batchGet

Membaca satu atau beberapa penawaran langganan.

batchUpdate

Memperbarui sekumpulan penawaran langganan.

batchUpdateStates

Memperbarui batch status penawaran langganan.

create

Membuat penawaran langganan baru.

deactivate

Menonaktifkan penawaran langganan.

delete

Menghapus penawaran langganan.

get

Membaca satu penawaran

list

Mencantumkan semua penawaran dalam langganan yang ditentukan.

patch

Memperbarui penawaran langganan yang sudah ada.