REST Resource: monetization.subscriptions

Risorsa: Abbonamento

Un singolo abbonamento per un'app.

Rappresentazione JSON 
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  },
  "restrictedPaymentCountries": {
    object (RestrictedPaymentCountries)
  }
}
Campi
packageName

string

Immutabile. Nome del pacchetto dell'app principale.
productId

string

Immutabile. ID prodotto univoco del prodotto. Unico all'interno dell'app genitore. Gli ID prodotto devono essere composti da lettere minuscole (a-z), numeri (0-9), trattini bassi (_) e punti (.). Devono iniziare con una lettera minuscola o un numero e avere una lunghezza compresa tra 1 e 40 caratteri (inclusi).
basePlans[]

object (BasePlan)

L'insieme dei piani base per questo abbonamento. Rappresenta i prezzi e la durata dell'abbonamento se non si applicano altre offerte.
listings[]

object (SubscriptionListing)

Obbligatorio. Elenco delle schede localizzate per questo abbonamento. Deve contenere almeno una voce per la lingua predefinita dell'app principale.
archived
(deprecated)

boolean

Solo output. Ritirato: l'archiviazione degli abbonamenti non è supportata.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Dettagli su tasse e conformità legale.
restrictedPaymentCountries

object (RestrictedPaymentCountries)

(Facoltativo) Paesi in cui l'acquisto di questo abbonamento è limitato ai metodi di pagamento registrati nello stesso paese. Se vuoto, non vengono imposte limitazioni relative alle località di pagamento.

BasePlan

Un singolo piano base per un abbonamento.

Rappresentazione 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)
  },
  "installmentsBasePlanType": {
    object (InstallmentsBasePlanType)
  }
  // End of list of possible types for union field base_plan_type.
}
Campi
basePlanId

string

Obbligatorio. Immutabile. L'identificatore univoco di questo piano base. Deve essere univoco all'interno dell'abbonamento e conforme a RFC-1034. ovvero può contenere solo lettere minuscole (a-z), numeri (0-9) e trattini (-) e avere al massimo 63 caratteri.
state

enum (State)

Solo output. Lo stato del piano base, ovvero se è attivo. I piani base in bozza e inattivi possono essere attivati o eliminati. I piani base attivi possono essere resi inattivi. I piani base non attivi possono essere annullati. Questo campo non può essere modificato aggiornando la risorsa. Utilizza invece gli endpoint dedicati.
regionalConfigs[]

object (RegionalBasePlanConfig)

Informazioni specifiche per regione per questo piano base.
offerTags[]

object (OfferTag)

Elenco di massimo 20 tag personalizzati specificati per questo piano base e restituiti all'app tramite la libreria di fatturazione. Anche le offerte di abbonamento per questo piano base riceveranno questi tag offerta nella libreria di fatturazione.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Informazioni sui prezzi per le nuove località in cui Google Play potrebbe essere lanciato in futuro. Se omesso, il piano base non sarà disponibile automaticamente in nuove località in cui Play potrebbe essere lanciato in futuro.
Campo unione base_plan_type. Il tipo di questo piano base. Deve essere impostato esattamente un valore. Il tipo di piano base è immutabile dopo la creazione del piano base. base_plan_type può essere solo uno dei seguenti:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

Imposta la data di rinnovo automatico del piano base a intervalli regolari.
prepaidBasePlanType

object (PrepaidBasePlanType)

Imposta il momento in cui il Base Plan non si rinnova automaticamente al termine del periodo di fatturazione.
installmentsBasePlanType

object (InstallmentsBasePlanType)

Impostato per i piani base a rate in cui un utente si impegna a effettuare un numero specificato di pagamenti.

Stato

Lo stato attuale di un piano base.

Enum
STATE_UNSPECIFIED Stato non specificato.
DRAFT Il piano base è attualmente in stato di bozza e non è stato attivato. A questo punto può essere eliminato in sicurezza.
ACTIVE Il piano base è attivo e disponibile per i nuovi abbonati.
INACTIVE Il piano base è inattivo e disponibile solo per gli abbonati esistenti.

AutoRenewingBasePlanType

Rappresenta un piano base che si rinnova automaticamente al termine del periodo di abbonamento.

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

string

Obbligatorio. Immutabile. Il periodo di abbonamento, specificato nel formato ISO 8601. Per un elenco dei periodi di fatturazione accettabili, consulta il Centro assistenza. La durata è immutabile dopo la creazione del piano base.
gracePeriodDuration

string

Il periodo di tolleranza dell'abbonamento, specificato nel formato ISO 8601. I valori accettabili devono essere in giorni e compresi tra P0D e il periodo di fatturazione del piano base, che deve essere inferiore o uguale a 30 giorni.

Se non specificato, verrà utilizzato un valore predefinito in base al periodo di fatturazione.

La somma di gracePeriodDuration e accountHoldDuration deve essere compresa tra P30D e P60D giorni, inclusi.
accountHoldDuration

string

(Facoltativo) Il periodo di sospensione dell'account dell'abbonamento, specificato nel formato ISO 8601. I valori accettabili devono essere in giorni e compresi tra P0D e P60D.

Se non specificato, il valore predefinito è P30D.

La somma di gracePeriodDuration e accountHoldDuration deve essere compresa tra P30D e P60D giorni, inclusi.
resubscribeState

enum (ResubscribeState)

Se gli utenti devono essere in grado di abbonarsi nuovamente a questo piano base nelle piattaforme Google Play. Se non specificato, il valore predefinito è RESUBSCRIBE_STATE_ACTIVE.
prorationMode

enum (SubscriptionProrationMode)

La modalità di ripartizione proporzionale per il piano base determina cosa succede quando un utente passa a questo piano da un altro piano base. Se non specificato, il valore predefinito è CHARGE_ON_NEXT_BILLING_DATE.
legacyCompatible

boolean

Se il piano base con rinnovo è compatibile con le versioni precedenti.

Il piano base compatibile con le versioni precedenti viene restituito dal metodo deprecato querySkuDetailsAsync() della Libreria Fatturazione Google Play.

Per un determinato abbonamento è possibile contrassegnare come compatibile con le versioni precedenti un solo piano base con rinnovo.
legacyCompatibleSubscriptionOfferId

string

ID offerta di abbonamento compatibile con la versione precedente.

L'offerta di abbonamento compatibile con le versioni precedenti viene restituita dal metodo deprecato querySkuDetailsAsync() della Libreria Fatturazione Google Play.

Per un determinato piano base con rinnovo, è possibile contrassegnare una sola offerta di abbonamento come compatibile con le versioni precedenti.

Per non avere un'offerta di abbonamento compatibile con la versione precedente, imposta questo campo come stringa vuota.

ResubscribeState

Stato di riabbonamento al piano base.

Enum
RESUBSCRIBE_STATE_UNSPECIFIED Stato non specificato.
RESUBSCRIBE_STATE_ACTIVE Il riabbonamento è attivo.
RESUBSCRIBE_STATE_INACTIVE La riattivazione dell'abbonamento non è attiva.

SubscriptionProrationMode

La modalità di ripartizione proporzionale utilizzata per il rinnovo dei piani base.

Enum
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Modalità non specificata.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Il nuovo piano base verrà addebitato agli utenti alla fine del periodo di fatturazione corrente.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Agli utenti verrà addebitato immediatamente l'intero importo del nuovo piano base. Il periodo rimanente dell'abbonamento esistente verrà utilizzato per estendere la durata del nuovo piano di fatturazione.

PrepaidBasePlanType

Rappresenta un piano base che non si rinnova automaticamente al termine del periodo e deve essere rinnovato manualmente dall'utente.

Rappresentazione JSON 
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
Campi
billingPeriodDuration

string

Obbligatorio. Immutabile. Il periodo di abbonamento, specificato nel formato ISO 8601. Per un elenco dei periodi di fatturazione accettabili, consulta il Centro assistenza. La durata è immutabile dopo la creazione del piano base.
timeExtension

enum (TimeExtension)

Se gli utenti devono essere in grado di estendere questo piano base prepagato nelle piattaforme Google Play. Se non specificato, il valore predefinito è TIME_EXTENSION_ACTIVE.

TimeExtension

Estensione del tempo del piano base.

Enum
TIME_EXTENSION_UNSPECIFIED Stato non specificato.
TIME_EXTENSION_ACTIVE L'estensione del tempo è attiva. Gli utenti possono ricaricare o estendere il proprio piano prepagato.
TIME_EXTENSION_INACTIVE L'estensione del tempo non è attiva. Gli utenti non possono ricaricare o estendere il proprio piano prepagato.

InstallmentsBasePlanType

Rappresenta un piano base a rate in cui un utente si impegna a effettuare un numero specificato di pagamenti.

Rappresentazione JSON 
{
  "billingPeriodDuration": string,
  "committedPaymentsCount": integer,
  "renewalType": enum (RenewalType),
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode)
}
Campi
billingPeriodDuration

string

Obbligatorio. Immutabile. Il periodo di abbonamento, specificato nel formato ISO 8601. Per un elenco dei periodi di fatturazione accettabili, consulta il Centro assistenza. La durata è immutabile dopo la creazione del piano base.
committedPaymentsCount

integer

Obbligatorio. Immutabile. Il numero di pagamenti a cui l'utente si è impegnato. È immutabile dopo la creazione del piano base.
renewalType

enum (RenewalType)

Obbligatorio. Immutabile. Tipo di rinnovo del piano base a rate. Determina il comportamento alla fine dell'impegno iniziale. Il tipo di rinnovo è immutabile dopo la creazione del piano base.
gracePeriodDuration

string

Il periodo di tolleranza dell'abbonamento, specificato nel formato ISO 8601. I valori accettabili devono essere in giorni e compresi tra P0D e il periodo di fatturazione del piano base, che deve essere inferiore o uguale a 30 giorni.

Se non specificato, verrà utilizzato un valore predefinito in base al periodo di fatturazione.

La somma di gracePeriodDuration e accountHoldDuration deve essere compresa tra P30D e P60D giorni, inclusi.
accountHoldDuration

string

(Facoltativo) Il periodo di sospensione dell'account dell'abbonamento, specificato nel formato ISO 8601. I valori accettabili devono essere in giorni e compresi tra P0D e P60D.

Se non specificato, il valore predefinito è P30D.

La somma di gracePeriodDuration e accountHoldDuration deve essere compresa tra P30D e P60D giorni, inclusi.
resubscribeState

enum (ResubscribeState)

Se gli utenti devono essere in grado di abbonarsi nuovamente a questo piano base nelle piattaforme Google Play. Se non specificato, il valore predefinito è RESUBSCRIBE_STATE_ACTIVE.
prorationMode

enum (SubscriptionProrationMode)

La modalità di ripartizione proporzionale per il piano base determina cosa succede quando un utente passa a questo piano da un altro piano base. Se non specificato, il valore predefinito è CHARGE_ON_NEXT_BILLING_DATE.

RenewalType

Tipo di rinnovo del piano base a rate. Determina il comportamento alla fine dell'impegno iniziale. Il tipo di rinnovo è immutabile dopo la creazione del piano base.

Enum
RENEWAL_TYPE_UNSPECIFIED Stato non specificato.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT Si rinnova periodicamente per la durata del periodo di fatturazione senza impegno.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT Si rinnova con l'impegno della stessa durata di quello iniziale.

RegionalBasePlanConfig

Configurazione di un piano base specifico per una regione.

Rappresentazione JSON 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}
Campi
regionCode

string

Obbligatorio. Codice regione a cui si applica questa configurazione, come definito da ISO 3166-2, ad esempio "US".
newSubscriberAvailability

boolean

Indica se il piano base nella regione specificata è disponibile per i nuovi abbonati. Gli abbonati esistenti non vedranno annullato il proprio abbonamento se questo valore è impostato su false. Se non specificato, il valore predefinito è false.
price

object (Money)

Il prezzo del piano base nella regione specificata. Deve essere impostato se il piano base è disponibile per i nuovi abbonati. Deve essere impostato nella valuta collegata alla regione specificata.

OtherRegionsBasePlanConfig

Informazioni sui prezzi per le nuove località in cui Play potrebbe essere lanciato.

Rappresentazione JSON 
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "newSubscriberAvailability": boolean
}
Campi
usdPrice

object (Money)

Obbligatorio. Prezzo in dollari statunitensi da utilizzare per le nuove sedi in cui Play potrebbe essere lanciato.
eurPrice

object (Money)

Obbligatorio. Prezzo in euro da utilizzare per le nuove località in cui Play potrebbe essere lanciato.
newSubscriberAvailability

boolean

Se il piano base è disponibile per i nuovi abbonati in nuove località in cui Play potrebbe essere lanciato. Se non specificato, il valore predefinito è false.

SubscriptionListing

I metadati visibili ai consumatori di un abbonamento.

Rappresentazione JSON 
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
Campi
languageCode

string

Obbligatorio. La lingua di questa scheda, come definita da BCP-47, ad esempio "en-US".
title

string

Obbligatorio. Il titolo di questo abbonamento nella lingua di questa scheda. Testo normale.
benefits[]

string

Un elenco di vantaggi mostrati all'utente su piattaforme come il Play Store e nei flussi di ripristino nella lingua di questa scheda. Testo normale. Elenco ordinato di massimo quattro vantaggi.
description

string

La descrizione di questo abbonamento nella lingua di questa scheda. Lunghezza massima: 80 caratteri. Testo normale.

Metodi

archive
(deprecated)

 Ritirato: l'archiviazione degli abbonamenti non è supportata.

batchGet

 Legge uno o più abbonamenti.

batchUpdate

 Aggiorna un batch di abbonamenti.

create

 Crea un nuovo abbonamento.

delete

 Elimina un abbonamento.

get

 Legge un singolo abbonamento.

list

 Elenca tutti gli abbonamenti per una determinata app.

patch

 Aggiorna un abbonamento esistente.