- Recurso: SubscriptionOffer
- Estado
- SubscriptionOfferPhase
- RegionalSubscriptionOfferPhaseConfig
- RegionalSubscriptionOfferPhaseFreePriceOverride
- OtherRegionsSubscriptionOfferPhaseConfig
- OtherRegionsSubscriptionOfferPhasePrices
- OtherRegionsSubscriptionOfferPhaseFreePriceOverride
- SubscriptionOfferTargeting
- AcquisitionTargetingRule
- TargetingRuleScope
- TargetingRuleScopeThisSubscription
- TargetingRuleScopeAnySubscriptionInApp
- UpgradeTargetingRule
- RegionalSubscriptionOfferConfig
- OtherRegionsSubscriptionOfferConfig
- Métodos
Recurso: SubscriptionOffer
Uma oferta única e temporária
Representação JSON |
---|
{ "packageName": string, "productId": string, "basePlanId": string, "offerId": string, "state": enum ( |
Campos | |
---|---|
packageName |
Obrigatório. Imutável. O nome do pacote do app a que a assinatura principal pertence. |
productId |
Obrigatório. Imutável. O ID da assinatura principal a que a oferta pertence. |
basePlanId |
Obrigatório. Imutável. O ID do plano básico que tem esta oferta como extensão. |
offerId |
Obrigatório. Imutável. ID exclusivo desta oferta de assinatura. Deve ser único no plano básico. |
state |
Apenas saída. O estado atual desta oferta. Pode ser alterado usando as 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[] |
Obrigatório. As fases desta oferta de assinatura. Precisa conter no mínimo uma e no máximo duas entradas. Os usuários sempre vão receber essas fases na ordem especificada. |
targeting |
Os requisitos que os usuários precisam cumprir para se qualificar para a oferta. Representa os requisitos que o Google Play vai avaliar para decidir se uma oferta será retornada. Os desenvolvedores podem filtrar ainda mais essas ofertas. |
regionalConfigs[] |
Obrigatório. A configuração regional específica desta oferta. Precisa conter pelo menos uma entrada. |
otherRegionsConfig |
A configuração de novos locais do Google Play pode ser lançada no futuro. |
offerTags[] |
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 aos 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 ( |
Campos | |
---|---|
recurrenceCount |
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 |
Obrigatório. A duração de uma única recorrência dessa fase. Especificado no formato ISO 8601. |
regionalConfigs[] |
Obrigatório. A configuração específica da região 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 |
Informações sobre preços de todos os novos locais em que o Google Play for 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 |
Campos | |
---|---|
regionCode |
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 |
O preço absoluto que o usuário paga por esta fase da oferta. O preço não pode ser menor do que o mínimo permitido para essa região. |
relativeDiscount |
A fração do preço do plano básico proporcional à duração da fase que o usuário paga por esta fase da oferta. 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 para USD). 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 |
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 de US $12 por um ano, um desconto absoluto de US $1 para uma fase com duração de três meses corresponderia a um preço 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 |
Defina para especificar que esta oferta é sem custo financeiro. |
RegionalSubscriptionOfferPhaseFreePriceOverride
Esse tipo não tem campos.
Representa a configuração de substituição de preço sem custo financeiro para uma única fase de uma oferta de assinatura.
OtherRegionsSubscriptionOfferPhaseConfig
Configuração para todos os novos locais que o Google Play pode lançar em uma única fase de oferta.
Representação JSON |
---|
{ // Union field |
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 |
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 |
A fração do preço do plano básico proporcional à duração da fase que o usuário paga por esta 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 um preço de US $1,50. O desconto precisa ser especificado como uma fração estritamente maior que 0 e menor que 1. 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 se o preço com desconto for menor do que o valor mínimo permitido em qualquer novo local em que o Google Play possa fazer o lançamento. |
absoluteDiscounts |
O valor absoluto subtraído 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 absoluto de US $1 para uma fase com duração de três meses corresponderia a um preço de US $2. O preço resultante não pode ser menor do que o valor mínimo permitido para novos locais em que o Google Play possa fazer o lançamento. |
free |
Defina para especificar que esta oferta é sem custo financeiro. |
OtherRegionsSubscriptionOfferPhasePrices
Informações de preço para qualquer novo local onde o Google Play possa lançar a oferta.
Representação JSON |
---|
{ "usdPrice": { object ( |
Campos | |
---|---|
usdPrice |
Obrigatório. Preço em USD para usar em novos locais em que o Google Play possa ser lançado. |
eurPrice |
Obrigatório. Preço em EUR para usar em novos locais em que o Google Play possa ser lançado. |
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 um usuário precisa cumprir para receber esta oferta.
Representação JSON |
---|
{ // Union field |
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 |
Regra de segmentação de oferta para aquisição de novos usuários. |
upgradeRule |
Regra de segmentação de oferta para atualizar os planos de usuários. |
AcquisitionTargetingRule
Representa uma regra de segmentação no formato: o usuário nunca teve {scope} antes.
Representação JSON |
---|
{
"scope": {
object ( |
Campos | |
---|---|
scope |
Obrigatório. O escopo de assinaturas considerado por esta regra. Permite apenas "esta assinatura" e "qualquer assinatura no app". |
TargetingRuleScope
Define o escopo das assinaturas que uma regra de segmentação pode corresponder para segmentar ofertas a usuários com base em direitos anteriores ou atuais.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união
|
|
thisSubscription |
O escopo da regra de segmentação atual é a assinatura em que esta oferta é definida. |
anySubscriptionInApp |
O escopo da regra de segmentação atual é qualquer assinatura no app principal. |
specificSubscriptionInApp |
O escopo da regra de segmentação atual é a assinatura com o ID de assinatura 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 é definida.
TargetingRuleScopeAnySubscriptionInApp
Esse tipo não tem campos.
Representa o escopo da regra de segmentação correspondente a qualquer assinatura no aplicativo 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 ( |
Campos | |
---|---|
oncePerUser |
O usuário só pode usar esta oferta uma única vez. Se ela for definida como verdadeira, o usuário nunca mais vai se qualificar para a oferta se já tiver assinado a oferta em algum momento. |
scope |
Obrigatório. O escopo das assinaturas consideradas por essa regra. Permite apenas "esta assinatura" e "assinatura específica no app". |
billingPeriodDuration |
A duração específica do período de faturamento, especificada no formato ISO 8601, que um usuário precisa assinar para se qualificar para essa regra. Se não for especificado, será feita a correspondência com os usuários inscritos em qualquer período de faturamento. |
RegionalSubscriptionOfferConfig
Configuração para uma oferta de assinatura em uma única região.
Representação JSON |
---|
{ "regionCode": string, "newSubscriberAvailability": boolean } |
Campos | |
---|---|
regionCode |
Obrigatório. Imutável. Código regional a que essa configuração se aplica, conforme definido pelo ISO 3166-2. Por exemplo, "US". |
newSubscriberAvailability |
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 todos os novos locais em que o Google Play pode ser lançado em uma oferta de assinatura.
Representação JSON |
---|
{ "otherRegionsNewSubscriberAvailability": boolean } |
Campos | |
---|---|
otherRegionsNewSubscriberAvailability |
Indica se a oferta de assinatura em qualquer novo local será lançada no futuro. Se não for especificado, o padrão será "false". |
Métodos |
|
---|---|
|
Ativa uma oferta de assinatura. |
|
Lê uma ou mais ofertas de assinatura. |
|
Atualiza um lote de ofertas de assinatura. |
|
Atualiza um lote de estados da oferta de assinatura. |
|
Cria uma nova oferta de assinatura. |
|
Desativa uma oferta de assinatura. |
|
Exclui uma oferta de assinatura. |
|
Lê uma única oferta. |
|
Lista todas as ofertas de uma determinada assinatura. |
|
Atualiza uma oferta de assinatura existente. |