Commandes pour les paywalls

Ces commandes CLI Adapty gèrent les paywalls et les produits que chaque paywall propose à la vente, et permettent de consulter leurs métriques.

adapty paywalls list

Liste tous les paywalls d’une application.

adapty paywalls list --app <app-id>
FlagRequisDescription
--appOuiID de l’application (UUID)

Accepte les flags de pagination.

adapty paywalls get

Obtenez les détails d’un paywall spécifique.

adapty paywalls get --app <app-id> <paywall-id>
ArgumentDescription
paywall-idID du paywall (UUID)
FlagRequisDescription
--appOuiID de l’application (UUID)

adapty paywalls create

Créez un nouveau paywall.

adapty paywalls create --app <app-id> --title "Default Paywall" --products '[{"product_id":"<product-id-1>"},{"product_id":"<product-id-2>"}]'
IndicateurRequisDescription
--appOuiID de l’application (UUID)
--titleOuiTitre du paywall
--productsOuiTableau JSON des produits, dans l’ordre d’affichage : [{product_id, offer_id, fallback_offer_id, billing_plan_id, flow_product_id}]. Seul product_id (ID du produit, UUID) est requis ; les autres clés proviennent de la liste products qu’affiche paywalls get
--remote-configsNonTableau JSON d’entrées {locale, data}, où data est le Remote Config sous forme de chaîne JSON
--use-paywall-builder-v4NonIndique si le paywall utilise le Paywall Builder
--screenshot-idNonID d’image de la capture d’écran du paywall (un entier), ou null
--builder-screenshot-idNonID d’image de la capture d’écran du builder (un entier), ou null
--web-purchase-urlNonURL d’achat web, ou null
--product-idNonObsolète : utilisez --products. ID du produit (UUID), répété pour chaque produit. Définit les produits sans offre ni plan de facturation, et ne peut pas être utilisé avec --products

Un champ que vous omettez prend la valeur par défaut du tableau de bord : pas de Remote Config, pas de builder, pas de captures d’écran et pas d’URL d’achat web. Les flags autres que --app, --title et --product-id nécessitent la version 0.20.0 ou ultérieure de la CLI.

adapty paywalls update

Remplacez tous les champs d’un paywall existant.

Important

Une fois qu’un paywall est lié à un placement, ses produits ne peuvent pas être modifiés. Pour utiliser des produits différents dans un paywall actif, créez un nouveau paywall et mettez à jour le placement pour qu’il pointe vers ce nouveau paywall.

Pour modifier un seul champ, lisez le paywall, modifiez ce champ dans le fichier, puis renvoyez l’intégralité du fichier :

adapty paywalls get --app <app-id> <paywall-id> --json > paywall.json
adapty paywalls update --app <app-id> <paywall-id> --file paywall.json

La commande remplace chaque champ du paywall, y compris la liste complète des produits et la liste entière des Remote Configs. Tous les champs sont obligatoires : si un indicateur est manquant, la commande se termine avec le code 2, liste les indicateurs manquants et n’envoie aucune requête. Cette fonctionnalité nécessite la version CLI 0.20.0 ou ultérieure : les versions antérieures n’acceptent que --title et --product-id.

ArgumentDescription
paywall-idIdentifiant du paywall (UUID)
IndicateurRequisDescription
--appOuiID de l’application (UUID)
--fileÀ la place des indicateurs de champChemin vers un fichier JSON contenant le paywall complet, ou - pour lire depuis stdin. La sortie de paywalls get --json fonctionne telle quelle ; son id est ignoré. Incompatible avec tout indicateur de champ
--titleSans --fileTitre du paywall
--productsSans --fileTableau JSON des produits, comme dans paywalls create. Envoyez la liste retournée par paywalls get pour conserver les offres et les plans de facturation
--remote-configsSans --fileTableau JSON d’entrées {locale, data}, où data est une chaîne JSON. [] supprime tous les Remote Configs
--use-paywall-builder-v4 ou --no-use-paywall-builder-v4Sans --fileIndique si le paywall utilise le Paywall Builder. Envoyez la valeur issue de paywalls get : --no-use-paywall-builder-v4 supprime la mise en page du builder des appareils
--screenshot-idSans --fileID d’image de la capture d’écran du paywall, ou null
--builder-screenshot-idSans --fileID d’image de la capture d’écran du builder, ou null
--web-purchase-urlSans --fileURL d’achat web, ou null
--product-idNonObsolète : utilisez --products. Définit les produits sans offre ni plan de facturation

adapty paywalls placements

Listez tous les placements qui utilisent actuellement un paywall donné.

adapty paywalls placements --app <app-id> <paywall-id>
ArgumentDescription
paywall-idID du paywall (UUID)
FlagRequisDescription
--appOuiID de l’application (UUID)

Utilisez cette commande avant de remplacer un paywall pour voir quels placements seraient affectés.

Les éléments de cette liste ne comportent pas de champ is_active. Pour lire l’état d’activation d’un placement, utilisez placements list ou placements get.

Liste des métriques des paywalls Adapty

Affiche les métriques sur toute la durée de vie de plusieurs paywalls, une ligne par paywall. Il s’agit des données du tableau des paywalls dans le tableau de bord.

adapty paywalls metrics list --app <app-id> --ids <paywall-id>,<paywall-id>
FlagRequisDescription
--appOuiID de l’application (UUID)
--idsOuiID des paywalls (UUID). Séparez-les par des virgules ou répétez le flag
--csvNonAffiche le CSV : une ligne par paywall, avec l’ID du paywall et les métriques numériques. Incompatible avec --json

Les commandes paywalls metrics lisent les données de la page métriques des paywalls et nécessitent la version CLI 0.16.0 ou ultérieure.

Chaque ligne affiche l’ID du paywall avec ses vues, achats, essais et revenus. --json inclut les 21 métriques, comme unique_profiles_views, net_revenue et conversion_rate_purchases, ainsi que last_purchases. --csv exclut les deux champs non numériques, in_current_state et last_purchases. Une métrique sans données vaut 0, jamais null.

adapty paywalls metrics values

Liste les clés et valeurs de filtre d’un paywall : ce qu’accepte paywalls metrics get --filter.

adapty paywalls metrics values --app <app-id> <paywall-id>
ArgumentDescription
paywall-idIdentifiant du paywall (UUID)
FlagObligatoireDescription
--appOuiIdentifiant de l’app (UUID)

La sortie a la même forme que flows metrics values : la valeur en tête de chaque groupe est la clé de filtre, et les valeurs les plus imbriquées sont celles qu’accepte cette clé.

adapty paywalls metrics get

Affiche les métriques d’un paywall pour une période donnée, sous forme d’arborescence similaire à la page métriques des paywalls.

adapty paywalls metrics get --app <app-id> <paywall-id> --date-from 2026-09-01 --date-to 2026-10-21 --date-type purchase_date --based-on placement
ArgumentDescription
paywall-idID du paywall (UUID)
IndicateurRequisDescription
--appOuiID de l’application (UUID)
--based-onOuiCe sur quoi se base le premier niveau de l’arborescence : placement ou audience. Ce sont les vues par placement et par audience de la page métriques des paywalls
--date-typeOuiLa date à laquelle la période s’applique : purchase_date ou profile_install_date pour filtrer par date d’installation
--date-fromOuiPremier jour de la période, inclus (YYYY-MM-DD)
--date-toOuiDernier jour de la période, inclus (YYYY-MM-DD)
--group-byNonRegrouper les produits par product, store ou country. Par défaut : product
--granularityNonDécouper la période en points : day, week, month, quarter ou year
--filterNonNe conserver que les données correspondant à ces valeurs de clé de filtre. Répétable. Voir Filtrer les métriques
--timezoneNonFuseau horaire IANA des points de la période, par exemple Europe/Berlin. Sans cela, Adapty utilise le fuseau horaire de l’application
--depthNonNombre de niveaux de l’arborescence à afficher sous Total. Par défaut : 1
--csvNonAfficher en CSV : une ligne par nœud de l’arborescence complète. Incompatible avec --json

Le CLI se ferme avec le code 2 et n’envoie aucune requête si --based-on ou --date-type est absent, ou si une seule des deux bornes de la période est fournie. Sans la période, Adapty refuse la requête et la commande se ferme avec le code 4. Adapty valide les valeurs de --based-on, --date-type, --group-by et --granularity : une valeur incorrecte provoque une sortie avec le code 4, et l’erreur liste les valeurs acceptées.

Lire la sortie

La commande affiche une ligne Total, puis le premier niveau de l’arborescence en dessous, avec les mêmes colonnes que flows metrics get. Les nœuds du premier niveau affichent toujours leurs points pour la période, avec ou sans --granularity.

Les niveaux de l’arborescence sont : placement ou audience, puis le paywall ou le test A/B qui s’y est exécuté, puis les groupes --group-by. Pour afficher davantage de niveaux, utilisez --depth, par exemple --depth 4.

Pour obtenir l’arborescence complète avec toutes les métriques, utilisez l’un de ces flags :

  • --json affiche la réponse du serveur telle quelle.
  • --csv affiche une ligne par nœud, points de période inclus. Les colonnes sont path (les titres de Total jusqu’au nœud, séparés par >), level, title, puis les métriques numériques. Un arbre de paywall n’a pas de niveaux, donc level vaut root sur Total et est vide sur toutes les autres lignes.

Filtrer les métriques

Rédigez chaque --filter sous la forme key=value, avec les clés et valeurs listées par paywalls metrics values. Les filtres suivent les mêmes règles que dans flows metrics get :

adapty paywalls metrics get --app <app-id> <paywall-id> --date-from 2026-09-01 --date-to 2026-10-21 \
  --date-type purchase_date --based-on placement --filter state=live

Et ensuite