REST Resource: monetization.subscriptions.basePlans.offers

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

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 do qual a assinatura mãe pertence.
productId

string

Obrigatório. Imutável. É o ID da assinatura mãe a que essa oferta pertence.
basePlanId

string

Obrigatório. Imutável. É o ID do plano básico a que esta 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. Ela pode ser alterada usando ações de ativação e desativação. Observação: o estado do plano básico substitui esse estado, por isso, uma oferta ativa poderá não estar disponível se o plano básico não estiver ativo.
phases[]

object (SubscriptionOfferPhase)

Obrigatório. Fases desta oferta de assinatura. Precisa conter pelo menos uma entrada e pode conter no máximo cinco. Os usuários sempre vão receber todas essas fases na ordem especificada. Não é possível adicionar, remover nem reordenar as fases após a criação inicial.
targeting

object (SubscriptionOfferTargeting)

São os requisitos que os usuários precisam atender para se qualificar para esta oferta. Representa os requisitos que o Google Play avaliará para decidir se uma oferta deve ser retornada. Os 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 talvez seja lançado no futuro.
offerTags[]

object (OfferTag)

apks.list de até 20 tags personalizadas especificadas para esta oferta e voltou ao app por meio da 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 esteve disponível 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 atuais mantêm o acesso.

Fase da oferta de assinatura

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 essa fase é repetida. Se esta fase da oferta não for sem custo financeiro, cada recorrência vai cobrar do usuário o preço dessa fase da oferta.
duration

string

Obrigatório. A duração de uma única recorrência dessa 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)

São informações de preço de todos os novos locais em que o Google Play pode ser lançado.

Configuração de assinatura regional da fase de configuração

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

number

A fração do preço do plano básico proporcional à duração da fase que o usuário paga por essa fase de oferta. Por exemplo, se o preço do plano básico para essa região for R $12 por um ano, então um desconto de 50% para uma fase de três meses vai corresponder a um preço de R $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 acabar sendo menor que o preço mínimo permitido nessa região.
absoluteDiscount

object (Money)

É o valor absoluto subtraído do preço do plano básico proporcional à duração da fase em que o usuário paga pela fase de oferta. Por exemplo, se o preço do plano básico nessa região for de R $12 por um período de um ano, um desconto absoluto de R $1 para uma fase de três meses corresponde a um preço de R $2. O preço resultante não pode ser inferior ao preço mínimo permitido para a região.
free

object

Definir para especificar que esta oferta é sem custo financeiro.

OtherRegionSignatureOfferFaseConfig

Configuração para novos locais em que o Google Play poderá ser lançado em 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ç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 pela fase de oferta. O preço não pode ser inferior ao preço mínimo permitido para novos locais em que o Google Play poderá 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 por essa fase de oferta. Por exemplo, se o preço do plano básico para essa região for R $12 por um ano, então um desconto de 50% para uma fase de três meses vai corresponder a um preço de R $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 acabar sendo menor que o preço mínimo permitido em novos locais em que o Google Play poderá ser lançado.
absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

É o valor absoluto subtraído do preço do plano básico proporcional à duração da fase em que o usuário paga pela fase de oferta. Por exemplo, se o preço do plano básico nessa região for de R $12 por um período de um ano, um desconto absoluto de R $1 para uma fase de três meses corresponde a um preço de R $2. O preço resultante não pode ser inferior ao preço mínimo permitido para novos locais em que o Google Play pode ser lançado.
free

object

Definir para especificar que esta oferta é sem custo financeiro.

OtherRegion Offer manu

São informações de preço de todos os novos locais em que o Google Play pode ser lançado.

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

object (Money)

Obrigatório. O preço é usado em USD para qualquer novo local em que o Google Play possa ser lançado.
eurPrice

object (Money)

Obrigatório. Preço em EUR para uso em novos locais em que o Google Play poderá ser lançado.

Segmentação da oferta de assinatura

Define a regra que um usuário precisa satisfazer 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.

rule pode ser apenas de um dos tipos a seguir:
acquisitionRule

object (AcquisitionTargetingRule)

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

object (UpgradeTargetingRule)

Regra de segmentação de ofertas para fazer upgrade de planos existentes.

Regra de aquisição de segmentação

Representa uma regra de segmentação do formulário: o usuário nunca teve {scope}.

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

object (TargetingRuleScope)

Obrigatório. O escopo das assinaturas consideradas por esta regra. Permite apenas "quo;esta assinatura" e "qualquer assinatura no aplicativo".

Escopo da regra de segmentação

Define o escopo de assinaturas que uma regra de segmentação pode corresponder para segmentar ofertas com base no direito atual ou no passado.

Representação JSON 
{

  // Union field scope can be only one of the following:
  "thisSubscription": {
    object
  },
  "anySubscriptionInApp": {
    object
  },
  "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

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

object

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 de assinatura especificado. É necessário ser uma assinatura no mesmo app pai.

Atualização da regra de segmentação

Representa uma regra de segmentação do formulário: 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

Limitar esta oferta apenas uma vez por usuário. Se for verdadeiro, o usuário não poderá se qualificar para esta oferta novamente se já tiver se inscrito na oferta.
scope

object (TargetingRuleScope)

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

string

É a duração específica do período de faturamento no formato ISO 8601 em que um usuário precisa estar inscrito para se qualificar para esta regra. Se não for especificado, os usuários inscritos em qualquer período de faturamento serão correspondidos.

Assinatura regionalOfertaConfig

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 ao qual esta configuração se aplica, conforme definido pela ISO 3166-2, por exemplo, "quot;US"".
newSubscriberAvailability

boolean

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

OtherRegionSignatureOfferConfig

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

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

boolean

Indica se a oferta de assinatura em novos locais pode ser lançada no futuro. Se não for especificado, o padrão será falso.

Métodos

activate

 Ativa uma 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.