- Recurso: Suscripción
- BasePlan
- Estado
- AutoRenewingBasePlanType
- ResubscribeState
- SubscriptionProrationMode
- PrepaidBasePlanType
- TimeExtension
- InstallmentsBasePlanType
- RenewalType
- RegionalBasePlanConfig
- OtherRegionsBasePlanConfig
- SubscriptionListing
- RestrictedPaymentCountries
- Métodos
Recurso: Suscripción
Una sola suscripción para una app.
Representación JSON |
---|
{ "packageName": string, "productId": string, "basePlans": [ { object ( |
Campos | |
---|---|
packageName |
Inmutable. Nombre del paquete de la app superior. |
productId |
Inmutable. Es el ID único del producto. Son únicos en la app principal. Los ID de producto deben incluir letras minúsculas (a-z), números (0-9), guiones bajos (_) y puntos (.). Debe comenzar con una letra o un número en minúscula y tener entre 1 y 40 caracteres (inclusive). |
basePlans[] |
Es el conjunto de planes básicos de esta suscripción. Representa los precios y la duración de la suscripción si no se aplican otras ofertas. |
listings[] |
Obligatorio. Lista de fichas localizadas para esta suscripción. Debe contener al menos una entrada para el idioma predeterminado de la app principal. |
archived |
Solo salida. Obsoleto: no se admite el archivado de suscripciones. |
taxAndComplianceSettings |
Detalles sobre impuestos y cumplimiento legal. |
restrictedPaymentCountries |
Opcional. Países donde la compra de esta suscripción está restringida a las formas de pago registradas en el mismo país. Si este campo está vacío, no se imponen restricciones por ubicación de pago. |
BasePlan
Un solo plan básico para una suscripción.
Representación JSON |
---|
{ "basePlanId": string, "state": enum ( |
Campos | |
---|---|
basePlanId |
Obligatorio. Inmutable. Es el identificador único de este plan básico. Debe ser único dentro de la suscripción y cumplir con el estándar RFC-1034. Es decir, este ID solo puede contener letras minúsculas (a-z), números (0-9) y guiones (-), y tener como máximo 63 caracteres. |
state |
Solo salida. El estado del plan básico, es decir, si está activo Los planes básicos inactivos y en borrador se pueden activar o borrar. Los planes básicos activos se pueden inhabilitar. Los planes básicos inactivos se pueden cancelar. Este campo no se puede cambiar mediante la actualización del recurso. En su lugar, usa los extremos dedicados. |
regionalConfigs[] |
Información específica de la región para este plan básico. |
offerTags[] |
Lista de hasta 20 etiquetas personalizadas especificadas para este plan básico y devueltas a la app a través de la biblioteca de facturación. Las ofertas de suscripción para este plan básico también recibirán estas etiquetas de oferta en la biblioteca de facturación. |
otherRegionsConfig |
Información de precios para nuevas ubicaciones que Play pueda lanzar en el futuro Si se omite, el Plan básico no estará disponible automáticamente en ninguna ubicación nueva que Play pueda lanzar en el futuro. |
Campo de unión base_plan_type . Es el tipo de este plan básico. Se debe establecer exactamente uno. Las direcciones (base_plan_type ) solo pueden ser una de las siguientes opciones: |
|
autoRenewingBasePlanType |
Establece cuándo se renueva automáticamente el plan básico a intervalos regulares. |
prepaidBasePlanType |
Se establece cuando el plan básico no se renueva automáticamente al final del período de facturación. |
installmentsBasePlanType |
Se establece para los planes básicos en cuotas en los que un usuario se compromete a realizar una cantidad específica de pagos. |
Estado
Estado actual de un plan básico.
Enumeradores | |
---|---|
STATE_UNSPECIFIED |
Estado sin especificar. |
DRAFT |
Actualmente, el plan básico se encuentra en estado de borrador y no está activado. En este momento, se puede borrar de forma segura. |
ACTIVE |
El plan básico está activo y disponible para suscriptores nuevos. |
INACTIVE |
El plan básico está inactivo y solo está disponible para los suscriptores existentes. |
AutoRenewingBasePlanType
Representa un plan básico que se renueva automáticamente al final de su período de suscripción.
Representación JSON |
---|
{ "billingPeriodDuration": string, "gracePeriodDuration": string, "accountHoldDuration": string, "resubscribeState": enum ( |
Campos | |
---|---|
billingPeriodDuration |
Obligatorio. Es el período de suscripción especificado en formato ISO 8601. Para obtener una lista de los períodos de facturación aceptables, consulta el Centro de ayuda. |
gracePeriodDuration |
Es el período de gracia de la suscripción, especificado en formato ISO 8601. Los valores aceptables son P0D (cero días), P3D (3 días), P7D (7 días), P14D (14 días) y P30D (30 días). Si no se especifica, se usará un valor predeterminado en función de la duración del período recurrente. |
accountHoldDuration |
Opcional. Período de suspensión de la cuenta de la suscripción, especificado en formato ISO 8601. Los valores aceptables deben expresarse en DÍAS y encontrarse en el rango de P0D (cero días) a P30D (30 días). Si no se especifica, el valor predeterminado es P30D (30 días). |
resubscribeState |
Si los usuarios deben poder volver a suscribirse a este plan básico en las plataformas de Google Play Si no se especifica, el valor predeterminado es RESUBSCRIPTION_STATE_ACTIVE. |
prorationMode |
El modo de prorrateo del plan básico determina qué sucede cuando un usuario cambia de otro plan básico a este plan. Si no se especifica, el valor predeterminado es CHARGE_ON_NEXT_BILLING_DATE. |
legacyCompatible |
Si el plan básico que se renueva es retrocompatible El plan básico retrocompatible es devuelto por el método obsoleto querySkuDetailsAsync() de la Biblioteca de Facturación Google Play. Solo se puede marcar un plan básico con renovación para una suscripción determinada. |
legacyCompatibleSubscriptionOfferId |
ID de oferta de suscripción compatible con versiones heredadas. La oferta de suscripción retrocompatible es devuelta por el método obsoleto querySkuDetailsAsync() de la Biblioteca de Facturación Google Play. Solo se puede marcar una oferta de suscripción como compatible con versiones heredadas para un plan básico con renovación. Para no tener ninguna oferta de suscripción como compatible con versiones heredadas, establece este campo como una cadena vacía. |
ResubscribeState
Estado de reactivación de la suscripción del plan básico
Enumeradores | |
---|---|
RESUBSCRIBE_STATE_UNSPECIFIED |
Estado sin especificar. |
RESUBSCRIBE_STATE_ACTIVE |
La opción para volver a suscribirse está activa. |
RESUBSCRIBE_STATE_INACTIVE |
La opción para volver a suscribirse está inactiva. |
SubscriptionProrationMode
El modo de prorrateo que se usa para renovar planes básicos.
Enumeradores | |
---|---|
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED |
Modo sin especificar. |
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE |
Los usuarios deberán abonar el nuevo plan básico al final del período de facturación actual. |
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY |
A los usuarios se les cobrará el nuevo plan básico de inmediato y en su totalidad. Cualquier período restante de la suscripción existente se usará para extender la duración del nuevo plan de facturación. |
PrepaidBasePlanType
Representa un plan básico que no se renueva automáticamente al final del plan básico, y el usuario debe renovarlo de forma manual.
Representación JSON |
---|
{
"billingPeriodDuration": string,
"timeExtension": enum ( |
Campos | |
---|---|
billingPeriodDuration |
Obligatorio. Es el período de suscripción especificado en formato ISO 8601. Para obtener una lista de los períodos de facturación aceptables, consulta el Centro de ayuda. |
timeExtension |
Si los usuarios deberían poder extender este plan básico prepagado en las plataformas de Google Play El valor predeterminado es TIME_EXTENSION_ACTIVE si no se especifica. |
TimeExtension
Extensión de tiempo del plan básico.
Enumeradores | |
---|---|
TIME_EXTENSION_UNSPECIFIED |
Estado sin especificar. |
TIME_EXTENSION_ACTIVE |
La extensión de tiempo está activa. Los usuarios pueden agregar dinero o extender su plan prepagado. |
TIME_EXTENSION_INACTIVE |
La extensión de tiempo está inactiva. Los usuarios no pueden agregar dinero ni extender su plan prepagado. |
InstallmentsBasePlanType
Representa un plan básico de cuotas en el que un usuario se compromete a realizar una cantidad específica de pagos.
Representación JSON |
---|
{ "billingPeriodDuration": string, "committedPaymentsCount": integer, "renewalType": enum ( |
Campos | |
---|---|
billingPeriodDuration |
Obligatorio. Es el período de suscripción especificado en formato ISO 8601. Para obtener una lista de los períodos de facturación aceptables, consulta el Centro de ayuda. |
committedPaymentsCount |
Obligatorio. La cantidad de pagos a los que se compromete el usuario. |
renewalType |
Obligatorio. Tipo de renovación del plan básico en cuotas. Determina el comportamiento al final del compromiso inicial. |
gracePeriodDuration |
Es el período de gracia de la suscripción, especificado en formato ISO 8601. Los valores aceptables son P0D (cero días), P3D (3 días), P7D (7 días), P14D (14 días) y P30D (30 días). Si no se especifica, se usará un valor predeterminado en función de la duración del período recurrente. |
accountHoldDuration |
Opcional. Es el período de suspensión de la cuenta de la suscripción, que se especifica exclusivamente en días y en formato ISO 8601. Los valores aceptables van desde P0D (cero días) hasta P30D (30 días). Si no se especifica, el valor predeterminado es P30D (30 días). |
resubscribeState |
Si los usuarios deben poder volver a suscribirse a este plan básico en las plataformas de Google Play Si no se especifica, el valor predeterminado es RESUBSCRIPTION_STATE_ACTIVE. |
prorationMode |
El modo de prorrateo del plan básico determina qué sucede cuando un usuario cambia de otro plan básico a este plan. Si no se especifica, el valor predeterminado es CHARGE_ON_NEXT_BILLING_DATE. |
RenewalType
Tipo de renovación del plan básico en cuotas. Determina el comportamiento al final del compromiso inicial.
Enumeradores | |
---|---|
RENEWAL_TYPE_UNSPECIFIED |
Estado sin especificar. |
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT |
Se renueva periódicamente durante el período de facturación sin compromisos. |
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT |
Se renueva con el compromiso de la misma duración que el inicial. |
RegionalBasePlanConfig
Configuración de un plan básico específico para una región.
Representación JSON |
---|
{
"regionCode": string,
"newSubscriberAvailability": boolean,
"price": {
object ( |
Campos | |
---|---|
regionCode |
Obligatorio. Es el 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 |
Indica si el plan básico en la región especificada está disponible para suscriptores nuevos. Si estableces este valor como falso, no se cancelará la suscripción de los suscriptores existentes. Si no se especifica, el valor predeterminado será falso. |
price |
Es el precio del plan básico en la región especificada. Se debe establecer si el plan básico está disponible para suscriptores nuevos. Se debe configurar en la moneda vinculada a la región especificada. |
OtherRegionsBasePlanConfig
Información de precios para ubicaciones nuevas en las que se pueda lanzar Play.
Representación JSON |
---|
{ "usdPrice": { object ( |
Campos | |
---|---|
usdPrice |
Obligatorio. Es el precio en USD que se puede usar en ubicaciones nuevas donde se pueda lanzar Play. |
eurPrice |
Obligatorio. Es el precio en EUR para usar en ubicaciones nuevas en las que se pueda lanzar Play. |
newSubscriberAvailability |
Si el plan básico está disponible para suscriptores nuevos en cualquier ubicación nueva en la que se pueda lanzar Play Si no se especifica, el valor predeterminado será falso. |
SubscriptionListing
Son los metadatos visibles para el consumidor de una suscripción.
Representación JSON |
---|
{ "languageCode": string, "title": string, "benefits": [ string ], "description": string } |
Campos | |
---|---|
languageCode |
Obligatorio. El idioma de esta ficha, según se define en la norma BCP-47, p.ej., "en-US". |
title |
Obligatorio. Es el título de esta suscripción en el idioma de esta ficha. Texto sin formato |
benefits[] |
Una lista de beneficios que se muestran al usuario en plataformas como Play Store y en los flujos de restablecimiento en el idioma de esta ficha. Texto sin formato Lista ordenada de un máximo de cuatro beneficios. |
description |
Es la descripción de esta suscripción en el idioma de esta ficha. La longitud máxima es de 80 caracteres. Texto sin formato |
RestrictedPaymentCountries
Países donde la compra de este producto está restringida a las formas de pago registradas en el mismo país. Si este campo está vacío, no se imponen restricciones por ubicación de pago.
Representación JSON |
---|
{ "regionCodes": [ string ] } |
Campos | |
---|---|
regionCodes[] |
Obligatorio. Son los códigos de regiones a los que se deben imponer restricciones de pago, según se define en la norma ISO 3166-2, p.ej., "US". |
Métodos |
|
---|---|
(deprecated) |
Obsoleto: no se admite el archivado de suscripciones. |
|
Lee una o más suscripciones. |
|
Actualiza un lote de suscripciones. |
|
Crea una nueva suscripción. |
|
Elimina una suscripción. |
|
Lee una sola suscripción. |
|
Muestra una lista de todas las suscripciones de una app determinada. |
|
Actualiza una suscripción existente. |