REST Resource: monetization.subscriptions

Risorsa: sottoscrizione

Un singolo 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 univoco del prodotto. Unici all'interno dell'app principale. 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 di piani base per questo abbonamento. Indica i prezzi e la durata dell'abbonamento se non sono applicabili altre offerte.
listings[]

object (SubscriptionListing)

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

boolean

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

object (SubscriptionTaxAndComplianceSettings)

Dettagli sulle imposte e sulla conformità legale.

BasePlan

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 di questo piano base. Deve essere univoco all'interno dell'abbonamento e deve essere conforme a RFC-1034. In altre parole, questo ID può contenere solo lettere minuscole (a-z), numeri (0-9) e trattini (-) ed essere al massimo di 63 caratteri.
state

enum (State)

Solo output. Lo stato del piano base, ad esempio se è attivo. I piani base in versione bozza e 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. Utilizza invece gli endpoint dedicati.
regionalConfigs[]

object (RegionalBasePlanConfig)

Informazioni specifiche della 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 Fatturazione. Le offerte di abbonamento per questo piano base riceveranno anche i tag dell'offerta nella Libreria Fatturazione.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Informazioni sui prezzi per eventuali nuove località che Google Play potrebbe lanciare in futuro. Se omesso, il BasePlan non sarà disponibile automaticamente nelle nuove località che Google Play potrebbe lanciare in futuro.
Campo di unione base_plan_type. Il tipo di questo piano base. Ne deve essere impostata una sola. base_plan_type può essere solo uno dei seguenti:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

Imposta il momento in cui il piano base viene rinnovato automaticamente a intervalli regolari.
prepaidBasePlanType

object (PrepaidBasePlanType)

Da impostare quando il piano base non viene rinnovato 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 può essere eliminato in sicurezza.
ACTIVE Il piano base è attivo e disponibile per i nuovi abbonati.
INACTIVE Il piano base non è attivo ed è disponibile soltanto 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. 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 in base alla durata del periodo ricorrente.
accountHoldDuration

string

Campo facoltativo. Periodo di sospensione dell'account dell'abbonamento, specificato nel formato ISO 8601. I valori accettati devono essere in DAYS e nell'intervallo da P0D (zero giorni) a P30D (30 giorni). Se non specificato, il valore predefinito è P30D (30 giorni).
resubscribeState

enum (ResubscribeState)

Se gli utenti devono essere in grado di riabbonarsi a questo piano base sulle piattaforme Google Play. Se non specificato, il valore predefinito è REMESSAGE_STATE_ACTIVE.
prorationMode

enum (SubscriptionProrationMode)

La modalità proporzionale del 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 in 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.

È possibile contrassegnare come compatibile con la versione precedente un solo piano base con rinnovo può essere contrassegnato come compatibile con la versione precedente per un determinato abbonamento.
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.

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

Per non avere offerte di abbonamento come compatibili con la versione precedente, imposta questo campo come stringa vuota.

ResubscribeState

Stato del rinnovo abbonamento del piano base.

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

SubscriptionProrationMode

La modalità 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 costo del nuovo piano base verrà addebitato agli utenti al termine del periodo di fatturazione corrente.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Il nuovo piano base verrà addebitato agli utenti immediatamente e per intero. L'eventuale 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 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 sulle 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 di tempo è 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.

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 dallo standard ISO 3166-2, ad esempio "US".
newSubscriberAvailability

boolean

Indica se il piano base nella regione specificata è disponibile per i nuovi abbonati. Se questo valore viene impostato su false, gli abbonamenti esistenti non vengono annullati. 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 eventuali nuove località in cui Google Play potrebbe essere lanciato.

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

object (Money)

obbligatorio. Prezzo in USD da utilizzare per le nuove località in cui Google Play potrebbe essere lanciato.
eurPrice

object (Money)

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

boolean

Se il piano base è disponibile per i nuovi abbonati in qualsiasi nuova località in cui Google 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 dell'abbonamento nella lingua della scheda. Testo normale.
benefits[]

string

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

Metodi

archive
(deprecated)

 Deprecato: l'archiviazione degli abbonamenti non è supportata.

batchGet

 Legge una o più sottoscrizioni.

batchUpdate

 Aggiorna un gruppo di sottoscrizioni.

create

 Crea una nuova sottoscrizione.

delete

 Elimina una sottoscrizione.

get

 Legge un singolo abbonamento.

list

 Elenca tutti gli abbonamenti di una determinata app.

patch

 Consente di aggiornare un abbonamento esistente.