REST Resource: monetization.subscriptions.basePlans.offers

Risorsa: SubscriptionOffer

Una singola offerta temporanea

Rappresentazione JSON
{
  "packageName": string,
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "state": enum (State),
  "phases": [
    {
      object (SubscriptionOfferPhase)
    }
  ],
  "targeting": {
    object (SubscriptionOfferTargeting)
  },
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferConfig)
  },
  "offerTags": [
    {
      object (OfferTag)
    }
  ]
}
Campi
packageName

string

Obbligatorio. Immutabile. Il nome del pacchetto dell'app a cui appartiene l'abbonamento principale.

productId

string

Obbligatorio. Immutabile. L'ID dell'abbonamento principale a cui appartiene questa offerta.

basePlanId

string

Obbligatorio. Immutabile. L'ID del piano base di cui questa offerta è un'estensione.

offerId

string

Obbligatorio. Immutabile. ID univoco di questa offerta di abbonamento. Deve essere univoco all'interno del piano base.

state

enum (State)

Solo output. Lo stato attuale dell'offerta. Può essere modificato utilizzando le azioni Attiva e Disattiva. Nota: lo stato del piano base sostituisce questo stato, pertanto un'offerta attiva potrebbe non essere disponibile se il piano base non è attivo.

phases[]

object (SubscriptionOfferPhase)

Obbligatorio. Le fasi di questa offerta di abbonamento. Deve contenere almeno una e al massimo due voci. Gli utenti riceveranno sempre tutte queste fasi nell'ordine specificato.

targeting

object (SubscriptionOfferTargeting)

I requisiti che gli utenti devono soddisfare per essere idonei a questa offerta. Rappresenta i requisiti che Play valuterà per decidere se restituire un'offerta. Gli sviluppatori possono filtrare ulteriormente queste offerte.

regionalConfigs[]

object (RegionalSubscriptionOfferConfig)

Obbligatorio. La configurazione specifica per la regione di questa offerta. Deve contenere almeno una voce.

otherRegionsConfig

object (OtherRegionsSubscriptionOfferConfig)

La configurazione per eventuali nuove località che Play potrebbe lanciare in futuro.

offerTags[]

object (OfferTag)

Elenco di massimo 20 tag personalizzati specificati per questa offerta e restituiti all'app tramite la libreria di fatturazione.

Stato

Lo stato attuale dell'offerta di abbonamento.

Enum
STATE_UNSPECIFIED Valore predefinito, da non utilizzare mai.
DRAFT L'offerta di abbonamento non è e non è mai stata disponibile per gli utenti.
ACTIVE L'offerta di abbonamento è disponibile per gli utenti nuovi ed esistenti.
INACTIVE L'offerta di abbonamento non è disponibile per i nuovi utenti. Gli utenti esistenti mantengono l'accesso.

SubscriptionOfferPhase

Una singola fase di un'offerta di abbonamento.

Rappresentazione JSON
{
  "recurrenceCount": integer,
  "duration": string,
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferPhaseConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferPhaseConfig)
  }
}
Campi
recurrenceCount

integer

Obbligatorio. Il numero di volte in cui si ripete questa fase. Se questa fase dell'offerta non è senza costi, a ogni ricorrenza all'utente viene addebitato il prezzo di questa fase dell'offerta.

duration

string

Obbligatorio. La durata di una singola occorrenza di questa fase. Specificato nel formato ISO 8601.

regionalConfigs[]

object (RegionalSubscriptionOfferPhaseConfig)

Obbligatorio. La configurazione specifica per la regione di questa fase dell'offerta. Questo elenco deve contenere esattamente una voce per ogni regione per la quale l'offerta di abbonamento ha una configurazione regionale.

otherRegionsConfig

object (OtherRegionsSubscriptionOfferPhaseConfig)

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

RegionalSubscriptionOfferPhaseConfig

Configurazione per una singola fase di un'offerta di abbonamento in una singola regione.

Rappresentazione JSON
{
  "regionCode": string,

  // Union field price_override can be only one of the following:
  "price": {
    object (Money)
  },
  "relativeDiscount": number,
  "absoluteDiscount": {
    object (Money)
  },
  "free": {
    object (RegionalSubscriptionOfferPhaseFreePriceOverride)
  }
  // End of list of possible types for union field price_override.
}
Campi
regionCode

string

Obbligatorio. Immutabile. La regione a cui si applica questa configurazione.

Campo unione price_override. L'override del prezzo di questa fase. Obbligatorio. price_override può essere solo uno dei seguenti:
price

object (Money)

Il prezzo assoluto pagato dall'utente per questa fase dell'offerta. Il prezzo non deve essere inferiore al prezzo minimo consentito per questa regione.

relativeDiscount

number

La frazione del prezzo del piano base ripartita proporzionalmente sulla durata della fase che l'utente paga per questa fase dell'offerta. Ad esempio, se il prezzo del piano base per questa regione è di 12 $per un periodo di 1 anno, uno sconto del 50% per una fase della durata di 3 mesi corrisponderà a un prezzo di 1,50 $. Lo sconto deve essere specificato come frazione strettamente maggiore di 0 e strettamente minore di 1. Il prezzo risultante verrà arrotondato all'unità fatturabile più vicina (ad es. centesimi per USD). Lo sconto relativo è considerato non valido se il prezzo scontato risulta inferiore al prezzo minimo consentito in questa regione.

absoluteDiscount

object (Money)

L'importo assoluto di denaro sottratto al prezzo del piano base ripartito proporzionalmente sulla durata della fase che l'utente paga per questa fase dell'offerta. Ad esempio, se il prezzo del piano base per questa regione è di 12 $per un periodo di 1 anno, uno sconto assoluto di 1 $per una fase di durata di 3 mesi corrisponderà a un prezzo di 2 $. Il prezzo risultante non può essere inferiore al prezzo minimo consentito per questa regione.

free

object (RegionalSubscriptionOfferPhaseFreePriceOverride)

Impostato per specificare che questa offerta è senza costi.

RegionalSubscriptionOfferPhaseFreePriceOverride

Questo tipo non contiene campi.

Rappresenta la configurazione dell'override del prezzo senza costi per una singola fase di un'offerta di abbonamento

OtherRegionsSubscriptionOfferPhaseConfig

Configurazione per le nuove località in cui Google Play potrebbe essere lanciato per una singola fase dell'offerta.

Rappresentazione JSON
{

  // Union field price_override can be only one of the following:
  "otherRegionsPrices": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "relativeDiscount": number,
  "absoluteDiscounts": {
    object (OtherRegionsSubscriptionOfferPhasePrices)
  },
  "free": {
    object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)
  }
  // End of list of possible types for union field price_override.
}
Campi
Campo unione price_override. L'override del prezzo di questa fase. Obbligatorio. price_override può essere solo uno dei seguenti:
otherRegionsPrices

object (OtherRegionsSubscriptionOfferPhasePrices)

Il prezzo assoluto pagato dall'utente per questa fase dell'offerta. Il prezzo non deve essere inferiore al prezzo minimo consentito per le nuove località in cui Play potrebbe essere lanciato.

relativeDiscount

number

La frazione del prezzo del piano base ripartita proporzionalmente sulla durata della fase che l'utente paga per questa fase dell'offerta. Ad esempio, se il prezzo del piano base per questa regione è di 12 $per un periodo di 1 anno, uno sconto del 50% per una fase della durata di 3 mesi corrisponderà a un prezzo di 1,50 $. Lo sconto deve essere specificato come frazione strettamente maggiore di 0 e strettamente minore di 1. Il prezzo risultante verrà arrotondato all'unità fatturabile più vicina (ad es. centesimi per USD). Lo sconto relativo è considerato non valido se il prezzo scontato risulta inferiore al prezzo minimo consentito in qualsiasi nuova località in cui Play potrebbe essere lanciato.

absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

L'importo assoluto di denaro sottratto al prezzo del piano base ripartito proporzionalmente sulla durata della fase che l'utente paga per questa fase dell'offerta. Ad esempio, se il prezzo del piano base per questa regione è di 12 $per un periodo di 1 anno, uno sconto assoluto di 1 $per una fase di durata di 3 mesi corrisponderà a un prezzo di 2 $. Il prezzo risultante non può essere inferiore al prezzo minimo consentito per le nuove località in cui Play potrebbe essere lanciato.

free

object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)

Impostato per specificare che questa offerta è senza costi.

OtherRegionsSubscriptionOfferPhasePrices

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

Rappresentazione JSON
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  }
}
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.

OtherRegionsSubscriptionOfferPhaseFreePriceOverride

Questo tipo non contiene campi.

Rappresenta la configurazione della sostituzione del prezzo senza costi per tutte le nuove località in cui Play potrebbe essere lanciato per una singola fase dell'offerta.

SubscriptionOfferTargeting

Definisce la regola che un utente deve soddisfare per ricevere questa offerta.

Rappresentazione JSON
{

  // Union field rule can be only one of the following:
  "acquisitionRule": {
    object (AcquisitionTargetingRule)
  },
  "upgradeRule": {
    object (UpgradeTargetingRule)
  }
  // End of list of possible types for union field rule.
}
Campi
Campo unione rule. Lascia vuoto per l'idoneità alle offerte stabilita dallo sviluppatore. rule può essere solo uno dei seguenti:
acquisitionRule

object (AcquisitionTargetingRule)

Regola di targeting delle offerte per l'acquisizione di nuovi utenti.

upgradeRule

object (UpgradeTargetingRule)

Regola di targeting dell'offerta per l'upgrade dei piani esistenti degli utenti.

AcquisitionTargetingRule

Rappresenta una regola di targeting del tipo: l'utente non ha mai avuto {scope} prima d'ora.

Rappresentazione JSON
{
  "scope": {
    object (TargetingRuleScope)
  }
}
Campi
scope

object (TargetingRuleScope)

Obbligatorio. L'ambito degli abbonamenti presi in considerazione da questa regola. Consente solo "questo abbonamento" e "qualsiasi abbonamento nell'app".

TargetingRuleScope

Definisce l'ambito degli abbonamenti che una regola di targeting può associare alle offerte di destinazione per gli utenti in base a diritti passati o attuali.

Rappresentazione JSON
{

  // Union field scope can be only one of the following:
  "thisSubscription": {
    object (TargetingRuleScopeThisSubscription)
  },
  "anySubscriptionInApp": {
    object (TargetingRuleScopeAnySubscriptionInApp)
  },
  "specificSubscriptionInApp": string
  // End of list of possible types for union field scope.
}
Campi

Campo unione scope.

scope può essere solo uno dei seguenti:

thisSubscription

object (TargetingRuleScopeThisSubscription)

L'ambito della regola di targeting corrente è l'abbonamento in cui è definita questa offerta.

anySubscriptionInApp

object (TargetingRuleScopeAnySubscriptionInApp)

L'ambito della regola di targeting corrente è qualsiasi abbonamento nell'app principale.

specificSubscriptionInApp

string

L'ambito della regola di targeting corrente è l'abbonamento con l'ID abbonamento specificato. Deve essere un abbonamento all'interno della stessa app principale.

TargetingRuleScopeThisSubscription

Questo tipo non contiene campi.

Rappresenta l'ambito della regola di targeting corrispondente agli abbonamenti in cui è definita questa offerta.

TargetingRuleScopeAnySubscriptionInApp

Questo tipo non contiene campi.

Rappresenta l'ambito della regola di targeting corrispondente a qualsiasi abbonamento nell'app principale.

UpgradeTargetingRule

Rappresenta una regola di targeting del tipo: l'utente ha attualmente {scope} [con periodo di fatturazione {billing_period}].

Rappresentazione JSON
{
  "oncePerUser": boolean,
  "scope": {
    object (TargetingRuleScope)
  },
  "billingPeriodDuration": string
}
Campi
oncePerUser

boolean

Limita questa offerta a una sola volta per utente. Se impostato su true, un utente non potrà mai più usufruire di questa offerta se l'ha già sottoscritta.

scope

object (TargetingRuleScope)

Obbligatorio. L'ambito degli abbonamenti presi in considerazione da questa regola. Consente solo "questa sottoscrizione" e "abbonamento specifico nell'app".

billingPeriodDuration

string

La durata specifica del periodo di fatturazione, specificata in formato ISO 8601, a cui un utente deve essere attualmente abbonato per essere idoneo per questa regola. Se non specificato, vengono trovati corrispondenze per gli utenti abbonati a qualsiasi periodo di fatturazione.

RegionalSubscriptionOfferConfig

Configurazione di un'offerta di abbonamento in un'unica regione.

Rappresentazione JSON
{
  "regionCode": string,
  "newSubscriberAvailability": boolean
}
Campi
regionCode

string

Obbligatorio. Immutabile. Il codice regione a cui si applica questa configurazione, come definito da ISO 3166-2, ad esempio "US".

newSubscriberAvailability

boolean

Indica se l'offerta di abbonamento 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.

OtherRegionsSubscriptionOfferConfig

Configurazione per le nuove località in cui Play potrebbe essere lanciato, specificata in un'offerta di abbonamento.

Rappresentazione JSON
{
  "otherRegionsNewSubscriberAvailability": boolean
}
Campi
otherRegionsNewSubscriberAvailability

boolean

Se l'offerta di abbonamento sarà disponibile in nuove località in cui Google Play potrebbe essere lanciato in futuro. Se non viene specificato, il valore predefinito è false.

Metodi

activate

Attiva un'offerta di abbonamento.

batchGet

Legge una o più offerte di abbonamento.

batchUpdate

Aggiorna un batch di offerte di abbonamento.

batchUpdateStates

Aggiorna un batch di stati delle offerte di abbonamento.

create

Crea una nuova offerta di abbonamento.

deactivate

Disattiva un'offerta di abbonamento.

delete

Consente di eliminare un'offerta di abbonamento.

get

Legge una singola offerta

list

Elenca tutte le offerte di un determinato abbonamento.

patch

Aggiorna un'offerta di abbonamento esistente.