REST Resource: monetization.subscriptions

Risorsa: abbonamento

Un unico abbonamento per un'app.

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

string

Immutabile. Nome del pacchetto dell'app principale.
productId

string

Immutabile. ID prodotto univoco del prodotto. È univoco 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 o un numero minuscolo e può 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 nel caso in cui non si applichino altre offerte.
listings[]

object (SubscriptionListing)

Obbligatorio. apk.list di schede localizzate per questo abbonamento. Deve contenere almeno una voce per la lingua predefinita dell'app principale.
archived

boolean

Solo output. Indica se l'abbonamento è archiviato. Le iscrizioni archiviate non sono più disponibili per nessun abbonato, non possono essere aggiornate e non vengono restituite nelle richieste di elenco a meno che non venga passato il flag Archiviato del programma.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Dettagli sulle imposte e sulla conformità legale.

Piano base

Un unico 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)
  }
  // End of list of possible types for union field base_plan_type.
}
Campi
basePlanId

string

Obbligatorio. Immutabile. L'identificatore univoco del piano base. Deve essere univoco all'interno dell'abbonamento ed essere conforme alla specifica RFC-1034. Ciò significa che questo ID può contenere solo lettere minuscole (a-z), numeri (0-9) e trattini (-) e può contenere al massimo 63 caratteri.
state

enum (State)

Solo output. Lo stato del piano base, ad esempio se è attivo. Le bozze e i piani base inattivi possono essere attivati o eliminati. I piani base attivi possono essere disattivati. I piani base non attivi possono essere annullati. Questo campo non può essere modificato aggiornando la risorsa. Usa invece gli endpoint dedicati.
regionalConfigs[]

object (RegionalBasePlanConfig)

Informazioni specifiche per area geografica per questo piano base.
offerTags[]

object (OfferTag)

apk.list di un massimo di 20 tag personalizzati specificati per questo piano base e restituiti all'app tramite la libreria di fatturazione. Le offerte di abbonamento per questo piano base riceveranno anche questi tag offerta nella Libreria Fatturazione.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Informazioni sui prezzi relative a qualsiasi nuova località in cui Play potrebbe essere lanciata in futuro. Se omesso, il piano base non sarà automaticamente disponibile per le nuove località che Play potrebbe lanciare in futuro.
Campo unione base_plan_type. Il tipo di questo piano base. Deve essere impostata una sola. 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)

Imposta quando il piano base non si rinnova automaticamente alla fine del periodo di fatturazione.

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 potrai eliminarlo 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.

Tipo di piano base rinnovo automatico

Rappresenta un piano base che si rinnova automaticamente alla fine del periodo di abbonamento.

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

string

Obbligatorio. Periodo di abbonamento, specificato nel formato ISO 8601. Per un elenco dei periodi di fatturazione accettabili, consulta il Centro assistenza.
gracePeriodDuration

string

Periodo di tolleranza dell'abbonamento, specificato nel formato ISO 8601. I valori accettati sono P0D (zero giorni), P3D (3 giorni), P7D (7 giorni), P14D (14 giorni) e P30D (30 giorni). Se non specificato, verrà utilizzato un valore predefinito basato sulla durata del periodo ricorrente.
resubscribeState

enum (ResubscribeState)

Indica se gli utenti devono essere in grado di riabbonarsi 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 al piano base determina cosa succede quando un utente passa a questo piano da un altro. Se non viene specificato un valore, viene utilizzato il valore predefinito CHARGE_ON_NEXT_BILLING_DATE.
legacyCompatible

boolean

Indica se il piano base rinnovato è compatibile con le versioni precedenti.

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

È possibile contrassegnare un solo piano base con rinnovo come compatibile con la versione precedente per un determinato abbonamento.
legacyCompatibleSubscriptionOfferId

string

ID offerta di abbonamento compatibile con la versione precedente.

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

È possibile contrassegnare una sola offerta di abbonamento come compatibile con la versione precedente per un determinato piano base con rinnovo.

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

Stato riabbonamento

Stato di riabbonamento del piano base.

Enums
RESUBSCRIBE_STATE_UNSPECIFIED Stato non specificato.
RESUBSCRIBE_STATE_ACTIVE Riabbonarsi è attivo.
RESUBSCRIBE_STATE_INACTIVE La nuova iscrizione non è attiva.

Modalità di abbonamento

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

Enum
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Modalità non specificata.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Il costo del nuovo piano base verrà addebitato agli utenti al termine del periodo di fatturazione corrente.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Il costo del nuovo piano base verrà addebitato agli utenti immediatamente e completamente. L'eventuale periodo rimanente del relativo abbonamento esistente verrà utilizzato per estendere la durata del nuovo piano di fatturazione.

Tipo di piano base prepagato

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

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

string

Obbligatorio. Periodo di abbonamento, specificato nel formato ISO 8601. Per un elenco dei periodi di fatturazione accettabili, consulta il Centro assistenza.
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.

Estensione temporale

Estensione di tempo del piano base.

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

Configurazione base piano base regione

Configurazione per 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 "quot&US".
newSubscriberAvailability

boolean

Indica se il piano base nell'area geografica specificata è disponibile per i nuovi abbonati. L'abbonamento agli abbonati esistenti non verrà annullato 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 impostata nella valuta collegata all'area geografica specificata.

AltreregioniBasePlanConfig

Informazioni sui prezzi relative alle nuove località in cui potrebbe essere lanciata Play.

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

object (Money)

Obbligatorio. Prezzo in USD da utilizzare per qualsiasi nuova località in cui potrebbe essere lanciato Play.
eurPrice

object (Money)

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

boolean

Indica se il piano base è disponibile per i nuovi abbonati in qualsiasi nuova località in cui sia possibile lanciare Play. Se non specificato, il valore predefinito è false.

Abbonamento

I metadati visibili all'utente 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 "quotidiano".
title

string

Obbligatorio. Il titolo dell'abbonamento nella lingua della scheda. Testo normale.
benefits[]

string

Un elenco dei vantaggi mostrati all'utente sulle 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 dell'abbonamento nella lingua di questa scheda. Lunghezza massima: 80 caratteri. Testo normale.

Metodi

archive

 Archivia un abbonamento.

create

 Crea un nuovo abbonamento.

delete

 Elimina un abbonamento.

get

 Legge un singolo abbonamento.

list

 Elenca tutti gli abbonamenti di una determinata app.

patch

 Aggiorna un abbonamento esistente.