REST Resource: monetization.subscriptions

Risorsa: sottoscrizione

Un unico 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. È 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 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 nel caso in cui non siano 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.
restrictedPaymentCountries

object (RestrictedPaymentCountries)

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

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)
  },
  "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 ed essere conforme a 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. 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. Usa 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 Fatturazione. Anche le offerte di abbonamento per questo piano base riceveranno questi tag nella Libreria Fatturazione.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Informazioni sui prezzi per eventuali nuove località in cui Google Play potrebbe essere lanciato in futuro. Se omesso, il Base Plan non sarà automaticamente disponibile nelle nuove località in cui Google Play potrebbe essere lanciato in futuro.
Campo unione base_plan_type. Il tipo di questo piano base. Deve essere impostato in modo esatto. base_plan_type può essere solo uno dei seguenti:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

Imposta il momento in cui 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.
installmentsBasePlanType

object (InstallmentsBasePlanType)

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

Stato

Stato attuale di un piano base.

Enum
STATE_UNSPECIFIED Stato non specificato.
DRAFT Al momento il piano base è in stato di bozza e non è stato attivato. A questo punto puoi 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.

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

(Facoltativo) Il periodo di sospensione dell'account dell'abbonamento, specificato nel formato ISO 8601. I valori accettati devono essere in DAYS e compresi tra P0D (zero giorni) e P30D (30 giorni). Se non specificato, il valore predefinito è P30D (30 giorni).
resubscribeState

enum (ResubscribeState)

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

enum (SubscriptionProrationMode)

La modalità di ripartizione 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 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 puoi contrassegnare come compatibile con la versione precedente un solo piano base rinnovato.
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 che si rinnova.

Per non avere un'offerta di abbonamento come 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 rinnovo dell'abbonamento è attivo.
RESUBSCRIBE_STATE_INACTIVE Riabbonati non è attivo.

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 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 alla fine del piano 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 di 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.

InstallmentsBasePlanType

Rappresenta un piano base a rate in cui un utente si impegna a effettuare un numero specifico 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. Periodo di abbonamento, specificato nel formato ISO 8601. Per un elenco dei periodi di fatturazione accettabili, consulta il Centro assistenza.
committedPaymentsCount

integer

Obbligatorio. Il numero di pagamenti a cui l'utente è impegnato.
renewalType

enum (RenewalType)

Obbligatorio. Tipo di rinnovo del piano base delle rate. Determina il comportamento alla fine dell'impegno iniziale.
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

(Facoltativo) Il periodo di sospensione dell'account dell'abbonamento, specificato esclusivamente in giorni e nel formato ISO 8601. I valori accettati sono da P0D (zero giorni) a P30D (30 giorni). Se non specificato, il valore predefinito è P30D (30 giorni).
resubscribeState

enum (ResubscribeState)

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

enum (SubscriptionProrationMode)

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

RenewalType

Tipo di rinnovo del piano base delle rate. Determina il comportamento alla fine dell'impegno iniziale.

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

boolean

Indica se il piano base nella regione specificata è disponibile per i nuovi abbonati. Se questo valore viene impostato su false, gli abbonati esistenti non verranno 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 nuovi abbonati. Deve essere impostata nella valuta collegata alla regione specificata.

OtherRegionsBasePlanConfig

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

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

object (Money)

Obbligatorio. Il prezzo in USD da utilizzare per eventuali nuove località in cui potrebbe essere lanciato Google Play.
eurPrice

object (Money)

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

boolean

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

SubscriptionListing

I metadati visibili per i 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 "it-IT".
title

string

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

string

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

string

La descrizione dell'abbonamento nella lingua di questa 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 viene lasciato vuoto, non vengono applicate limitazioni relative alle località di pagamento.

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

string

Obbligatorio. Codici regionali per i quali imporre restrizioni di pagamento, come definito dallo standard ISO 3166-2, ad esempio "Stati Uniti".

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 una singola sottoscrizione.

list

 Elenca tutti gli abbonamenti di una determinata app.

patch

 Aggiorna un abbonamento esistente.