REST Resource: monetization.onetimeproducts.purchaseOptions.offers

Recurso: OneTimeProductOffer

Uma só oferta para um produto único.

Representação JSON 
{
  "packageName": string,
  "productId": string,
  "purchaseOptionId": string,
  "offerId": string,
  "state": enum (State),
  "regionalPricingAndAvailabilityConfigs": [
    {
      object (RegionalPricingAndAvailabilityConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "regionsVersion": {
    object (RegionsVersion)
  },

  // Union field offer_type can be only one of the following:
  "preOrderOffer": {
    object (OneTimeProductPreOrderOffer)
  },
  "discountedOffer": {
    object (OneTimeProductDiscountedOffer)
  }
  // End of list of possible types for union field offer_type.
}
Campos
packageName

string

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

string

Obrigatório. Imutável. O ID do produto principal a que esta oferta pertence.
purchaseOptionId

string

Obrigatório. Imutável. O ID da opção de compra que tem esta oferta como extensão.
offerId

string

Obrigatório. Imutável. O ID desta oferta de produto. Precisa ser exclusivo na opção de compra. Ele precisa começar com um número ou letra minúscula e só pode conter letras minúsculas (a-z), números (0-9) e hifens (-). O tamanho máximo é de 63 caracteres.
state

enum (State)

Apenas saída. O estado atual desta oferta. Este campo não pode ser mudado atualizando o recurso. Em vez disso, use os endpoints dedicados.
regionalPricingAndAvailabilityConfigs[]

object (RegionalPricingAndAvailabilityConfig)

Conjunto de informações sobre preço regional e disponibilidade para esta oferta. Entradas duplicadas com o mesmo regionCode são proibidas.
offerTags[]

object (OfferTag)

Opcional. Uma lista de até 20 tags personalizadas especificadas para esta oferta, retornadas ao app pela Biblioteca Faturamento.
regionsVersion

object (RegionsVersion)

Apenas saída. A versão da configuração de regiões usada para gerar a oferta de produto único.
Campo de união offer_type. O tipo dessa oferta. É necessário definir exatamente um. offer_type pode ser apenas de um dos tipos a seguir:
preOrderOffer

object (OneTimeProductPreOrderOffer)

Uma oferta de compra na pré-venda.
discountedOffer

object (OneTimeProductDiscountedOffer)

Uma oferta com desconto.

Estado

O estado atual da oferta.

Enums
STATE_UNSPECIFIED Valor padrão. Nunca deve ser usado.
DRAFT A oferta não está e nunca esteve disponível a usuários.
ACTIVE A oferta fica disponível para usuários desde que as condições sejam atendidas.
CANCELLED Esse estado é específico à pré-venda. A oferta é cancelada e não está disponível para usuários. Todos os pedidos pendentes relacionados a essa oferta foram cancelados.
INACTIVE Esse estado é específico para ofertas com desconto. A oferta não está mais disponível aos usuários.

OneTimeProductPreOrderOffer

Configuração específica a ofertas de compra na pré-venda.

Representação JSON 
{
  "startTime": string,
  "endTime": string,
  "releaseTime": string,
  "priceChangeBehavior": enum (PreOrderPriceChangeBehavior)
}
Campos
startTime

string (Timestamp format)

Obrigatório. Data e hora em que a pré-venda vai estar disponível.

Usa RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Outros ajustes também são aceitos. Por exemplo, "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30";
endTime

string (Timestamp format)

Obrigatório. Data e hora em que a compra na pré-venda não vai estar mais disponível.

Usa RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Outros ajustes também são aceitos. Por exemplo, "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30";
releaseTime

string (Timestamp format)

Obrigatório. Data e hora em que o produto associado à pré-venda será lançado e os pedidos serão atendidos.

Usa RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Outros ajustes também são aceitos. Por exemplo, "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30";
priceChangeBehavior

enum (PreOrderPriceChangeBehavior)

Obrigatório. Imutável. Especifica como as mudanças de preço afetam as pré-vendas preexistentes.

PreOrderPriceChangeBehavior

Especifica como as mudanças de preço afetam as pré-vendas preexistentes.

Enums
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_UNSPECIFIED Comportamento de mudança de preço não especificado. Não pode ser usado.
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_TWO_POINT_LOWEST O comprador é cobrado o mínimo entre o preço inicial no momento da pré-venda e o preço final da oferta na data de lançamento.
PRE_ORDER_PRICE_CHANGE_BEHAVIOR_NEW_ORDERS_ONLY O comprador recebe o mesmo preço da pré-venda, independente de mudanças que possam ter ocorrido depois.

OneTimeProductDiscountedOffer

Configuração específica para ofertas com desconto.

Representação JSON 
{
  "startTime": string,
  "endTime": string,
  "redemptionLimit": string
}
Campos
startTime

string (Timestamp format)

Data e hora em que a oferta vai estar disponível.

Usa RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Outros ajustes também são aceitos. Por exemplo, "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30";
endTime

string (Timestamp format)

Data e hora em que a oferta não vai estar mais disponível.

Usa RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Outros ajustes também são aceitos. Por exemplo, "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30";
redemptionLimit

string (int64 format)

Opcional. O número de vezes que esta oferta pode ser resgatada. Se não for definido ou for definido como 0, permitirá resgates ilimitados de ofertas. Caso contrário, precisa ser um número entre 1 e 50 (inclusive).

RegionalPricingAndAvailabilityConfig

Configuração de preço regional e disponibilidade para uma oferta de produto único.

Representação JSON 
{
  "regionCode": string,
  "availability": enum (Availability),

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

string

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

enum (Availability)

Obrigatório. A disponibilidade para essa região.
Campo de união price_override. A substituição de preço dessa oferta. É necessário definir exatamente um. price_override pode ser apenas de um dos tipos a seguir:
noOverride

object (OneTimeProductOfferNoPriceOverrideOptions)

O preço definido na opção de compra para essa região será usado.
relativeDiscount

number

A fração do preço da opção de compra que o usuário paga por essa oferta. Por exemplo, se o preço da opção de compra para essa região for US $12, então um desconto de 50% corresponderia a um preço de US $6. O desconto precisa ser especificado como uma fração 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 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 do desconto subtraído do preço da opção de compra.

Ele precisa estar entre 0 e o preço da opção de compra.

OneTimeProductOfferNoPriceOverrideOptions

Esse tipo não tem campos.

Opções para ofertas de produtos únicos sem uma substituição de preço regional.

Disponibilidade

A disponibilidade da oferta.

Enums
AVAILABILITY_UNSPECIFIED Disponibilidade não especificada. Não pode ser usado.
AVAILABLE A oferta está disponível aos usuários.
NO_LONGER_AVAILABLE A oferta não está mais disponível aos usuários. Esse valor só pode ser usado se a disponibilidade tiver sido definida como "AVAILABLE" anteriormente.

Métodos

activate

 Ativa uma oferta de produto único.

batchDelete

 Exclui uma ou mais ofertas de produto único.

batchGet

 Lê uma ou mais ofertas de produto único.

batchUpdate

 Cria ou atualiza uma ou mais ofertas de produto único.

batchUpdateStates

 Atualiza um lote de estados de oferta de produto único.

cancel

 Cancela uma oferta de produto único.

deactivate

 Desativa uma oferta de produto único.

list

 Lista todas as ofertas em um determinado app, produto ou opção de compra.