POST /api/v2/web-api/paywall/

Obtener paywall

Obtiene el paywall del placement indicado.

Request body

storestringrequired

Store donde se realizó la compra del producto. Valores posibles: app_store, play_store, stripe o el Store ID de tu store personalizado.

localestring

Identificador de la configuración regional del paywall. Se espera que este parámetro sea un código de idioma compuesto por una o más subetiquetas separadas por el carácter "-". La primera subetiqueta corresponde al idioma y la segunda a la región.

placement_idstringrequired

El identificador del placement. Es el valor que especificaste al crear un placement en tu Adapty Dashboard.

customer_user_idstring

Se requiere customer_user_id o profile_id. ID de usuario que utilizas en tu aplicación para identificar al usuario. Por ejemplo, puede ser tu UUID de usuario, correo electrónico o cualquier otro ID.

profile_idstring

Se requiere customer_user_id o profile_id. Identificador de un usuario en Adapty.

Responses

La respuesta satisfactoria contendrá el objeto Paywall.

Schema
placement_idstringrequired

El ID del placement donde se muestra este paywall. Este valor se establece al crear un placement en tu Adapty Dashboard.

variation_idstringrequired

El ID de variante utilizado para rastrear las compras vinculadas a este paywall específico.

paywall_idstringrequired

El identificador único del paywall.

ab_test_namestring

El nombre de la prueba A/B padre.

paywall_namestringrequired

El nombre del paywall, tal como se define en tu Adapty Dashboard.

productsarray of objectrequired

Array de objetos Product que contienen la información de los productos del paywall.

titlestring

Nombre del producto de la sección de productos en el Adapty Dashboard.

is_consumablebooleanrequired

Indica si el producto es consumible.

adapty_product_idstring

ID interno del producto tal como se utiliza en Adapty.

vendor_product_idstringrequired

El ID del producto en los stores de aplicaciones.

introductory_offer_eligibilityboolean

Indica si el usuario es elegible para una oferta introductoria de iOS.

promotional_offer_eligibilityboolean

Indica si el usuario es elegible para una oferta promocional.

base_plan_idstring

ID del plan base para Google Play o ID de precio para Stripe. Consulta Base plan ID para Google Play o price ID para Stripe.

offerallOf

Un objeto Offer como JSON.

categorystring

La categoría de la oferta aplicada.

One of: "introductory", "promotional", "offer_code", "win_back"

typestring

El tipo de oferta activa. Si este valor no es nulo, significa que la oferta se aplicó en el período de suscripción actual.

One of: "free_trial", "pay_as_you_go", "pay_up_front", "unknown"

idstring

El ID de la oferta aplicada.

remote_configobject

Un objeto RemoteConfig que contiene el Remote Config completo del paywall.

langstringrequired

Código de configuración regional para la localización del paywall. Utiliza subetiquetas de idioma y región separadas por un guion (-). Ejemplos: en para inglés, pt-br para portugués de Brasil.

datastringrequired

Cadena JSON serializada que representa el Remote Config de tu paywall. Puedes encontrarla en la pestaña Remote Config de un paywall específico en el Adapty Dashboard.

Example
{
  "placement_id": "onboarding",
  "variation_id": "d76feea0-c0cf-4942-bef5-84ed701fc6db",
  "paywall_id": "9a93fe6f-9162-4dc0-b4b7-73079ed95c34",
  "ab_test_name": "1 week + 1 month | apple picture",
  "paywall_name": "1 week + 1 month | apple picture",
  "products": [
    {
      "title": "1 week",
      "is_consumable": false,
      "adapty_product_id": "1c3e03e1-9c43-4f94-aeb5-c7ae2f73d0c2",
      "vendor_product_id": "1_week_apple",
      "introductory_offer_eligibility": true,
      "promotional_offer_eligibility": true,
      "base_plan_id": null,
      "offer": null
    },
    {
      "title": "1 month",
      "is_consumable": false,
      "adapty_product_id": "f4088450-45a8-4737-8db0-367e642d7dcb",
      "vendor_product_id": "1_month_apple",
      "introductory_offer_eligibility": true,
      "promotional_offer_eligibility": true,
      "base_plan_id": null,
      "offer": null
    }
  ],
  "remote_config": {
    "lang": "en",
    "data": "{\"default_product_number\":1,\"features\":[\"#fresh\",\"#green\",\"#healthy1\"],\"soft_paywall\":false,\"image_url\":\"https://adapty.io/apple.png\"}"
  }
}

Solicitud incorrecta

Schema
errorsarray of object
sourcestring
errorsarray of string
error_codestring
status_codeinteger

No autorizado

Schema
errorsarray of object
sourcestring
errorsarray of string
error_codestring
status_codeinteger

No encontrado

Schema
errorsarray of object
sourcestring
errorsarray of string
error_codestring
status_codeinteger