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. Valore 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 e avere una lunghezza compresa tra 1 e 40 caratteri (inclusi).
basePlans[]

object (BasePlan)

L'insieme dei piani base per questo abbonamento. Indica i prezzi e la durata dell'abbonamento nel caso in cui non siano applicate 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

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 trasmesso il flag Archiviato.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Dettagli sulle tasse 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 a RFC-1034. In altre parole, questo ID può contenere solo lettere minuscole (a-z), numeri (0-9) e trattini (-) e 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 resi inattivi. I piani base non attivi possono essere annullati. Non è possibile modificare questo campo aggiornando la risorsa. Utilizza invece gli endpoint dedicati.
regionalConfigs[]

object (RegionalBasePlanConfig)

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

object (OfferTag)

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

object (OtherRegionsBasePlanConfig)

Informazioni sui prezzi delle nuove località in cui Play potrebbe essere lanciata in futuro. Se omesso, l'oggetto BasePlan non sarà automaticamente disponibile per le nuove località che Play potrebbe lanciare in futuro.
Campo di unione base_plan_type. Il tipo di questo piano base. Devi impostarne esattamente una. 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. Puoi eliminarlo in questa fase.
ACTIVE Il piano base è attivo e disponibile per i nuovi abbonati.
INACTIVE Il piano base non è attivo e disponibile solo per gli abbonati esistenti.

Tipo di piano di base con 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 accettabili 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 in base alla 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 per il piano base determina cosa succede quando un utente passa a questo piano da un altro. Se non specificati, il valore predefinito è CHARGE_ON_NEXT_BILLING_DATE.
legacyCompatible

boolean

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

Il piano base compatibile con le versioni precedenti viene restituito dal metodo deprecato 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 dell'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.

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

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

Stato riabbonamento

Stato riabbonamento piano base.

Enum
RESUBSCRIBE_STATE_UNSPECIFIED Stato non specificato.
RESUBSCRIBE_STATE_ACTIVE La riiscrizione è attiva.
RESUBSCRIBE_STATE_INACTIVE La riiscrizione non è attiva.

Modalità di abbonamento

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 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à completamente addebitato agli utenti immediatamente. L'eventuale periodo rimanente del loro 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 tempo

Estensione di tempo del piano base.

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

Configurazione piano base regionale

Configurazione per 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 dalla norma ISO 3166-2, ad esempio "US".
newSubscriberAvailability

boolean

Indica se il piano base nella regione specificata è disponibile per i nuovi abbonati. L'abbonamento degli abbonati esistenti non verrà annullato se viene impostato su falso. 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 all'area geografica specificata.

Altre configurazioni base del piano base per aree geografiche

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

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

object (Money)

Obbligatorio. Prezzo in USD da utilizzare per il lancio di qualsiasi nuova località.
eurPrice

object (Money)

Obbligatorio. Prezzo in euro da utilizzare per il lancio di qualsiasi nuova località in cui potrebbe essere lanciata Google Play.
newSubscriberAvailability

boolean

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

Scheda di iscrizione

I metadati visibili al consumatore 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 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 di questo abbonamento nella lingua di questa scheda. Lunghezza massima: 80 caratteri. Testo normale.

Metodi

archive

 Archivia un abbonamento.

create

 Crea un nuovo abbonamento.

delete

 Elimina una sottoscrizione.

get

 Legge un singolo abbonamento.

list

 Elenca tutti gli abbonamenti di una determinata app.

patch

 Aggiorna un abbonamento esistente.