ペイウォールコマンド
これらの 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 | Yes | アプリ 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 | はい | アプリ 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 | いいえ | Web 購入 URL、または null |
--product-id | いいえ | 非推奨: --products を使用してください。プロダクト ID(UUID)。プロダクトごとに繰り返し指定します。オファーや請求プランなしでプロダクトを設定しますが、--products と同時に使用することはできません |
フィールドを省略すると、ダッシュボードのデフォルト値が適用されます(リモートコンフィグなし、ビルダーなし、スクリーンショットなし、ウェブ購入URLなし)。--app、--title、--product-id 以外のフラグを使用するには、CLIバージョン 0.20.0 以降が必要です。
adapty paywalls update
既存のペイウォールのすべてのフィールドを置き換えます。
ペイウォールがプレースメントにリンクされると、そのプロダクトは変更できません。公開中のペイウォールで別のプロダクトを使用するには、新しいペイウォールを作成し、プレースメントがそちらを指すように更新してください。
1つのフィールドを変更するには、ペイウォールを取得し、そのファイルでフィールドを編集してから、ファイル全体を送り返します:
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 なしの場合 | Web購入URL、または 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
複数のペイウォールのライフタイム指標を表示します。ペイウォールごとに1行で表示されます。ダッシュボードのペイウォールテーブルのデータです。
adapty paywalls metrics list --app <app-id> --ids <paywall-id>,<paywall-id>
| フラグ | 必須 | 説明 |
|---|---|---|
--app | はい | アプリID(UUID) |
--ids | はい | ペイウォールID(UUID)。カンマ区切りで指定するか、フラグを繰り返して指定 |
--csv | いいえ | CSVで出力:ペイウォールIDと数値指標を含む行をペイウォールごとに1行。--json との併用不可 |
paywalls metrics コマンドは ペイウォール指標 ページの数値を読み取るもので、CLI バージョン 0.16.0 以降が必要です。
各行にはペイウォール ID とそのビュー数、購入数、トライアル数、収益が表示されます。--json を使うと unique_profiles_views、net_revenue、conversion_rate_purchases、last_purchases など 21 項目すべての指標が取得できます。--csv では数値以外の 2 フィールド(in_current_state と last_purchases)が省かれます。データのない指標は null ではなく 0 になります。
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
ペイウォール指標ページのツリーと同様に、1つのペイウォールの指定期間における指標を表示します。
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 | はい | ツリーの第1レベルの分割基準: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で出力:ツリー全体の各ノードを1行で表示。--json と同時使用不可 |
--based-on または --date-type が指定されていない場合、または期間の一方の端のみが指定されている場合、CLI はコード 2 で終了し、リクエストを送信しません。期間がない場合、Adapty はリクエストを拒否し、コマンドはコード 4 で終了します。Adapty は --based-on、--date-type、--group-by、--granularity の値を検証します。値が誤っている場合はコード 4 で終了し、エラーには受け付けられる値の一覧が表示されます。
出力を読む
このコマンドは Total 行を出力し、その下にツリーの第1レベルを表示します。列は flows metrics get と同じです。第1レベルのノードは、--granularity の有無に関わらず、常に期間のポイントとともに表示されます。
ツリーの階層は、プレースメントまたはオーディエンス、次にそこで実行されたペイウォールまたは A/B テスト、そして --group-by グループとなります。さらに深い階層を表示するには、--depth を指定します(例: --depth 4)。
すべての指標を含むツリー全体を表示するには、次のいずれかのフラグを使用します:
--jsonはサーバーからの回答をそのまま出力します。--csvはノードごとに1行出力します(ピリオドポイントを含む)。カラムはpath(Totalからノードまでのタイトルを>で区切ったもの)、level、title、そして数値の指標です。ペイウォールツリーにはレベルがないため、Totalのlevelはrootになり、他のすべての行では空になります。
指標のフィルタリング
各 --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 トピック、グローバルフラグ、ページネーションフラグ。