Lệnh Paywalls

Các lệnh Adapty CLI này quản lý paywall và các sản phẩm mà mỗi paywall bán, đồng thời đọc các chỉ số của chúng.

Danh sách paywall của Adapty

Liệt kê tất cả paywall của một ứng dụng.

adapty paywalls list --app <app-id>
FlagBắt buộcMô tả
--appCóApp ID (UUID)

Chấp nhận pagination flags.

adapty paywalls get

Lấy chi tiết cho một paywall cụ thể.

adapty paywalls get --app <app-id> <paywall-id>
ArgumentDescription
paywall-idPaywall ID (UUID)
FlagRequiredDescription
--appYesApp ID (UUID)

adapty paywalls create

Tạo một paywall mới.

adapty paywalls create --app <app-id> --title "Default Paywall" --products '[{"product_id":"<product-id-1>"},{"product_id":"<product-id-2>"}]'
FlagBắt buộcMô tả
--appCóApp ID (UUID)
--titleCóTiêu đề paywall
--productsCóMảng JSON của các sản phẩm, theo thứ tự hiển thị: [{product_id, offer_id, fallback_offer_id, billing_plan_id, flow_product_id}]. Chỉ cần product_id (ID sản phẩm, UUID); các khóa còn lại lấy từ danh sách products mà paywalls get hiển thị
--remote-configsKhôngMảng JSON gồm các mục {locale, data}, trong đó data là Remote Config dưới dạng chuỗi JSON
--use-paywall-builder-v4KhôngPaywall có sử dụng Paywall Builder hay không
--screenshot-idKhôngID hình ảnh của ảnh chụp màn hình paywall (số nguyên), hoặc null
--builder-screenshot-idKhôngID hình ảnh của ảnh chụp màn hình builder (số nguyên), hoặc null
--web-purchase-urlKhôngURL mua hàng qua web, hoặc null
--product-idKhôngKhông còn được khuyến nghị: hãy dùng --products. ID sản phẩm (UUID), lặp lại cho từng sản phẩm. Tùy chọn này thiết lập sản phẩm không có ưu đãi và không có billing plan, không thể dùng cùng với --products

Trường nào bạn bỏ trống sẽ dùng giá trị mặc định của dashboard: không có Remote Config, không dùng builder, không có ảnh chụp màn hình và không có URL mua hàng trên web. Các flag khác ngoài --app, --title và --product-id yêu cầu CLI phiên bản 0.20.0 trở lên.

adapty paywalls update

Thay thế tất cả các trường của một paywall hiện có.

Important

Khi paywall đã được liên kết với một placement, sản phẩm của nó không thể thay đổi. Để sử dụng sản phẩm khác trong paywall đang hoạt động, hãy tạo paywall mới và cập nhật placement để trỏ đến paywall đó.

Để thay đổi một trường, hãy đọc paywall, chỉnh sửa trường đó trong file, rồi gửi lại toàn bộ file:

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

Lệnh này sẽ thay thế toàn bộ các trường của paywall, bao gồm danh sách sản phẩm đầy đủ và toàn bộ danh sách remote config. Tất cả các trường đều bắt buộc: nếu thiếu flag nào, lệnh sẽ thoát với mã 2, liệt kê các flag còn thiếu và không gửi request. Yêu cầu CLI phiên bản 0.20.0 trở lên: các phiên bản trước đó chỉ nhận --title và --product-id.

Tham sốMô tả
paywall-idID paywall (UUID)
CờBắt buộcMô tả
--appCóID ứng dụng (UUID)
--fileThay cho các cờ trườngĐường dẫn đến file JSON chứa toàn bộ paywall, hoặc - để đọc từ stdin. Kết quả của paywalls get --json dùng được ngay; id của nó sẽ bị bỏ qua. Không thể dùng cùng với bất kỳ cờ trường nào
--titleKhông dùng --fileTiêu đề paywall
--productsKhông dùng --fileMảng JSON các sản phẩm, như trong paywalls create. Gửi danh sách mà paywalls get đã in ra để giữ nguyên các ưu đãi và billing plan
--remote-configsKhông dùng --fileMảng JSON các mục {locale, data}, trong đó data là một chuỗi JSON. [] sẽ xóa tất cả Remote Config
--use-paywall-builder-v4 hoặc --no-use-paywall-builder-v4Không dùng --filePaywall có dùng Paywall Builder hay không. Gửi giá trị từ paywalls get: --no-use-paywall-builder-v4 sẽ xóa layout builder khỏi các thiết bị
--screenshot-idKhông dùng --fileID hình ảnh của ảnh chụp màn hình paywall, hoặc null
--builder-screenshot-idKhông dùng --fileID hình ảnh của ảnh chụp màn hình builder, hoặc null
--web-purchase-urlKhông dùng --fileURL mua hàng qua web, hoặc null
--product-idKhôngĐã lỗi thời: hãy dùng --products. Thiết lập sản phẩm không có ưu đãi và không có billing plan

adapty paywalls placements

Liệt kê tất cả các placement hiện đang sử dụng một paywall cụ thể.

adapty paywalls placements --app <app-id> <paywall-id>
Đối sốMô tả
paywall-idID của paywall (UUID)
FlagBắt buộcMô tả
--appCóID của app (UUID)

Dùng lệnh này trước khi thay thế một paywall để xem những placement nào sẽ bị ảnh hưởng.

Các mục trong danh sách này không có trường is_active. Để đọc trạng thái kích hoạt của một placement, hãy dùng placements list hoặc placements get.

Danh sách chỉ số adapty paywalls metrics

Hiển thị các chỉ số theo thời gian của nhiều paywall, mỗi dòng là một paywall. Đây là dữ liệu từ bảng paywalls trong dashboard.

adapty paywalls metrics list --app <app-id> --ids <paywall-id>,<paywall-id>
CờBắt buộcMô tả
--appCóID ứng dụng (UUID)
--idsCóID các paywall (UUID). Phân cách bằng dấu phẩy hoặc lặp lại cờ
--csvKhôngIn CSV: mỗi hàng là một paywall, gồm ID paywall và các chỉ số dạng số. Không dùng được cùng với --json

Các lệnh paywalls metrics đọc dữ liệu từ trang paywall metrics, và yêu cầu CLI phiên bản 0.16.0 trở lên.

Mỗi dòng hiển thị ID paywall cùng với số lượt xem, lượt mua, số lượng trial và doanh thu. --json cung cấp đầy đủ 21 chỉ số, chẳng hạn như unique_profiles_views, net_revenue và conversion_rate_purchases, cùng với last_purchases. --csv bỏ qua hai trường không phải số là in_current_state và last_purchases. Chỉ số không có dữ liệu sẽ là 0, không bao giờ là null.

adapty paywalls metrics values

Liệt kê các khóa và giá trị bộ lọc của một paywall: những gì paywalls metrics get --filter nhận vào.

adapty paywalls metrics values --app <app-id> <paywall-id>
Đối sốMô tả
paywall-idID paywall (UUID)
CờBắt buộcMô tả
--appCóID ứng dụng (UUID)

Đầu ra có dạng giống với flows metrics values: giá trị đầu tiên của mỗi nhóm là khóa bộ lọc, và các giá trị trong cùng là những gì khóa đó nhận vào.

adapty paywalls metrics get

Hiển thị các chỉ số của một paywall trong một khoảng thời gian, dưới dạng cây của trang paywall metrics.

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
Đối sốMô tả
paywall-idID paywall (UUID)
FlagBắt buộcMô tả
--appCóApp ID (UUID)
--based-onCóCấp đầu tiên của cây phân chia theo: placement hoặc audience. Đây là các chế độ xem theo placement và audience của trang chỉ số paywall
--date-typeCóNgày áp dụng cho khoảng thời gian: purchase_date, hoặc profile_install_date để lọc theo ngày cài đặt
--date-fromCóNgày đầu tiên của khoảng thời gian, bao gồm cả ngày này (YYYY-MM-DD)
--date-toCóNgày cuối cùng của khoảng thời gian, bao gồm cả ngày này (YYYY-MM-DD)
--group-byKhôngNhóm sản phẩm theo product, store, hoặc country. Mặc định: product
--granularityKhôngChia khoảng thời gian thành các điểm: day, week, month, quarter, hoặc year
--filterKhôngChỉ giữ lại dữ liệu có các giá trị của filter key này. Có thể dùng lặp lại. Xem Lọc các chỉ số
--timezoneKhôngMúi giờ IANA cho các điểm thời gian, ví dụ Europe/Berlin. Nếu không có, Adapty sẽ dùng múi giờ của ứng dụng
--depthKhôngSố cấp của cây sẽ được in dưới Total. Mặc định: 1
--csvKhôngIn dạng CSV: mỗi hàng tương ứng với một node của toàn bộ cây. Không thể dùng cùng với --json

CLI thoát với mã 2 và không gửi yêu cầu khi thiếu --based-on hoặc --date-type, hoặc khi chỉ cung cấp một đầu của khoảng thời gian. Nếu không có khoảng thời gian, Adapty từ chối yêu cầu và lệnh thoát với mã 4. Adapty kiểm tra các giá trị của --based-on, --date-type, --group-by và --granularity: giá trị sai sẽ thoát với mã 4, và thông báo lỗi liệt kê các giá trị được chấp nhận.

Đọc kết quả đầu ra

Lệnh này in ra một dòng Total, tiếp theo là cấp đầu tiên của cây bên dưới, với các cột tương tự như flows metrics get. Các nút ở cấp đầu tiên luôn hiển thị điểm của kỳ, dù có hay không có --granularity.

Các cấp của cây lần lượt là placement hoặc đối tượng, rồi đến paywall hoặc A/B test đã chạy ở đó, rồi đến các nhóm theo --group-by. Để in thêm các cấp, hãy truyền --depth, ví dụ --depth 4.

Để xem toàn bộ cây với tất cả các chỉ số, hãy dùng một trong các flag sau:

  • --json in ra câu trả lời của server không thay đổi.
  • --csv in ra một hàng cho mỗi node, bao gồm cả các điểm chu kỳ. Các cột gồm path (tiêu đề từ Total xuống đến node, phân cách bằng >), level, title, và các chỉ số dạng số. Cây paywall không có level, vì vậy level là root ở Total và trống ở mọi hàng khác.

Lọc các chỉ số

Viết mỗi --filter theo dạng key=value, với các khóa và giá trị mà paywalls metrics values liệt kê. Các bộ lọc tuân theo cùng quy tắc như trong 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

Tiếp theo