Команды для пейволов

Эти команды Adapty CLI управляют пейволами и продуктами, которые каждый пейвол продаёт, а также считывают их метрики.

adapty paywalls list

Список всех пейволов приложения.

adapty paywalls list --app <app-id>
ФлагОбязательныйОписание
--appДаID приложения (UUID)

Принимает флаги пагинации.

adapty paywalls get

Получить подробные сведения о конкретном пейволе.

adapty paywalls get --app <app-id> <paywall-id>
АргументОписание
paywall-idID пейвола (UUID)
ФлагОбязательныйОписание
--appДаID приложения (UUID)

adapty paywalls create

Создайте новый пейвол.

adapty paywalls create --app <app-id> --title "Default Paywall" --products '[{"product_id":"<product-id-1>"},{"product_id":"<product-id-2>"}]'
ФлагОбязательныйОписание
--appДаID приложения (UUID)
--titleДаНазвание пейвола
--productsДаJSON-массив продуктов в порядке отображения: [{product_id, offer_id, fallback_offer_id, billing_plan_id, flow_product_id}]. Обязателен только product_id (ID продукта, UUID); остальные ключи берутся из списка products, который выводит paywalls get
--remote-configsНетJSON-массив записей {locale, data}, где data — это Remote Config в виде JSON-строки
--use-paywall-builder-v4НетИспользует ли пейвол Paywall Builder
--screenshot-idНетID изображения скриншота пейвола (целое число) или null
--builder-screenshot-idНетID изображения скриншота билдера (целое число) или null
--web-purchase-urlНетURL для веб-покупки или null
--product-idНетУстарело: используйте --products. ID продукта (UUID), указывается отдельно для каждого продукта. Задаёт продукты без оффера и тарифного плана; нельзя использовать вместе с --products

Поле, которое вы не указываете, получает стандартное значение дашборда: без Remote Config, без билдера, без скриншотов и без URL для веб-покупок. Флаги, отличные от --app, --title и --product-id, требуют версии CLI 0.20.0 или выше.

adapty paywalls update

Замените все поля существующего пейвола.

Important

После того как пейвол привязан к плейсменту, изменить его продукты невозможно. Чтобы использовать другие продукты в активном пейволе, создайте новый пейвол и обновите плейсмент, указав на него.

Чтобы изменить одно поле, получите пейвол, отредактируйте нужное поле в файле и отправьте весь файл обратно:

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

Команда заменяет все поля пейвола, включая полный список продуктов и весь список Remote Config. Все поля обязательны: если какой-либо флаг отсутствует, команда завершается с кодом 2, перечисляет недостающие флаги и не отправляет запрос. Требуется CLI версии 0.20.0 или выше: более ранние версии принимают только --title и --product-id.

АргументОписание
paywall-idID пейвола (UUID)
ФлагОбязателенОписание
--appДаID приложения (UUID)
--fileВместо флагов полейПуть к JSON-файлу с полным пейволом или - для чтения из stdin. Вывод команды paywalls get --json подходит без изменений; поле id игнорируется. Нельзя использовать вместе с флагами полей
--titleБез --fileЗаголовок пейвола
--productsБез --fileJSON-массив продуктов, как в paywalls create. Передайте список, выведенный командой paywalls get, чтобы сохранить офферы и тарифные планы
--remote-configsБез --fileJSON-массив записей {locale, data}, где data — строка JSON. [] удаляет все Remote Config
--use-paywall-builder-v4 или --no-use-paywall-builder-v4Без --fileИспользует ли пейвол Paywall Builder. Передайте значение из paywalls get: --no-use-paywall-builder-v4 удаляет макет конструктора с устройств
--screenshot-idБез --fileID изображения скриншота пейвола или null
--builder-screenshot-idБез --fileID изображения скриншота конструктора или null
--web-purchase-urlБез --fileURL для веб-покупки или null
--product-idНетУстарело: используйте --products. Устанавливает продукты без оффера и тарифного плана

adapty paywalls placements

Выводит все плейсменты, в которых используется указанный пейвол.

adapty paywalls placements --app <app-id> <paywall-id>
АргументОписание
paywall-idID пейвола (UUID)
ФлагОбязательныйОписание
--appДаID приложения (UUID)

Используйте эту команду перед заменой пейвола, чтобы заранее увидеть, какие плейсменты будут затронуты.

Элементы в этом списке не содержат поля is_active. Чтобы узнать состояние активации плейсмента, используйте placements list или placements get.

adapty paywalls metrics list

Показывает метрики за всё время для нескольких пейволов — по одной строке на каждый пейвол. Это данные из таблицы пейволов в дашборде.

adapty paywalls metrics list --app <app-id> --ids <paywall-id>,<paywall-id>
ФлагОбязателенОписание
--appДаID приложения (UUID)
--idsДаID пейволов (UUID). Разделяйте запятыми или повторяйте флаг
--csvНетВывести CSV: по одной строке на каждый пейвол с его ID и числовыми метриками. Нельзя использовать вместе с --json

Команды paywalls metrics считывают данные со страницы метрики пейволов и требуют CLI версии 0.16.0 или выше.

Каждая строка содержит ID пейвола с количеством просмотров, покупок, пробных периодов и выручкой. Флаг --json возвращает все 21 метрику, например unique_profiles_views, net_revenue и conversion_rate_purchases, а также last_purchases. Флаг --csv исключает два нечисловых поля: in_current_state и last_purchases. Метрика без данных равна 0, но не null.

adapty paywalls metrics values

Список ключей и значений фильтра для пейвола: то, что принимает paywalls metrics get --filter.

adapty paywalls metrics values --app <app-id> <paywall-id>
АргументОписание
paywall-idID пейвола (UUID)
ФлагОбязательныйОписание
--appДаID приложения (UUID)

Вывод имеет ту же форму, что и flows metrics values: верхнее значение каждой группы — это ключ фильтра, а самые вложенные значения — то, что принимает этот ключ.

adapty paywalls 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
АргументОписание
paywall-idID пейвола (UUID)
ФлагОбязательныйОписание
--appДаID приложения (UUID)
--based-onДаПо чему строится первый уровень дерева: placement или audience. Это виды «по плейсменту» и «по аудитории» на странице метрик пейвола
--date-typeДаК какой дате привязан период: purchase_date или profile_install_date для фильтрации по дате установки
--date-fromДаПервый день периода включительно (YYYY-MM-DD)
--date-toДаПоследний день периода включительно (YYYY-MM-DD)
--group-byНетГруппировка продуктов по product, store или country. По умолчанию: product
--granularityНетРазбивка периода на точки: day, week, month, quarter или year
--filterНетОставить только данные с указанными значениями ключа фильтра. Можно указывать несколько раз. См. Фильтрация метрик
--timezoneНетЧасовой пояс IANA для точек периода, например Europe/Berlin. Без него Adapty использует часовой пояс приложения
--depthНетСколько уровней дерева выводить под Total. По умолчанию: 1
--csvНетВывод в формате CSV: одна строка для каждого узла всего дерева. Нельзя использовать вместе с --json

CLI завершается с кодом 2 и не отправляет запрос, если не указан --based-on или --date-type, либо задан только один конец периода. Без периода Adapty отклоняет запрос, и команда завершается с кодом 4. Adapty проверяет значения --based-on, --date-type, --group-by и --granularity: неверное значение приводит к завершению с кодом 4, а в сообщении об ошибке перечислены допустимые значения.

Вывод результатов

Команда выводит строку Total, затем первый уровень дерева под ней с теми же столбцами, что и flows metrics get. Узлы первого уровня всегда включают точки периода — с флагом --granularity или без него.

Уровни дерева: плейсмент или аудитория, затем пейвол или A/B-тест, который там использовался, затем группы --group-by. Чтобы вывести больше уровней, передайте --depth, например --depth 4.

Для получения полного дерева со всеми метриками используйте один из этих флагов:

  • --json выводит ответ сервера без изменений.
  • --csv выводит одну строку на каждый узел, включая промежуточные итоги. Столбцы: path (заголовки от Total до узла, разделённые >), level, title, а затем числовые метрики. В дереве пейволов уровней нет, поэтому level равен root для Total и пуст для всех остальных строк.

Фильтрация метрик

Каждый --filter задаётся в формате key=value, где ключи и значения перечислены в paywalls metrics values. Правила применения фильтров такие же, как в 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

Что дальше