ÿÿ Tài liệu đầy đủ vá» Developer CLI | Tài liệu Adapty
English 中文TürkçeРуÑÑкийEspañol日本語Tiếng Việt

Tài liệu đầy đủ vỠAdapty Developer CLI

Äang dùng trợ lý AI? Có sẵn Adapty CLI skill để giúp các LLM làm việc vá»›i CLI.

Bài viết này liệt kê tất cả các lệnh Adapty CLI cùng với các đối số, cỠvà giá trị được chấp nhận.

Äể thiết lập xác thá»±c và quản lý token, xem Xác thá»±c.

CỠtoàn cục

Các cỠnày có thể dùng với tất cả các lệnh.

Cá»Mô tả
--jsonXuất dưới dạng JSON thay vì văn bản định dạng
--helpHiển thị trợ giúp lệnh

Tất cả lệnh list cũng chấp nhận cỠphân trang:

Cá»Mặc địnhMô tả
--page1Số trang
--page-size20Số mục mỗi trang (tối đa: 100)

Apps

Quản lý các ứng dụng trong tài khoản Adapty của bạn. Äể cấu hình qua Dashboard, xem App settings.

adapty apps list

Liệt kê tất cả ứng dụng trong tài khoản Adapty của bạn.

adapty apps list

Chấp nhận cỠphân trang.

adapty apps get

Lấy thông tin chi tiết của một ứng dụng cụ thể.

adapty apps get <app-id>
Äối sốMô tả
app-idApp ID (UUID)

adapty apps create

Tạo ứng dụng mới.

adapty apps create --title "My App" --platform ios --apple-bundle-id com.example.app
Cá»Bắt buá»™cMô tả
--titleCóTên ứng dụng
--platformCóNá»n tảng: ios hoặc android. Lặp lại để dùng cả hai: --platform ios --platform android
--apple-bundle-idBắt buộc khi dùng --platform iosApple bundle ID
--google-bundle-idBắt buộc khi dùng --platform androidGoogle bundle ID

adapty apps update

Cập nhật ứng dụng hiện có.

adapty apps update <app-id> --title "New Name"
Äối sốMô tả
app-idApp ID (UUID)
Cá»Mô tả
--titleTên ứng dụng mới
--apple-bundle-idApple bundle ID má»›i
--google-bundle-idGoogle bundle ID má»›i

Cần có ít nhất má»™t cá». --platform không thể thay đổi sau khi tạo.

Mức độ truy cập

adapty access-levels list

Liệt kê tất cả mức độ truy cập của một ứng dụng.

adapty access-levels list --app <app-id>
Cá»Bắt buá»™cMô tả
--appCóApp ID (UUID)

Chấp nhận cỠphân trang.

adapty access-levels get

Lấy thông tin chi tiết của một mức độ truy cập cụ thể.

adapty access-levels get --app <app-id> <access-level-id>
Äối sốMô tả
access-level-idAccess level ID (UUID)
Cá»Bắt buá»™cMô tả
--appCóApp ID (UUID)

adapty access-levels create

Tạo mức độ truy cập mới.

adapty access-levels create --app <app-id> --sdk-id "pro" --title "Pro"
Cá»Bắt buá»™cMô tả
--appCóApp ID (UUID)
--sdk-idCóÄịnh danh dùng trong code ứng dụng để kiểm tra quyá»n truy cập (ví dụ: "pro" hoặc "premium")
--titleCóNhãn hiển thị trên Adapty dashboard

adapty access-levels update

Cập nhật mức độ truy cập hiện có.

adapty access-levels update --app <app-id> <access-level-id> --title "Pro Access"
Äối sốMô tả
access-level-idAccess level ID (UUID)
Cá»Bắt buá»™cMô tả
--appCóApp ID (UUID)
--titleCóNhãn hiển thị mới

--sdk-id không thể thay đổi sau khi tạo.

Sản phẩm

adapty products list

Liệt kê tất cả sản phẩm của một ứng dụng.

adapty products list --app <app-id>
Cá»Bắt buá»™cMô tả
--appCóApp ID (UUID)

Chấp nhận cỠphân trang.

adapty products get

Lấy thông tin chi tiết của một sản phẩm cụ thể.

adapty products get --app <app-id> <product-id>
Äối sốMô tả
product-idProduct ID (UUID)
Cá»Bắt buá»™cMô tả
--appCóApp ID (UUID)

adapty products create

Tạo sản phẩm mới.

Các ID sản phẩm trong cá»­a hàng (--ios-product-id, --android-product-id, --android-base-plan-id) không thể thay đổi sau khi tạo. Äể dùng ID sản phẩm khác trong cá»­a hàng, hãy tạo sản phẩm má»›i.

adapty products create --app <app-id> --title "Monthly" --access-level-id <access-level-id> --period monthly --ios-product-id com.example.monthly
ÿÿ
Cá»Bắt buá»™cMô tả
--appCóApp ID (UUID)
--titleCóTên sản phẩm
--access-level-idCóID mức độ truy cập (UUID) mà sản phẩm này mở khóa
--periodCóChu kỳ gói đăng ký: weekly, monthly, 2_months, 3_months, 6_months, yearly, lifetime
--ios-product-idCần ít nhất má»™t ná»n tảngProduct ID từ App Store Connect
--android-product-idCần ít nhất má»™t ná»n tảngProduct ID từ Google Play Console
--android-base-plan-idBắt buộc khi dùng --android-product-id trừ khi --period lifetimeBase plan ID từ Google Play Console

adapty products update

Cập nhật sản phẩm hiện có.

Các ID sản phẩm trong cá»­a hàng (--ios-product-id, --android-product-id) không thể thay đổi sau khi tạo và không có trong lệnh này. Äể dùng ID sản phẩm khác trong cá»­a hàng, hãy tạo sản phẩm má»›i.

adapty products update --app <app-id> <product-id> --title "Monthly" --access-level-id <access-level-id>
Äối sốMô tả
product-idProduct ID (UUID)
Cá»Bắt buá»™cMô tả
--appCóApp ID (UUID)
--titleKhôngTên sản phẩm
--access-level-idKhôngID mức độ truy cập (UUID) mà sản phẩm này mở khóa

Paywall

adapty paywalls list

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

adapty paywalls list --app <app-id>
Cá»Bắt buá»™cMô tả
--appCóApp ID (UUID)

Chấp nhận cỠphân trang.

adapty paywalls get

Lấy thông tin chi tiết của một paywall cụ thể.

adapty paywalls get --app <app-id> <paywall-id>
Äối sốMô tả
paywall-idPaywall ID (UUID)
Cá»Bắt buá»™cMô tả
--appCóApp ID (UUID)

adapty paywalls create

Tạo paywall mới.

adapty paywalls create --app <app-id> --title "Default Paywall" --product-id <product-id>
Cá»Bắt buá»™cMô tả
--appCóApp ID (UUID)
--titleCóTên paywall
--product-idCóID sản phẩm (UUID). Lặp lại cho nhiá»u sản phẩm: --product-id <id1> --product-id <id2>

adapty paywalls update

Thay thế toàn bá»™ các trÆ°á»ng của má»™t paywall hiện có.

Khi paywall đã được liên kết vá»›i má»™t placement, không thể thay đổi sản phẩm của nó. Äể 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 đó.

adapty paywalls update --app <app-id> <paywall-id> --title "Default Paywall" --product-id <product-id>

Lệnh này thay thế toàn bá»™ các trÆ°á»ng của paywall, bao gồm cả danh sách sản phẩm đầy đủ.

Äối sốMô tả
paywall-idPaywall ID (UUID)
Cá»Bắt buá»™cMô tả
--appCóApp ID (UUID)
--titleCóTên paywall
--product-idCóID sản phẩm (UUID). Lặp lại cho nhiá»u sản phẩm: --product-id <id1> --product-id <id2>

adapty paywalls placements

Liệt kê tất cả placement đang dùng một paywall nhất định.

adapty paywalls placements --app <app-id> <paywall-id>
Äối sốMô tả
paywall-idPaywall ID (UUID)
Cá»Bắt buá»™cMô tả
--appCóApp ID (UUID)

Dùng lệnh này trước khi thay đổi paywall để xem các placement nào sẽ bị ảnh hưởng.

Placement

adapty placements list

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

adapty placements list --app <app-id>
Cá»Bắt buá»™cMô tả
--appCóApp ID (UUID)

Chấp nhận cỠphân trang.

adapty placements get

Lấy thông tin chi tiết của một placement cụ thể.

adapty placements get --app <app-id> <placement-id>
Äối sốMô tả
placement-idPlacement ID (UUID)
Cá»Bắt buá»™cMô tả
--appCóApp ID (UUID)

Kết quả trả vá» chứa mảng audiences. Má»—i phần tá»­ có dạng {segment_ids, paywall_id, priority}. Äối tượng mặc định có segment_ids: [] và giá trị Æ°u tiên cao nhất (được đánh giá cuối cùng). Äầu ra dạng văn bản cÅ©ng hiển thị Paywall ID ở cấp cao nhất, lấy từ đối tượng mặc định để tiện tham khảo. --json trả vá» dữ liệu API thô không thay đổi.

adapty placements create

Tạo placement mới.

adapty placements create --app <app-id> --title "Main" --developer-id "main" --audiences '[{"segment_ids":[],"paywall_id":"<paywall-id>","priority":0}]'
Cá»Bắt buá»™cMô tả
--appCóApp ID (UUID)
--titleCóTên placement
--developer-idCóÄịnh danh chuá»—i dùng trong code ứng dụng để yêu cầu placement này
--audiencesMột trong haiMảng JSON gồm các phần tử {segment_ids, paywall_id, priority}. Xem Cấu trúc Audiences
--paywall-idMá»™t trong haiKhông còn dùng. ID paywall (UUID). Äược phía client chuyển đổi thành má»™t đối tượng mặc định

Truyá»n đúng má»™t trong --audiences hoặc --paywall-id. Truyá»n cả hai hoặc không truyá»n cái nào sẽ báo lá»—i.

--paywall-id không còn được khuyến nghị và sẽ bị xóa. Khi truyá»n vào, CLI sẽ in cảnh báo ra stderr và chuyển đổi giá trị thành má»™t đối tượng mặc định. Hãy dùng --audiences cho các tá»± Ä‘á»™ng hóa má»›i.

adapty placements update

Thay thế toàn bá»™ các trÆ°á»ng của má»™t placement hiện có.

adapty placements update --app <app-id> <placement-id> --title "Main" --developer-id "main" --audiences '[{"segment_ids":[],"paywall_id":"<paywall-id>","priority":0}]'

Lệnh này thay thế toàn bá»™ các trÆ°á»ng của placement, bao gồm cả danh sách audiences đầy đủ.

Äối sốMô tả
placement-idPlacement ID (UUID)
Cá»Bắt buá»™cMô tả
--appCóApp ID (UUID)
--titleCóTên placement
--developer-idCóÄịnh danh chuá»—i dùng trong code ứng dụng để yêu cầu placement này
--audiencesMột trong haiMảng JSON gồm các phần tử {segment_ids, paywall_id, priority}. Xem Cấu trúc Audiences
--paywall-idMột trong haiKhông còn dùng. ID paywall (UUID). Thay thế toàn bộ audiences bằng một đối tượng mặc định

Truyá»n --paywall-id sẽ ghi đè toàn bá»™ audiences của placement. Các audiences theo phân khúc sẽ bị xóa. Äể giữ lại chúng, hãy dùng --audiences và thêm đầy đủ các phần tá»­ bạn muốn giữ.

Cấu trúc Audiences

Cá» --audiences nhận má»™t mảng JSON. Má»—i phần tá»­ có các trÆ°á»ng sau:

TrÆ°á»ngKiểuMô tả
segment_idsstring[]Các ID phân khúc được nhắm mục tiêu bởi đối tượng này. Äá»™ dài 0 hoặc 1. Mảng rá»—ng đánh dấu đối tượng mặc định — dá»± phòng cho ngÆ°á»i dùng không khá»›p vá»›i phân khúc nào khác
paywall_idstringID paywall (UUID) hiển thị cho ngÆ°á»i dùng trong đối tượng này
prioritynumberBắt đầu từ 0, không trùng nhau trong cùng placement. Audiences được đánh giá từ thấp đến cao; đối tượng mặc định phải có giá trị cao nhất

Một placement phải có đúng một đối tượng mặc định.

Ví dụ với một đối tượng có mục tiêu và một đối tượng mặc định:

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

Äể thay đổi paywall trên nhiá»u placement mà không mất cấu hình định tuyến theo phân khúc:

  1. Tìm các placement bị ảnh hưởng:

    adapty paywalls placements --app <app-id> <old-paywall-id>

  2. Vá»›i má»—i placement, Ä‘á»c toàn bá»™ mảng audiences:

    adapty placements get --app <app-id> <placement-id> --json

  3. Thay thế các giá trị paywall_id tương ứng ở phía client.

  4. Ghi lại payload đã chỉnh sửa:

    adapty placements update --app <app-id> <placement-id> --title "<title>" --developer-id "<developer-id>" --audiences '<modified-payload>'

Phân khúc

Phân khúc chỉ có thể Ä‘á»c qua CLI. Tạo và chỉnh sá»­a chúng trên Adapty dashboard. Dùng các lệnh này để tra cứu ID phân khúc khi soạn audiences cho placement.

adapty segments list

Liệt kê tất cả phân khúc của một ứng dụng.

adapty segments list --app <app-id>
Cá»Bắt buá»™cMô tả
--appCóApp ID (UUID)

Chấp nhận cỠphân trang.

adapty segments get

Lấy thông tin chi tiết của một phân khúc cụ thể.

adapty segments get --app <app-id> <segment-id>
Äối sốMô tả
segment-idSegment ID (UUID)
Cá»Bắt buá»™cMô tả
--appCóApp ID (UUID)

Kết quả trả vá» chứa id, title và description. Các quy tắc lá»c không được hiển thị qua API này.

Xác thực

LệnhMô tả
adapty auth loginXác thực qua trình duyệt bằng device flow
adapty auth logoutXóa thông tin đăng nhập đã lưu ở máy cục bộ
adapty auth whoamiXác minh token vá»›i máy chủ và hiển thị thông tin ngÆ°á»i dùng
adapty auth statusHiển thị trạng thái xác thá»±c cục bá»™ mà không gá»i máy chủ
adapty auth revokeThu hồi token ở phía máy chủ và xóa ở máy cục bộ

Xem Xác thực để biết chi tiết từng lệnh.

ÿÿÿÿ