Referencia completa de la CLI para desarrolladores de Adapty

¿Usas un asistente de IA? Hay disponible una skill de Adapty CLI para ayudar a los LLMs a trabajar con la CLI.

Este artículo lista todos los comandos de la CLI de Adapty con sus argumentos, flags y valores aceptados.

Para configurar la autenticación y gestionar tokens, consulta Autenticación.

Flags globales

Estos flags están disponibles en todos los comandos.

FlagDescripción
--jsonMostrar la salida en JSON en lugar de texto formateado
--helpMostrar la ayuda del comando

Todos los comandos list también aceptan flags de paginación:

FlagPor defectoDescripción
--page1Número de página
--page-size20Elementos por página (máx.: 100)

Apps

Gestiona las apps de tu cuenta de Adapty. Para la configuración desde el dashboard, consulta App settings.

adapty apps list

Lista todas las apps de tu cuenta de Adapty.

adapty apps list

Acepta flags de paginación.

adapty apps get

Obtén los detalles de una app específica.

adapty apps get <app-id>
ArgumentoDescripción
app-idID de la app (UUID)

adapty apps create

Crea una nueva app.

adapty apps create --title "My App" --platform ios --apple-bundle-id com.example.app
FlagRequeridoDescripción
--titleTítulo de la app
--platformPlataforma: ios o android. Repite para ambas: --platform ios --platform android
--apple-bundle-idRequerido con --platform iosBundle ID de Apple
--google-bundle-idRequerido con --platform androidBundle ID de Google

adapty apps update

Actualiza una app existente.

adapty apps update <app-id> --title "New Name"
ArgumentoDescripción
app-idID de la app (UUID)
FlagDescripción
--titleNuevo título de la app
--apple-bundle-idNuevo bundle ID de Apple
--google-bundle-idNuevo bundle ID de Google

Se requiere al menos un flag. --platform no se puede cambiar después de la creación.

Niveles de acceso

adapty access-levels list

Lista todos los niveles de acceso de una app.

adapty access-levels list --app <app-id>
FlagRequeridoDescripción
--appID de la app (UUID)

Acepta flags de paginación.

adapty access-levels get

Obtén los detalles de un nivel de acceso específico.

adapty access-levels get --app <app-id> <access-level-id>
ArgumentoDescripción
access-level-idID del nivel de acceso (UUID)
FlagRequeridoDescripción
--appID de la app (UUID)

adapty access-levels create

Crea un nuevo nivel de acceso.

adapty access-levels create --app <app-id> --sdk-id "pro" --title "Pro"
FlagRequeridoDescripción
--appID de la app (UUID)
--sdk-idIdentificador utilizado en el código de la app para comprobar el acceso (por ejemplo, "pro" o "premium")
--titleEtiqueta de visualización en el Adapty Dashboard

adapty access-levels update

Actualiza un nivel de acceso existente.

adapty access-levels update --app <app-id> <access-level-id> --title "Pro Access"
ArgumentoDescripción
access-level-idID del nivel de acceso (UUID)
FlagRequeridoDescripción
--appID de la app (UUID)
--titleNueva etiqueta de visualización

--sdk-id no se puede cambiar después de la creación.

Productos

adapty products list

Lista todos los productos de una app.

adapty products list --app <app-id>
FlagRequeridoDescripción
--appID de la app (UUID)

Acepta flags de paginación.

adapty products get

Obtén los detalles de un producto específico.

adapty products get --app <app-id> <product-id>
ArgumentoDescripción
product-idID del producto (UUID)
FlagRequeridoDescripción
--appID de la app (UUID)

adapty products create

Crea un nuevo producto.

Los IDs de producto de la store (--ios-product-id, --android-product-id, --android-base-plan-id) no se pueden cambiar después de la creación. Para usar IDs de producto de la store distintos, crea un nuevo producto.

adapty products create --app <app-id> --title "Monthly" --access-level-id <access-level-id> --period monthly --ios-product-id com.example.monthly
FlagRequeridoDescripción
--appID de la app (UUID)
--titleTítulo del producto
--access-level-idID (UUID) del nivel de acceso que desbloquea este producto
--periodPeríodo de suscripción: weekly, monthly, 2_months, 3_months, 6_months, yearly, lifetime
--ios-product-idSe requiere al menos una plataformaID del producto en App Store Connect
--android-product-idSe requiere al menos una plataformaID del producto en Google Play Console
--android-base-plan-idRequerido con --android-product-id salvo que --period lifetimeID del plan base en Google Play Console

adapty products update

Actualiza un producto existente.

Los IDs de producto de la store (--ios-product-id, --android-product-id) no se pueden cambiar después de la creación y no están disponibles en este comando. Para usar IDs de producto de la store distintos, crea un nuevo producto.

adapty products update --app <app-id> <product-id> --title "Monthly" --access-level-id <access-level-id>
ArgumentoDescripción
product-idID del producto (UUID)
FlagRequeridoDescripción
--appID de la app (UUID)
--titleNoTítulo del producto
--access-level-idNoID (UUID) del nivel de acceso que desbloquea este producto

Paywalls

adapty paywalls list

Lista todos los paywalls de una app.

adapty paywalls list --app <app-id>
FlagRequeridoDescripción
--appID de la app (UUID)

Acepta flags de paginación.

adapty paywalls get

Obtén los detalles de un paywall específico.

adapty paywalls get --app <app-id> <paywall-id>
ArgumentoDescripción
paywall-idID del paywall (UUID)
FlagRequeridoDescripción
--appID de la app (UUID)

adapty paywalls create

Crea un nuevo paywall.

adapty paywalls create --app <app-id> --title "Default Paywall" --product-id <product-id>
FlagRequeridoDescripción
--appID de la app (UUID)
--titleTítulo del paywall
--product-idID (UUID) del producto. Repite para varios productos: --product-id <id1> --product-id <id2>

adapty paywalls update

Reemplaza todos los campos de un paywall existente.

Una vez que un paywall está vinculado a un placement, sus productos no se pueden cambiar. Para usar productos distintos en un paywall en producción, crea un nuevo paywall y actualiza el placement para que apunte a él.

adapty paywalls update --app <app-id> <paywall-id> --title "Default Paywall" --product-id <product-id>

Este comando reemplaza todos los campos del paywall, incluida la lista completa de productos.

ArgumentoDescripción
paywall-idID del paywall (UUID)
FlagRequeridoDescripción
--appID de la app (UUID)
--titleTítulo del paywall
--product-idID (UUID) del producto. Repite para varios productos: --product-id <id1> --product-id <id2>

adapty paywalls placements

Lista todos los placements que actualmente usan un paywall determinado.

adapty paywalls placements --app <app-id> <paywall-id>
ArgumentoDescripción
paywall-idID del paywall (UUID)
FlagRequeridoDescripción
--appID de la app (UUID)

Usa este comando antes de reemplazar un paywall para ver qué placements se verían afectados.

Placements

adapty placements list

Lista todos los placements de una app.

adapty placements list --app <app-id>
FlagRequeridoDescripción
--appID de la app (UUID)

Acepta flags de paginación.

adapty placements get

Obtén los detalles de un placement específico.

adapty placements get --app <app-id> <placement-id>
ArgumentoDescripción
placement-idID del placement (UUID)
FlagRequeridoDescripción
--appID de la app (UUID)

La respuesta contiene un array audiences. Cada entrada es {segment_ids, paywall_id, priority}. La audiencia por defecto tiene segment_ids: [] y el valor de prioridad más alto (se evalúa en último lugar). La salida formateada en texto también muestra un Paywall ID de nivel superior derivado de la audiencia por defecto, por comodidad. Con --json se devuelve la forma de la API sin modificar.

adapty placements create

Crea un nuevo placement.

adapty placements create --app <app-id> --title "Main" --developer-id "main" --audiences '[{"segment_ids":[],"paywall_id":"<paywall-id>","priority":0}]'
FlagRequeridoDescripción
--appID de la app (UUID)
--titleTítulo del placement
--developer-idIdentificador de cadena utilizado en el código de la app para solicitar este placement
--audiencesUno de los dosArray JSON de entradas {segment_ids, paywall_id, priority}. Consulta Forma de las audiencias
--paywall-idUno de los dosObsoleto. ID (UUID) del paywall. Se convierte en el cliente en una única audiencia por defecto

Pasa exactamente uno de --audiences o --paywall-id. Si se pasan ambos o ninguno, se produce un error.

--paywall-id está obsoleto y se eliminará. Al usarlo, la CLI muestra una advertencia en stderr y convierte el valor en una audiencia por defecto. Para nuevas automatizaciones, usa --audiences.

adapty placements update

Reemplaza todos los campos de un placement existente.

adapty placements update --app <app-id> <placement-id> --title "Main" --developer-id "main" --audiences '[{"segment_ids":[],"paywall_id":"<paywall-id>","priority":0}]'

Este comando reemplaza todos los campos del placement, incluida la lista completa de audiencias.

ArgumentoDescripción
placement-idID del placement (UUID)
FlagRequeridoDescripción
--appID de la app (UUID)
--titleTítulo del placement
--developer-idIdentificador de cadena utilizado en el código de la app para solicitar este placement
--audiencesUno de los dosArray JSON de entradas {segment_ids, paywall_id, priority}. Consulta Forma de las audiencias
--paywall-idUno de los dosObsoleto. ID (UUID) del paywall. Reemplaza todas las audiencias con una única audiencia por defecto

Al usar --paywall-id se sobreescriben todas las audiencias del placement. Las audiencias específicas de segmento se eliminan. Para conservarlas, usa --audiences e incluye todas las entradas que quieras mantener.

Forma de las audiencias

El flag --audiences acepta un array JSON. Cada entrada tiene:

CampoTipoDescripción
segment_idsstring[]IDs de segmento a los que se dirige esta audiencia. Longitud 0 o 1. Un array vacío marca la audiencia por defecto: el fallback para usuarios que no coinciden con ningún otro segmento
paywall_idstringID (UUID) del paywall que se muestra a los usuarios de esta audiencia
prioritynumberBasado en 0, único dentro del placement. Las audiencias se evalúan de menor a mayor; la audiencia por defecto debe tener el valor más alto

Un placement debe tener exactamente una audiencia por defecto.

Ejemplo con una audiencia segmentada y una por defecto:

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}]'

Para reemplazar un paywall en varios placements sin perder el enrutamiento por segmento:

  1. Encuentra los placements afectados:

    adapty paywalls placements --app <app-id> <old-paywall-id>
  2. Para cada uno, lee el array completo de audiences:

    adapty placements get --app <app-id> <placement-id> --json
  3. Reemplaza los valores de paywall_id correspondientes en el cliente.

  4. Escribe el payload modificado:

    adapty placements update --app <app-id> <placement-id> --title "<title>" --developer-id "<developer-id>" --audiences '<modified-payload>'

Segmentos

Los segmentos son de solo lectura a través de la CLI. Créalos y edítalos en el Adapty dashboard. Usa estos comandos para buscar los IDs de segmento al componer audiencias de placements.

adapty segments list

Lista todos los segmentos de una app.

adapty segments list --app <app-id>
FlagRequeridoDescripción
--appID de la app (UUID)

Acepta flags de paginación.

adapty segments get

Obtén los detalles de un segmento específico.

adapty segments get --app <app-id> <segment-id>
ArgumentoDescripción
segment-idID del segmento (UUID)
FlagRequeridoDescripción
--appID de la app (UUID)

La respuesta contiene id, title y description. Las reglas de filtro no están expuestas a través de esta API.

Auth

ComandoDescripción
adapty auth loginAutenticarse mediante el navegador usando el flujo de dispositivo
adapty auth logoutBorrar las credenciales almacenadas localmente
adapty auth whoamiVerificar el token con el servidor y mostrar información del usuario
adapty auth statusMostrar el estado de autenticación local sin hacer una llamada al servidor
adapty auth revokeRevocar el token en el servidor y borrarlo localmente

Consulta Autenticación para ver todos los detalles de cada comando.