REST Resource: monetization.subscriptions.basePlans.offers

Recurso: SubscriptionOffer

Uma oferta única e 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 ao qual a assinatura pai pertence.
productId

string

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

string

Obrigatório. Imutável. O ID do plano básico de que a oferta é uma extensão.
offerId

string

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

enum (State)

Apenas saída. O estado atual desta oferta. Podem ser alteradas usando as ações "Ativar" e "Desativar". Observação: o estado do plano básico substitui esse estado. Por isso, uma oferta ativa talvez não esteja 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 entrada e pode conter no máximo cinco. Os usuários sempre receberão todas essas fases na ordem especificada. As fases não podem ser adicionadas, removidas ou reordenadas após a criação inicial.
targeting

object (SubscriptionOfferTargeting)

Os requisitos que os usuários precisam atender para se qualificarem para a oferta. Representa os requisitos que o Google Play avalia para decidir se uma oferta deve ser retornada. Os próprios desenvolvedores podem filtrar ainda mais essas ofertas.
regionalConfigs[]

object (RegionalSubscriptionOfferConfig)

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

object (OtherRegionsSubscriptionOfferConfig)

A configuração de todos os novos locais que o Google Play poderá lançar no futuro.
offerTags[]

object (OfferTag)

Lista de até 20 tags personalizadas especificadas para esta oferta e retornadas ao app pela biblioteca de 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 foi disponibilizada para os 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 antigos mantêm o 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 da oferta não for sem custo financeiro, cada recorrência cobrará do usuário o preço desta fase da oferta.
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 específica da região desta fase de oferta. Essa lista precisa conter exatamente uma entrada para cada região onde a oferta de assinatura tem uma configuração regional.
otherRegionsConfig

object (OtherRegionsSubscriptionOfferPhaseConfig)

Informações sobre os preços dos novos locais em que o Google Play poderá ser lançado.

RegionalSubscriptionOfferPhaseConfig

Configuração para 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
  }
  // 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ços 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 pela fase de oferta. O preço não pode ser menor do que o valor mínimo permitido para essa região.
relativeDiscount

number

A fração do preço do plano básico proporcional à duração da fase que o usuário paga pela fase da oferta. Por exemplo, se o preço do plano básico para essa região for de US $12 por um ano, um desconto de 50% para uma fase com duração de três meses corresponderia a US $1,50. O desconto precisa ser especificado como uma fração estritamente maior que 0 e estritamente menor que 1. O preço resultante será arredondado para a unidade faturável mais próxima (por exemplo, centavos para USD). O desconto relativo é considerado inválido se o preço com desconto acabar sendo menor que o preço mínimo permitido na região.
absoluteDiscount

object (Money)

É o valor absoluto de dinheiro subtraído do preço do plano básico proporcionalmente à duração da fase que o usuário paga pela fase da oferta. Por exemplo, se o preço do plano básico para essa região for US $12 por um ano, um desconto absoluto de US $1 para uma fase com duração de três meses corresponderia a US $2. O preço resultante não pode ser menor do que o preço mínimo permitido para essa região.
free

object

Defina para especificar que esta oferta é sem custo financeiro.

OtherRegionsSubscriptionOfferPhaseConfig

Configuração para novos locais que o Google Play pode lançar para uma única fase de 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
  }
  // End of list of possible types for union field price_override.
}
Campos
Campo de união price_override. A substituição de preços 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 pela fase de oferta. O valor não pode ser menor do que o mínimo permitido para todos os novos locais em que o Google Play pode ser lançado.
relativeDiscount

number

A fração do preço do plano básico proporcional à duração da fase que o usuário paga pela fase da oferta. Por exemplo, se o preço do plano básico para essa região for de US $12 por um ano, um desconto de 50% para uma fase com duração de três meses corresponderia a US $1,50. O desconto precisa ser especificado como uma fração estritamente maior que 0 e estritamente menor que 1. O preço resultante será arredondado para a unidade faturável mais próxima (por exemplo, centavos para USD). O desconto relativo será considerado inválido se o preço com desconto for menor que o preço mínimo permitido em novos locais em que o Google Play possa ser lançado.
absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

É o valor absoluto de dinheiro subtraído do preço do plano básico proporcionalmente à duração da fase que o usuário paga pela fase da oferta. Por exemplo, se o preço do plano básico para essa região for US $12 por um ano, um desconto absoluto de US $1 para uma fase com duração de três meses corresponderia a US $2. O preço resultante não pode ser menor do que o mínimo permitido para todos os novos locais em que o Google Play pode ser lançado.
free

object

Defina para especificar que esta oferta é sem custo financeiro.

OtherRegionsSubscriptionOfferPhasePrices

Informações sobre os preços dos novos locais em que o Google Play poderá ser lançado.

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

object (Money)

Obrigatório. Preço em USD para usar em novos locais em que o Google Play for lançado.
eurPrice

object (Money)

Obrigatório. Preço em EUR usado em todos os novos locais em que o Google Play for lançado.

SubscriptionOfferTargeting

Define a regra que um usuário precisa satisfazer para receber a 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 a qualificação da oferta determinada pelo desenvolvedor. rule pode ser apenas de um dos tipos a seguir:
acquisitionRule

object (AcquisitionTargetingRule)

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

object (UpgradeTargetingRule)

Regra de segmentação da oferta para fazer upgrade dos planos atuais dos usuários.

AcquisitionTargetingRule

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

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

object (TargetingRuleScope)

Obrigatório. O escopo das assinaturas que esta regra considera. Só permite "esta assinatura" e "qualquer assinatura no app".

TargetingRuleScope

Define o escopo das assinaturas que uma regra de segmentação pode corresponder para segmentar ofertas para usuários com base no direito anterior ou atual.

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 a oferta é definida.
anySubscriptionInApp

object (TargetingRuleScopeAnySubscriptionInApp)

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

string

O escopo da regra de segmentação atual é a inscrição com o ID de inscrição especificado. Precisa ser uma assinatura 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 está 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 da forma: o usuário tem {scope} [com período de faturamento {billing_period}].

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

boolean

Limite esta oferta a apenas uma vez por usuário. Se definida como verdadeira, um usuário nunca mais se qualificará para a oferta se já se inscreveu nela.
scope

object (TargetingRuleScope)

Obrigatório. O escopo das assinaturas que esta regra considera. Só permite "esta assinatura" e "assinatura específica no app".
billingPeriodDuration

string

A duração específica do período de faturamento, especificada no formato ISO 8601, no qual um usuário precisa estar inscrito para ser qualificado para essa regra. Caso não seja especificado, os usuários inscritos em qualquer período de faturamento serão correspondidos.

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 de região a que essa configuração se aplica, conforme definido pela ISO 3166-2, por exemplo, "US".
newSubscriberAvailability

boolean

Se a oferta na região especificada está disponível para novos assinantes. As assinaturas existentes não serão canceladas se esse valor for definido como "false". Se não for especificado, o padrão será "false".

OtherRegionsSubscriptionOfferConfig

Configuração para novos locais em que o Google Play pode ser lançado em uma oferta de assinatura.

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

boolean

Se a oferta de assinatura em novos locais pode ser lançada 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 de uma determinada assinatura.

patch

 Atualiza uma oferta de assinatura existente.