/api/v2/web-api/paywall/ Obtenir un paywall
Récupère le paywall depuis le placement fourni.
Request body
Store où le produit a été acheté. Valeurs possibles : app_store, play_store, stripe, ou le Store ID de votre store personnalisé.
Identifiant de la locale du paywall. Ce paramètre doit être un code de langue composé d'un ou plusieurs sous-tags séparés par le caractère « - ». Le premier sous-tag correspond à la langue, le second à la région.
L'identifiant du placement. Il s'agit de la valeur que vous avez spécifiée lors de la création d'un placement dans votre Adapty Dashboard.
Soit customer_user_id, soit profile_id est requis. L'identifiant utilisateur que vous utilisez dans votre application pour identifier l'utilisateur, le cas échéant. Il peut s'agir par exemple de l'UUID, de l'e-mail ou de tout autre identifiant de l'utilisateur.
Soit customer_user_id, soit profile_id est requis. Identifiant d'un utilisateur dans Adapty.
Responses
La réponse en cas de succès contiendra l'objet Paywall.
Schema
L'ID du placement où ce paywall est affiché. Cette valeur est définie lors de la création d'un placement dans votre Adapty Dashboard.
L'ID de variante utilisé pour suivre les achats liés à ce paywall spécifique.
L'identifiant unique du paywall.
Le nom du test A/B parent.
Le nom du paywall, tel que défini dans votre Adapty Dashboard.
Tableau d'objets Product contenant les informations sur les produits du paywall.
Nom du produit issu de la section Produits dans l'Adapty Dashboard.
Indique si le produit est consommable.
Identifiant interne du produit tel qu'utilisé dans Adapty.
L'identifiant du produit dans les stores.
Indique si l'utilisateur est éligible à une offre de lancement iOS.
Indique si l'utilisateur est éligible à une offre promotionnelle.
ID du plan de base pour Google Play ou ID de prix pour Stripe. Voir Base plan ID pour Google Play ou price ID pour Stripe.
Un objet Offer au format JSON.
La catégorie de l'offre appliquée.
One of: "introductory", "promotional", "offer_code", "win_back"
Le type d'offre active. Si cette valeur n'est pas null, cela signifie que l'offre a été appliquée durant la période d'abonnement en cours.
One of: "free_trial", "pay_as_you_go", "pay_up_front", "unknown"
L'identifiant de l'offre appliquée.
Un objet RemoteConfig contenant la configuration Remote Config complète du paywall.
Code de locale pour la localisation du paywall. Il utilise des sous-tags de langue et de région
séparés par un tiret (-). Exemples : en pour l'anglais, pt-br pour le portugais brésilien.
Chaîne JSON sérialisée représentant le Remote Config de votre paywall. Vous pouvez la trouver dans l'onglet Remote Config d'un paywall spécifique dans l'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\"}"
}
}Requête incorrecte
Schema
Non autorisé
Schema
Introuvable