Полный справочник по Adapty Developer CLI
Используете ИИ-ассистент? Доступен навык Adapty CLI для работы с CLI через LLM.
В этой статье перечислены все команды Adapty CLI с их аргументами, флагами и допустимыми значениями.
Для настройки аутентификации и управления токенами см. Аутентификация.
Глобальные флаги
Эти флаги доступны для всех команд.
| Флаг | Описание |
|---|---|
--json | Вывод в формате JSON вместо форматированного текста |
--help | Показать справку по команде |
Все команды list также принимают флаги пагинации:
| Флаг | По умолчанию | Описание |
|---|---|---|
--page | 1 | Номер страницы |
--page-size | 20 | Элементов на странице (макс.: 100) |
Приложения
Управляйте приложениями в вашем аккаунте Adapty. Для настройки через дашборд см. App settings.
adapty apps list
Вывести список всех приложений в вашем аккаунте Adapty.
adapty apps list
Принимает флаги пагинации.
adapty apps get
Получить сведения о конкретном приложении.
adapty apps get <app-id>
| Аргумент | Описание |
|---|---|
app-id | ID приложения (UUID) |
adapty apps create
Создание нового приложения.
adapty apps create --title "My App" --platform ios --apple-bundle-id com.example.app
| Флаг | Обязательный | Описание |
|---|---|---|
--title | Да | Название приложения |
--platform | Да | Платформа: ios или android. Укажите оба: --platform ios --platform android |
--apple-bundle-id | Обязателен при --platform ios | Apple bundle ID |
--google-bundle-id | Обязателен при --platform android | Google bundle ID |
adapty apps update
Обновить существующее приложение.
adapty apps update <app-id> --title "New Name"
| Аргумент | Описание |
|---|---|
app-id | ID приложения (UUID) |
| Флаг | Описание |
|---|---|
--title | Новое название приложения |
--apple-bundle-id | Новый Apple bundle ID |
--google-bundle-id | Новый Google bundle ID |
Необходимо указать хотя бы один флаг. --platform нельзя изменить после создания.
Уровни доступа
adapty access-levels list
Список всех уровней доступа для приложения.
adapty access-levels list --app <app-id>
| Флаг | Обязательный | Описание |
|---|---|---|
--app | Да | ID приложения (UUID) |
Принимает флаги пагинации.
adapty access-levels get
Получить детали конкретного уровня доступа.
adapty access-levels get --app <app-id> <access-level-id>
| Аргумент | Описание |
|---|---|
access-level-id | ID уровня доступа (UUID) |
| Флаг | Обязательный | Описание |
|---|---|---|
--app | Да | ID приложения (UUID) |
adapty access-levels create
Создать новый уровень доступа.
adapty access-levels create --app <app-id> --sdk-id "pro" --title "Pro"
| Флаг | Обязательный | Описание |
|---|---|---|
--app | Да | ID приложения (UUID) |
--sdk-id | Да | Идентификатор, используемый в коде приложения для проверки доступа (например, "pro" или "premium") |
--title | Да | Отображаемое название в дашборде Adapty |
adapty access-levels update
Обновление существующего уровня доступа.
adapty access-levels update --app <app-id> <access-level-id> --title "Pro Access"
| Аргумент | Описание |
|---|---|
access-level-id | ID уровня доступа (UUID) |
| Флаг | Обязательный | Описание |
|---|---|---|
--app | Да | ID приложения (UUID) |
--title | Да | Новое отображаемое название |
--sdk-id нельзя изменить после создания.
Продукты
Список продуктов Adapty
Список всех продуктов приложения.
adapty products list --app <app-id>
| Флаг | Обязательный | Описание |
|---|---|---|
--app | Да | ID приложения (UUID) |
Принимает флаги пагинации.
adapty products get
Получить информацию о конкретном продукте.
adapty products get --app <app-id> <product-id>
| Аргумент | Описание |
|---|---|
product-id | ID продукта (UUID) |
| Флаг | Обязательный | Описание |
|---|---|---|
--app | Да | ID приложения (UUID) |
adapty products create
Создание нового продукта.
Идентификаторы продуктов стора (--ios-product-id, --android-product-id, --android-base-plan-id) нельзя изменить после создания. Чтобы использовать другие идентификаторы, создайте новый продукт.
adapty products create --app <app-id> --title "Monthly" --access-level-id <access-level-id> --period monthly --ios-product-id com.example.monthly
| Флаг | Обязательный | Описание |
|---|---|---|
--app | Да | ID приложения (UUID) |
--title | Да | Название продукта |
--access-level-id | Да | ID уровня доступа (UUID), который открывает этот продукт |
--period | Да | Период подписки: weekly, monthly, 2_months, 3_months, 6_months, yearly, lifetime |
--ios-product-id | Требуется хотя бы одна платформа | ID продукта из App Store Connect |
--android-product-id | Требуется хотя бы одна платформа | ID продукта из Google Play Console |
--android-base-plan-id | Обязателен вместе с --android-product-id, если не указан --period lifetime | ID базового плана из Google Play Console |
adapty products update
Обновить существующий продукт.
Идентификаторы продуктов стора (--ios-product-id, --android-product-id) нельзя изменить после создания — они недоступны в этой команде. Чтобы использовать другие идентификаторы, создайте новый продукт.
adapty products update --app <app-id> <product-id> --title "Monthly" --access-level-id <access-level-id>
| Аргумент | Описание |
|---|---|
product-id | ID продукта (UUID) |
| Флаг | Обязательный |
| --- | --- |
--app | Да |
--title | Нет |
--access-level-id | Нет |
Пейволы
Список пейволов Adapty
Получить список всех пейволов приложения.
adapty paywalls list --app <app-id>
| Флаг | Обязательный | Описание |
|---|---|---|
--app | Да | ID приложения (UUID) |
Принимает флаги пагинации.
adapty paywalls get
Получить подробную информацию о конкретном пейволе.
adapty paywalls get --app <app-id> <paywall-id>
| Аргумент | Описание |
|---|---|
paywall-id | ID пейвола (UUID) |
| Флаг | Обязателен | Описание |
|---|---|---|
--app | Да | ID приложения (UUID) |
adapty paywalls create
Создайте новый пейвол.
adapty paywalls create --app <app-id> --title "Default Paywall" --product-id <product-id>
| Флаг | Обязательный | Описание |
|---|---|---|
--app | Да | ID приложения (UUID) |
--title | Да | Название пейвола |
--product-id | Да | ID продукта (UUID). Повторите для нескольких продуктов: --product-id <id1> --product-id <id2> |
adapty paywalls update
Замените все поля существующего пейвола.
Если пейвол уже привязан к плейсменту, его продукты нельзя изменить. Чтобы использовать другие продукты в активном пейволе, создайте новый пейвол и обновите плейсмент, чтобы он указывал на него.
adapty paywalls update --app <app-id> <paywall-id> --title "Default Paywall" --product-id <product-id>
Эта команда заменяет все поля пейвола, включая полный список продуктов.
| Аргумент | Описание |
|---|---|
paywall-id | ID пейвола (UUID) |
| Флаг | Обязательный |
| --- | --- |
--app | Да |
--title | Да |
--product-id | Да |
adapty paywalls placements
Выводит список всех плейсментов, которые в данный момент используют указанный пейвол.
adapty paywalls placements --app <app-id> <paywall-id>
| Аргумент | Описание |
|---|---|
paywall-id | ID пейвола (UUID) |
| Флаг | Обязательный | Описание |
|---|---|---|
--app | Да | ID приложения (UUID) |
Используйте эту команду перед заменой пейвола, чтобы заранее увидеть, какие плейсменты будут затронуты.
Плейсменты
Список плейсментов Adapty
Выводит все плейсменты приложения.
adapty placements list --app <app-id>
| Флаг | Обязательный | Описание |
|---|---|---|
--app | Да | ID приложения (UUID) |
Принимает флаги пагинации.
adapty placements get
Получить подробную информацию о конкретном плейсменте.
adapty placements get --app <app-id> <placement-id>
| Аргумент | Описание |
|---|---|
placement-id | ID плейсмента (UUID) |
| Флаг | Обязательный | Описание |
|---|---|---|
--app | Да | ID приложения (UUID) |
Ответ содержит массив audiences. Каждый элемент — это {segment_ids, paywall_id, priority}. Дефолтная аудитория имеет segment_ids: [] и наибольшее значение приоритета (оценивается последней). В форматированном выводе также отображается Paywall ID верхнего уровня, полученный из дефолтной аудитории для удобства. --json возвращает исходную форму ответа API без изменений. |
adapty placements create
Создать новый плейсмент.
adapty placements create --app <app-id> --title "Main" --developer-id "main" --audiences '[{"segment_ids":[],"paywall_id":"<paywall-id>","priority":0}]'
| Флаг | Обязательный | Описание |
|---|---|---|
--app | Да | ID приложения (UUID) |
--title | Да | Название плейсмента |
--developer-id | Да | Строковый идентификатор, используемый в коде приложения для запроса этого плейсмента |
--audiences | Один из двух | JSON-массив записей {segment_ids, paywall_id, priority}. См. Форма audiences |
--paywall-id | Один из двух | Устарело. ID пейвола (UUID). На стороне клиента оборачивается в единственную дефолтную аудиторию |
Передайте ровно один из параметров: --audiences или --paywall-id. Передача обоих или ни одного из них приведёт к ошибке.
--paywall-id устарел и будет удалён. При передаче этого параметра CLI выводит предупреждение в stderr и преобразует значение в аудиторию по умолчанию. Используйте --audiences для новой автоматизации.
adapty placements update
Заменяет все поля существующего плейсмента.
adapty placements update --app <app-id> <placement-id> --title "Main" --developer-id "main" --audiences '[{"segment_ids":[],"paywall_id":"<paywall-id>","priority":0}]'
Эта команда заменяет все поля плейсмента, включая полный список аудиторий.
| Аргумент | Описание |
|---|---|
placement-id | ID плейсмента (UUID) |
| Флаг | Обязательный |
| --- | --- |
--app | Да |
--title | Да |
--developer-id | Да |
--audiences | Один из двух |
--paywall-id | Один из двух |
Передача --paywall-id перезаписывает все аудитории на плейсменте. Аудитории, привязанные к сегментам, удаляются. Чтобы сохранить их, используйте --audiences и включите все нужные записи.
Форма аудиторий
Флаг --audiences принимает JSON-массив. Каждый элемент содержит:
| Поле | Тип | Описание |
|---|---|---|
segment_ids | string[] | Массив ID сегментов, на которые нацелена данная аудитория. Длина 0 или 1. Пустой массив обозначает аудиторию по умолчанию — резервный вариант для пользователей, не попавших ни в один другой сегмент |
paywall_id | string | ID пейвола (UUID), который показывается пользователям в данной аудитории |
priority | number | Нумерация с нуля, уникальная в рамках плейсмента. Аудитории проверяются от меньшего значения к большему; аудитория по умолчанию должна иметь наибольшее значение |
Плейсмент должен содержать ровно одну аудиторию по умолчанию.
Пример с одной целевой аудиторией и одной аудиторией по умолчанию:
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}]'
Чтобы заменить пейвол сразу в нескольких плейсментах, не потеряв маршрутизацию по сегментам:
-
Найдите затронутые плейсменты:
adapty paywalls placements --app <app-id> <old-paywall-id> -
Для каждого из них получите полный массив
audiences:adapty placements get --app <app-id> <placement-id> --json -
Замените совпадающие значения
paywall_idна стороне клиента. -
Запишите изменённый payload обратно:
adapty placements update --app <app-id> <placement-id> --title "<title>" --developer-id "<developer-id>" --audiences '<modified-payload>'
Сегменты
Сегменты доступны через CLI только для чтения. Создавайте и редактируйте их в дашборде Adapty. Используйте эти команды, чтобы находить идентификаторы сегментов при настройке аудиторий плейсментов.
Список сегментов adapty
Выводит все сегменты приложения.
adapty segments list --app <app-id>
| Флаг | Обязателен | Описание |
|---|---|---|
--app | Да | ID приложения (UUID) |
Поддерживает флаги пагинации.
adapty segments get
Получить подробную информацию о конкретном сегменте.
adapty segments get --app <app-id> <segment-id>
| Аргумент | Описание |
|---|---|
segment-id | ID сегмента (UUID) |
| Флаг | Обязательный | Описание |
|---|---|---|
--app | Да | ID приложения (UUID) |
Ответ содержит id, title и description. Правила фильтрации через этот API не предоставляются.
Auth
| Команда | Описание |
|---|---|
adapty auth login | Аутентификация через браузер с использованием device flow |
adapty auth logout | Удалить сохранённые учётные данные локально |
adapty auth whoami | Проверить токен на сервере и показать информацию о пользователе |
adapty auth status | Показать локальное состояние аутентификации без обращения к серверу |
adapty auth revoke | Отозвать токен на сервере и удалить его локально |
Подробное описание каждой команды см. в разделе Аутентификация.