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.

Indicateurs globaux

Ces indicateurs sont disponibles sur toutes les commandes.

IndicateurDescription
--jsonAfficher en JSON plutôt qu’en texte formaté
--helpAfficher l’aide de la commande

Toutes les commandes list acceptent également des indicateurs de pagination :

IndicateurDéfautDescription
--page1Numéro de page
--page-size20É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>
ArgumentDescription
app-idID 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
FlagRequiredDescription
--titleYesTitre de l’application
--platformYesPlateforme : ios ou android. Répéter pour les deux : --platform ios --platform android
--apple-bundle-idRequired with --platform iosBundle ID Apple
--google-bundle-idRequired with --platform androidBundle ID Google

adapty apps update

Mettre à jour une application existante.

adapty apps update <app-id> --title "New Name"
ArgumentDescription
app-idID de l’application (UUID)
FlagDescription
--titleNouveau titre de l’application
--apple-bundle-idNouvel Apple bundle ID
--google-bundle-idNouvel 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>
FlagRequiredDescription
--appYesApp 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>
ArgumentDescription
access-level-idID du niveau d’accès (UUID)
FlagRequisDescription
--appOuiID 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"
FlagRequisDescription
--appOuiID de l’app (UUID)
--sdk-idOuiIdentifiant utilisé dans le code de l’app pour vérifier l’accès (par exemple, "pro" ou "premium")
--titleOuiLibellé 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"
ArgumentDescription
access-level-idID du niveau d’accès (UUID)
FlagRequisDescription
--appOuiID de l’app (UUID)
--titleOuiNouveau 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>
FlagRequisDescription
--appOuiID 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>
ArgumentDescription
product-idID du produit (UUID)
IndicateurRequisDescription
--appOuiID de l’application (UUID)

adapty products create

Créez un nouveau produit.

Important

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ètreObligatoireDescription
--appOuiID de l’app (UUID)
--titleOuiTitre du produit
--access-level-idOuiID (UUID) du niveau d’accès que ce produit débloque
--periodOuiPériode d’abonnement : weekly, monthly, two_months, trimonthly, semiannual, annual, lifetime
--ios-product-idAu moins un store requisID du produit dans App Store Connect
--android-product-idAu moins un store requisID du produit dans Google Play Console
--android-base-plan-idObligatoire avec --android-product-id sauf si --period lifetimeID du plan de base dans Google Play Console
--stripe-product-idAu moins un store requisID du produit dans Stripe
--stripe-price-idObligatoire avec --stripe-product-idID du prix dans Stripe
--paddle-product-idAu moins un store requisID du produit dans Paddle
--paddle-price-idObligatoire avec --paddle-product-idID 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>
ArgumentDescription
product-idID du produit (UUID)
IndicateurRequisDescription
--appOuiID de l’application (UUID)
--titleNonTitre du produit
--access-level-idNonID (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>
IndicateurRequisDescription
--appOuiID 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>
ArgumentDescription
paywall-idID du paywall (UUID)
FlagRequisDescription
--appOuiID 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>
FlagRequisDescription
--appOuiID de l’application (UUID)
--titleOuiTitre du paywall
--product-idOuiID 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.

Important

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.

ArgumentDescription
paywall-idID du paywall (UUID)
IndicateurObligatoireDescription
--appOuiID d’application (UUID)
--titleOuiTitre du paywall
--product-idOuiID 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>
ArgumentDescription
paywall-idID du paywall (UUID)
FlagRequisDescription
--appOuiID 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>
FlagRequisDescription
--appOuiID 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>
ArgumentDescription
placement-idID du placement (UUID)
FlagRequisDescription
--appOuiID 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}]'
IndicateurRequisDescription
--appOuiID de l’application (UUID)
--titleOuiTitre du placement
--developer-idOuiIdentifiant de chaîne utilisé dans le code de l’application pour demander ce placement
--audiencesL’un des deuxTableau JSON d’entrées {segment_ids, paywall_id, priority}. Voir Structure des audiences
--paywall-idL’un des deuxDé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.

Warning

--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.

ArgumentDescription
placement-idID du placement (UUID)
IndicateurRequisDescription
--appOuiID de l’app (UUID)
--titleOuiTitre du placement
--developer-idOuiIdentifiant string utilisé dans le code de l’app pour requêter ce placement
--audiencesL’un des deuxTableau JSON d’entrées {segment_ids, paywall_id, priority}. Voir Format des audiences
--paywall-idL’un des deuxDéprécié. ID du paywall (UUID). Remplace toutes les audiences par une seule audience par défaut
Warning

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 :

ChampTypeDescription
segment_idsstring[]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_idstringID de paywall (UUID) affiché aux utilisateurs de cette audience
prioritynumberBase 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 :

  1. Trouvez les placements concernés :

    adapty paywalls placements --app <app-id> <old-paywall-id>
  2. Pour chacun, lisez le tableau audiences complet :

    adapty placements get --app <app-id> <placement-id> --json
  3. Remplacez les valeurs paywall_id correspondantes côté client.

  4. 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>
FlagRequiredDescription
--appYesApp 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>
ArgumentDescription
segment-idID du segment (UUID)
FlagRequisDescription
--appOuiID 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

CommandeDescription
adapty auth loginS’authentifier via le navigateur en utilisant le flow de l’appareil
adapty auth logoutSupprimer les identifiants stockés localement
adapty auth whoamiVérifier le token auprès du serveur et afficher les informations de l’utilisateur
adapty auth statusAfficher l’état d’authentification local sans appel au serveur
adapty auth revokeRévoquer le token côté serveur et le supprimer localement

Consultez Authentification pour tous les détails sur chaque commande.