REST Resource: monetization.subscriptions.basePlans.offers

Recurso: SubscriptionOffer

Uma única oferta temporária.

Representação 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)
    }
  ]
}
Campos
packageName

string

Obrigatório. Imutável. O nome do pacote do app a que a assinatura principal pertence.
productId

string

Obrigatório. Imutável. O ID da assinatura principal a que esta oferta pertence.
basePlanId

string

Obrigatório. Imutável. O ID do plano básico que tem esta oferta como extensão.
offerId

string

Obrigatório. Imutável. ID exclusivo desta oferta de assinatura. Deve ser único no plano básico.
state

enum (State)

Apenas saída. O estado atual desta oferta. Pode ser alterado usando ações Ativar e Desativar. Observação: o estado do plano básico substitui este estado. Logo, talvez não haja uma oferta ativa disponível se o plano básico não estiver ativo.
phases[]

object (SubscriptionOfferPhase)

Obrigatório. As fases desta oferta de assinatura. Precisa conter pelo menos uma e no máximo duas entradas. Os usuários sempre vão receber essas fases na ordem especificada.
targeting

object (SubscriptionOfferTargeting)

Os requisitos que os usuários precisam cumprir para se qualificarem para esta oferta. Representa os requisitos que o Google Play vai avaliar para decidir se uma oferta deve ser retornada. Os desenvolvedores também podem filtrar essas ofertas.
regionalConfigs[]

object (RegionalSubscriptionOfferConfig)

Obrigatório. A configuração regional específica desta oferta. Precisa conter pelo menos uma entrada.
otherRegionsConfig

object (OtherRegionsSubscriptionOfferConfig)

A configuração de novos locais onde o Google Play possa lançar a oferta no futuro.
offerTags[]

object (OfferTag)

Lista de até 20 tags personalizadas especificadas para esta oferta, retornadas ao app pela Biblioteca Faturamento.

Estado

O estado atual da oferta de assinatura.

Enums
STATE_UNSPECIFIED Valor padrão. Nunca deve ser usado.
DRAFT A oferta de assinatura não está e nunca esteve disponível a usuários.
ACTIVE A oferta de assinatura está disponível para usuários novos e atuais.
INACTIVE A oferta de assinatura não está disponível para novos usuários. Os usuários atuais continuam tendo acesso.

SubscriptionOfferPhase

Uma única fase de uma oferta de assinatura.

Representação JSON 
{
  "recurrenceCount": integer,
  "duration": string,
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferPhaseConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferPhaseConfig)
  }
}
Campos
recurrenceCount

integer

Obrigatório. O número de vezes que esta fase se repete. Se esta fase de oferta tiver custos financeiros, cada recorrência cobrará do usuário o preço da fase.
duration

string

Obrigatório. A duração de uma única recorrência desta fase. Especificado no formato ISO 8601.
regionalConfigs[]

object (RegionalSubscriptionOfferPhaseConfig)

Obrigatório. A configuração regional específica desta fase de oferta. Esta lista precisa conter exatamente uma entrada para cada região que tem uma configuração regional para a oferta de assinatura.
otherRegionsConfig

object (OtherRegionsSubscriptionOfferPhaseConfig)

Informações de preço para qualquer novo local onde o Google Play possa lançar a oferta.

RegionalSubscriptionOfferPhaseConfig

Configuração de uma única fase de uma oferta de assinatura em uma única região.

Representação 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.
}
Campos
regionCode

string

Obrigatório. Imutável. A região a que esta configuração se aplica.
Campo de união price_override. A substituição de preço desta fase. Obrigatório. price_override pode ser apenas de um dos tipos a seguir:
price

object (Money)

O preço absoluto que o usuário paga por esta fase de oferta. Não pode ser menor do que o preço mínimo permitido nesta região.
relativeDiscount

number

A fração do preço do plano básico proporcional à duração da fase paga pelo usuário. Por exemplo, se o preço do plano básico para essa região é US $12 por um período de um ano, então um desconto de 50% para uma fase com duração de 3 meses corresponderia a um valor de US $1,50. O desconto precisa ser especificado como uma fração maior que zero e menor que um. O preço resultante será arredondado para a unidade faturável mais próxima (por exemplo, centavos de dólar). O desconto relativo é considerado inválido caso o preço com o desconto acabe sendo menor do que o preço mínimo permitido nesta região.
absoluteDiscount

object (Money)

O valor absoluto subtraído do preço do plano básico, proporcional à duração da fase paga pelo usuário. Por exemplo, se o preço do plano básico para essa região for US $12 por um período de um ano, então um desconto absoluto de US $1,00 para uma fase com duração de 3 meses corresponderia a um valor de US $2. O preço resultante não pode ser menor do que o preço mínimo permitido para a região.
free

object (RegionalSubscriptionOfferPhaseFreePriceOverride)

Defina para especificar que a obtenção desta oferta não tem custos financeiros.

RegionalSubscriptionOfferPhaseFreePriceOverride

Esse tipo não tem campos.

Representa a configuração de substituição de gratuidade para uma única fase de uma oferta de assinatura.

OtherRegionsSubscriptionOfferPhaseConfig

Configuração de uma única fase para qualquer novo local onde o Google Play possa lançar a oferta.

Representação 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.
}
Campos
Campo de união price_override. A substituição de preço desta fase. Obrigatório. price_override pode ser apenas de um dos tipos a seguir:
otherRegionsPrices

object (OtherRegionsSubscriptionOfferPhasePrices)

O preço absoluto que o usuário paga por esta fase de oferta. Não pode ser menor do que o preço mínimo permitido em qualquer novo local onde o Google Play possa lançar a oferta.
relativeDiscount

number

A fração do preço do plano básico proporcional à duração da fase paga pelo usuário. Por exemplo, se o preço do plano básico para essa região é US $12 por um período de um ano, então um desconto de 50% para uma fase com duração de 3 meses corresponderia a um valor de US $1,50. O desconto precisa ser especificado como uma fração maior que zero e menor que um. O preço resultante será arredondado para a unidade faturável mais próxima (por exemplo, centavos de dólar). O desconto relativo é considerado inválido caso o preço com o desconto acabe sendo menor do que o preço mínimo permitido em qualquer nova região onde o Google Play possa lançar a oferta.
absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

O valor absoluto subtraído do preço do plano básico, proporcional à duração da fase paga pelo usuário. Por exemplo, se o preço do plano básico para essa região for US $12 por um período de um ano, então um desconto absoluto de US $1,00 para uma fase com duração de 3 meses corresponderia a um valor de US $2. O preço resultante não pode ser menor do que o preço mínimo permitido para qualquer novo local onde o Google Play possa lançar a oferta.
free

object (OtherRegionsSubscriptionOfferPhaseFreePriceOverride)

Defina para especificar que a obtenção desta oferta não tem custos financeiros.

OtherRegionsSubscriptionOfferPhasePrices

Informações de preço para qualquer novo local onde o Google Play possa lançar a oferta.

Representação JSON 
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  }
}
Campos
usdPrice

object (Money)

Obrigatório. Preço em USD a ser usado em qualquer novo local onde o Google Play possa lançar a oferta.
eurPrice

object (Money)

Obrigatório. Preço em EUR a ser usado em qualquer novo local onde o Google Play possa lançar a oferta.

OtherRegionsSubscriptionOfferPhaseFreePriceOverride

Esse tipo não tem campos.

Representa a configuração de substituição de gratuidade para uma única fase de oferta em qualquer novo local onde o Google Play possa fazer o lançamento.

SubscriptionOfferTargeting

Define a regra que o usuário precisa cumprir para receber esta oferta.

Representação 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.
}
Campos
Campo de união rule. Deixe em branco para qualificação determinada pelo desenvolvedor. rule pode ser apenas de um dos tipos a seguir:
acquisitionRule

object (AcquisitionTargetingRule)

Regra de segmentação de oferta para aquisição de novos usuários.
upgradeRule

object (UpgradeTargetingRule)

Regra de segmentação de oferta para atualizar os planos de usuários.

AcquisitionTargetingRule

Representa uma regra de segmentação neste formato: usuário nunca teve {escopo} antes.

Representação JSON 
{
  "scope": {
    object (TargetingRuleScope)
  }
}
Campos
scope

object (TargetingRuleScope)

Obrigatório. O escopo de assinaturas considerado por esta regra. Permite apenas "esta assinatura" ou "qualquer assinatura no app".

TargetingRuleScope

Define o escopo de assinatura a que uma regra pode corresponder para segmentar ofertas a usuários com base no direito de acesso atual ou anterior.

Representação 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.
}
Campos

Campo de união scope.

scope pode ser apenas de um dos tipos a seguir:
thisSubscription

object (TargetingRuleScopeThisSubscription)

O escopo da regra de segmentação atual é a assinatura em que esta oferta é definida.
anySubscriptionInApp

object (TargetingRuleScopeAnySubscriptionInApp)

O escopo da regra de segmentação atual é qualquer assinatura no app principal.
specificSubscriptionInApp

string

O escopo da regra de segmentação atual é a assinatura com o ID especificado. Precisa estar no mesmo app principal.

TargetingRuleScopeThisSubscription

Esse tipo não tem campos.

Representa o escopo da regra de segmentação correspondente às assinaturas em que esta oferta foi definida.

TargetingRuleScopeAnySubscriptionInApp

Esse tipo não tem campos.

Representa o escopo da regra de segmentação correspondente a qualquer assinatura no app principal.

UpgradeTargetingRule

Representa uma regra de segmentação no formato: o usuário atualmente tem {escopo} [com período de faturamento {período de faturamento}].

Representação JSON 
{
  "oncePerUser": boolean,
  "scope": {
    object (TargetingRuleScope)
  },
  "billingPeriodDuration": string
}
Campos
oncePerUser

boolean

O usuário só pode usar esta oferta uma única vez. Se definido como "true", o usuário nunca mais será qualificado para a oferta se fizer a assinatura.
scope

object (TargetingRuleScope)

Obrigatório. O escopo de assinaturas considerado por esta regra. Permite apenas "esta assinatura" ou "assinatura específica no app".
billingPeriodDuration

string

A duração específica do período de faturamento, no formato ISO 8601, que um usuário precisa estar assinando no momento para ser qualificado para essa regra. Se este campo não for especificado, assinantes de qualquer período de faturamento serão qualificados.

RegionalSubscriptionOfferConfig

Configuração de uma oferta de assinatura em uma única região.

Representação JSON 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean
}
Campos
regionCode

string

Obrigatório. Imutável. Código regional a que essa configuração se aplica, conforme definido pelo ISO 3166-2. Por exemplo, "US".
newSubscriberAvailability

boolean

Se a oferta de assinatura na região especificada está disponível para novos assinantes. Assinantes atuais não terão a assinatura cancelada se este valor for definido como "false". Se não for especificado, o padrão será "false".

OtherRegionsSubscriptionOfferConfig

Configuração para qualquer novo local em que o Google Play possa fazer o lançamento, especificada em uma oferta de assinatura.

Representação JSON 
{
  "otherRegionsNewSubscriberAvailability": boolean
}
Campos
otherRegionsNewSubscriberAvailability

boolean

Se a oferta de assinatura vai estar disponível em qualquer novo local onde o Google Play possa fazer o lançamento no futuro. Se não for especificado, o padrão será "false".

Métodos

activate

 Ativa uma oferta de assinatura.

batchGet

 Lê uma ou mais ofertas de assinatura.

batchUpdate

 Atualiza um lote de ofertas de assinatura.

batchUpdateStates

 Atualiza um lote de estados de oferta de assinatura.

create

 Cria uma nova oferta de assinatura.

deactivate

 Desativa uma oferta de assinatura.

delete

 Exclui uma oferta de assinatura.

get

 Lê uma única oferta.

list

 Lista todas as ofertas em uma determinada assinatura.

patch

 Atualiza uma oferta de assinatura.