REST Resource: monetization.subscriptions

Risorsa: Subscription

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

object (BasePlan)

L'insieme di piani base per questo abbonamento. Rappresenta i prezzi e la durata dell'abbonamento se non sono applicabili 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. Ritiro: l'archiviazione degli abbonamenti non è supportata.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Dettagli su tasse e conformità alle normative.
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 alla 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. In altre parole, questo ID può contenere solo lettere minuscole (a-z), numeri (0-9) e trattini (-) e deve 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 disattivati. I piani base inattivi 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 dell'offerta nella raccolta di fatturazione.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Informazioni sui prezzi per le nuove località in cui Play potrebbe essere lanciato in futuro. Se questo attributo viene omesso, il BasePlan non sarà disponibile automaticamente nelle nuove località in cui Play potrebbe essere lanciato in futuro.
Campo unione base_plan_type. Il tipo di piano base. È necessario impostarne esattamente uno. 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 quando il piano base si rinnova automaticamente a intervalli regolari.
prepaidBasePlanType

object (PrepaidBasePlanType)

Impostato quando il Base Plan non si rinnova automaticamente alla fine del periodo di fatturazione.
installmentsBasePlanType

object (InstallmentsBasePlanType)

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

Stato

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 non è attivo ed è disponibile solo per gli abbonati esistenti.

AutoRenewingBasePlanType

Rappresenta un piano base che si rinnova automaticamente alla fine 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. 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 di base.
gracePeriodDuration

string

Periodo di tolleranza dell'abbonamento, specificato in formato ISO 8601. I valori accettabili devono essere in giorni e compresi tra P0D e il valore più basso tra 30 giorni e il periodo di fatturazione del piano base.

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, inclusi.
accountHoldDuration

string

Facoltativo. Periodo di blocco 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, inclusi.
resubscribeState

enum (ResubscribeState)

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

enum (SubscriptionProrationMode)

La modalità di ripartizione 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

Indica se il piano base di 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 può essere contrassegnato come compatibile con le versioni precedenti un solo piano base con rinnovo.
legacyCompatibleSubscriptionOfferId

string

L'ID offerta dell'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 automatico, è possibile contrassegnare come compatibile con le versioni precedenti una sola offerta di abbonamento.

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

ResubscribeState

Stato della riiscrizione al Base Plan.

Enum
RESUBSCRIBE_STATE_UNSPECIFIED Stato non specificato.
RESUBSCRIBE_STATE_ACTIVE La funzionalità Riabbonati è attiva.
RESUBSCRIBE_STATE_INACTIVE La funzionalità di riiscrizione non è attiva.

SubscriptionProrationMode

La modalità di ripartizione 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 L'addebito del nuovo piano base verrà effettuato immediatamente e per intero. Qualsiasi periodo rimanente dell'abbonamento esistente verrà utilizzato per estendere la durata del nuovo piano di fatturazione.

PrepaidBasePlanType

Rappresenta un Base Plan che non si rinnova automaticamente al termine del periodo di abbonamento e deve essere rinnovato manualmente dall'utente.

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

string

Obbligatorio. Immutabile. 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 di base.
timeExtension

enum (TimeExtension)

Indica 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 di tempo non è attiva. Gli utenti non possono ricaricare o estendere il 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. 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 di base.
committedPaymentsCount

integer

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

enum (RenewalType)

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

string

Periodo di tolleranza dell'abbonamento, specificato in formato ISO 8601. I valori accettabili devono essere in giorni e compresi tra P0D e il valore più basso tra 30 giorni e il periodo di fatturazione del piano base.

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, inclusi.
accountHoldDuration

string

Facoltativo. Periodo di blocco 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, inclusi.
resubscribeState

enum (ResubscribeState)

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

enum (SubscriptionProrationMode)

La modalità di ripartizione 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 al termine 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. Il 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. Se questo valore è impostato su false, l'abbonamento degli abbonati esistenti non verrà annullato. Se non viene 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 località 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

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

SubscriptionListing

I metadati di un abbonamento visibili al consumatore.

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 dell'abbonamento nella lingua della 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 della scheda. Lunghezza massima: 80 caratteri. Testo normale.

RestrictedPaymentCountries

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

Rappresentazione JSON 
{
  "regionCodes": [
    string
  ]
}
Campi
regionCodes[]

string

Obbligatorio. Codici regione su cui applicare le limitazioni di pagamento, come definito da ISO 3166-2, ad esempio "US".

Metodi

archive
(deprecated)

 Ritiro: l'archiviazione degli abbonamenti non è supportata.

batchGet

 Legge uno o più abbonamenti.

batchUpdate

 Aggiorna un batch di abbonamenti.

create

 Crea un nuovo abbonamento.

delete

 Consente di eliminare un abbonamento.

get

 Legge un singolo abbonamento.

list

 Elenca tutti gli abbonamenti di una determinata app.

patch

 Aggiorna un abbonamento esistente.