Référence des commandes du CLI Développeur Adapty
Cet article liste les commandes du CLI Adapty permettant de configurer votre compte — applications, niveaux d’accès, produits, paywalls, placements et segments — avec leurs arguments, options et valeurs acceptées. Pour les campagnes Apple Ads, consultez les commandes Ads Manager.
Pour la configuration de l’authentification et la gestion des tokens, consultez Authentification.
Indicateurs globaux
Ces indicateurs sont disponibles sur toutes les commandes.
| Indicateur | Description |
|---|---|
--json | Afficher en JSON plutôt qu’en texte formaté |
--help | Afficher l’aide de la commande |
Toutes les commandes list acceptent également des indicateurs de pagination :
| Indicateur | Défaut | Description |
|---|---|---|
--page | 1 | Numéro de page |
--page-size | 20 | Éléments par page (max : 100) |
Applications
Gérez les applications de votre compte Adapty. Pour la configuration via le tableau de bord, consultez Paramètres de l’application.
adapty apps list
Listez toutes les applications de votre compte Adapty.
adapty apps list
Accepte les options de pagination.
adapty apps get
Obtenez les détails d’une application spécifique.
adapty apps get <app-id>
| Argument | Description |
|---|---|
app-id | ID de l’application (UUID) |
adapty apps create
Créer une nouvelle application.
adapty apps create --title "My App" --platform ios --apple-bundle-id com.example.app
| Flag | Required | Description |
|---|---|---|
--title | Yes | Titre de l’application |
--platform | Yes | Plateforme : ios ou android. Répéter pour les deux : --platform ios --platform android |
--apple-bundle-id | Required with --platform ios | Bundle ID Apple |
--google-bundle-id | Required with --platform android | Bundle ID Google |
adapty apps update
Mettre à jour une application existante.
adapty apps update <app-id> --title "New Name"
| Argument | Description |
|---|---|
app-id | ID de l’application (UUID) |
| Flag | Description |
|---|---|
--title | Nouveau titre de l’application |
--apple-bundle-id | Nouvel Apple bundle ID |
--google-bundle-id | Nouvel Google bundle ID |
Au moins un flag est requis. --platform ne peut pas être modifié après la création.
Niveaux d’accès
adapty access-levels list
Liste tous les niveaux d’accès d’une application.
adapty access-levels list --app <app-id>
| Flag | Required | Description |
|---|---|---|
--app | Yes | App ID (UUID) |
Accepte les options de pagination.
adapty access-levels get
Obtenez les détails d’un niveau d’accès spécifique.
adapty access-levels get --app <app-id> <access-level-id>
| Argument | Description |
|---|---|
access-level-id | ID du niveau d’accès (UUID) |
| Flag | Requis | Description |
|---|---|---|
--app | Oui | ID de l’application (UUID) |
adapty access-levels create
Créer un nouveau niveau d’accès.
adapty access-levels create --app <app-id> --sdk-id "pro" --title "Pro"
| Flag | Requis | Description |
|---|---|---|
--app | Oui | ID de l’app (UUID) |
--sdk-id | Oui | Identifiant utilisé dans le code de l’app pour vérifier l’accès (par exemple, "pro" ou "premium") |
--title | Oui | Libellé d’affichage dans l’Adapty Dashboard |
adapty access-levels update
Mettez à jour un niveau d’accès existant.
adapty access-levels update --app <app-id> <access-level-id> --title "Pro Access"
| Argument | Description |
|---|---|
access-level-id | ID du niveau d’accès (UUID) |
| Flag | Requis | Description |
|---|---|---|
--app | Oui | ID de l’app (UUID) |
--title | Oui | Nouveau libellé d’affichage |
--sdk-id ne peut pas être modifié après la création.
Produits
Liste des produits Adapty
Listez tous les produits d’une application.
adapty products list --app <app-id>
| Flag | Requis | Description |
|---|---|---|
--app | Oui | ID de l’application (UUID) |
Accepte les flags de pagination.
adapty products get
Obtenez les détails d’un produit spécifique.
adapty products get --app <app-id> <product-id>
| Argument | Description |
|---|---|
product-id | ID du produit (UUID) |
| Indicateur | Requis | Description |
|---|---|---|
--app | Oui | ID de l’application (UUID) |
adapty products create
Créez un nouveau produit.
Les identifiants de produit et de prix du store ne peuvent pas être modifiés après la création. Pour utiliser d’autres identifiants de store, créez un nouveau produit.
adapty products create --app <app-id> --title "Monthly" --access-level-id <access-level-id> --period monthly --ios-product-id com.example.monthly
| Paramètre | Obligatoire | Description |
|---|---|---|
--app | Oui | ID de l’app (UUID) |
--title | Oui | Titre du produit |
--access-level-id | Oui | ID (UUID) du niveau d’accès que ce produit débloque |
--period | Oui | Période d’abonnement : weekly, monthly, two_months, trimonthly, semiannual, annual, lifetime |
--ios-product-id | Au moins un store requis | ID du produit dans App Store Connect |
--android-product-id | Au moins un store requis | ID du produit dans Google Play Console |
--android-base-plan-id | Obligatoire avec --android-product-id sauf si --period lifetime | ID du plan de base dans Google Play Console |
--stripe-product-id | Au moins un store requis | ID du produit dans Stripe |
--stripe-price-id | Obligatoire avec --stripe-product-id | ID du prix dans Stripe |
--paddle-product-id | Au moins un store requis | ID du produit dans Paddle |
--paddle-price-id | Obligatoire avec --paddle-product-id | ID du prix dans Paddle |
Chaque produit nécessite au moins un store : --ios-product-id, --android-product-id, --stripe-product-id ou --paddle-product-id. Un même produit peut avoir des identifiants pour plusieurs stores à la fois.
Pour vendre un produit sur le web via Stripe ou Paddle, connectez d’abord le fournisseur de paiement à Adapty : voir Stripe et Paddle. Pour chacun de ces stores, passez l’identifiant du produit et l’identifiant du prix ensemble. La commande échoue si vous ne passez qu’un seul des deux.
adapty products create --app <app-id> --title "Monthly" --access-level-id <access-level-id> --period monthly --stripe-product-id prod_xxx --stripe-price-id price_xxx
Un produit web uniquement est valide : vous pouvez créer un produit avec des identifiants Stripe ou Paddle sans identifiants App Store ou Google Play.
adapty products update
Mettez à jour un produit existant.
Les identifiants de produit et de prix du store ne peuvent pas être modifiés après la création et ne sont pas disponibles dans cette commande. Pour utiliser des identifiants de store différents, créez un nouveau produit.
adapty products update --app <app-id> <product-id> --title "Monthly" --access-level-id <access-level-id>
| Argument | Description |
|---|---|
product-id | ID du produit (UUID) |
| Indicateur | Requis | Description |
|---|---|---|
--app | Oui | ID de l’application (UUID) |
--title | Non | Titre du produit |
--access-level-id | Non | ID (UUID) du niveau d’accès que ce produit déverrouille |
Paywalls
Liste des paywalls Adapty
Listez tous les paywalls d’une application.
adapty paywalls list --app <app-id>
| Indicateur | Requis | Description |
|---|---|---|
--app | Oui | ID de l’application (UUID) |
Accepte les indicateurs de pagination.
adapty paywalls get
Obtenir les détails d’un paywall spécifique.
adapty paywalls get --app <app-id> <paywall-id>
| Argument | Description |
|---|---|
paywall-id | ID du paywall (UUID) |
| Flag | Requis | Description |
|---|---|---|
--app | Oui | ID de l’app (UUID) |
adapty paywalls create
Crée un nouveau paywall.
adapty paywalls create --app <app-id> --title "Default Paywall" --product-id <product-id>
| Flag | Requis | Description |
|---|---|---|
--app | Oui | ID de l’application (UUID) |
--title | Oui | Titre du paywall |
--product-id | Oui | ID du produit (UUID). Répétez pour plusieurs produits : --product-id <id1> --product-id <id2> |
adapty paywalls update
Remplacez tous les champs d’un paywall existant.
Une fois qu’un paywall est lié à un placement, ses produits ne peuvent plus ê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 celui-ci.
adapty paywalls update --app <app-id> <paywall-id> --title "Default Paywall" --product-id <product-id>
Cette commande remplace tous les champs du paywall, y compris la liste complète des produits.
| Argument | Description |
|---|---|
paywall-id | ID du paywall (UUID) |
| Indicateur | Obligatoire | Description |
|---|---|---|
--app | Oui | ID d’application (UUID) |
--title | Oui | Titre du paywall |
--product-id | Oui | ID de produit (UUID). Répéter pour plusieurs produits : --product-id <id1> --product-id <id2> |
adapty paywalls placements
Liste tous les placements qui utilisent actuellement un paywall donné.
adapty paywalls placements --app <app-id> <paywall-id>
| Argument | Description |
|---|---|
paywall-id | ID du paywall (UUID) |
| Flag | Requis | Description |
|---|---|---|
--app | Oui | ID de l’app (UUID) |
Utilisez cette commande avant de remplacer un paywall pour voir quels placements seraient affectés.
Placements
Liste des placements Adapty
Listez tous les placements d’une application.
adapty placements list --app <app-id>
| Flag | Requis | Description |
|---|---|---|
--app | Oui | ID de l’application (UUID) |
Accepte les flags de pagination.
adapty placements get
Récupère les détails d’un placement spécifique.
adapty placements get --app <app-id> <placement-id>
| Argument | Description |
|---|---|
placement-id | ID du placement (UUID) |
| Flag | Requis | Description |
|---|---|---|
--app | Oui | ID de l’application (UUID) |
Le tableau audiences contient un tableau de résultats. Chaque entrée est composée de {segment_ids, paywall_id, priority}. L’audience par défaut a segment_ids: [] et la valeur de priorité la plus élevée (évaluée en dernier). La sortie formatée pour l’humain affiche également un Paywall ID de niveau supérieur, dérivé de l’audience par défaut pour plus de commodité. --json renvoie la structure brute de l’API sans modification.
adapty placements create
Créez un nouveau placement.
adapty placements create --app <app-id> --title "Main" --developer-id "main" --audiences '[{"segment_ids":[],"paywall_id":"<paywall-id>","priority":0}]'
| Indicateur | Requis | Description |
|---|---|---|
--app | Oui | ID de l’application (UUID) |
--title | Oui | Titre du placement |
--developer-id | Oui | Identifiant de chaîne utilisé dans le code de l’application pour demander ce placement |
--audiences | L’un des deux | Tableau JSON d’entrées {segment_ids, paywall_id, priority}. Voir Structure des audiences |
--paywall-id | L’un des deux | Déprécié. ID de paywall (UUID). Encapsulé côté client dans une audience par défaut unique |
Passez exactement l’un de --audiences ou --paywall-id. Passer les deux ou aucun provoque une erreur.
--paywall-id est obsolète et sera supprimé. Lorsqu’il est passé, le CLI affiche un avertissement sur stderr et convertit la valeur en audience par défaut. Utilisez --audiences pour les nouvelles automatisations.
adapty placements update
Remplace tous les champs d’un placement existant.
adapty placements update --app <app-id> <placement-id> --title "Main" --developer-id "main" --audiences '[{"segment_ids":[],"paywall_id":"<paywall-id>","priority":0}]'
Cette commande remplace tous les champs du placement, y compris la liste complète des audiences.
| Argument | Description |
|---|---|
placement-id | ID du placement (UUID) |
| Indicateur | Requis | Description |
|---|---|---|
--app | Oui | ID de l’app (UUID) |
--title | Oui | Titre du placement |
--developer-id | Oui | Identifiant string utilisé dans le code de l’app pour requêter ce placement |
--audiences | L’un des deux | Tableau JSON d’entrées {segment_ids, paywall_id, priority}. Voir Format des audiences |
--paywall-id | L’un des deux | Déprécié. ID du paywall (UUID). Remplace toutes les audiences par une seule audience par défaut |
Passer --paywall-id réécrit toutes les audiences du placement. Les audiences spécifiques à un segment sont supprimées. Pour les conserver, utilisez --audiences et incluez toutes les entrées que vous souhaitez garder.
Structure des audiences
Le paramètre --audiences prend un tableau JSON. Chaque entrée contient :
| Champ | Type | Description |
|---|---|---|
segment_ids | string[] | IDs de segment ciblés par cette audience. Longueur 0 ou 1. Un tableau vide marque l’audience par défaut — le repli pour les utilisateurs qui ne correspondent à aucun autre segment |
paywall_id | string | ID de paywall (UUID) affiché aux utilisateurs de cette audience |
priority | number | Base 0, unique au sein du placement. Les audiences sont évaluées de la plus basse à la plus haute ; l’audience par défaut doit avoir la valeur la plus élevée |
Un placement doit avoir exactement une audience par défaut.
Exemple avec une audience ciblée et une audience par défaut :
adapty placements update <placement-id> --app <app-id> --title "Main" --developer-id "main" \
--audiences '[{"segment_ids":["<vip-segment-id>"],"paywall_id":"<vip-paywall-id>","priority":0},{"segment_ids":[],"paywall_id":"<default-paywall-id>","priority":1}]'
Pour remplacer un paywall dans plusieurs placements sans perdre le routage par segment :
-
Trouvez les placements concernés :
adapty paywalls placements --app <app-id> <old-paywall-id> -
Pour chacun, lisez le tableau
audiencescomplet :adapty placements get --app <app-id> <placement-id> --json -
Remplacez les valeurs
paywall_idcorrespondantes côté client. -
Réécrivez le payload modifié :
adapty placements update --app <app-id> <placement-id> --title "<title>" --developer-id "<developer-id>" --audiences '<modified-payload>'
Segments
Les segments sont en lecture seule via la CLI. Créez-les et modifiez-les dans l’Adapty Dashboard. Utilisez ces commandes pour rechercher les ID de segment lors de la composition des audiences de placement.
adapty segments list
Liste tous les segments d’une application.
adapty segments list --app <app-id>
| Flag | Required | Description |
|---|---|---|
--app | Yes | App ID (UUID) |
Accepte les drapeaux de pagination.
adapty segments get
Obtenez les détails d’un segment spécifique.
adapty segments get --app <app-id> <segment-id>
| Argument | Description |
|---|---|
segment-id | ID du segment (UUID) |
| Flag | Requis | Description |
|---|---|---|
--app | Oui | ID de l’application (UUID) |
La réponse contient id, title et description. Les règles de filtrage ne sont pas exposées via cette API.
Auth
| Commande | Description |
|---|---|
adapty auth login | S’authentifier via le navigateur en utilisant le flow de l’appareil |
adapty auth logout | Supprimer les identifiants stockés localement |
adapty auth whoami | Vérifier le token auprès du serveur et afficher les informations de l’utilisateur |
adapty auth status | Afficher l’état d’authentification local sans appel au serveur |
adapty auth revoke | Révoquer le token côté serveur et le supprimer localement |
Consultez Authentification pour tous les détails sur chaque commande.