付费墙命令

这些 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-id付费墙 ID(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是App ID(UUID)
--title是付费墙标题
--products是产品的 JSON 数组,按显示顺序排列:[{product_id, offer_id, fallback_offer_id, billing_plan_id, flow_product_id}]。只有 product_id(产品 ID,UUID)是必填项;其他字段来自 paywalls get 输出的 products 列表
--remote-configs否{locale, data} 条目的 JSON 数组,其中 data 是 JSON 字符串格式的远程配置
--use-paywall-builder-v4否付费墙是否使用付费墙编辑工具
--screenshot-id否付费墙截图的图片 ID(整数),或 null
--builder-screenshot-id否编辑工具截图的图片 ID(整数),或 null
--web-purchase-url否网页购买链接,或 null
--product-id否已弃用,请使用 --products。产品 ID(UUID),每个产品重复一次。该参数设置不带优惠和计费方案的产品,不能与 --products 同时使用

您未填写的字段将使用看板默认值:无远程配置、无编辑工具、无截图、无网页购买 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

该命令会替换付费墙的每个字段,包括完整的产品列表和全部远程配置列表。每个字段都是必填项:如果缺少某个标志,命令将以退出码 2 结束,列出缺失的标志,并且不发送任何请求。此功能需要 CLI 0.20.0 或更高版本:更早的版本仅支持 --title 和 --product-id。

参数描述
paywall-id付费墙 ID(UUID)
参数是否必填说明
--app是应用 ID(UUID)
--file与字段参数二选一JSON 文件路径(包含完整付费墙内容),或使用 - 从标准输入读取。paywalls get --json 的输出可直接使用,其中的 id 会被忽略。不可与任何字段参数同时使用
--title不使用 --file 时付费墙标题
--products不使用 --file 时产品的 JSON 数组,格式同 paywalls create。如需保留优惠和计费方案,请传入 paywalls get 输出的列表
--remote-configs不使用 --file 时{locale, data} 条目的 JSON 数组,其中 data 为 JSON 字符串。传入 [] 将删除所有远程配置
--use-paywall-builder-v4 或 --no-use-paywall-builder-v4不使用 --file 时付费墙是否使用付费墙编辑工具。请传入 paywalls get 中的值:--no-use-paywall-builder-v4 会从设备上移除编辑工具布局
--screenshot-id不使用 --file 时付费墙截图的图片 ID,或 null
--builder-screenshot-id不使用 --file 时编辑工具截图的图片 ID,或 null
--web-purchase-url不使用 --file 时网页购买链接,或 null
--product-id否已废弃,请改用 --products。设置不含优惠和计费方案的产品

adapty paywalls placements

列出当前使用指定付费墙的所有版位。

adapty paywalls placements --app <app-id> <paywall-id>
参数说明
paywall-id付费墙 ID(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是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-id付费墙 ID(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-id付费墙 ID(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 同时使用

当 --based-on 或 --date-type 缺失,或者只提供了时间段的一个端点时,CLI 会以代码 2 退出且不发送任何请求。若未提供时间段,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,以及各数值类数据图表。付费墙树没有层级,因此 Total 行的 level 为 root,其他所有行的 level 为空。

筛选数据图表

每个 --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

下一步

  • 命令参考 — 所有 CLI 主题、全局标志和分页标志。