Полный справочник по Adapty Developer CLI

Используете ИИ-ассистент? Доступен навык Adapty CLI для работы с CLI через LLM.

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

Для настройки аутентификации и управления токенами см. Аутентификация.

Глобальные флаги

Эти флаги доступны для всех команд.

ФлагОписание
--jsonВывод в формате JSON вместо форматированного текста
--helpПоказать справку по команде

Все команды list также принимают флаги пагинации:

ФлагПо умолчаниюОписание
--page1Номер страницы
--page-size20Элементов на странице (макс.: 100)

Приложения

Управляйте приложениями в вашем аккаунте Adapty. Для настройки через дашборд см. App settings.

adapty apps list

Вывести список всех приложений в вашем аккаунте Adapty.

adapty apps list

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

adapty apps get

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

adapty apps get <app-id>
АргументОписание
app-idID приложения (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 iosApple bundle ID
--google-bundle-idОбязателен при --platform androidGoogle bundle ID

adapty apps update

Обновить существующее приложение.

adapty apps update <app-id> --title "New Name"
АргументОписание
app-idID приложения (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-idID уровня доступа (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-idID уровня доступа (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-idID продукта (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 lifetimeID базового плана из 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-idID продукта (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-idID пейвола (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-idID пейвола (UUID)
ФлагОбязательный
------
--appДа
--titleДа
--product-idДа

adapty paywalls placements

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

adapty paywalls placements --app <app-id> <paywall-id>
АргументОписание
paywall-idID пейвола (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-idID плейсмента (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-idID плейсмента (UUID)
ФлагОбязательный
------
--appДа
--titleДа
--developer-idДа
--audiencesОдин из двух
--paywall-idОдин из двух

Передача --paywall-id перезаписывает все аудитории на плейсменте. Аудитории, привязанные к сегментам, удаляются. Чтобы сохранить их, используйте --audiences и включите все нужные записи.

Форма аудиторий

Флаг --audiences принимает JSON-массив. Каждый элемент содержит:

ПолеТипОписание
segment_idsstring[]Массив ID сегментов, на которые нацелена данная аудитория. Длина 0 или 1. Пустой массив обозначает аудиторию по умолчанию — резервный вариант для пользователей, не попавших ни в один другой сегмент
paywall_idstringID пейвола (UUID), который показывается пользователям в данной аудитории
prioritynumberНумерация с нуля, уникальная в рамках плейсмента. Аудитории проверяются от меньшего значения к большему; аудитория по умолчанию должна иметь наибольшее значение

Плейсмент должен содержать ровно одну аудиторию по умолчанию.

Пример с одной целевой аудиторией и одной аудиторией по умолчанию:

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

Чтобы заменить пейвол сразу в нескольких плейсментах, не потеряв маршрутизацию по сегментам:

  1. Найдите затронутые плейсменты:

    adapty paywalls placements --app <app-id> <old-paywall-id>
  2. Для каждого из них получите полный массив audiences:

    adapty placements get --app <app-id> <placement-id> --json
  3. Замените совпадающие значения paywall_id на стороне клиента.

  4. Запишите изменённый 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-idID сегмента (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Отозвать токен на сервере и удалить его локально

Подробное описание каждой команды см. в разделе Аутентификация.