REST Resource: monetization.subscriptions.basePlans.offers

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Recurso: SubscriptionOffer

Una oferta temporal única

Representación 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

Obligatorio. Inmutable. Es el nombre del paquete de la app a la que pertenece la suscripción superior.

productId

string

Obligatorio. Inmutable. Es el ID de la suscripción principal a la que pertenece esta oferta.

basePlanId

string

Obligatorio. Inmutable. Es el ID del plan básico al que pertenece esta oferta.

offerId

string

Obligatorio. Inmutable. ID único de esta oferta de suscripción. Debe ser único dentro del plan básico.

state

enum (State)

Solo salida. El estado actual de esta oferta. Se puede cambiar con las acciones Activar y Desactivar. Nota: El estado del plan básico prevalece sobre este estado, por lo que es posible que no haya una oferta activa si no lo está.

phases[]

object (SubscriptionOfferPhase)

Obligatorio. Las fases de esta oferta de suscripción. Debe contener al menos una entrada y un máximo de cinco. Los usuarios siempre recibirán todas estas fases en el orden especificado. No se pueden agregar, quitar ni reordenar las fases después de su creación inicial.

targeting

object (SubscriptionOfferTargeting)

Los requisitos que los usuarios deben cumplir a fin de ser aptos para esta oferta. Representa los requisitos que evaluará Play para decidir si se debe mostrar una oferta. Los desarrolladores pueden filtrar estas ofertas por su cuenta.

regionalConfigs[]

object (RegionalSubscriptionOfferConfig)

Obligatorio. La configuración específica de la región de esta oferta. Debe contener al menos una entrada.

otherRegionsConfig

object (OtherRegionsSubscriptionOfferConfig)

La configuración de las ubicaciones nuevas que Play pueda lanzar en el futuro.

offerTags[]

object (OfferTag)

apks.list de hasta 20 etiquetas personalizadas especificadas para esta oferta y que se devuelven a la app a través de la biblioteca de facturación.

State

El estado actual de la oferta de suscripción.

Enumeradores
STATE_UNSPECIFIED El valor predeterminado nunca debe usarse.
DRAFT La oferta de suscripción no está disponible para los usuarios y nunca estuvo disponible.
ACTIVE La oferta de suscripción está disponible para usuarios nuevos y existentes.
INACTIVE La oferta de suscripción no está disponible para los usuarios nuevos. Los usuarios existentes conservan el acceso.

Fase de oferta de suscripción

Es una fase única de una oferta de suscripción.

Representación JSON
{
  "recurrenceCount": integer,
  "duration": string,
  "regionalConfigs": [
    {
      object (RegionalSubscriptionOfferPhaseConfig)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsSubscriptionOfferPhaseConfig)
  }
}
Campos
recurrenceCount

integer

Obligatorio. La cantidad de veces que se repite esta fase. Si esta fase de la oferta no es gratuita, cada recurrencia cobra al usuario el precio de esta fase.

duration

string

Obligatorio. Es la duración de una única recurrencia de esta fase. Especificado en formato ISO 8601.

regionalConfigs[]

object (RegionalSubscriptionOfferPhaseConfig)

Obligatorio. La configuración específica de la región de esta fase de la oferta. Esta lista debe contener exactamente una entrada para cada región en la que la oferta de suscripción tiene una configuración regional.

otherRegionsConfig

object (OtherRegionsSubscriptionOfferPhaseConfig)

Información de precios para las nuevas ubicaciones en las que Play pueda lanzar contenido.

Configuración de fase de oferta regional de suscripción

Configuración para una sola fase de una oferta de suscripción en una sola región.

Representación 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

Obligatorio. Inmutable. La región a la que se aplica esta configuración.

Campo de unión price_override. La anulación del precio de esta fase. Obligatorio. Las direcciones (price_override) solo pueden ser una de las siguientes opciones:
price

object (Money)

Es el precio absoluto que el usuario paga en esta fase de la oferta. El precio no debe ser inferior al precio mínimo permitido para esta región.

relativeDiscount

number

Es la fracción del precio del plan básico prorrateado durante el período de fase que el usuario paga por esta fase de la oferta. Por ejemplo, si el precio del plan básico para esta región es de USD 12 durante un período de 1 año, un descuento del 50% para una fase de una duración de 3 meses correspondería a un precio de USD 1.50. El descuento debe especificarse como una fracción mayor que 0 y menor que 1. El precio resultante se redondeará a la unidad facturable más cercana (p.ej., centavos para USD). El descuento relativo se considera no válido si el precio con descuento termina siendo menor que el precio mínimo permitido en esta región.

absoluteDiscount

object (Money)

El monto absoluto de dinero que se restó del precio del plan básico prorrateado durante la duración de la fase que el usuario paga por esta fase de la oferta. Por ejemplo, si el precio del plan básico para esta región es de USD 12 durante un período de 1 año, un descuento absoluto de USD 1 para una fase de 3 meses correspondería a un precio de USD 2. Es posible que el precio resultante no sea menor que el precio mínimo permitido para esta región.

free

object

No se puede obtener la oferta para establecerla.

Otra regiónSuscripciónOfertaFaseConfig

Configuración de las ubicaciones nuevas en las que Play pueda lanzarse para una fase de oferta única.

Representación 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ón price_override. La anulación del precio de esta fase. Obligatorio. Las direcciones (price_override) solo pueden ser una de las siguientes opciones:
otherRegionsPrices

object (OtherRegionsSubscriptionOfferPhasePrices)

Es el precio absoluto que el usuario paga en esta fase de la oferta. El precio no debe ser inferior al precio mínimo permitido para las ubicaciones nuevas en las que Play pueda lanzar contenido.

relativeDiscount

number

Es la fracción del precio del plan básico prorrateado durante el período de fase que el usuario paga por esta fase de la oferta. Por ejemplo, si el precio del plan básico para esta región es de USD 12 durante un período de 1 año, un descuento del 50% para una fase de una duración de 3 meses correspondería a un precio de USD 1.50. El descuento debe especificarse como una fracción mayor que 0 y menor que 1. El precio resultante se redondeará a la unidad facturable más cercana (p.ej., centavos para USD). El descuento relativo se considera no válido si el precio con descuento termina siendo menor que el precio mínimo permitido en las ubicaciones nuevas en las que Play pueda lanzar contenido.

absoluteDiscounts

object (OtherRegionsSubscriptionOfferPhasePrices)

El monto absoluto de dinero que se restó del precio del plan básico prorrateado durante la duración de la fase que el usuario paga por esta fase de la oferta. Por ejemplo, si el precio del plan básico para esta región es de USD 12 durante un período de 1 año, un descuento absoluto de USD 1 para una fase de 3 meses correspondería a un precio de USD 2. El precio resultante no puede ser menor que el precio mínimo permitido para las ubicaciones nuevas en las que Play pueda lanzar contenido.

free

object

No se puede obtener la oferta para establecerla.

Otra regiónSuscripciónOfertaFaseFases

Información de precios para las nuevas ubicaciones en las que Play pueda lanzar contenido.

Representación JSON
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  }
}
Campos
usdPrice

object (Money)

Obligatorio. Precio en USD que se usará para cualquier ubicación nueva en la que Play pueda lanzarse.

eurPrice

object (Money)

Obligatorio. Precio en EUR que se usará para las nuevas ubicaciones en las que Play pueda lanzar contenido.

Orientación de ofertas de suscripción

Define la regla que un usuario debe cumplir para recibir esta oferta.

Representación 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ón rule.

rule puede ser solo una de las siguientes opciones:

acquisitionRule

object (AcquisitionTargetingRule)

Regla de orientación de ofertas para la adquisición de usuarios nuevos.

upgradeRule

object (UpgradeTargetingRule)

Regla de orientación de ofertas para actualizar planes existentes de los usuarios.

Norma de orientación de la adquisición

Representa una regla de orientación con el siguiente formato: El usuario nunca tuvo {scope} antes.

Representación JSON
{
  "scope": {
    object (TargetingRuleScope)
  }
}
Campos
scope

object (TargetingRuleScope)

Obligatorio. El alcance de las suscripciones que considera esta regla. Solo permite "esta suscripción" y "cualquier suscripción en la aplicación".

Ámbito de la regla de orientación

Define el alcance de las suscripciones con las que puede coincidir una regla de segmentación para orientar ofertas a los usuarios según los derechos pasados o actuales.

Representación 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ón scope.

scope puede ser solo una de las siguientes opciones:

thisSubscription

object

El alcance de la regla de orientación actual es la suscripción en la que se define esta oferta.

anySubscriptionInApp

object

El alcance de la regla de segmentación actual es cualquier suscripción en la app superior.

specificSubscriptionInApp

string

El alcance de la regla de orientación actual es la suscripción con el ID de suscripción especificado. Debe ser una suscripción dentro de la misma app principal.

Regla de orientación de la actualización

Representa una regla de orientación con el siguiente formato: El usuario tiene actualmente {scope} [con el período de facturación {billing_period}].

Representación JSON
{
  "oncePerUser": boolean,
  "scope": {
    object (TargetingRuleScope)
  },
  "billingPeriodDuration": string
}
Campos
oncePerUser

boolean

Limita esta oferta a un solo usuario por usuario. Si se establece como verdadera, el usuario nunca podrá volver a ser apto para esta oferta si se suscribe a esta oferta.

scope

object (TargetingRuleScope)

Obligatorio. El alcance de las suscripciones que considera esta regla. Solo permite “esta suscripción” y otra específica en la app.

billingPeriodDuration

string

Es la duración específica del período de facturación, especificada en formato ISO 8601, a la que el usuario debe estar suscrito para ser apto para esta regla. Si no se especifica, se establece la coincidencia con los usuarios suscritos a cualquier período de facturación.

Configuración de la oferta regional de suscripción

Configuración para una oferta de suscripción en una sola región.

Representación JSON
{
  "regionCode": string,
  "newSubscriberAvailability": boolean
}
Campos
regionCode

string

Obligatorio. Inmutable. Código de región al que se aplica esta configuración, según lo define la norma ISO 3166-2, p. ej., "US"

newSubscriberAvailability

boolean

Indica si la oferta de suscripción en la región especificada está disponible para los suscriptores nuevos. La suscripción no se cancelará si el valor se establece como falso. Si no se especifica, el valor predeterminado será “false”.

Otra regiónSubscriptionOfferConfig

Configuración para cualquier ubicación nueva que Play pueda lanzar según lo especificado en una oferta de suscripción.

Representación JSON
{
  "otherRegionsNewSubscriberAvailability": boolean
}
Campos
otherRegionsNewSubscriberAvailability

boolean

Indica si la oferta de suscripción se puede lanzar en cualquier ubicación nueva en el futuro. Si no se especifica, el valor predeterminado será “false”.

Métodos

activate

Activa una oferta de suscripción.

create

Crea una nueva oferta de suscripción.

deactivate

Desactiva la oferta de suscripción.

delete

Borra una oferta de suscripción.

get

Lee una sola oferta

list

Muestra todas las ofertas de una suscripción determinada.

patch

Actualiza una oferta de suscripción existente.