adapty 0.9.3 → 0.9.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (8) hide show
  1. package/README.md +6 -0
  2. package/dist/commands/asa/change-history/get.d.ts +14 -0
  3. package/dist/commands/asa/change-history/get.js +39 -0
  4. package/dist/commands/asa/change-history/list.d.ts +27 -0
  5. package/dist/commands/asa/change-history/list.js +102 -0
  6. package/dist/lib/asa-schemas.d.ts +47 -0
  7. package/oclif.manifest.json +1682 -1479
  8. package/package.json +4 -4
package/oclif.manifest.json CHANGED
@@ -421,6 +421,85 @@
421
421
  "update.js"
422
422
  ]
423
423
  },
424
+ "asa:connect": {
425
+ "aliases": [],
426
+ "args": {},
427
+ "description": "Connect an Apple Search Ads account to this company",
428
+ "examples": [
429
+ "<%= config.bin %> asa connect",
430
+ "<%= config.bin %> asa connect --no-wait"
431
+ ],
432
+ "flags": {
433
+ "json": {
434
+ "description": "Format output as json.",
435
+ "helpGroup": "GLOBAL",
436
+ "name": "json",
437
+ "allowNo": false,
438
+ "type": "boolean"
439
+ },
440
+ "timeout": {
441
+ "description": "Seconds to wait for the browser step",
442
+ "name": "timeout",
443
+ "default": 300,
444
+ "hasDynamicHelp": false,
445
+ "multiple": false,
446
+ "type": "option"
447
+ },
448
+ "wait": {
449
+ "description": "Wait until Apple Ads reports as connected",
450
+ "name": "wait",
451
+ "allowNo": true,
452
+ "type": "boolean"
453
+ }
454
+ },
455
+ "hasDynamicHelp": false,
456
+ "hiddenAliases": [],
457
+ "id": "asa:connect",
458
+ "pluginAlias": "adapty",
459
+ "pluginName": "adapty",
460
+ "pluginType": "core",
461
+ "strict": true,
462
+ "enableJsonFlag": true,
463
+ "isESM": true,
464
+ "relativePath": [
465
+ "dist",
466
+ "commands",
467
+ "asa",
468
+ "connect.js"
469
+ ]
470
+ },
471
+ "asa:whoami": {
472
+ "aliases": [],
473
+ "args": {},
474
+ "description": "Show which company the token unlocks, whether Apple Ads is connected, and the request budgets it gets\n\nLimits are raised per company, so read them here rather than assuming the defaults: metrics_limit_per_minute\nand metrics_burst_limit govern asa metrics, keywords_read_limit_per_minute the keyword lists,\nmetrics_inflight_limit how many analytics calls may overlap, and max_breakdown_rows_per_page the size a\ngrouped page may project to before it is refused.",
475
+ "examples": [
476
+ "<%= config.bin %> asa whoami"
477
+ ],
478
+ "flags": {
479
+ "json": {
480
+ "description": "Format output as json.",
481
+ "helpGroup": "GLOBAL",
482
+ "name": "json",
483
+ "allowNo": false,
484
+ "type": "boolean"
485
+ }
486
+ },
487
+ "hasDynamicHelp": false,
488
+ "hiddenAliases": [],
489
+ "id": "asa:whoami",
490
+ "pluginAlias": "adapty",
491
+ "pluginName": "adapty",
492
+ "pluginType": "core",
493
+ "strict": true,
494
+ "enableJsonFlag": true,
495
+ "isESM": true,
496
+ "relativePath": [
497
+ "dist",
498
+ "commands",
499
+ "asa",
500
+ "whoami.js"
501
+ ]
502
+ },
424
503
  "attribution:dimensions": {
425
504
  "aliases": [],
426
505
  "args": {},
@@ -690,13 +769,36 @@
690
769
  "values.js"
691
770
  ]
692
771
  },
693
- "asa:connect": {
772
+ "auth:login": {
694
773
  "aliases": [],
695
774
  "args": {},
696
- "description": "Connect an Apple Search Ads account to this company",
775
+ "description": "Authenticate with Adapty via browser",
697
776
  "examples": [
698
- "<%= config.bin %> asa connect",
699
- "<%= config.bin %> asa connect --no-wait"
777
+ "<%= config.bin %> auth login"
778
+ ],
779
+ "flags": {},
780
+ "hasDynamicHelp": false,
781
+ "hiddenAliases": [],
782
+ "id": "auth:login",
783
+ "pluginAlias": "adapty",
784
+ "pluginName": "adapty",
785
+ "pluginType": "core",
786
+ "strict": true,
787
+ "enableJsonFlag": false,
788
+ "isESM": true,
789
+ "relativePath": [
790
+ "dist",
791
+ "commands",
792
+ "auth",
793
+ "login.js"
794
+ ]
795
+ },
796
+ "auth:logout": {
797
+ "aliases": [],
798
+ "args": {},
799
+ "description": "Remove stored credentials and the saved migration selection",
800
+ "examples": [
801
+ "<%= config.bin %> auth logout"
700
802
  ],
701
803
  "flags": {
702
804
  "json": {
@@ -705,25 +807,43 @@
705
807
  "name": "json",
706
808
  "allowNo": false,
707
809
  "type": "boolean"
708
- },
709
- "timeout": {
710
- "description": "Seconds to wait for the browser step",
711
- "name": "timeout",
712
- "default": 300,
713
- "hasDynamicHelp": false,
714
- "multiple": false,
715
- "type": "option"
716
- },
717
- "wait": {
718
- "description": "Wait until Apple Ads reports as connected",
719
- "name": "wait",
720
- "allowNo": true,
810
+ }
811
+ },
812
+ "hasDynamicHelp": false,
813
+ "hiddenAliases": [],
814
+ "id": "auth:logout",
815
+ "pluginAlias": "adapty",
816
+ "pluginName": "adapty",
817
+ "pluginType": "core",
818
+ "strict": true,
819
+ "enableJsonFlag": true,
820
+ "isESM": true,
821
+ "relativePath": [
822
+ "dist",
823
+ "commands",
824
+ "auth",
825
+ "logout.js"
826
+ ]
827
+ },
828
+ "auth:revoke": {
829
+ "aliases": [],
830
+ "args": {},
831
+ "description": "Revoke the current token and remove matching stored credentials and migration selection",
832
+ "examples": [
833
+ "<%= config.bin %> auth revoke"
834
+ ],
835
+ "flags": {
836
+ "json": {
837
+ "description": "Format output as json.",
838
+ "helpGroup": "GLOBAL",
839
+ "name": "json",
840
+ "allowNo": false,
721
841
  "type": "boolean"
722
842
  }
723
843
  },
724
844
  "hasDynamicHelp": false,
725
845
  "hiddenAliases": [],
726
- "id": "asa:connect",
846
+ "id": "auth:revoke",
727
847
  "pluginAlias": "adapty",
728
848
  "pluginName": "adapty",
729
849
  "pluginType": "core",
@@ -733,16 +853,16 @@
733
853
  "relativePath": [
734
854
  "dist",
735
855
  "commands",
736
- "asa",
737
- "connect.js"
856
+ "auth",
857
+ "revoke.js"
738
858
  ]
739
859
  },
740
- "asa:whoami": {
860
+ "auth:status": {
741
861
  "aliases": [],
742
862
  "args": {},
743
- "description": "Show which company the token unlocks, whether Apple Ads is connected, and the request budgets it gets\n\nLimits are raised per company, so read them here rather than assuming the defaults: metrics_limit_per_minute\nand metrics_burst_limit govern asa metrics, keywords_read_limit_per_minute the keyword lists,\nmetrics_inflight_limit how many analytics calls may overlap, and max_breakdown_rows_per_page the size a\ngrouped page may project to before it is refused.",
863
+ "description": "Show the local authentication state (no network)",
744
864
  "examples": [
745
- "<%= config.bin %> asa whoami"
865
+ "<%= config.bin %> auth status"
746
866
  ],
747
867
  "flags": {
748
868
  "json": {
@@ -755,7 +875,7 @@
755
875
  },
756
876
  "hasDynamicHelp": false,
757
877
  "hiddenAliases": [],
758
- "id": "asa:whoami",
878
+ "id": "auth:status",
759
879
  "pluginAlias": "adapty",
760
880
  "pluginName": "adapty",
761
881
  "pluginType": "core",
@@ -765,7 +885,38 @@
765
885
  "relativePath": [
766
886
  "dist",
767
887
  "commands",
768
- "asa",
888
+ "auth",
889
+ "status.js"
890
+ ]
891
+ },
892
+ "auth:whoami": {
893
+ "aliases": [],
894
+ "args": {},
895
+ "description": "Show the current user from the server (verifies the token)",
896
+ "examples": [
897
+ "<%= config.bin %> auth whoami"
898
+ ],
899
+ "flags": {
900
+ "json": {
901
+ "description": "Format output as json.",
902
+ "helpGroup": "GLOBAL",
903
+ "name": "json",
904
+ "allowNo": false,
905
+ "type": "boolean"
906
+ }
907
+ },
908
+ "hasDynamicHelp": false,
909
+ "hiddenAliases": [],
910
+ "id": "auth:whoami",
911
+ "pluginAlias": "adapty",
912
+ "pluginName": "adapty",
913
+ "pluginType": "core",
914
+ "strict": true,
915
+ "isESM": true,
916
+ "relativePath": [
917
+ "dist",
918
+ "commands",
919
+ "auth",
769
920
  "whoami.js"
770
921
  ]
771
922
  },
@@ -2593,36 +2744,12 @@
2593
2744
  "install.js"
2594
2745
  ]
2595
2746
  },
2596
- "auth:login": {
2597
- "aliases": [],
2598
- "args": {},
2599
- "description": "Authenticate with Adapty via browser",
2600
- "examples": [
2601
- "<%= config.bin %> auth login"
2602
- ],
2603
- "flags": {},
2604
- "hasDynamicHelp": false,
2605
- "hiddenAliases": [],
2606
- "id": "auth:login",
2607
- "pluginAlias": "adapty",
2608
- "pluginName": "adapty",
2609
- "pluginType": "core",
2610
- "strict": true,
2611
- "enableJsonFlag": false,
2612
- "isESM": true,
2613
- "relativePath": [
2614
- "dist",
2615
- "commands",
2616
- "auth",
2617
- "login.js"
2618
- ]
2619
- },
2620
- "auth:logout": {
2747
+ "asa:ads:create": {
2621
2748
  "aliases": [],
2622
2749
  "args": {},
2623
- "description": "Remove stored credentials and the saved migration selection",
2750
+ "description": "Create an ad from a creative in an ad group",
2624
2751
  "examples": [
2625
- "<%= config.bin %> auth logout"
2752
+ "<%= config.bin %> asa ads create --ad-group UUID --creative-id 4321 --name \"Summer ad\""
2626
2753
  ],
2627
2754
  "flags": {
2628
2755
  "json": {
@@ -2631,169 +2758,6 @@
2631
2758
  "name": "json",
2632
2759
  "allowNo": false,
2633
2760
  "type": "boolean"
2634
- }
2635
- },
2636
- "hasDynamicHelp": false,
2637
- "hiddenAliases": [],
2638
- "id": "auth:logout",
2639
- "pluginAlias": "adapty",
2640
- "pluginName": "adapty",
2641
- "pluginType": "core",
2642
- "strict": true,
2643
- "enableJsonFlag": true,
2644
- "isESM": true,
2645
- "relativePath": [
2646
- "dist",
2647
- "commands",
2648
- "auth",
2649
- "logout.js"
2650
- ]
2651
- },
2652
- "auth:revoke": {
2653
- "aliases": [],
2654
- "args": {},
2655
- "description": "Revoke the current token and remove matching stored credentials and migration selection",
2656
- "examples": [
2657
- "<%= config.bin %> auth revoke"
2658
- ],
2659
- "flags": {
2660
- "json": {
2661
- "description": "Format output as json.",
2662
- "helpGroup": "GLOBAL",
2663
- "name": "json",
2664
- "allowNo": false,
2665
- "type": "boolean"
2666
- }
2667
- },
2668
- "hasDynamicHelp": false,
2669
- "hiddenAliases": [],
2670
- "id": "auth:revoke",
2671
- "pluginAlias": "adapty",
2672
- "pluginName": "adapty",
2673
- "pluginType": "core",
2674
- "strict": true,
2675
- "enableJsonFlag": true,
2676
- "isESM": true,
2677
- "relativePath": [
2678
- "dist",
2679
- "commands",
2680
- "auth",
2681
- "revoke.js"
2682
- ]
2683
- },
2684
- "auth:status": {
2685
- "aliases": [],
2686
- "args": {},
2687
- "description": "Show the local authentication state (no network)",
2688
- "examples": [
2689
- "<%= config.bin %> auth status"
2690
- ],
2691
- "flags": {
2692
- "json": {
2693
- "description": "Format output as json.",
2694
- "helpGroup": "GLOBAL",
2695
- "name": "json",
2696
- "allowNo": false,
2697
- "type": "boolean"
2698
- }
2699
- },
2700
- "hasDynamicHelp": false,
2701
- "hiddenAliases": [],
2702
- "id": "auth:status",
2703
- "pluginAlias": "adapty",
2704
- "pluginName": "adapty",
2705
- "pluginType": "core",
2706
- "strict": true,
2707
- "enableJsonFlag": true,
2708
- "isESM": true,
2709
- "relativePath": [
2710
- "dist",
2711
- "commands",
2712
- "auth",
2713
- "status.js"
2714
- ]
2715
- },
2716
- "auth:whoami": {
2717
- "aliases": [],
2718
- "args": {},
2719
- "description": "Show the current user from the server (verifies the token)",
2720
- "examples": [
2721
- "<%= config.bin %> auth whoami"
2722
- ],
2723
- "flags": {
2724
- "json": {
2725
- "description": "Format output as json.",
2726
- "helpGroup": "GLOBAL",
2727
- "name": "json",
2728
- "allowNo": false,
2729
- "type": "boolean"
2730
- }
2731
- },
2732
- "hasDynamicHelp": false,
2733
- "hiddenAliases": [],
2734
- "id": "auth:whoami",
2735
- "pluginAlias": "adapty",
2736
- "pluginName": "adapty",
2737
- "pluginType": "core",
2738
- "strict": true,
2739
- "isESM": true,
2740
- "relativePath": [
2741
- "dist",
2742
- "commands",
2743
- "auth",
2744
- "whoami.js"
2745
- ]
2746
- },
2747
- "asa:ad-groups:create": {
2748
- "aliases": [],
2749
- "args": {},
2750
- "description": "Create an ad group inside a campaign; --automated creates the automated ad group a Max Conversions campaign needs to run",
2751
- "examples": [
2752
- "<%= config.bin %> asa ad-groups create --campaign UUID --name \"Brand terms\" --default-bid 1.20",
2753
- "<%= config.bin %> asa ad-groups create --campaign UUID --name \"Brand terms\" --default-bid 1.20 --start-time 2026-09-01 --pricing-model CPM",
2754
- "<%= config.bin %> asa ad-groups create --campaign UUID --name \"Automated Max Conv\" --automated"
2755
- ],
2756
- "flags": {
2757
- "json": {
2758
- "description": "Format output as json.",
2759
- "helpGroup": "GLOBAL",
2760
- "name": "json",
2761
- "allowNo": false,
2762
- "type": "boolean"
2763
- },
2764
- "currency": {
2765
- "description": "Currency code for the amounts in this call",
2766
- "name": "currency",
2767
- "default": "USD",
2768
- "hasDynamicHelp": false,
2769
- "multiple": false,
2770
- "type": "option"
2771
- },
2772
- "end-time": {
2773
- "description": "Schedule end (YYYY-MM-DD)",
2774
- "name": "end-time",
2775
- "hasDynamicHelp": false,
2776
- "multiple": false,
2777
- "type": "option"
2778
- },
2779
- "start-time": {
2780
- "description": "Schedule start (YYYY-MM-DD), defaults to today",
2781
- "name": "start-time",
2782
- "hasDynamicHelp": false,
2783
- "multiple": false,
2784
- "type": "option"
2785
- },
2786
- "pricing-model": {
2787
- "description": "Pricing model; Apple requires one on every ad group",
2788
- "name": "pricing-model",
2789
- "default": "CPC",
2790
- "hasDynamicHelp": false,
2791
- "multiple": false,
2792
- "options": [
2793
- "CPC",
2794
- "CPM"
2795
- ],
2796
- "type": "option"
2797
2761
  },
2798
2762
  "yes": {
2799
2763
  "char": "y",
@@ -2809,45 +2773,24 @@
2809
2773
  "multiple": false,
2810
2774
  "type": "option"
2811
2775
  },
2812
- "automated": {
2813
- "description": "Create the automated ad group a Max Conversions campaign needs (no bid, no schedule, always ENABLED)",
2814
- "exclusive": [
2815
- "automated-keywords"
2816
- ],
2817
- "name": "automated",
2818
- "allowNo": false,
2819
- "type": "boolean"
2820
- },
2821
- "automated-keywords": {
2822
- "description": "Let Apple add keywords automatically",
2823
- "name": "automated-keywords",
2824
- "allowNo": true,
2825
- "type": "boolean"
2826
- },
2827
- "campaign": {
2828
- "description": "Campaign ID (UUID)",
2829
- "name": "campaign",
2776
+ "ad-group": {
2777
+ "description": "Ad group ID (UUID) — the campaign is resolved from it",
2778
+ "name": "ad-group",
2830
2779
  "required": true,
2831
2780
  "hasDynamicHelp": false,
2832
2781
  "multiple": false,
2833
2782
  "type": "option"
2834
2783
  },
2835
- "cpa-goal": {
2836
- "description": "CPA goal (amount, e.g. 50 or 12.50)",
2837
- "name": "cpa-goal",
2838
- "hasDynamicHelp": false,
2839
- "multiple": false,
2840
- "type": "option"
2841
- },
2842
- "default-bid": {
2843
- "description": "Default bid; required unless --automated is set (amount, e.g. 50 or 12.50)",
2844
- "name": "default-bid",
2784
+ "creative-id": {
2785
+ "description": "Apple creative ID from a product page or the default set",
2786
+ "name": "creative-id",
2787
+ "required": true,
2845
2788
  "hasDynamicHelp": false,
2846
2789
  "multiple": false,
2847
2790
  "type": "option"
2848
2791
  },
2849
2792
  "name": {
2850
- "description": "Ad group name",
2793
+ "description": "Ad name",
2851
2794
  "name": "name",
2852
2795
  "required": true,
2853
2796
  "hasDynamicHelp": false,
@@ -2868,7 +2811,7 @@
2868
2811
  },
2869
2812
  "hasDynamicHelp": false,
2870
2813
  "hiddenAliases": [],
2871
- "id": "asa:ad-groups:create",
2814
+ "id": "asa:ads:create",
2872
2815
  "pluginAlias": "adapty",
2873
2816
  "pluginName": "adapty",
2874
2817
  "pluginType": "core",
@@ -2879,22 +2822,22 @@
2879
2822
  "dist",
2880
2823
  "commands",
2881
2824
  "asa",
2882
- "ad-groups",
2825
+ "ads",
2883
2826
  "create.js"
2884
2827
  ]
2885
2828
  },
2886
- "asa:ad-groups:get": {
2829
+ "asa:ads:get": {
2887
2830
  "aliases": [],
2888
2831
  "args": {
2889
- "ad_group_id": {
2890
- "description": "Ad group ID (UUID)",
2891
- "name": "ad_group_id",
2832
+ "ad_id": {
2833
+ "description": "Ad ID (UUID)",
2834
+ "name": "ad_id",
2892
2835
  "required": true
2893
2836
  }
2894
2837
  },
2895
- "description": "Show one ad group; read numbers with asa metrics",
2838
+ "description": "Show one ad and its serving state",
2896
2839
  "examples": [
2897
- "<%= config.bin %> asa ad-groups get 550e8400-e29b-41d4-a716-446655440000"
2840
+ "<%= config.bin %> asa ads get 550e8400-e29b-41d4-a716-446655440000"
2898
2841
  ],
2899
2842
  "flags": {
2900
2843
  "json": {
@@ -2907,7 +2850,7 @@
2907
2850
  },
2908
2851
  "hasDynamicHelp": false,
2909
2852
  "hiddenAliases": [],
2910
- "id": "asa:ad-groups:get",
2853
+ "id": "asa:ads:get",
2911
2854
  "pluginAlias": "adapty",
2912
2855
  "pluginName": "adapty",
2913
2856
  "pluginType": "core",
@@ -2918,17 +2861,17 @@
2918
2861
  "dist",
2919
2862
  "commands",
2920
2863
  "asa",
2921
- "ad-groups",
2864
+ "ads",
2922
2865
  "get.js"
2923
2866
  ]
2924
2867
  },
2925
- "asa:ad-groups:list": {
2868
+ "asa:ads:list": {
2926
2869
  "aliases": [],
2927
2870
  "args": {},
2928
- "description": "List ad groups; read numbers with asa metrics",
2871
+ "description": "List ads; serving_state_reasons explains why an enabled ad is not running",
2929
2872
  "examples": [
2930
- "<%= config.bin %> asa ad-groups list",
2931
- "<%= config.bin %> asa ad-groups list --campaign CAMPAIGN_UUID"
2873
+ "<%= config.bin %> asa ads list",
2874
+ "<%= config.bin %> asa ads list --ad-group AD_GROUP_UUID --status ENABLED"
2932
2875
  ],
2933
2876
  "flags": {
2934
2877
  "json": {
@@ -2954,9 +2897,16 @@
2954
2897
  "multiple": false,
2955
2898
  "type": "option"
2956
2899
  },
2957
- "app": {
2958
- "description": "Keep only rows in this app; repeatable",
2959
- "name": "app",
2900
+ "ad-group": {
2901
+ "description": "Keep only rows in this ad group; repeatable",
2902
+ "name": "ad-group",
2903
+ "hasDynamicHelp": false,
2904
+ "multiple": true,
2905
+ "type": "option"
2906
+ },
2907
+ "campaign": {
2908
+ "description": "Keep only rows in this campaign; repeatable",
2909
+ "name": "campaign",
2960
2910
  "hasDynamicHelp": false,
2961
2911
  "multiple": true,
2962
2912
  "type": "option"
@@ -2975,13 +2925,6 @@
2975
2925
  "multiple": false,
2976
2926
  "type": "option"
2977
2927
  },
2978
- "campaign": {
2979
- "description": "Keep only rows in this campaign; repeatable",
2980
- "name": "campaign",
2981
- "hasDynamicHelp": false,
2982
- "multiple": true,
2983
- "type": "option"
2984
- },
2985
2928
  "status": {
2986
2929
  "description": "Keep only rows in this state",
2987
2930
  "name": "status",
@@ -2996,7 +2939,7 @@
2996
2939
  },
2997
2940
  "hasDynamicHelp": false,
2998
2941
  "hiddenAliases": [],
2999
- "id": "asa:ad-groups:list",
2942
+ "id": "asa:ads:list",
3000
2943
  "pluginAlias": "adapty",
3001
2944
  "pluginName": "adapty",
3002
2945
  "pluginType": "core",
@@ -3007,23 +2950,22 @@
3007
2950
  "dist",
3008
2951
  "commands",
3009
2952
  "asa",
3010
- "ad-groups",
2953
+ "ads",
3011
2954
  "list.js"
3012
2955
  ]
3013
2956
  },
3014
- "asa:ad-groups:update": {
2957
+ "asa:ads:update": {
3015
2958
  "aliases": [],
3016
2959
  "args": {
3017
- "ad_group_id": {
3018
- "description": "Ad group ID (UUID)",
3019
- "name": "ad_group_id",
2960
+ "ad_id": {
2961
+ "description": "Ad ID (UUID)",
2962
+ "name": "ad_id",
3020
2963
  "required": true
3021
2964
  }
3022
2965
  },
3023
- "description": "Change an ad group: bid, CPA goal, status or schedule",
2966
+ "description": "Rename an ad or pause it; the creative and ad group are fixed at creation",
3024
2967
  "examples": [
3025
- "<%= config.bin %> asa ad-groups update UUID --default-bid 1.50",
3026
- "<%= config.bin %> asa ad-groups update UUID --status PAUSED"
2968
+ "<%= config.bin %> asa ads update UUID --status PAUSED"
3027
2969
  ],
3028
2970
  "flags": {
3029
2971
  "json": {
@@ -3033,71 +2975,29 @@
3033
2975
  "allowNo": false,
3034
2976
  "type": "boolean"
3035
2977
  },
3036
- "currency": {
3037
- "description": "Currency code for the amounts in this call",
3038
- "name": "currency",
3039
- "default": "USD",
3040
- "hasDynamicHelp": false,
3041
- "multiple": false,
3042
- "type": "option"
3043
- },
3044
- "end-time": {
3045
- "description": "Schedule end (YYYY-MM-DD)",
3046
- "name": "end-time",
3047
- "hasDynamicHelp": false,
3048
- "multiple": false,
3049
- "type": "option"
3050
- },
3051
- "start-time": {
3052
- "description": "Schedule start (YYYY-MM-DD), defaults to today",
3053
- "name": "start-time",
3054
- "hasDynamicHelp": false,
3055
- "multiple": false,
3056
- "type": "option"
3057
- },
3058
- "yes": {
3059
- "char": "y",
3060
- "description": "Apply without asking; required when the output is piped or --json is used",
3061
- "name": "yes",
3062
- "allowNo": false,
3063
- "type": "boolean"
3064
- },
3065
- "idempotency-key": {
3066
- "description": "Idempotency key for this write; re-running with the same key replays the stored result instead of applying twice",
3067
- "name": "idempotency-key",
3068
- "hasDynamicHelp": false,
3069
- "multiple": false,
3070
- "type": "option"
3071
- },
3072
- "automated-keywords": {
3073
- "description": "Let Apple add keywords automatically",
3074
- "name": "automated-keywords",
3075
- "allowNo": true,
3076
- "type": "boolean"
3077
- },
3078
- "cpa-goal": {
3079
- "description": "CPA goal (amount, e.g. 50 or 12.50)",
3080
- "name": "cpa-goal",
3081
- "hasDynamicHelp": false,
3082
- "multiple": false,
3083
- "type": "option"
3084
- },
3085
- "default-bid": {
3086
- "description": "Default bid (amount, e.g. 50 or 12.50)",
3087
- "name": "default-bid",
2978
+ "yes": {
2979
+ "char": "y",
2980
+ "description": "Apply without asking; required when the output is piped or --json is used",
2981
+ "name": "yes",
2982
+ "allowNo": false,
2983
+ "type": "boolean"
2984
+ },
2985
+ "idempotency-key": {
2986
+ "description": "Idempotency key for this write; re-running with the same key replays the stored result instead of applying twice",
2987
+ "name": "idempotency-key",
3088
2988
  "hasDynamicHelp": false,
3089
2989
  "multiple": false,
3090
2990
  "type": "option"
3091
2991
  },
3092
2992
  "name": {
3093
- "description": "Ad group name",
2993
+ "description": "Ad name",
3094
2994
  "name": "name",
3095
2995
  "hasDynamicHelp": false,
3096
2996
  "multiple": false,
3097
2997
  "type": "option"
3098
2998
  },
3099
2999
  "status": {
3100
- "description": "Ad group status",
3000
+ "description": "Ad status",
3101
3001
  "name": "status",
3102
3002
  "hasDynamicHelp": false,
3103
3003
  "multiple": false,
@@ -3110,7 +3010,7 @@
3110
3010
  },
3111
3011
  "hasDynamicHelp": false,
3112
3012
  "hiddenAliases": [],
3113
- "id": "asa:ad-groups:update",
3013
+ "id": "asa:ads:update",
3114
3014
  "pluginAlias": "adapty",
3115
3015
  "pluginName": "adapty",
3116
3016
  "pluginType": "core",
@@ -3121,16 +3021,17 @@
3121
3021
  "dist",
3122
3022
  "commands",
3123
3023
  "asa",
3124
- "ad-groups",
3024
+ "ads",
3125
3025
  "update.js"
3126
3026
  ]
3127
3027
  },
3128
- "asa:ads:create": {
3028
+ "asa:apps:list": {
3129
3029
  "aliases": [],
3130
3030
  "args": {},
3131
- "description": "Create an ad from a creative in an ad group",
3031
+ "description": "List the apps promoted by this company in Apple Search Ads",
3132
3032
  "examples": [
3133
- "<%= config.bin %> asa ads create --ad-group UUID --creative-id 4321 --name \"Summer ad\""
3033
+ "<%= config.bin %> asa apps list",
3034
+ "<%= config.bin %> asa apps list --page 2 --page-size 50"
3134
3035
  ],
3135
3036
  "flags": {
3136
3037
  "json": {
@@ -3140,59 +3041,163 @@
3140
3041
  "allowNo": false,
3141
3042
  "type": "boolean"
3142
3043
  },
3143
- "yes": {
3144
- "char": "y",
3145
- "description": "Apply without asking; required when the output is piped or --json is used",
3146
- "name": "yes",
3147
- "allowNo": false,
3148
- "type": "boolean"
3044
+ "page": {
3045
+ "description": "Page number",
3046
+ "name": "page",
3047
+ "default": 1,
3048
+ "hasDynamicHelp": false,
3049
+ "multiple": false,
3050
+ "type": "option"
3149
3051
  },
3150
- "idempotency-key": {
3151
- "description": "Idempotency key for this write; re-running with the same key replays the stored result instead of applying twice",
3152
- "name": "idempotency-key",
3052
+ "page-size": {
3053
+ "description": "Items per page (max 1000); prefer one big page over a pagination loop",
3054
+ "name": "page-size",
3055
+ "default": 100,
3153
3056
  "hasDynamicHelp": false,
3154
3057
  "multiple": false,
3155
3058
  "type": "option"
3059
+ }
3060
+ },
3061
+ "hasDynamicHelp": false,
3062
+ "hiddenAliases": [],
3063
+ "id": "asa:apps:list",
3064
+ "pluginAlias": "adapty",
3065
+ "pluginName": "adapty",
3066
+ "pluginType": "core",
3067
+ "strict": true,
3068
+ "enableJsonFlag": true,
3069
+ "isESM": true,
3070
+ "relativePath": [
3071
+ "dist",
3072
+ "commands",
3073
+ "asa",
3074
+ "apps",
3075
+ "list.js"
3076
+ ]
3077
+ },
3078
+ "asa:automations:create": {
3079
+ "aliases": [],
3080
+ "args": {},
3081
+ "description": "Create an automation rule from a JSON rule file. The add-as-keyword action flags fill in or override actions[0].params, so the bid, the match type and the target ad groups need no hand-written JSON.",
3082
+ "examples": [
3083
+ "<%= config.bin %> asa automations create --file rule.json",
3084
+ "<%= config.bin %> asa automations create --file rule.json --run-now",
3085
+ "<%= config.bin %> asa automations create --file rule.json --target-ad-group AD_GROUP_ID --match-type EXACT --cpt-bid-type search_term_current_cpt",
3086
+ "<%= config.bin %> asa automations create --file rule.json --target-ad-group AD_GROUP_ID --match-type EXACT --cpt-bid-type set_to --cpt-bid 1.50 --negate ad-group"
3087
+ ],
3088
+ "flags": {
3089
+ "json": {
3090
+ "description": "Format output as json.",
3091
+ "helpGroup": "GLOBAL",
3092
+ "name": "json",
3093
+ "allowNo": false,
3094
+ "type": "boolean"
3156
3095
  },
3157
- "ad-group": {
3158
- "description": "Ad group ID (UUID) — the campaign is resolved from it",
3159
- "name": "ad-group",
3160
- "required": true,
3096
+ "cpt-bid": {
3097
+ "description": "cpt_bid.value: the bid itself with --cpt-bid-type set_to, or a percent markup on the entity bid with search_term_current_cpt / keyword_current_bid; not accepted with ad_group_default_bid",
3098
+ "name": "cpt-bid",
3161
3099
  "hasDynamicHelp": false,
3162
3100
  "multiple": false,
3163
3101
  "type": "option"
3164
3102
  },
3165
- "creative-id": {
3166
- "description": "Apple creative ID from a product page or the default set",
3167
- "name": "creative-id",
3168
- "required": true,
3103
+ "cpt-bid-type": {
3104
+ "description": "Where the bid of the created keyword comes from; the API has no default",
3105
+ "name": "cpt-bid-type",
3169
3106
  "hasDynamicHelp": false,
3170
3107
  "multiple": false,
3108
+ "options": [
3109
+ "ad_group_default_bid",
3110
+ "keyword_current_bid",
3111
+ "search_term_current_cpt",
3112
+ "set_to"
3113
+ ],
3171
3114
  "type": "option"
3172
3115
  },
3173
- "name": {
3174
- "description": "Ad name",
3175
- "name": "name",
3176
- "required": true,
3116
+ "match-type": {
3117
+ "description": "Match type of the created keyword; the API has no default",
3118
+ "name": "match-type",
3177
3119
  "hasDynamicHelp": false,
3178
3120
  "multiple": false,
3121
+ "options": [
3122
+ "BROAD",
3123
+ "EXACT"
3124
+ ],
3179
3125
  "type": "option"
3180
3126
  },
3181
- "status": {
3182
- "description": "Initial status",
3183
- "name": "status",
3127
+ "negate": {
3128
+ "description": "Also add the search term as a negative keyword at this level (search-term rules)",
3129
+ "exclusive": [
3130
+ "no-negate"
3131
+ ],
3132
+ "name": "negate",
3184
3133
  "hasDynamicHelp": false,
3185
3134
  "multiple": false,
3186
3135
  "options": [
3187
- "ENABLED",
3188
- "PAUSED"
3136
+ "ad-group",
3137
+ "campaign"
3138
+ ],
3139
+ "type": "option"
3140
+ },
3141
+ "no-negate": {
3142
+ "description": "Leave no negative keyword behind (search-term rules)",
3143
+ "exclusive": [
3144
+ "negate"
3189
3145
  ],
3146
+ "name": "no-negate",
3147
+ "allowNo": false,
3148
+ "type": "boolean"
3149
+ },
3150
+ "pause-original": {
3151
+ "description": "Pause the source keyword in its own ad group (targeting-keyword rules)",
3152
+ "name": "pause-original",
3153
+ "allowNo": true,
3154
+ "type": "boolean"
3155
+ },
3156
+ "skip-enable-duplicates": {
3157
+ "description": "Skip a keyword that already exists in the target ad group instead of enabling it (search-term rules)",
3158
+ "name": "skip-enable-duplicates",
3159
+ "allowNo": true,
3160
+ "type": "boolean"
3161
+ },
3162
+ "target-ad-group": {
3163
+ "description": "Ad group the keyword is added to (UUID), repeatable; a rule without one does nothing",
3164
+ "name": "target-ad-group",
3165
+ "hasDynamicHelp": false,
3166
+ "multiple": true,
3167
+ "type": "option"
3168
+ },
3169
+ "yes": {
3170
+ "char": "y",
3171
+ "description": "Apply without asking; required when the output is piped or --json is used",
3172
+ "name": "yes",
3173
+ "allowNo": false,
3174
+ "type": "boolean"
3175
+ },
3176
+ "idempotency-key": {
3177
+ "description": "Idempotency key for this write; re-running with the same key replays the stored result instead of applying twice",
3178
+ "name": "idempotency-key",
3179
+ "hasDynamicHelp": false,
3180
+ "multiple": false,
3181
+ "type": "option"
3182
+ },
3183
+ "file": {
3184
+ "description": "JSON file with the rule body, or - to read stdin",
3185
+ "name": "file",
3186
+ "required": true,
3187
+ "hasDynamicHelp": false,
3188
+ "multiple": false,
3190
3189
  "type": "option"
3190
+ },
3191
+ "run-now": {
3192
+ "description": "Queue the first run right after the rule is stored",
3193
+ "name": "run-now",
3194
+ "allowNo": false,
3195
+ "type": "boolean"
3191
3196
  }
3192
3197
  },
3193
3198
  "hasDynamicHelp": false,
3194
3199
  "hiddenAliases": [],
3195
- "id": "asa:ads:create",
3200
+ "id": "asa:automations:create",
3196
3201
  "pluginAlias": "adapty",
3197
3202
  "pluginName": "adapty",
3198
3203
  "pluginType": "core",
@@ -3203,22 +3208,22 @@
3203
3208
  "dist",
3204
3209
  "commands",
3205
3210
  "asa",
3206
- "ads",
3211
+ "automations",
3207
3212
  "create.js"
3208
3213
  ]
3209
3214
  },
3210
- "asa:ads:get": {
3215
+ "asa:automations:get": {
3211
3216
  "aliases": [],
3212
3217
  "args": {
3213
- "ad_id": {
3214
- "description": "Ad ID (UUID)",
3215
- "name": "ad_id",
3218
+ "automation_id": {
3219
+ "description": "Automation rule ID (UUID)",
3220
+ "name": "automation_id",
3216
3221
  "required": true
3217
3222
  }
3218
3223
  },
3219
- "description": "Show one ad and its serving state",
3224
+ "description": "Show one automation rule with its conditions and actions",
3220
3225
  "examples": [
3221
- "<%= config.bin %> asa ads get 550e8400-e29b-41d4-a716-446655440000"
3226
+ "<%= config.bin %> asa automations get 550e8400-e29b-41d4-a716-446655440000"
3222
3227
  ],
3223
3228
  "flags": {
3224
3229
  "json": {
@@ -3231,7 +3236,7 @@
3231
3236
  },
3232
3237
  "hasDynamicHelp": false,
3233
3238
  "hiddenAliases": [],
3234
- "id": "asa:ads:get",
3239
+ "id": "asa:automations:get",
3235
3240
  "pluginAlias": "adapty",
3236
3241
  "pluginName": "adapty",
3237
3242
  "pluginType": "core",
@@ -3242,17 +3247,16 @@
3242
3247
  "dist",
3243
3248
  "commands",
3244
3249
  "asa",
3245
- "ads",
3250
+ "automations",
3246
3251
  "get.js"
3247
3252
  ]
3248
3253
  },
3249
- "asa:ads:list": {
3254
+ "asa:automations:list": {
3250
3255
  "aliases": [],
3251
3256
  "args": {},
3252
- "description": "List ads; serving_state_reasons explains why an enabled ad is not running",
3257
+ "description": "List automation rules; status 1 is active, 0 is stopped",
3253
3258
  "examples": [
3254
- "<%= config.bin %> asa ads list",
3255
- "<%= config.bin %> asa ads list --ad-group AD_GROUP_UUID --status ENABLED"
3259
+ "<%= config.bin %> asa automations list"
3256
3260
  ],
3257
3261
  "flags": {
3258
3262
  "json": {
@@ -3277,50 +3281,11 @@
3277
3281
  "hasDynamicHelp": false,
3278
3282
  "multiple": false,
3279
3283
  "type": "option"
3280
- },
3281
- "ad-group": {
3282
- "description": "Keep only rows in this ad group; repeatable",
3283
- "name": "ad-group",
3284
- "hasDynamicHelp": false,
3285
- "multiple": true,
3286
- "type": "option"
3287
- },
3288
- "campaign": {
3289
- "description": "Keep only rows in this campaign; repeatable",
3290
- "name": "campaign",
3291
- "hasDynamicHelp": false,
3292
- "multiple": true,
3293
- "type": "option"
3294
- },
3295
- "campaign-group": {
3296
- "description": "Keep only rows in this campaign group; repeatable",
3297
- "name": "campaign-group",
3298
- "hasDynamicHelp": false,
3299
- "multiple": true,
3300
- "type": "option"
3301
- },
3302
- "search": {
3303
- "description": "Case-insensitive substring match on the name",
3304
- "name": "search",
3305
- "hasDynamicHelp": false,
3306
- "multiple": false,
3307
- "type": "option"
3308
- },
3309
- "status": {
3310
- "description": "Keep only rows in this state",
3311
- "name": "status",
3312
- "hasDynamicHelp": false,
3313
- "multiple": false,
3314
- "options": [
3315
- "ENABLED",
3316
- "PAUSED"
3317
- ],
3318
- "type": "option"
3319
3284
  }
3320
3285
  },
3321
3286
  "hasDynamicHelp": false,
3322
3287
  "hiddenAliases": [],
3323
- "id": "asa:ads:list",
3288
+ "id": "asa:automations:list",
3324
3289
  "pluginAlias": "adapty",
3325
3290
  "pluginName": "adapty",
3326
3291
  "pluginType": "core",
@@ -3331,22 +3296,23 @@
3331
3296
  "dist",
3332
3297
  "commands",
3333
3298
  "asa",
3334
- "ads",
3299
+ "automations",
3335
3300
  "list.js"
3336
3301
  ]
3337
3302
  },
3338
- "asa:ads:update": {
3303
+ "asa:automations:run": {
3339
3304
  "aliases": [],
3340
3305
  "args": {
3341
- "ad_id": {
3342
- "description": "Ad ID (UUID)",
3343
- "name": "ad_id",
3306
+ "automation_id": {
3307
+ "description": "Automation rule ID (UUID)",
3308
+ "name": "automation_id",
3344
3309
  "required": true
3345
3310
  }
3346
3311
  },
3347
- "description": "Rename an ad or pause it; the creative and ad group are fixed at creation",
3312
+ "description": "Run an automation rule now; the run is queued, not awaited",
3348
3313
  "examples": [
3349
- "<%= config.bin %> asa ads update UUID --status PAUSED"
3314
+ "<%= config.bin %> asa automations run UUID",
3315
+ "<%= config.bin %> asa automations run UUID --dry-run"
3350
3316
  ],
3351
3317
  "flags": {
3352
3318
  "json": {
@@ -3370,28 +3336,16 @@
3370
3336
  "multiple": false,
3371
3337
  "type": "option"
3372
3338
  },
3373
- "name": {
3374
- "description": "Ad name",
3375
- "name": "name",
3376
- "hasDynamicHelp": false,
3377
- "multiple": false,
3378
- "type": "option"
3379
- },
3380
- "status": {
3381
- "description": "Ad status",
3382
- "name": "status",
3383
- "hasDynamicHelp": false,
3384
- "multiple": false,
3385
- "options": [
3386
- "ENABLED",
3387
- "PAUSED"
3388
- ],
3389
- "type": "option"
3339
+ "dry-run": {
3340
+ "description": "Evaluate and log the rule without touching Apple",
3341
+ "name": "dry-run",
3342
+ "allowNo": false,
3343
+ "type": "boolean"
3390
3344
  }
3391
3345
  },
3392
3346
  "hasDynamicHelp": false,
3393
3347
  "hiddenAliases": [],
3394
- "id": "asa:ads:update",
3348
+ "id": "asa:automations:run",
3395
3349
  "pluginAlias": "adapty",
3396
3350
  "pluginName": "adapty",
3397
3351
  "pluginType": "core",
@@ -3402,17 +3356,22 @@
3402
3356
  "dist",
3403
3357
  "commands",
3404
3358
  "asa",
3405
- "ads",
3406
- "update.js"
3359
+ "automations",
3360
+ "run.js"
3407
3361
  ]
3408
3362
  },
3409
- "asa:apps:list": {
3363
+ "asa:automations:runs": {
3410
3364
  "aliases": [],
3411
- "args": {},
3412
- "description": "List the apps promoted by this company in Apple Search Ads",
3365
+ "args": {
3366
+ "automation_id": {
3367
+ "description": "Automation rule ID (UUID)",
3368
+ "name": "automation_id",
3369
+ "required": true
3370
+ }
3371
+ },
3372
+ "description": "List past runs of an automation rule, including dry runs",
3413
3373
  "examples": [
3414
- "<%= config.bin %> asa apps list",
3415
- "<%= config.bin %> asa apps list --page 2 --page-size 50"
3374
+ "<%= config.bin %> asa automations runs 550e8400-e29b-41d4-a716-446655440000"
3416
3375
  ],
3417
3376
  "flags": {
3418
3377
  "json": {
@@ -3441,7 +3400,7 @@
3441
3400
  },
3442
3401
  "hasDynamicHelp": false,
3443
3402
  "hiddenAliases": [],
3444
- "id": "asa:apps:list",
3403
+ "id": "asa:automations:runs",
3445
3404
  "pluginAlias": "adapty",
3446
3405
  "pluginName": "adapty",
3447
3406
  "pluginType": "core",
@@ -3452,19 +3411,24 @@
3452
3411
  "dist",
3453
3412
  "commands",
3454
3413
  "asa",
3455
- "apps",
3456
- "list.js"
3414
+ "automations",
3415
+ "runs.js"
3457
3416
  ]
3458
3417
  },
3459
- "asa:automations:create": {
3418
+ "asa:automations:update": {
3460
3419
  "aliases": [],
3461
- "args": {},
3462
- "description": "Create an automation rule from a JSON rule file. The add-as-keyword action flags fill in or override actions[0].params, so the bid, the match type and the target ad groups need no hand-written JSON.",
3420
+ "args": {
3421
+ "automation_id": {
3422
+ "description": "Automation rule ID (UUID)",
3423
+ "name": "automation_id",
3424
+ "required": true
3425
+ }
3426
+ },
3427
+ "description": "Change an automation rule: stop it, rename it, or replace parts of the rule. An add-as-keyword action flag turns the call into a read-modify-write: the rule is read, actions[0].params is rebuilt from the flags and the whole actions list is written back — an edit someone makes in the dashboard in between is overwritten. This is also the way to repair a rule whose stored params carry the wrong shape.",
3463
3428
  "examples": [
3464
- "<%= config.bin %> asa automations create --file rule.json",
3465
- "<%= config.bin %> asa automations create --file rule.json --run-now",
3466
- "<%= config.bin %> asa automations create --file rule.json --target-ad-group AD_GROUP_ID --match-type EXACT --cpt-bid-type search_term_current_cpt",
3467
- "<%= config.bin %> asa automations create --file rule.json --target-ad-group AD_GROUP_ID --match-type EXACT --cpt-bid-type set_to --cpt-bid 1.50 --negate ad-group"
3429
+ "<%= config.bin %> asa automations update UUID --stop",
3430
+ "<%= config.bin %> asa automations update UUID --file rule.json",
3431
+ "<%= config.bin %> asa automations update UUID --target-ad-group AD_GROUP_ID --match-type EXACT --cpt-bid-type search_term_current_cpt"
3468
3432
  ],
3469
3433
  "flags": {
3470
3434
  "json": {
@@ -3562,23 +3526,41 @@
3562
3526
  "type": "option"
3563
3527
  },
3564
3528
  "file": {
3565
- "description": "JSON file with the rule body, or - to read stdin",
3529
+ "description": "JSON file with the parts to change, or - to read stdin",
3566
3530
  "name": "file",
3567
- "required": true,
3568
3531
  "hasDynamicHelp": false,
3569
3532
  "multiple": false,
3570
3533
  "type": "option"
3571
3534
  },
3572
- "run-now": {
3573
- "description": "Queue the first run right after the rule is stored",
3574
- "name": "run-now",
3535
+ "name": {
3536
+ "description": "Rule name",
3537
+ "name": "name",
3538
+ "hasDynamicHelp": false,
3539
+ "multiple": false,
3540
+ "type": "option"
3541
+ },
3542
+ "start": {
3543
+ "description": "Activate the rule",
3544
+ "exclusive": [
3545
+ "stop"
3546
+ ],
3547
+ "name": "start",
3548
+ "allowNo": false,
3549
+ "type": "boolean"
3550
+ },
3551
+ "stop": {
3552
+ "description": "Stop the rule and clear its next run",
3553
+ "exclusive": [
3554
+ "start"
3555
+ ],
3556
+ "name": "stop",
3575
3557
  "allowNo": false,
3576
3558
  "type": "boolean"
3577
3559
  }
3578
3560
  },
3579
3561
  "hasDynamicHelp": false,
3580
3562
  "hiddenAliases": [],
3581
- "id": "asa:automations:create",
3563
+ "id": "asa:automations:update",
3582
3564
  "pluginAlias": "adapty",
3583
3565
  "pluginName": "adapty",
3584
3566
  "pluginType": "core",
@@ -3590,21 +3572,18 @@
3590
3572
  "commands",
3591
3573
  "asa",
3592
3574
  "automations",
3593
- "create.js"
3575
+ "update.js"
3594
3576
  ]
3595
3577
  },
3596
- "asa:automations:get": {
3578
+ "asa:campaigns:bulk-create": {
3597
3579
  "aliases": [],
3598
- "args": {
3599
- "automation_id": {
3600
- "description": "Automation rule ID (UUID)",
3601
- "name": "automation_id",
3602
- "required": true
3603
- }
3604
- },
3605
- "description": "Show one automation rule with its conditions and actions",
3580
+ "args": {},
3581
+ "description": "Create a whole campaign structure (campaigns → ad groups → keywords/negative keywords/ads) in one bulk operation",
3606
3582
  "examples": [
3607
- "<%= config.bin %> asa automations get 550e8400-e29b-41d4-a716-446655440000"
3583
+ "<%= config.bin %> asa campaigns bulk-create --file structure.json",
3584
+ "cat structure.json | <%= config.bin %> asa campaigns bulk-create --file -",
3585
+ "<%= config.bin %> asa campaigns bulk-create --from-file Campaign_And_Adgroup_Template.xlsx --org-id 1234567",
3586
+ "<%= config.bin %> asa campaigns bulk-create --from-file keywords_template.csv --org-id 1234567 --preview"
3608
3587
  ],
3609
3588
  "flags": {
3610
3589
  "json": {
@@ -3613,11 +3592,74 @@
3613
3592
  "name": "json",
3614
3593
  "allowNo": false,
3615
3594
  "type": "boolean"
3595
+ },
3596
+ "yes": {
3597
+ "char": "y",
3598
+ "description": "Apply without asking; required when the output is piped or --json is used",
3599
+ "name": "yes",
3600
+ "allowNo": false,
3601
+ "type": "boolean"
3602
+ },
3603
+ "idempotency-key": {
3604
+ "description": "Idempotency key for this write; re-running with the same key replays the stored result instead of applying twice",
3605
+ "name": "idempotency-key",
3606
+ "hasDynamicHelp": false,
3607
+ "multiple": false,
3608
+ "type": "option"
3609
+ },
3610
+ "file": {
3611
+ "description": "JSON file with the campaign structure (the POST /bulk-operations/ body); use \"-\" for stdin",
3612
+ "name": "file",
3613
+ "hasDynamicHelp": false,
3614
+ "multiple": false,
3615
+ "type": "option"
3616
+ },
3617
+ "from-file": {
3618
+ "description": "Apple Ads bulk template (Campaign_And_Adgroup_Template.xlsx or keywords .csv) to convert and submit",
3619
+ "name": "from-file",
3620
+ "hasDynamicHelp": false,
3621
+ "multiple": false,
3622
+ "type": "option"
3623
+ },
3624
+ "org-id": {
3625
+ "description": "Apple org id (campaign_group_id) the converted template will target; required with --from-file",
3626
+ "name": "org-id",
3627
+ "hasDynamicHelp": false,
3628
+ "multiple": false,
3629
+ "type": "option"
3630
+ },
3631
+ "poll-interval": {
3632
+ "description": "Seconds between progress polls",
3633
+ "name": "poll-interval",
3634
+ "default": 5,
3635
+ "hasDynamicHelp": false,
3636
+ "multiple": false,
3637
+ "type": "option"
3638
+ },
3639
+ "preview": {
3640
+ "description": "With --from-file: print the converted request and stop, nothing is created",
3641
+ "name": "preview",
3642
+ "allowNo": false,
3643
+ "type": "boolean"
3644
+ },
3645
+ "timeout": {
3646
+ "description": "Max seconds to wait for the operation to finish",
3647
+ "name": "timeout",
3648
+ "default": 900,
3649
+ "hasDynamicHelp": false,
3650
+ "multiple": false,
3651
+ "type": "option"
3652
+ },
3653
+ "wait": {
3654
+ "description": "Poll the operation until it finishes; --no-wait returns the operation id immediately",
3655
+ "name": "wait",
3656
+ "allowNo": true,
3657
+ "type": "boolean"
3616
3658
  }
3617
3659
  },
3618
3660
  "hasDynamicHelp": false,
3619
3661
  "hiddenAliases": [],
3620
- "id": "asa:automations:get",
3662
+ "id": "asa:campaigns:bulk-create",
3621
3663
  "pluginAlias": "adapty",
3622
3664
  "pluginName": "adapty",
3623
3665
  "pluginType": "core",
@@ -3628,16 +3670,18 @@
3628
3670
  "dist",
3629
3671
  "commands",
3630
3672
  "asa",
3631
- "automations",
3632
- "get.js"
3673
+ "campaigns",
3674
+ "bulk-create.js"
3633
3675
  ]
3634
3676
  },
3635
- "asa:automations:list": {
3677
+ "asa:campaigns:bulk-list": {
3636
3678
  "aliases": [],
3637
3679
  "args": {},
3638
- "description": "List automation rules; status 1 is active, 0 is stopped",
3680
+ "description": "This company's bulk operations, newest first; inspect one with bulk-status",
3639
3681
  "examples": [
3640
- "<%= config.bin %> asa automations list"
3682
+ "<%= config.bin %> asa campaigns bulk-list",
3683
+ "<%= config.bin %> asa campaigns bulk-list --status partial --status failed",
3684
+ "<%= config.bin %> asa campaigns bulk-list --created-from 2026-08-01 --created-to 2026-08-20"
3641
3685
  ],
3642
3686
  "flags": {
3643
3687
  "json": {
@@ -3662,71 +3706,46 @@
3662
3706
  "hasDynamicHelp": false,
3663
3707
  "multiple": false,
3664
3708
  "type": "option"
3665
- }
3666
- },
3667
- "hasDynamicHelp": false,
3668
- "hiddenAliases": [],
3669
- "id": "asa:automations:list",
3670
- "pluginAlias": "adapty",
3671
- "pluginName": "adapty",
3672
- "pluginType": "core",
3673
- "strict": true,
3674
- "enableJsonFlag": true,
3675
- "isESM": true,
3676
- "relativePath": [
3677
- "dist",
3678
- "commands",
3679
- "asa",
3680
- "automations",
3681
- "list.js"
3682
- ]
3683
- },
3684
- "asa:automations:run": {
3685
- "aliases": [],
3686
- "args": {
3687
- "automation_id": {
3688
- "description": "Automation rule ID (UUID)",
3689
- "name": "automation_id",
3690
- "required": true
3691
- }
3692
- },
3693
- "description": "Run an automation rule now; the run is queued, not awaited",
3694
- "examples": [
3695
- "<%= config.bin %> asa automations run UUID",
3696
- "<%= config.bin %> asa automations run UUID --dry-run"
3697
- ],
3698
- "flags": {
3699
- "json": {
3700
- "description": "Format output as json.",
3701
- "helpGroup": "GLOBAL",
3702
- "name": "json",
3703
- "allowNo": false,
3704
- "type": "boolean"
3705
3709
  },
3706
- "yes": {
3707
- "char": "y",
3708
- "description": "Apply without asking; required when the output is piped or --json is used",
3709
- "name": "yes",
3710
- "allowNo": false,
3711
- "type": "boolean"
3710
+ "app": {
3711
+ "description": "Keep only operations of this app (UUID)",
3712
+ "name": "app",
3713
+ "hasDynamicHelp": false,
3714
+ "multiple": false,
3715
+ "type": "option"
3712
3716
  },
3713
- "idempotency-key": {
3714
- "description": "Idempotency key for this write; re-running with the same key replays the stored result instead of applying twice",
3715
- "name": "idempotency-key",
3717
+ "created-from": {
3718
+ "description": "Keep only operations created on or after this date (YYYY-MM-DD)",
3719
+ "name": "created-from",
3716
3720
  "hasDynamicHelp": false,
3717
3721
  "multiple": false,
3718
3722
  "type": "option"
3719
3723
  },
3720
- "dry-run": {
3721
- "description": "Evaluate and log the rule without touching Apple",
3722
- "name": "dry-run",
3723
- "allowNo": false,
3724
- "type": "boolean"
3724
+ "created-to": {
3725
+ "description": "Keep only operations created on or before this date (YYYY-MM-DD)",
3726
+ "name": "created-to",
3727
+ "hasDynamicHelp": false,
3728
+ "multiple": false,
3729
+ "type": "option"
3730
+ },
3731
+ "status": {
3732
+ "description": "Keep only operations in this state; repeatable",
3733
+ "name": "status",
3734
+ "hasDynamicHelp": false,
3735
+ "multiple": true,
3736
+ "options": [
3737
+ "failed",
3738
+ "partial",
3739
+ "pending",
3740
+ "running",
3741
+ "success"
3742
+ ],
3743
+ "type": "option"
3725
3744
  }
3726
3745
  },
3727
3746
  "hasDynamicHelp": false,
3728
3747
  "hiddenAliases": [],
3729
- "id": "asa:automations:run",
3748
+ "id": "asa:campaigns:bulk-list",
3730
3749
  "pluginAlias": "adapty",
3731
3750
  "pluginName": "adapty",
3732
3751
  "pluginType": "core",
@@ -3737,22 +3756,22 @@
3737
3756
  "dist",
3738
3757
  "commands",
3739
3758
  "asa",
3740
- "automations",
3741
- "run.js"
3759
+ "campaigns",
3760
+ "bulk-list.js"
3742
3761
  ]
3743
3762
  },
3744
- "asa:automations:runs": {
3763
+ "asa:campaigns:bulk-status": {
3745
3764
  "aliases": [],
3746
3765
  "args": {
3747
- "automation_id": {
3748
- "description": "Automation rule ID (UUID)",
3749
- "name": "automation_id",
3766
+ "operation-id": {
3767
+ "description": "Bulk operation ID returned by bulk-create",
3768
+ "name": "operation-id",
3750
3769
  "required": true
3751
3770
  }
3752
3771
  },
3753
- "description": "List past runs of an automation rule, including dry runs",
3772
+ "description": "Progress board of one bulk operation: counts, pipelines and the per-object log",
3754
3773
  "examples": [
3755
- "<%= config.bin %> asa automations runs 550e8400-e29b-41d4-a716-446655440000"
3774
+ "<%= config.bin %> asa campaigns bulk-status 660e8400-e29b-41d4-a716-446655440001"
3756
3775
  ],
3757
3776
  "flags": {
3758
3777
  "json": {
@@ -3781,7 +3800,7 @@
3781
3800
  },
3782
3801
  "hasDynamicHelp": false,
3783
3802
  "hiddenAliases": [],
3784
- "id": "asa:automations:runs",
3803
+ "id": "asa:campaigns:bulk-status",
3785
3804
  "pluginAlias": "adapty",
3786
3805
  "pluginName": "adapty",
3787
3806
  "pluginType": "core",
@@ -3792,24 +3811,18 @@
3792
3811
  "dist",
3793
3812
  "commands",
3794
3813
  "asa",
3795
- "automations",
3796
- "runs.js"
3814
+ "campaigns",
3815
+ "bulk-status.js"
3797
3816
  ]
3798
3817
  },
3799
- "asa:automations:update": {
3818
+ "asa:campaigns:create": {
3800
3819
  "aliases": [],
3801
- "args": {
3802
- "automation_id": {
3803
- "description": "Automation rule ID (UUID)",
3804
- "name": "automation_id",
3805
- "required": true
3806
- }
3807
- },
3808
- "description": "Change an automation rule: stop it, rename it, or replace parts of the rule. An add-as-keyword action flag turns the call into a read-modify-write: the rule is read, actions[0].params is rebuilt from the flags and the whole actions list is written back — an edit someone makes in the dashboard in between is overwritten. This is also the way to repair a rule whose stored params carry the wrong shape.",
3820
+ "args": {},
3821
+ "description": "Create a campaign in Apple Search Ads. A Max Conversions campaign also needs an automated ad group (`asa ad-groups create --automated`); line-of-credit organizations must pass all five --invoice-* flags",
3809
3822
  "examples": [
3810
- "<%= config.bin %> asa automations update UUID --stop",
3811
- "<%= config.bin %> asa automations update UUID --file rule.json",
3812
- "<%= config.bin %> asa automations update UUID --target-ad-group AD_GROUP_ID --match-type EXACT --cpt-bid-type search_term_current_cpt"
3823
+ "<%= config.bin %> asa campaigns create --org UUID --name \"Winter push\" --adam-id 123456 --country US --daily-budget 50",
3824
+ "<%= config.bin %> asa campaigns create --org UUID --name \"Max Conv\" --adam-id 123456 --country US --daily-budget 50 --bidding-strategy MAX_CONVERSIONS",
3825
+ "<%= config.bin %> asa campaigns create --org UUID --name \"LOC push\" --adam-id 123456 --country US --daily-budget 50 --invoice-advertiser \"Acme Inc\" --invoice-order-number PO-42 --invoice-contact-name \"Jane Doe\" --invoice-contact-email jane@acme.com --invoice-billing-email billing@acme.com"
3813
3826
  ],
3814
3827
  "flags": {
3815
3828
  "json": {
@@ -3819,129 +3832,170 @@
3819
3832
  "allowNo": false,
3820
3833
  "type": "boolean"
3821
3834
  },
3822
- "cpt-bid": {
3823
- "description": "cpt_bid.value: the bid itself with --cpt-bid-type set_to, or a percent markup on the entity bid with search_term_current_cpt / keyword_current_bid; not accepted with ad_group_default_bid",
3824
- "name": "cpt-bid",
3835
+ "currency": {
3836
+ "description": "Currency code for the amounts in this call",
3837
+ "name": "currency",
3838
+ "default": "USD",
3825
3839
  "hasDynamicHelp": false,
3826
3840
  "multiple": false,
3827
3841
  "type": "option"
3828
3842
  },
3829
- "cpt-bid-type": {
3830
- "description": "Where the bid of the created keyword comes from; the API has no default",
3831
- "name": "cpt-bid-type",
3843
+ "yes": {
3844
+ "char": "y",
3845
+ "description": "Apply without asking; required when the output is piped or --json is used",
3846
+ "name": "yes",
3847
+ "allowNo": false,
3848
+ "type": "boolean"
3849
+ },
3850
+ "idempotency-key": {
3851
+ "description": "Idempotency key for this write; re-running with the same key replays the stored result instead of applying twice",
3852
+ "name": "idempotency-key",
3832
3853
  "hasDynamicHelp": false,
3833
3854
  "multiple": false,
3834
- "options": [
3835
- "ad_group_default_bid",
3836
- "keyword_current_bid",
3837
- "search_term_current_cpt",
3838
- "set_to"
3839
- ],
3840
3855
  "type": "option"
3841
3856
  },
3842
- "match-type": {
3843
- "description": "Match type of the created keyword; the API has no default",
3844
- "name": "match-type",
3857
+ "invoice-advertiser": {
3858
+ "description": "Invoicing Options (line-of-credit orgs, see payment_model in asa orgs list): advertiser name",
3859
+ "name": "invoice-advertiser",
3845
3860
  "hasDynamicHelp": false,
3846
3861
  "multiple": false,
3847
- "options": [
3848
- "BROAD",
3849
- "EXACT"
3850
- ],
3851
3862
  "type": "option"
3852
3863
  },
3853
- "negate": {
3854
- "description": "Also add the search term as a negative keyword at this level (search-term rules)",
3855
- "exclusive": [
3856
- "no-negate"
3857
- ],
3858
- "name": "negate",
3864
+ "invoice-billing-email": {
3865
+ "description": "Invoicing Options (line-of-credit orgs, see payment_model in asa orgs list): billing contact email",
3866
+ "name": "invoice-billing-email",
3859
3867
  "hasDynamicHelp": false,
3860
3868
  "multiple": false,
3861
- "options": [
3862
- "ad-group",
3863
- "campaign"
3864
- ],
3865
3869
  "type": "option"
3866
3870
  },
3867
- "no-negate": {
3868
- "description": "Leave no negative keyword behind (search-term rules)",
3869
- "exclusive": [
3870
- "negate"
3871
- ],
3872
- "name": "no-negate",
3873
- "allowNo": false,
3874
- "type": "boolean"
3875
- },
3876
- "pause-original": {
3877
- "description": "Pause the source keyword in its own ad group (targeting-keyword rules)",
3878
- "name": "pause-original",
3879
- "allowNo": true,
3880
- "type": "boolean"
3881
- },
3882
- "skip-enable-duplicates": {
3883
- "description": "Skip a keyword that already exists in the target ad group instead of enabling it (search-term rules)",
3884
- "name": "skip-enable-duplicates",
3885
- "allowNo": true,
3886
- "type": "boolean"
3887
- },
3888
- "target-ad-group": {
3889
- "description": "Ad group the keyword is added to (UUID), repeatable; a rule without one does nothing",
3890
- "name": "target-ad-group",
3871
+ "invoice-contact-email": {
3872
+ "description": "Invoicing Options (line-of-credit orgs, see payment_model in asa orgs list): buyer contact email",
3873
+ "name": "invoice-contact-email",
3891
3874
  "hasDynamicHelp": false,
3892
- "multiple": true,
3875
+ "multiple": false,
3893
3876
  "type": "option"
3894
3877
  },
3895
- "yes": {
3896
- "char": "y",
3897
- "description": "Apply without asking; required when the output is piped or --json is used",
3898
- "name": "yes",
3899
- "allowNo": false,
3900
- "type": "boolean"
3878
+ "invoice-contact-name": {
3879
+ "description": "Invoicing Options (line-of-credit orgs, see payment_model in asa orgs list): buyer contact name",
3880
+ "name": "invoice-contact-name",
3881
+ "hasDynamicHelp": false,
3882
+ "multiple": false,
3883
+ "type": "option"
3901
3884
  },
3902
- "idempotency-key": {
3903
- "description": "Idempotency key for this write; re-running with the same key replays the stored result instead of applying twice",
3904
- "name": "idempotency-key",
3885
+ "invoice-order-number": {
3886
+ "description": "Invoicing Options (line-of-credit orgs, see payment_model in asa orgs list): order number",
3887
+ "name": "invoice-order-number",
3905
3888
  "hasDynamicHelp": false,
3906
3889
  "multiple": false,
3907
3890
  "type": "option"
3908
3891
  },
3909
- "file": {
3910
- "description": "JSON file with the parts to change, or - to read stdin",
3911
- "name": "file",
3892
+ "ad-channel-type": {
3893
+ "description": "Ad channel type",
3894
+ "name": "ad-channel-type",
3895
+ "default": "SEARCH",
3912
3896
  "hasDynamicHelp": false,
3913
3897
  "multiple": false,
3898
+ "options": [
3899
+ "DISPLAY",
3900
+ "SEARCH"
3901
+ ],
3914
3902
  "type": "option"
3915
3903
  },
3916
- "name": {
3917
- "description": "Rule name",
3918
- "name": "name",
3904
+ "adam-id": {
3905
+ "description": "App Store app ID (adam_id)",
3906
+ "name": "adam-id",
3907
+ "required": true,
3919
3908
  "hasDynamicHelp": false,
3920
3909
  "multiple": false,
3921
3910
  "type": "option"
3922
3911
  },
3923
- "start": {
3924
- "description": "Activate the rule",
3925
- "exclusive": [
3926
- "stop"
3912
+ "bidding-strategy": {
3913
+ "description": "Bidding strategy; Apple defaults to MANUAL_CPT when omitted",
3914
+ "name": "bidding-strategy",
3915
+ "hasDynamicHelp": false,
3916
+ "multiple": false,
3917
+ "options": [
3918
+ "MANUAL_CPT",
3919
+ "MAX_CONVERSIONS"
3927
3920
  ],
3928
- "name": "start",
3929
- "allowNo": false,
3930
- "type": "boolean"
3921
+ "type": "option"
3931
3922
  },
3932
- "stop": {
3933
- "description": "Stop the rule and clear its next run",
3934
- "exclusive": [
3935
- "start"
3923
+ "billing-event": {
3924
+ "description": "Billing event",
3925
+ "name": "billing-event",
3926
+ "default": "TAPS",
3927
+ "hasDynamicHelp": false,
3928
+ "multiple": false,
3929
+ "options": [
3930
+ "IMPRESSIONS",
3931
+ "TAPS"
3936
3932
  ],
3937
- "name": "stop",
3938
- "allowNo": false,
3939
- "type": "boolean"
3940
- }
3941
- },
3942
- "hasDynamicHelp": false,
3933
+ "type": "option"
3934
+ },
3935
+ "country": {
3936
+ "description": "Country or region code, repeatable",
3937
+ "name": "country",
3938
+ "required": true,
3939
+ "hasDynamicHelp": false,
3940
+ "multiple": true,
3941
+ "type": "option"
3942
+ },
3943
+ "daily-budget": {
3944
+ "description": "Daily budget (amount, e.g. 50 or 12.50)",
3945
+ "name": "daily-budget",
3946
+ "required": true,
3947
+ "hasDynamicHelp": false,
3948
+ "multiple": false,
3949
+ "type": "option"
3950
+ },
3951
+ "name": {
3952
+ "description": "Campaign name",
3953
+ "name": "name",
3954
+ "required": true,
3955
+ "hasDynamicHelp": false,
3956
+ "multiple": false,
3957
+ "type": "option"
3958
+ },
3959
+ "org": {
3960
+ "description": "Campaign group ID (UUID) — see `adapty asa orgs list`",
3961
+ "name": "org",
3962
+ "required": true,
3963
+ "hasDynamicHelp": false,
3964
+ "multiple": false,
3965
+ "type": "option"
3966
+ },
3967
+ "status": {
3968
+ "description": "Initial status",
3969
+ "name": "status",
3970
+ "hasDynamicHelp": false,
3971
+ "multiple": false,
3972
+ "options": [
3973
+ "ENABLED",
3974
+ "PAUSED"
3975
+ ],
3976
+ "type": "option"
3977
+ },
3978
+ "supply-source": {
3979
+ "description": "Supply source, repeatable",
3980
+ "name": "supply-source",
3981
+ "default": [
3982
+ "APPSTORE_SEARCH_RESULTS"
3983
+ ],
3984
+ "hasDynamicHelp": false,
3985
+ "multiple": true,
3986
+ "type": "option"
3987
+ },
3988
+ "target-cpa": {
3989
+ "description": "Target CPA; must be lower than --daily-budget (amount, e.g. 50 or 12.50)",
3990
+ "name": "target-cpa",
3991
+ "hasDynamicHelp": false,
3992
+ "multiple": false,
3993
+ "type": "option"
3994
+ }
3995
+ },
3996
+ "hasDynamicHelp": false,
3943
3997
  "hiddenAliases": [],
3944
- "id": "asa:automations:update",
3998
+ "id": "asa:campaigns:create",
3945
3999
  "pluginAlias": "adapty",
3946
4000
  "pluginName": "adapty",
3947
4001
  "pluginType": "core",
@@ -3952,19 +4006,22 @@
3952
4006
  "dist",
3953
4007
  "commands",
3954
4008
  "asa",
3955
- "automations",
3956
- "update.js"
4009
+ "campaigns",
4010
+ "create.js"
3957
4011
  ]
3958
4012
  },
3959
- "asa:campaigns:bulk-create": {
4013
+ "asa:campaigns:get": {
3960
4014
  "aliases": [],
3961
- "args": {},
3962
- "description": "Create a whole campaign structure (campaigns → ad groups → keywords/negative keywords/ads) in one bulk operation",
4015
+ "args": {
4016
+ "campaign_id": {
4017
+ "description": "Campaign ID (UUID)",
4018
+ "name": "campaign_id",
4019
+ "required": true
4020
+ }
4021
+ },
4022
+ "description": "Show one campaign; read numbers with asa metrics",
3963
4023
  "examples": [
3964
- "<%= config.bin %> asa campaigns bulk-create --file structure.json",
3965
- "cat structure.json | <%= config.bin %> asa campaigns bulk-create --file -",
3966
- "<%= config.bin %> asa campaigns bulk-create --from-file Campaign_And_Adgroup_Template.xlsx --org-id 1234567",
3967
- "<%= config.bin %> asa campaigns bulk-create --from-file keywords_template.csv --org-id 1234567 --preview"
4024
+ "<%= config.bin %> asa campaigns get 550e8400-e29b-41d4-a716-446655440000"
3968
4025
  ],
3969
4026
  "flags": {
3970
4027
  "json": {
@@ -3973,74 +4030,93 @@
3973
4030
  "name": "json",
3974
4031
  "allowNo": false,
3975
4032
  "type": "boolean"
3976
- },
3977
- "yes": {
3978
- "char": "y",
3979
- "description": "Apply without asking; required when the output is piped or --json is used",
3980
- "name": "yes",
4033
+ }
4034
+ },
4035
+ "hasDynamicHelp": false,
4036
+ "hiddenAliases": [],
4037
+ "id": "asa:campaigns:get",
4038
+ "pluginAlias": "adapty",
4039
+ "pluginName": "adapty",
4040
+ "pluginType": "core",
4041
+ "strict": true,
4042
+ "enableJsonFlag": true,
4043
+ "isESM": true,
4044
+ "relativePath": [
4045
+ "dist",
4046
+ "commands",
4047
+ "asa",
4048
+ "campaigns",
4049
+ "get.js"
4050
+ ]
4051
+ },
4052
+ "asa:campaigns:list": {
4053
+ "aliases": [],
4054
+ "args": {},
4055
+ "description": "List Apple Search Ads campaigns; read numbers with asa metrics",
4056
+ "examples": [
4057
+ "<%= config.bin %> asa campaigns list",
4058
+ "<%= config.bin %> asa campaigns list --app APP_UUID --status PAUSED"
4059
+ ],
4060
+ "flags": {
4061
+ "json": {
4062
+ "description": "Format output as json.",
4063
+ "helpGroup": "GLOBAL",
4064
+ "name": "json",
3981
4065
  "allowNo": false,
3982
4066
  "type": "boolean"
3983
4067
  },
3984
- "idempotency-key": {
3985
- "description": "Idempotency key for this write; re-running with the same key replays the stored result instead of applying twice",
3986
- "name": "idempotency-key",
4068
+ "page": {
4069
+ "description": "Page number",
4070
+ "name": "page",
4071
+ "default": 1,
3987
4072
  "hasDynamicHelp": false,
3988
4073
  "multiple": false,
3989
4074
  "type": "option"
3990
4075
  },
3991
- "file": {
3992
- "description": "JSON file with the campaign structure (the POST /bulk-operations/ body); use \"-\" for stdin",
3993
- "name": "file",
4076
+ "page-size": {
4077
+ "description": "Items per page (max 1000); prefer one big page over a pagination loop",
4078
+ "name": "page-size",
4079
+ "default": 100,
3994
4080
  "hasDynamicHelp": false,
3995
4081
  "multiple": false,
3996
4082
  "type": "option"
3997
4083
  },
3998
- "from-file": {
3999
- "description": "Apple Ads bulk template (Campaign_And_Adgroup_Template.xlsx or keywords .csv) to convert and submit",
4000
- "name": "from-file",
4084
+ "app": {
4085
+ "description": "Keep only rows in this app; repeatable",
4086
+ "name": "app",
4001
4087
  "hasDynamicHelp": false,
4002
- "multiple": false,
4088
+ "multiple": true,
4003
4089
  "type": "option"
4004
4090
  },
4005
- "org-id": {
4006
- "description": "Apple org id (campaign_group_id) the converted template will target; required with --from-file",
4007
- "name": "org-id",
4091
+ "campaign-group": {
4092
+ "description": "Keep only rows in this campaign group; repeatable",
4093
+ "name": "campaign-group",
4008
4094
  "hasDynamicHelp": false,
4009
- "multiple": false,
4095
+ "multiple": true,
4010
4096
  "type": "option"
4011
4097
  },
4012
- "poll-interval": {
4013
- "description": "Seconds between progress polls",
4014
- "name": "poll-interval",
4015
- "default": 5,
4098
+ "search": {
4099
+ "description": "Case-insensitive substring match on the name",
4100
+ "name": "search",
4016
4101
  "hasDynamicHelp": false,
4017
4102
  "multiple": false,
4018
4103
  "type": "option"
4019
4104
  },
4020
- "preview": {
4021
- "description": "With --from-file: print the converted request and stop, nothing is created",
4022
- "name": "preview",
4023
- "allowNo": false,
4024
- "type": "boolean"
4025
- },
4026
- "timeout": {
4027
- "description": "Max seconds to wait for the operation to finish",
4028
- "name": "timeout",
4029
- "default": 900,
4105
+ "status": {
4106
+ "description": "Keep only rows in this state",
4107
+ "name": "status",
4030
4108
  "hasDynamicHelp": false,
4031
4109
  "multiple": false,
4110
+ "options": [
4111
+ "ENABLED",
4112
+ "PAUSED"
4113
+ ],
4032
4114
  "type": "option"
4033
- },
4034
- "wait": {
4035
- "description": "Poll the operation until it finishes; --no-wait returns the operation id immediately",
4036
- "name": "wait",
4037
- "allowNo": true,
4038
- "type": "boolean"
4039
4115
  }
4040
4116
  },
4041
4117
  "hasDynamicHelp": false,
4042
4118
  "hiddenAliases": [],
4043
- "id": "asa:campaigns:bulk-create",
4119
+ "id": "asa:campaigns:list",
4044
4120
  "pluginAlias": "adapty",
4045
4121
  "pluginName": "adapty",
4046
4122
  "pluginType": "core",
@@ -4052,17 +4128,23 @@
4052
4128
  "commands",
4053
4129
  "asa",
4054
4130
  "campaigns",
4055
- "bulk-create.js"
4131
+ "list.js"
4056
4132
  ]
4057
4133
  },
4058
- "asa:campaigns:bulk-list": {
4134
+ "asa:campaigns:update": {
4059
4135
  "aliases": [],
4060
- "args": {},
4061
- "description": "This company's bulk operations, newest first; inspect one with bulk-status",
4136
+ "args": {
4137
+ "campaign_id": {
4138
+ "description": "Campaign ID (UUID)",
4139
+ "name": "campaign_id",
4140
+ "required": true
4141
+ }
4142
+ },
4143
+ "description": "Change a campaign: daily budget, countries, status or Invoicing Options (all five --invoice-* flags together; they replace the stored set)",
4062
4144
  "examples": [
4063
- "<%= config.bin %> asa campaigns bulk-list",
4064
- "<%= config.bin %> asa campaigns bulk-list --status partial --status failed",
4065
- "<%= config.bin %> asa campaigns bulk-list --created-from 2026-08-01 --created-to 2026-08-20"
4145
+ "<%= config.bin %> asa campaigns update UUID --status PAUSED",
4146
+ "<%= config.bin %> asa campaigns update UUID --daily-budget 80",
4147
+ "<%= config.bin %> asa campaigns update UUID --invoice-advertiser \"Acme Inc\" --invoice-order-number PO-42 --invoice-contact-name \"Jane Doe\" --invoice-contact-email jane@acme.com --invoice-billing-email billing@acme.com"
4066
4148
  ],
4067
4149
  "flags": {
4068
4150
  "json": {
@@ -4072,61 +4154,117 @@
4072
4154
  "allowNo": false,
4073
4155
  "type": "boolean"
4074
4156
  },
4075
- "page": {
4076
- "description": "Page number",
4077
- "name": "page",
4078
- "default": 1,
4157
+ "currency": {
4158
+ "description": "Currency code for the amounts in this call",
4159
+ "name": "currency",
4160
+ "default": "USD",
4079
4161
  "hasDynamicHelp": false,
4080
4162
  "multiple": false,
4081
4163
  "type": "option"
4082
4164
  },
4083
- "page-size": {
4084
- "description": "Items per page (max 1000); prefer one big page over a pagination loop",
4085
- "name": "page-size",
4086
- "default": 100,
4165
+ "yes": {
4166
+ "char": "y",
4167
+ "description": "Apply without asking; required when the output is piped or --json is used",
4168
+ "name": "yes",
4169
+ "allowNo": false,
4170
+ "type": "boolean"
4171
+ },
4172
+ "idempotency-key": {
4173
+ "description": "Idempotency key for this write; re-running with the same key replays the stored result instead of applying twice",
4174
+ "name": "idempotency-key",
4087
4175
  "hasDynamicHelp": false,
4088
4176
  "multiple": false,
4089
4177
  "type": "option"
4090
4178
  },
4091
- "app": {
4092
- "description": "Keep only operations of this app (UUID)",
4093
- "name": "app",
4179
+ "invoice-advertiser": {
4180
+ "description": "Invoicing Options (line-of-credit orgs, see payment_model in asa orgs list): advertiser name",
4181
+ "name": "invoice-advertiser",
4094
4182
  "hasDynamicHelp": false,
4095
4183
  "multiple": false,
4096
4184
  "type": "option"
4097
4185
  },
4098
- "created-from": {
4099
- "description": "Keep only operations created on or after this date (YYYY-MM-DD)",
4100
- "name": "created-from",
4186
+ "invoice-billing-email": {
4187
+ "description": "Invoicing Options (line-of-credit orgs, see payment_model in asa orgs list): billing contact email",
4188
+ "name": "invoice-billing-email",
4189
+ "hasDynamicHelp": false,
4190
+ "multiple": false,
4191
+ "type": "option"
4192
+ },
4193
+ "invoice-contact-email": {
4194
+ "description": "Invoicing Options (line-of-credit orgs, see payment_model in asa orgs list): buyer contact email",
4195
+ "name": "invoice-contact-email",
4196
+ "hasDynamicHelp": false,
4197
+ "multiple": false,
4198
+ "type": "option"
4199
+ },
4200
+ "invoice-contact-name": {
4201
+ "description": "Invoicing Options (line-of-credit orgs, see payment_model in asa orgs list): buyer contact name",
4202
+ "name": "invoice-contact-name",
4203
+ "hasDynamicHelp": false,
4204
+ "multiple": false,
4205
+ "type": "option"
4206
+ },
4207
+ "invoice-order-number": {
4208
+ "description": "Invoicing Options (line-of-credit orgs, see payment_model in asa orgs list): order number",
4209
+ "name": "invoice-order-number",
4210
+ "hasDynamicHelp": false,
4211
+ "multiple": false,
4212
+ "type": "option"
4213
+ },
4214
+ "bidding-strategy": {
4215
+ "description": "Bidding strategy",
4216
+ "name": "bidding-strategy",
4217
+ "hasDynamicHelp": false,
4218
+ "multiple": false,
4219
+ "options": [
4220
+ "MANUAL_CPT",
4221
+ "MAX_CONVERSIONS"
4222
+ ],
4223
+ "type": "option"
4224
+ },
4225
+ "country": {
4226
+ "description": "Replace the country list, repeatable",
4227
+ "name": "country",
4228
+ "hasDynamicHelp": false,
4229
+ "multiple": true,
4230
+ "type": "option"
4231
+ },
4232
+ "daily-budget": {
4233
+ "description": "Daily budget (amount, e.g. 50 or 12.50)",
4234
+ "name": "daily-budget",
4101
4235
  "hasDynamicHelp": false,
4102
4236
  "multiple": false,
4103
4237
  "type": "option"
4104
4238
  },
4105
- "created-to": {
4106
- "description": "Keep only operations created on or before this date (YYYY-MM-DD)",
4107
- "name": "created-to",
4239
+ "name": {
4240
+ "description": "Campaign name",
4241
+ "name": "name",
4108
4242
  "hasDynamicHelp": false,
4109
4243
  "multiple": false,
4110
4244
  "type": "option"
4111
4245
  },
4112
4246
  "status": {
4113
- "description": "Keep only operations in this state; repeatable",
4247
+ "description": "Campaign status",
4114
4248
  "name": "status",
4115
4249
  "hasDynamicHelp": false,
4116
- "multiple": true,
4250
+ "multiple": false,
4117
4251
  "options": [
4118
- "failed",
4119
- "partial",
4120
- "pending",
4121
- "running",
4122
- "success"
4252
+ "ENABLED",
4253
+ "PAUSED"
4123
4254
  ],
4124
4255
  "type": "option"
4256
+ },
4257
+ "target-cpa": {
4258
+ "description": "Target CPA (amount, e.g. 50 or 12.50)",
4259
+ "name": "target-cpa",
4260
+ "hasDynamicHelp": false,
4261
+ "multiple": false,
4262
+ "type": "option"
4125
4263
  }
4126
4264
  },
4127
4265
  "hasDynamicHelp": false,
4128
4266
  "hiddenAliases": [],
4129
- "id": "asa:campaigns:bulk-list",
4267
+ "id": "asa:campaigns:update",
4130
4268
  "pluginAlias": "adapty",
4131
4269
  "pluginName": "adapty",
4132
4270
  "pluginType": "core",
@@ -4138,21 +4276,21 @@
4138
4276
  "commands",
4139
4277
  "asa",
4140
4278
  "campaigns",
4141
- "bulk-list.js"
4279
+ "update.js"
4142
4280
  ]
4143
4281
  },
4144
- "asa:campaigns:bulk-status": {
4282
+ "asa:change-history:get": {
4145
4283
  "aliases": [],
4146
4284
  "args": {
4147
- "operation-id": {
4148
- "description": "Bulk operation ID returned by bulk-create",
4149
- "name": "operation-id",
4285
+ "detail_id": {
4286
+ "description": "Detail ID from asa change-history list (EntityType.entityId.txnId)",
4287
+ "name": "detail_id",
4150
4288
  "required": true
4151
4289
  }
4152
4290
  },
4153
- "description": "Progress board of one bulk operation: counts, pipelines and the per-object log",
4291
+ "description": "Field-level before/after of one change (proxied from the Apple Ads Platform API)",
4154
4292
  "examples": [
4155
- "<%= config.bin %> asa campaigns bulk-status 660e8400-e29b-41d4-a716-446655440001"
4293
+ "<%= config.bin %> asa change-history get Campaign.444555666.TXN_ID --campaign-group <uuid>"
4156
4294
  ],
4157
4295
  "flags": {
4158
4296
  "json": {
@@ -4162,18 +4300,10 @@
4162
4300
  "allowNo": false,
4163
4301
  "type": "boolean"
4164
4302
  },
4165
- "page": {
4166
- "description": "Page number",
4167
- "name": "page",
4168
- "default": 1,
4169
- "hasDynamicHelp": false,
4170
- "multiple": false,
4171
- "type": "option"
4172
- },
4173
- "page-size": {
4174
- "description": "Items per page (max 1000); prefer one big page over a pagination loop",
4175
- "name": "page-size",
4176
- "default": 100,
4303
+ "campaign-group": {
4304
+ "description": "Organization the change belongs to (UUID; take campaign_group_id from the list row)",
4305
+ "name": "campaign-group",
4306
+ "required": true,
4177
4307
  "hasDynamicHelp": false,
4178
4308
  "multiple": false,
4179
4309
  "type": "option"
@@ -4181,7 +4311,7 @@
4181
4311
  },
4182
4312
  "hasDynamicHelp": false,
4183
4313
  "hiddenAliases": [],
4184
- "id": "asa:campaigns:bulk-status",
4314
+ "id": "asa:change-history:get",
4185
4315
  "pluginAlias": "adapty",
4186
4316
  "pluginName": "adapty",
4187
4317
  "pluginType": "core",
@@ -4192,18 +4322,18 @@
4192
4322
  "dist",
4193
4323
  "commands",
4194
4324
  "asa",
4195
- "campaigns",
4196
- "bulk-status.js"
4325
+ "change-history",
4326
+ "get.js"
4197
4327
  ]
4198
4328
  },
4199
- "asa:campaigns:create": {
4329
+ "asa:change-history:list": {
4200
4330
  "aliases": [],
4201
4331
  "args": {},
4202
- "description": "Create a campaign in Apple Search Ads. A Max Conversions campaign also needs an automated ad group (`asa ad-groups create --automated`); line-of-credit organizations must pass all five --invoice-* flags",
4332
+ "description": "Apple Ads change history of one organization, read live from Apple (proxied from the Apple Ads Platform API)",
4203
4333
  "examples": [
4204
- "<%= config.bin %> asa campaigns create --org UUID --name \"Winter push\" --adam-id 123456 --country US --daily-budget 50",
4205
- "<%= config.bin %> asa campaigns create --org UUID --name \"Max Conv\" --adam-id 123456 --country US --daily-budget 50 --bidding-strategy MAX_CONVERSIONS",
4206
- "<%= config.bin %> asa campaigns create --org UUID --name \"LOC push\" --adam-id 123456 --country US --daily-budget 50 --invoice-advertiser \"Acme Inc\" --invoice-order-number PO-42 --invoice-contact-name \"Jane Doe\" --invoice-contact-email jane@acme.com --invoice-billing-email billing@acme.com"
4334
+ "<%= config.bin %> asa change-history list --campaign-group <uuid>",
4335
+ "<%= config.bin %> asa change-history list --campaign-group <uuid> --date-from 2026-09-01 --entity-type Campaign --event-type UPDATE",
4336
+ "<%= config.bin %> asa change-history list --campaign-group <uuid> --fields"
4207
4337
  ],
4208
4338
  "flags": {
4209
4339
  "json": {
@@ -4213,170 +4343,131 @@
4213
4343
  "allowNo": false,
4214
4344
  "type": "boolean"
4215
4345
  },
4216
- "currency": {
4217
- "description": "Currency code for the amounts in this call",
4218
- "name": "currency",
4219
- "default": "USD",
4220
- "hasDynamicHelp": false,
4221
- "multiple": false,
4222
- "type": "option"
4223
- },
4224
- "yes": {
4225
- "char": "y",
4226
- "description": "Apply without asking; required when the output is piped or --json is used",
4227
- "name": "yes",
4228
- "allowNo": false,
4229
- "type": "boolean"
4230
- },
4231
- "idempotency-key": {
4232
- "description": "Idempotency key for this write; re-running with the same key replays the stored result instead of applying twice",
4233
- "name": "idempotency-key",
4346
+ "page": {
4347
+ "description": "Page number",
4348
+ "name": "page",
4349
+ "default": 1,
4234
4350
  "hasDynamicHelp": false,
4235
4351
  "multiple": false,
4236
4352
  "type": "option"
4237
4353
  },
4238
- "invoice-advertiser": {
4239
- "description": "Invoicing Options (line-of-credit orgs, see payment_model in asa orgs list): advertiser name",
4240
- "name": "invoice-advertiser",
4354
+ "page-size": {
4355
+ "description": "Items per page (max 1000); prefer one big page over a pagination loop",
4356
+ "name": "page-size",
4357
+ "default": 100,
4241
4358
  "hasDynamicHelp": false,
4242
4359
  "multiple": false,
4243
4360
  "type": "option"
4244
4361
  },
4245
- "invoice-billing-email": {
4246
- "description": "Invoicing Options (line-of-credit orgs, see payment_model in asa orgs list): billing contact email",
4247
- "name": "invoice-billing-email",
4362
+ "ad-group": {
4363
+ "description": "Keep only changes inside these Apple ad group ids (not UUIDs); repeatable",
4364
+ "name": "ad-group",
4248
4365
  "hasDynamicHelp": false,
4249
- "multiple": false,
4366
+ "multiple": true,
4250
4367
  "type": "option"
4251
4368
  },
4252
- "invoice-contact-email": {
4253
- "description": "Invoicing Options (line-of-credit orgs, see payment_model in asa orgs list): buyer contact email",
4254
- "name": "invoice-contact-email",
4369
+ "campaign": {
4370
+ "description": "Keep only changes inside these Apple campaign ids (not UUIDs); repeatable",
4371
+ "name": "campaign",
4255
4372
  "hasDynamicHelp": false,
4256
- "multiple": false,
4373
+ "multiple": true,
4257
4374
  "type": "option"
4258
4375
  },
4259
- "invoice-contact-name": {
4260
- "description": "Invoicing Options (line-of-credit orgs, see payment_model in asa orgs list): buyer contact name",
4261
- "name": "invoice-contact-name",
4376
+ "campaign-group": {
4377
+ "description": "Organization to read (UUID from asa orgs list); one organization per call",
4378
+ "name": "campaign-group",
4379
+ "required": true,
4262
4380
  "hasDynamicHelp": false,
4263
4381
  "multiple": false,
4264
4382
  "type": "option"
4265
4383
  },
4266
- "invoice-order-number": {
4267
- "description": "Invoicing Options (line-of-credit orgs, see payment_model in asa orgs list): order number",
4268
- "name": "invoice-order-number",
4384
+ "date-from": {
4385
+ "description": "Start of the period (YYYY-MM-DD), defaults to 7 days ago; at most 14 days per call, Apple keeps 6 months",
4386
+ "name": "date-from",
4269
4387
  "hasDynamicHelp": false,
4270
4388
  "multiple": false,
4271
4389
  "type": "option"
4272
4390
  },
4273
- "ad-channel-type": {
4274
- "description": "Ad channel type",
4275
- "name": "ad-channel-type",
4276
- "default": "SEARCH",
4391
+ "date-to": {
4392
+ "description": "End of the period (YYYY-MM-DD), defaults to today",
4393
+ "name": "date-to",
4277
4394
  "hasDynamicHelp": false,
4278
4395
  "multiple": false,
4279
- "options": [
4280
- "DISPLAY",
4281
- "SEARCH"
4282
- ],
4283
4396
  "type": "option"
4284
4397
  },
4285
- "adam-id": {
4286
- "description": "App Store app ID (adam_id)",
4287
- "name": "adam-id",
4288
- "required": true,
4398
+ "entity-id": {
4399
+ "description": "Keep only changes of these Apple entity ids (not UUIDs); repeatable",
4400
+ "name": "entity-id",
4289
4401
  "hasDynamicHelp": false,
4290
- "multiple": false,
4402
+ "multiple": true,
4291
4403
  "type": "option"
4292
4404
  },
4293
- "bidding-strategy": {
4294
- "description": "Bidding strategy; Apple defaults to MANUAL_CPT when omitted",
4295
- "name": "bidding-strategy",
4405
+ "entity-type": {
4406
+ "description": "Keep only changes of this entity type; repeatable. Default is the campaign domain (Campaign, AdGroup, Keyword, NegativeKeyword, Ad, Creative, LocationGroup); Org and AdAccount cannot be mixed with it",
4407
+ "name": "entity-type",
4296
4408
  "hasDynamicHelp": false,
4297
- "multiple": false,
4409
+ "multiple": true,
4298
4410
  "options": [
4299
- "MANUAL_CPT",
4300
- "MAX_CONVERSIONS"
4411
+ "Ad",
4412
+ "AdAccount",
4413
+ "AdGroup",
4414
+ "Campaign",
4415
+ "Creative",
4416
+ "Keyword",
4417
+ "LocationGroup",
4418
+ "NegativeKeyword",
4419
+ "Org"
4301
4420
  ],
4302
4421
  "type": "option"
4303
4422
  },
4304
- "billing-event": {
4305
- "description": "Billing event",
4306
- "name": "billing-event",
4307
- "default": "TAPS",
4423
+ "event-type": {
4424
+ "description": "Keep only this operation; repeatable",
4425
+ "name": "event-type",
4308
4426
  "hasDynamicHelp": false,
4309
- "multiple": false,
4427
+ "multiple": true,
4310
4428
  "options": [
4311
- "IMPRESSIONS",
4312
- "TAPS"
4429
+ "CREATE",
4430
+ "DELETE",
4431
+ "UPDATE"
4313
4432
  ],
4314
4433
  "type": "option"
4315
4434
  },
4316
- "country": {
4317
- "description": "Country or region code, repeatable",
4318
- "name": "country",
4319
- "required": true,
4320
- "hasDynamicHelp": false,
4321
- "multiple": true,
4322
- "type": "option"
4323
- },
4324
- "daily-budget": {
4325
- "description": "Daily budget (amount, e.g. 50 or 12.50)",
4326
- "name": "daily-budget",
4327
- "required": true,
4328
- "hasDynamicHelp": false,
4329
- "multiple": false,
4330
- "type": "option"
4435
+ "fields": {
4436
+ "description": "Expand into flat field-level rows (field, old values, new values); page size defaults to 10 and may not exceed it",
4437
+ "name": "fields",
4438
+ "allowNo": false,
4439
+ "type": "boolean"
4331
4440
  },
4332
- "name": {
4333
- "description": "Campaign name",
4334
- "name": "name",
4335
- "required": true,
4441
+ "txn": {
4442
+ "description": "Keep only these Apple transaction ids; repeatable",
4443
+ "name": "txn",
4336
4444
  "hasDynamicHelp": false,
4337
- "multiple": false,
4445
+ "multiple": true,
4338
4446
  "type": "option"
4339
4447
  },
4340
- "org": {
4341
- "description": "Campaign group ID (UUID) — see `adapty asa orgs list`",
4342
- "name": "org",
4343
- "required": true,
4448
+ "user": {
4449
+ "description": "Keep only changes made by these Apple user ids (not emails); repeatable",
4450
+ "name": "user",
4344
4451
  "hasDynamicHelp": false,
4345
- "multiple": false,
4452
+ "multiple": true,
4346
4453
  "type": "option"
4347
4454
  },
4348
- "status": {
4349
- "description": "Initial status",
4350
- "name": "status",
4455
+ "user-type": {
4456
+ "description": "Keep only changes by this actor category; repeatable",
4457
+ "name": "user-type",
4351
4458
  "hasDynamicHelp": false,
4352
- "multiple": false,
4459
+ "multiple": true,
4353
4460
  "options": [
4354
- "ENABLED",
4355
- "PAUSED"
4356
- ],
4357
- "type": "option"
4358
- },
4359
- "supply-source": {
4360
- "description": "Supply source, repeatable",
4361
- "name": "supply-source",
4362
- "default": [
4363
- "APPSTORE_SEARCH_RESULTS"
4461
+ "APPLE_SUPPORT",
4462
+ "CUSTOMER",
4463
+ "CUSTOMER_API"
4364
4464
  ],
4365
- "hasDynamicHelp": false,
4366
- "multiple": true,
4367
- "type": "option"
4368
- },
4369
- "target-cpa": {
4370
- "description": "Target CPA; must be lower than --daily-budget (amount, e.g. 50 or 12.50)",
4371
- "name": "target-cpa",
4372
- "hasDynamicHelp": false,
4373
- "multiple": false,
4374
4465
  "type": "option"
4375
4466
  }
4376
4467
  },
4377
4468
  "hasDynamicHelp": false,
4378
4469
  "hiddenAliases": [],
4379
- "id": "asa:campaigns:create",
4470
+ "id": "asa:change-history:list",
4380
4471
  "pluginAlias": "adapty",
4381
4472
  "pluginName": "adapty",
4382
4473
  "pluginType": "core",
@@ -4387,22 +4478,16 @@
4387
4478
  "dist",
4388
4479
  "commands",
4389
4480
  "asa",
4390
- "campaigns",
4391
- "create.js"
4481
+ "change-history",
4482
+ "list.js"
4392
4483
  ]
4393
4484
  },
4394
- "asa:campaigns:get": {
4485
+ "asa:competitors:summary": {
4395
4486
  "aliases": [],
4396
- "args": {
4397
- "campaign_id": {
4398
- "description": "Campaign ID (UUID)",
4399
- "name": "campaign_id",
4400
- "required": true
4401
- }
4402
- },
4403
- "description": "Show one campaign; read numbers with asa metrics",
4487
+ "args": {},
4488
+ "description": "Competitor summary for up to five App Store apps; the server covers the last full month and every country",
4404
4489
  "examples": [
4405
- "<%= config.bin %> asa campaigns get 550e8400-e29b-41d4-a716-446655440000"
4490
+ "<%= config.bin %> asa competitors summary --app-ids 1668337467,6503873027"
4406
4491
  ],
4407
4492
  "flags": {
4408
4493
  "json": {
@@ -4411,11 +4496,19 @@
4411
4496
  "name": "json",
4412
4497
  "allowNo": false,
4413
4498
  "type": "boolean"
4499
+ },
4500
+ "app-ids": {
4501
+ "description": "Apple App Store IDs (adam_id), comma-separated, 1-5 values",
4502
+ "name": "app-ids",
4503
+ "required": true,
4504
+ "hasDynamicHelp": false,
4505
+ "multiple": false,
4506
+ "type": "option"
4414
4507
  }
4415
4508
  },
4416
4509
  "hasDynamicHelp": false,
4417
4510
  "hiddenAliases": [],
4418
- "id": "asa:campaigns:get",
4511
+ "id": "asa:competitors:summary",
4419
4512
  "pluginAlias": "adapty",
4420
4513
  "pluginName": "adapty",
4421
4514
  "pluginType": "core",
@@ -4426,17 +4519,17 @@
4426
4519
  "dist",
4427
4520
  "commands",
4428
4521
  "asa",
4429
- "campaigns",
4430
- "get.js"
4522
+ "competitors",
4523
+ "summary.js"
4431
4524
  ]
4432
4525
  },
4433
- "asa:campaigns:list": {
4526
+ "asa:creatives:list": {
4434
4527
  "aliases": [],
4435
4528
  "args": {},
4436
- "description": "List Apple Search Ads campaigns; read numbers with asa metrics",
4529
+ "description": "List creatives; creative_id is what `asa ads create` needs",
4437
4530
  "examples": [
4438
- "<%= config.bin %> asa campaigns list",
4439
- "<%= config.bin %> asa campaigns list --app APP_UUID --status PAUSED"
4531
+ "<%= config.bin %> asa creatives list",
4532
+ "<%= config.bin %> asa creatives list --app APP_UUID"
4440
4533
  ],
4441
4534
  "flags": {
4442
4535
  "json": {
@@ -4472,32 +4565,14 @@
4472
4565
  "campaign-group": {
4473
4566
  "description": "Keep only rows in this campaign group; repeatable",
4474
4567
  "name": "campaign-group",
4475
- "hasDynamicHelp": false,
4476
- "multiple": true,
4477
- "type": "option"
4478
- },
4479
- "search": {
4480
- "description": "Case-insensitive substring match on the name",
4481
- "name": "search",
4482
- "hasDynamicHelp": false,
4483
- "multiple": false,
4484
- "type": "option"
4485
- },
4486
- "status": {
4487
- "description": "Keep only rows in this state",
4488
- "name": "status",
4489
- "hasDynamicHelp": false,
4490
- "multiple": false,
4491
- "options": [
4492
- "ENABLED",
4493
- "PAUSED"
4494
- ],
4568
+ "hasDynamicHelp": false,
4569
+ "multiple": true,
4495
4570
  "type": "option"
4496
4571
  }
4497
4572
  },
4498
4573
  "hasDynamicHelp": false,
4499
4574
  "hiddenAliases": [],
4500
- "id": "asa:campaigns:list",
4575
+ "id": "asa:creatives:list",
4501
4576
  "pluginAlias": "adapty",
4502
4577
  "pluginName": "adapty",
4503
4578
  "pluginType": "core",
@@ -4508,24 +4583,17 @@
4508
4583
  "dist",
4509
4584
  "commands",
4510
4585
  "asa",
4511
- "campaigns",
4586
+ "creatives",
4512
4587
  "list.js"
4513
4588
  ]
4514
4589
  },
4515
- "asa:campaigns:update": {
4590
+ "asa:keywords:add": {
4516
4591
  "aliases": [],
4517
- "args": {
4518
- "campaign_id": {
4519
- "description": "Campaign ID (UUID)",
4520
- "name": "campaign_id",
4521
- "required": true
4522
- }
4523
- },
4524
- "description": "Change a campaign: daily budget, countries, status or Invoicing Options (all five --invoice-* flags together; they replace the stored set)",
4592
+ "args": {},
4593
+ "description": "Add targeting keywords to an ad group",
4525
4594
  "examples": [
4526
- "<%= config.bin %> asa campaigns update UUID --status PAUSED",
4527
- "<%= config.bin %> asa campaigns update UUID --daily-budget 80",
4528
- "<%= config.bin %> asa campaigns update UUID --invoice-advertiser \"Acme Inc\" --invoice-order-number PO-42 --invoice-contact-name \"Jane Doe\" --invoice-contact-email jane@acme.com --invoice-billing-email billing@acme.com"
4595
+ "<%= config.bin %> asa keywords add --ad-group UUID --text \"running shoes\" --text \"trail shoes\" --bid 1.20",
4596
+ "<%= config.bin %> asa keywords add --ad-group UUID --from-file keywords.txt --match-type EXACT"
4529
4597
  ],
4530
4598
  "flags": {
4531
4599
  "json": {
@@ -4557,95 +4625,63 @@
4557
4625
  "multiple": false,
4558
4626
  "type": "option"
4559
4627
  },
4560
- "invoice-advertiser": {
4561
- "description": "Invoicing Options (line-of-credit orgs, see payment_model in asa orgs list): advertiser name",
4562
- "name": "invoice-advertiser",
4563
- "hasDynamicHelp": false,
4564
- "multiple": false,
4565
- "type": "option"
4566
- },
4567
- "invoice-billing-email": {
4568
- "description": "Invoicing Options (line-of-credit orgs, see payment_model in asa orgs list): billing contact email",
4569
- "name": "invoice-billing-email",
4570
- "hasDynamicHelp": false,
4571
- "multiple": false,
4572
- "type": "option"
4573
- },
4574
- "invoice-contact-email": {
4575
- "description": "Invoicing Options (line-of-credit orgs, see payment_model in asa orgs list): buyer contact email",
4576
- "name": "invoice-contact-email",
4628
+ "ad-group": {
4629
+ "description": "Ad group ID (UUID) — the campaign is resolved from it",
4630
+ "name": "ad-group",
4631
+ "required": true,
4577
4632
  "hasDynamicHelp": false,
4578
4633
  "multiple": false,
4579
4634
  "type": "option"
4580
4635
  },
4581
- "invoice-contact-name": {
4582
- "description": "Invoicing Options (line-of-credit orgs, see payment_model in asa orgs list): buyer contact name",
4583
- "name": "invoice-contact-name",
4636
+ "bid": {
4637
+ "description": "Bid per keyword (amount, e.g. 50 or 12.50)",
4638
+ "name": "bid",
4584
4639
  "hasDynamicHelp": false,
4585
4640
  "multiple": false,
4586
4641
  "type": "option"
4587
4642
  },
4588
- "invoice-order-number": {
4589
- "description": "Invoicing Options (line-of-credit orgs, see payment_model in asa orgs list): order number",
4590
- "name": "invoice-order-number",
4643
+ "from-file": {
4644
+ "description": "File with one keyword per line, combined with any --text values",
4645
+ "name": "from-file",
4591
4646
  "hasDynamicHelp": false,
4592
4647
  "multiple": false,
4593
4648
  "type": "option"
4594
4649
  },
4595
- "bidding-strategy": {
4596
- "description": "Bidding strategy",
4597
- "name": "bidding-strategy",
4650
+ "match-type": {
4651
+ "description": "Match type",
4652
+ "name": "match-type",
4653
+ "default": "BROAD",
4598
4654
  "hasDynamicHelp": false,
4599
4655
  "multiple": false,
4600
4656
  "options": [
4601
- "MANUAL_CPT",
4602
- "MAX_CONVERSIONS"
4657
+ "BROAD",
4658
+ "EXACT"
4603
4659
  ],
4604
4660
  "type": "option"
4605
4661
  },
4606
- "country": {
4607
- "description": "Replace the country list, repeatable",
4608
- "name": "country",
4609
- "hasDynamicHelp": false,
4610
- "multiple": true,
4611
- "type": "option"
4612
- },
4613
- "daily-budget": {
4614
- "description": "Daily budget (amount, e.g. 50 or 12.50)",
4615
- "name": "daily-budget",
4616
- "hasDynamicHelp": false,
4617
- "multiple": false,
4618
- "type": "option"
4619
- },
4620
- "name": {
4621
- "description": "Campaign name",
4622
- "name": "name",
4623
- "hasDynamicHelp": false,
4624
- "multiple": false,
4625
- "type": "option"
4626
- },
4627
4662
  "status": {
4628
- "description": "Campaign status",
4663
+ "description": "Keyword status",
4629
4664
  "name": "status",
4665
+ "default": "ACTIVE",
4630
4666
  "hasDynamicHelp": false,
4631
4667
  "multiple": false,
4632
4668
  "options": [
4633
- "ENABLED",
4669
+ "ACTIVE",
4634
4670
  "PAUSED"
4635
4671
  ],
4636
4672
  "type": "option"
4637
4673
  },
4638
- "target-cpa": {
4639
- "description": "Target CPA (amount, e.g. 50 or 12.50)",
4640
- "name": "target-cpa",
4674
+ "text": {
4675
+ "description": "Keyword text, repeatable",
4676
+ "name": "text",
4641
4677
  "hasDynamicHelp": false,
4642
- "multiple": false,
4678
+ "multiple": true,
4643
4679
  "type": "option"
4644
4680
  }
4645
4681
  },
4646
4682
  "hasDynamicHelp": false,
4647
4683
  "hiddenAliases": [],
4648
- "id": "asa:campaigns:update",
4684
+ "id": "asa:keywords:add",
4649
4685
  "pluginAlias": "adapty",
4650
4686
  "pluginName": "adapty",
4651
4687
  "pluginType": "core",
@@ -4656,16 +4692,17 @@
4656
4692
  "dist",
4657
4693
  "commands",
4658
4694
  "asa",
4659
- "campaigns",
4660
- "update.js"
4695
+ "keywords",
4696
+ "add.js"
4661
4697
  ]
4662
4698
  },
4663
- "asa:competitors:summary": {
4699
+ "asa:keywords:list": {
4664
4700
  "aliases": [],
4665
4701
  "args": {},
4666
- "description": "Competitor summary for up to five App Store apps; the server covers the last full month and every country",
4702
+ "description": "List targeting keywords; read numbers with asa metrics",
4667
4703
  "examples": [
4668
- "<%= config.bin %> asa competitors summary --app-ids 1668337467,6503873027"
4704
+ "<%= config.bin %> asa keywords list",
4705
+ "<%= config.bin %> asa keywords list --ad-group AD_GROUP_UUID --status ACTIVE"
4669
4706
  ],
4670
4707
  "flags": {
4671
4708
  "json": {
@@ -4675,18 +4712,72 @@
4675
4712
  "allowNo": false,
4676
4713
  "type": "boolean"
4677
4714
  },
4678
- "app-ids": {
4679
- "description": "Apple App Store IDs (adam_id), comma-separated, 1-5 values",
4680
- "name": "app-ids",
4681
- "required": true,
4715
+ "page": {
4716
+ "description": "Page number",
4717
+ "name": "page",
4718
+ "default": 1,
4719
+ "hasDynamicHelp": false,
4720
+ "multiple": false,
4721
+ "type": "option"
4722
+ },
4723
+ "page-size": {
4724
+ "description": "Items per page (max 1000); prefer one big page over a pagination loop",
4725
+ "name": "page-size",
4726
+ "default": 100,
4727
+ "hasDynamicHelp": false,
4728
+ "multiple": false,
4729
+ "type": "option"
4730
+ },
4731
+ "app": {
4732
+ "description": "Keep only rows in this app; repeatable",
4733
+ "name": "app",
4734
+ "hasDynamicHelp": false,
4735
+ "multiple": true,
4736
+ "type": "option"
4737
+ },
4738
+ "campaign-group": {
4739
+ "description": "Keep only rows in this campaign group; repeatable",
4740
+ "name": "campaign-group",
4741
+ "hasDynamicHelp": false,
4742
+ "multiple": true,
4743
+ "type": "option"
4744
+ },
4745
+ "search": {
4746
+ "description": "Case-insensitive substring match on the name",
4747
+ "name": "search",
4748
+ "hasDynamicHelp": false,
4749
+ "multiple": false,
4750
+ "type": "option"
4751
+ },
4752
+ "campaign": {
4753
+ "description": "Keep only rows in this campaign; repeatable",
4754
+ "name": "campaign",
4755
+ "hasDynamicHelp": false,
4756
+ "multiple": true,
4757
+ "type": "option"
4758
+ },
4759
+ "ad-group": {
4760
+ "description": "Keep only rows in this ad group; repeatable",
4761
+ "name": "ad-group",
4762
+ "hasDynamicHelp": false,
4763
+ "multiple": true,
4764
+ "type": "option"
4765
+ },
4766
+ "status": {
4767
+ "description": "Keep only rows in this state",
4768
+ "name": "status",
4682
4769
  "hasDynamicHelp": false,
4683
4770
  "multiple": false,
4771
+ "options": [
4772
+ "ACTIVE",
4773
+ "PAUSED"
4774
+ ],
4684
4775
  "type": "option"
4685
4776
  }
4686
4777
  },
4687
4778
  "hasDynamicHelp": false,
4688
4779
  "hiddenAliases": [],
4689
- "id": "asa:competitors:summary",
4780
+ "id": "asa:keywords:list",
4690
4781
  "pluginAlias": "adapty",
4691
4782
  "pluginName": "adapty",
4692
4783
  "pluginType": "core",
@@ -4697,17 +4788,18 @@
4697
4788
  "dist",
4698
4789
  "commands",
4699
4790
  "asa",
4700
- "competitors",
4701
- "summary.js"
4791
+ "keywords",
4792
+ "list.js"
4702
4793
  ]
4703
4794
  },
4704
- "asa:creatives:list": {
4795
+ "asa:keywords:recommend": {
4705
4796
  "aliases": [],
4706
4797
  "args": {},
4707
- "description": "List creatives; creative_id is what `asa ads create` needs",
4798
+ "description": "Keyword recommendations for one of your apps: its brand terms, generic terms, or the brand terms of its selected competitors",
4708
4799
  "examples": [
4709
- "<%= config.bin %> asa creatives list",
4710
- "<%= config.bin %> asa creatives list --app APP_UUID"
4800
+ "<%= config.bin %> asa keywords recommend --adam-id 1668337467 --type brand",
4801
+ "<%= config.bin %> asa keywords recommend --adam-id 1668337467 --type generic --country US",
4802
+ "<%= config.bin %> asa keywords recommend --adam-id 1668337467 --type competitor"
4711
4803
  ],
4712
4804
  "flags": {
4713
4805
  "json": {
@@ -4717,40 +4809,38 @@
4717
4809
  "allowNo": false,
4718
4810
  "type": "boolean"
4719
4811
  },
4720
- "page": {
4721
- "description": "Page number",
4722
- "name": "page",
4723
- "default": 1,
4724
- "hasDynamicHelp": false,
4725
- "multiple": false,
4726
- "type": "option"
4727
- },
4728
- "page-size": {
4729
- "description": "Items per page (max 1000); prefer one big page over a pagination loop",
4730
- "name": "page-size",
4731
- "default": 100,
4812
+ "adam-id": {
4813
+ "description": "Apple App Store ID (adam_id) of your app, from `asa apps list`",
4814
+ "name": "adam-id",
4815
+ "required": true,
4732
4816
  "hasDynamicHelp": false,
4733
4817
  "multiple": false,
4734
4818
  "type": "option"
4735
4819
  },
4736
- "app": {
4737
- "description": "Keep only rows in this app; repeatable",
4738
- "name": "app",
4820
+ "country": {
4821
+ "description": "ISO country code (e.g. US); repeatable, default every country in the pool",
4822
+ "name": "country",
4739
4823
  "hasDynamicHelp": false,
4740
4824
  "multiple": true,
4741
4825
  "type": "option"
4742
4826
  },
4743
- "campaign-group": {
4744
- "description": "Keep only rows in this campaign group; repeatable",
4745
- "name": "campaign-group",
4827
+ "type": {
4828
+ "description": "Which pool to read",
4829
+ "name": "type",
4830
+ "required": true,
4746
4831
  "hasDynamicHelp": false,
4747
- "multiple": true,
4832
+ "multiple": false,
4833
+ "options": [
4834
+ "brand",
4835
+ "generic",
4836
+ "competitor"
4837
+ ],
4748
4838
  "type": "option"
4749
4839
  }
4750
4840
  },
4751
4841
  "hasDynamicHelp": false,
4752
4842
  "hiddenAliases": [],
4753
- "id": "asa:creatives:list",
4843
+ "id": "asa:keywords:recommend",
4754
4844
  "pluginAlias": "adapty",
4755
4845
  "pluginName": "adapty",
4756
4846
  "pluginType": "core",
@@ -4761,17 +4851,23 @@
4761
4851
  "dist",
4762
4852
  "commands",
4763
4853
  "asa",
4764
- "creatives",
4765
- "list.js"
4854
+ "keywords",
4855
+ "recommend.js"
4766
4856
  ]
4767
4857
  },
4768
- "asa:keywords:add": {
4858
+ "asa:keywords:update": {
4769
4859
  "aliases": [],
4770
- "args": {},
4771
- "description": "Add targeting keywords to an ad group",
4860
+ "args": {
4861
+ "keyword_id": {
4862
+ "description": "Keyword ID (UUID), repeatable as extra arguments",
4863
+ "name": "keyword_id",
4864
+ "required": true
4865
+ }
4866
+ },
4867
+ "description": "Change bid, status, text or match type of keywords",
4772
4868
  "examples": [
4773
- "<%= config.bin %> asa keywords add --ad-group UUID --text \"running shoes\" --text \"trail shoes\" --bid 1.20",
4774
- "<%= config.bin %> asa keywords add --ad-group UUID --from-file keywords.txt --match-type EXACT"
4869
+ "<%= config.bin %> asa keywords update UUID --bid 2.00",
4870
+ "<%= config.bin %> asa keywords update UUID_A UUID_B --status PAUSED"
4775
4871
  ],
4776
4872
  "flags": {
4777
4873
  "json": {
@@ -4796,39 +4892,23 @@
4796
4892
  "allowNo": false,
4797
4893
  "type": "boolean"
4798
4894
  },
4799
- "idempotency-key": {
4800
- "description": "Idempotency key for this write; re-running with the same key replays the stored result instead of applying twice",
4801
- "name": "idempotency-key",
4802
- "hasDynamicHelp": false,
4803
- "multiple": false,
4804
- "type": "option"
4805
- },
4806
- "ad-group": {
4807
- "description": "Ad group ID (UUID) — the campaign is resolved from it",
4808
- "name": "ad-group",
4809
- "required": true,
4895
+ "idempotency-key": {
4896
+ "description": "Idempotency key for this write; re-running with the same key replays the stored result instead of applying twice",
4897
+ "name": "idempotency-key",
4810
4898
  "hasDynamicHelp": false,
4811
4899
  "multiple": false,
4812
4900
  "type": "option"
4813
4901
  },
4814
4902
  "bid": {
4815
- "description": "Bid per keyword (amount, e.g. 50 or 12.50)",
4903
+ "description": "Bid (amount, e.g. 50 or 12.50)",
4816
4904
  "name": "bid",
4817
4905
  "hasDynamicHelp": false,
4818
4906
  "multiple": false,
4819
4907
  "type": "option"
4820
4908
  },
4821
- "from-file": {
4822
- "description": "File with one keyword per line, combined with any --text values",
4823
- "name": "from-file",
4824
- "hasDynamicHelp": false,
4825
- "multiple": false,
4826
- "type": "option"
4827
- },
4828
4909
  "match-type": {
4829
4910
  "description": "Match type",
4830
4911
  "name": "match-type",
4831
- "default": "BROAD",
4832
4912
  "hasDynamicHelp": false,
4833
4913
  "multiple": false,
4834
4914
  "options": [
@@ -4840,7 +4920,6 @@
4840
4920
  "status": {
4841
4921
  "description": "Keyword status",
4842
4922
  "name": "status",
4843
- "default": "ACTIVE",
4844
4923
  "hasDynamicHelp": false,
4845
4924
  "multiple": false,
4846
4925
  "options": [
@@ -4850,20 +4929,20 @@
4850
4929
  "type": "option"
4851
4930
  },
4852
4931
  "text": {
4853
- "description": "Keyword text, repeatable",
4932
+ "description": "Keyword text (only meaningful for a single keyword)",
4854
4933
  "name": "text",
4855
4934
  "hasDynamicHelp": false,
4856
- "multiple": true,
4935
+ "multiple": false,
4857
4936
  "type": "option"
4858
4937
  }
4859
4938
  },
4860
4939
  "hasDynamicHelp": false,
4861
4940
  "hiddenAliases": [],
4862
- "id": "asa:keywords:add",
4941
+ "id": "asa:keywords:update",
4863
4942
  "pluginAlias": "adapty",
4864
4943
  "pluginName": "adapty",
4865
4944
  "pluginType": "core",
4866
- "strict": true,
4945
+ "strict": false,
4867
4946
  "enableJsonFlag": true,
4868
4947
  "isESM": true,
4869
4948
  "relativePath": [
@@ -4871,16 +4950,20 @@
4871
4950
  "commands",
4872
4951
  "asa",
4873
4952
  "keywords",
4874
- "add.js"
4953
+ "update.js"
4875
4954
  ]
4876
4955
  },
4877
- "asa:keywords:list": {
4956
+ "asa:metrics": {
4878
4957
  "aliases": [],
4879
4958
  "args": {},
4880
- "description": "List targeting keywords; read numbers with asa metrics",
4959
+ "description": "Query metrics for any level of the account over a date range\n\nOne row per entity, already aggregated server-side and sorted by --order-by, so a top-N question is one\ncall with --order-by and --page-size N — never sum pages yourself. Account-level totals are one call to\nasa metrics overview instead. The date window is capped by the finest --group-by period: 28 days when\nday is grouped, 90 with no period grouping, 180 by week, 365 by month and coarser — widen the window by\ncoarsening the grouping, not by splitting into more calls. Each page is also capped at a breakdown-row\ncount (entities × countries × periods); over it the call fails with 422 cli_response_too_large naming the\npage[size] that fits — coarsen the grouping, narrow the window, or reduce page[size].\n\nMoney columns are in the campaign group currency, not USD, and spend and local_spend carry the same\nfigure; the currency itself comes from asa orgs list. Rate budgets and the breakdown-row cap are set per\ncompany: read the current ones with asa whoami rather than assuming a default. meta.pagination.count is\nthe full entity count behind the filters, so take inventory from there instead of counting the rows on a\npage. meta.max_valid_day says how many days the youngest cohort in the window has lived — any --by-days\nwindow above it repeats the last real figure because that time has not passed yet, so treat those as\nunreached rather than as a plateau.\n\n--metric is required and every metric named is computed over the whole entity set, so ask for the\ncolumns you actually read. subscribers and paid_subscribers (and arppu / arpas, which derive from them)\ncount unique profiles per entity and cost roughly seventeen times the rest; whatever the --entity, they\nare refused unless --campaign or --ad-group scopes the call. Those scope flags are also the cheapest way\nto make any call fast, since cost follows the number of entities aggregated, not the page size.",
4881
4960
  "examples": [
4882
- "<%= config.bin %> asa keywords list",
4883
- "<%= config.bin %> asa keywords list --ad-group AD_GROUP_UUID --status ACTIVE"
4961
+ "<%= config.bin %> asa metrics --entity campaign --date-from 2026-07-01 --date-to 2026-07-31 --metric spend --metric adapty_installs",
4962
+ "<%= config.bin %> asa metrics --entity campaign --date-from 2026-07-01 --date-to 2026-07-31 --metric spend --order-by spend --page-size 5",
4963
+ "<%= config.bin %> asa metrics --entity campaign --date-from 2026-07-01 --date-to 2026-07-31 --metric spend --group-by country --page-size 1000",
4964
+ "<%= config.bin %> asa metrics --entity keyword --date-from 2026-07-01 --date-to 2026-07-31 --metric spend --metric roas",
4965
+ "<%= config.bin %> asa metrics --entity campaign --date-from 2026-07-01 --date-to 2026-07-31 --metric roas --by-days 7 --by-days 90",
4966
+ "<%= config.bin %> asa metrics --entity keyword --date-from 2026-07-01 --date-to 2026-07-31 --metric arpas --campaign 0f0e..."
4884
4967
  ],
4885
4968
  "flags": {
4886
4969
  "json": {
@@ -4906,6 +4989,20 @@
4906
4989
  "multiple": false,
4907
4990
  "type": "option"
4908
4991
  },
4992
+ "by-days": {
4993
+ "description": "Renewal window in days for cohort metrics, repeatable; omit for the dashboard defaults",
4994
+ "name": "by-days",
4995
+ "hasDynamicHelp": false,
4996
+ "multiple": true,
4997
+ "type": "option"
4998
+ },
4999
+ "ad-group": {
5000
+ "description": "Keep only rows in this ad group; repeatable",
5001
+ "name": "ad-group",
5002
+ "hasDynamicHelp": false,
5003
+ "multiple": true,
5004
+ "type": "option"
5005
+ },
4909
5006
  "app": {
4910
5007
  "description": "Keep only rows in this app; repeatable",
4911
5008
  "name": "app",
@@ -4913,49 +5010,96 @@
4913
5010
  "multiple": true,
4914
5011
  "type": "option"
4915
5012
  },
4916
- "campaign-group": {
4917
- "description": "Keep only rows in this campaign group; repeatable",
4918
- "name": "campaign-group",
5013
+ "campaign": {
5014
+ "description": "Keep only rows in this campaign; repeatable",
5015
+ "name": "campaign",
4919
5016
  "hasDynamicHelp": false,
4920
5017
  "multiple": true,
4921
5018
  "type": "option"
4922
5019
  },
4923
- "search": {
4924
- "description": "Case-insensitive substring match on the name",
4925
- "name": "search",
5020
+ "date-from": {
5021
+ "description": "Start of the period (YYYY-MM-DD)",
5022
+ "name": "date-from",
5023
+ "required": true,
4926
5024
  "hasDynamicHelp": false,
4927
5025
  "multiple": false,
4928
5026
  "type": "option"
4929
5027
  },
4930
- "campaign": {
4931
- "description": "Keep only rows in this campaign; repeatable",
4932
- "name": "campaign",
5028
+ "date-to": {
5029
+ "description": "End of the period (YYYY-MM-DD)",
5030
+ "name": "date-to",
5031
+ "required": true,
5032
+ "hasDynamicHelp": false,
5033
+ "multiple": false,
5034
+ "type": "option"
5035
+ },
5036
+ "entity": {
5037
+ "description": "What to report on",
5038
+ "name": "entity",
5039
+ "required": true,
5040
+ "hasDynamicHelp": false,
5041
+ "multiple": false,
5042
+ "options": [
5043
+ "ad",
5044
+ "ad-group",
5045
+ "campaign",
5046
+ "keyword"
5047
+ ],
5048
+ "type": "option"
5049
+ },
5050
+ "group-by": {
5051
+ "description": "Break the rows down by a dimension, repeatable",
5052
+ "name": "group-by",
4933
5053
  "hasDynamicHelp": false,
4934
5054
  "multiple": true,
5055
+ "options": [
5056
+ "country",
5057
+ "day",
5058
+ "month",
5059
+ "quarter",
5060
+ "week",
5061
+ "year"
5062
+ ],
4935
5063
  "type": "option"
4936
5064
  },
4937
- "ad-group": {
4938
- "description": "Keep only rows in this ad group; repeatable",
4939
- "name": "ad-group",
5065
+ "metric": {
5066
+ "description": "Metric name (dashboard nomenclature, e.g. spend, taps, gross_roas), repeatable and required; every metric asked for is computed over the whole entity set, so list only what you read; a wrong name fails listing all valid ones",
5067
+ "name": "metric",
5068
+ "required": true,
4940
5069
  "hasDynamicHelp": false,
4941
5070
  "multiple": true,
4942
5071
  "type": "option"
4943
5072
  },
4944
- "status": {
4945
- "description": "Keep only rows in this state",
4946
- "name": "status",
5073
+ "order": {
5074
+ "description": "Sort direction",
5075
+ "name": "order",
5076
+ "default": "desc",
4947
5077
  "hasDynamicHelp": false,
4948
5078
  "multiple": false,
4949
5079
  "options": [
4950
- "ACTIVE",
4951
- "PAUSED"
5080
+ "asc",
5081
+ "desc"
4952
5082
  ],
4953
5083
  "type": "option"
5084
+ },
5085
+ "order-by": {
5086
+ "description": "Metric or field to sort by; cohort metrics rank via their gross_/proceeds_/net_ names",
5087
+ "name": "order-by",
5088
+ "hasDynamicHelp": false,
5089
+ "multiple": false,
5090
+ "type": "option"
5091
+ },
5092
+ "order-by-day": {
5093
+ "description": "Rank by a cohort metric at this renewal window; must be one of the --by-days values",
5094
+ "name": "order-by-day",
5095
+ "hasDynamicHelp": false,
5096
+ "multiple": false,
5097
+ "type": "option"
4954
5098
  }
4955
5099
  },
4956
5100
  "hasDynamicHelp": false,
4957
5101
  "hiddenAliases": [],
4958
- "id": "asa:keywords:list",
5102
+ "id": "asa:metrics",
4959
5103
  "pluginAlias": "adapty",
4960
5104
  "pluginName": "adapty",
4961
5105
  "pluginType": "core",
@@ -4966,18 +5110,17 @@
4966
5110
  "dist",
4967
5111
  "commands",
4968
5112
  "asa",
4969
- "keywords",
4970
- "list.js"
5113
+ "metrics",
5114
+ "index.js"
4971
5115
  ]
4972
5116
  },
4973
- "asa:keywords:recommend": {
5117
+ "asa:metrics:overview": {
4974
5118
  "aliases": [],
4975
5119
  "args": {},
4976
- "description": "Keyword recommendations for one of your apps: its brand terms, generic terms, or the brand terms of its selected competitors",
5120
+ "description": "Totals for a period, optionally split into day, week or month buckets\n\nThe one-call answer to \"how much did I spend / earn overall\" and to any single-period trend question:\ntotals for the whole entity level plus a per-period series, no pagination, no client-side summing. The\ndate window is capped by --period-unit: 90 days at day, 180 by week, 365 by month and coarser. Shares\nthe 5-per-minute metrics budget with asa metrics.",
4977
5121
  "examples": [
4978
- "<%= config.bin %> asa keywords recommend --adam-id 1668337467 --type brand",
4979
- "<%= config.bin %> asa keywords recommend --adam-id 1668337467 --type generic --country US",
4980
- "<%= config.bin %> asa keywords recommend --adam-id 1668337467 --type competitor"
5122
+ "<%= config.bin %> asa metrics overview --entity campaign --date-from 2026-07-01 --date-to 2026-07-31",
5123
+ "<%= config.bin %> asa metrics overview --entity campaign --date-from 2026-07-01 --date-to 2026-07-31 --period-unit WEEK"
4981
5124
  ],
4982
5125
  "flags": {
4983
5126
  "json": {
@@ -4987,38 +5130,69 @@
4987
5130
  "allowNo": false,
4988
5131
  "type": "boolean"
4989
5132
  },
4990
- "adam-id": {
4991
- "description": "Apple App Store ID (adam_id) of your app, from `asa apps list`",
4992
- "name": "adam-id",
5133
+ "by-days": {
5134
+ "description": "Renewal window in days for cohort metrics, repeatable; omit for the dashboard defaults",
5135
+ "name": "by-days",
5136
+ "hasDynamicHelp": false,
5137
+ "multiple": true,
5138
+ "type": "option"
5139
+ },
5140
+ "date-from": {
5141
+ "description": "Start of the period (YYYY-MM-DD)",
5142
+ "name": "date-from",
4993
5143
  "required": true,
4994
5144
  "hasDynamicHelp": false,
4995
5145
  "multiple": false,
4996
5146
  "type": "option"
4997
5147
  },
4998
- "country": {
4999
- "description": "ISO country code (e.g. US); repeatable, default every country in the pool",
5000
- "name": "country",
5148
+ "date-to": {
5149
+ "description": "End of the period (YYYY-MM-DD)",
5150
+ "name": "date-to",
5151
+ "required": true,
5001
5152
  "hasDynamicHelp": false,
5002
- "multiple": true,
5153
+ "multiple": false,
5003
5154
  "type": "option"
5004
5155
  },
5005
- "type": {
5006
- "description": "Which pool to read",
5007
- "name": "type",
5156
+ "entity": {
5157
+ "description": "What to report on",
5158
+ "name": "entity",
5008
5159
  "required": true,
5009
5160
  "hasDynamicHelp": false,
5010
5161
  "multiple": false,
5011
5162
  "options": [
5012
- "brand",
5013
- "generic",
5014
- "competitor"
5163
+ "ad",
5164
+ "ad-group",
5165
+ "campaign",
5166
+ "keyword"
5167
+ ],
5168
+ "type": "option"
5169
+ },
5170
+ "metric": {
5171
+ "description": "Metric name, repeatable; cohort roots only here (revenue, roas, arpu), not their gross_/proceeds_/net_ variants; omit for every metric",
5172
+ "name": "metric",
5173
+ "hasDynamicHelp": false,
5174
+ "multiple": true,
5175
+ "type": "option"
5176
+ },
5177
+ "period-unit": {
5178
+ "description": "Bucket size",
5179
+ "name": "period-unit",
5180
+ "default": "day",
5181
+ "hasDynamicHelp": false,
5182
+ "multiple": false,
5183
+ "options": [
5184
+ "day",
5185
+ "month",
5186
+ "quarter",
5187
+ "week",
5188
+ "year"
5015
5189
  ],
5016
5190
  "type": "option"
5017
5191
  }
5018
5192
  },
5019
5193
  "hasDynamicHelp": false,
5020
5194
  "hiddenAliases": [],
5021
- "id": "asa:keywords:recommend",
5195
+ "id": "asa:metrics:overview",
5022
5196
  "pluginAlias": "adapty",
5023
5197
  "pluginName": "adapty",
5024
5198
  "pluginType": "core",
@@ -5029,23 +5203,18 @@
5029
5203
  "dist",
5030
5204
  "commands",
5031
5205
  "asa",
5032
- "keywords",
5033
- "recommend.js"
5206
+ "metrics",
5207
+ "overview.js"
5034
5208
  ]
5035
5209
  },
5036
- "asa:keywords:update": {
5210
+ "asa:negative-keywords:add": {
5037
5211
  "aliases": [],
5038
- "args": {
5039
- "keyword_id": {
5040
- "description": "Keyword ID (UUID), repeatable as extra arguments",
5041
- "name": "keyword_id",
5042
- "required": true
5043
- }
5044
- },
5045
- "description": "Change bid, status, text or match type of keywords",
5212
+ "args": {},
5213
+ "description": "Add negative keywords to an ad group or across a campaign",
5046
5214
  "examples": [
5047
- "<%= config.bin %> asa keywords update UUID --bid 2.00",
5048
- "<%= config.bin %> asa keywords update UUID_A UUID_B --status PAUSED"
5215
+ "<%= config.bin %> asa negative-keywords add --ad-group UUID --text \"free\"",
5216
+ "<%= config.bin %> asa negative-keywords add --campaign UUID --text \"free\" --text \"cheap\"",
5217
+ "<%= config.bin %> asa negative-keywords add --campaign UUID --all-ad-groups --text \"free\""
5049
5218
  ],
5050
5219
  "flags": {
5051
5220
  "json": {
@@ -5055,14 +5224,6 @@
5055
5224
  "allowNo": false,
5056
5225
  "type": "boolean"
5057
5226
  },
5058
- "currency": {
5059
- "description": "Currency code for the amounts in this call",
5060
- "name": "currency",
5061
- "default": "USD",
5062
- "hasDynamicHelp": false,
5063
- "multiple": false,
5064
- "type": "option"
5065
- },
5066
5227
  "yes": {
5067
5228
  "char": "y",
5068
5229
  "description": "Apply without asking; required when the output is piped or --json is used",
@@ -5077,9 +5238,31 @@
5077
5238
  "multiple": false,
5078
5239
  "type": "option"
5079
5240
  },
5080
- "bid": {
5081
- "description": "Bid (amount, e.g. 50 or 12.50)",
5082
- "name": "bid",
5241
+ "ad-group": {
5242
+ "description": "Ad group ID (UUID) — the campaign is resolved from it",
5243
+ "exclusive": [
5244
+ "campaign"
5245
+ ],
5246
+ "name": "ad-group",
5247
+ "hasDynamicHelp": false,
5248
+ "multiple": false,
5249
+ "type": "option"
5250
+ },
5251
+ "all-ad-groups": {
5252
+ "dependsOn": [
5253
+ "campaign"
5254
+ ],
5255
+ "description": "Apply to every ad group of the campaign instead of the campaign itself",
5256
+ "name": "all-ad-groups",
5257
+ "allowNo": false,
5258
+ "type": "boolean"
5259
+ },
5260
+ "campaign": {
5261
+ "description": "Campaign ID (UUID)",
5262
+ "exclusive": [
5263
+ "ad-group"
5264
+ ],
5265
+ "name": "campaign",
5083
5266
  "hasDynamicHelp": false,
5084
5267
  "multiple": false,
5085
5268
  "type": "option"
@@ -5087,6 +5270,7 @@
5087
5270
  "match-type": {
5088
5271
  "description": "Match type",
5089
5272
  "name": "match-type",
5273
+ "default": "EXACT",
5090
5274
  "hasDynamicHelp": false,
5091
5275
  "multiple": false,
5092
5276
  "options": [
@@ -5098,6 +5282,7 @@
5098
5282
  "status": {
5099
5283
  "description": "Keyword status",
5100
5284
  "name": "status",
5285
+ "default": "ACTIVE",
5101
5286
  "hasDynamicHelp": false,
5102
5287
  "multiple": false,
5103
5288
  "options": [
@@ -5107,41 +5292,38 @@
5107
5292
  "type": "option"
5108
5293
  },
5109
5294
  "text": {
5110
- "description": "Keyword text (only meaningful for a single keyword)",
5295
+ "description": "Keyword text, repeatable",
5111
5296
  "name": "text",
5297
+ "required": true,
5112
5298
  "hasDynamicHelp": false,
5113
- "multiple": false,
5299
+ "multiple": true,
5114
5300
  "type": "option"
5115
5301
  }
5116
5302
  },
5117
5303
  "hasDynamicHelp": false,
5118
5304
  "hiddenAliases": [],
5119
- "id": "asa:keywords:update",
5305
+ "id": "asa:negative-keywords:add",
5120
5306
  "pluginAlias": "adapty",
5121
5307
  "pluginName": "adapty",
5122
5308
  "pluginType": "core",
5123
- "strict": false,
5309
+ "strict": true,
5124
5310
  "enableJsonFlag": true,
5125
5311
  "isESM": true,
5126
5312
  "relativePath": [
5127
5313
  "dist",
5128
5314
  "commands",
5129
5315
  "asa",
5130
- "keywords",
5131
- "update.js"
5316
+ "negative-keywords",
5317
+ "add.js"
5132
5318
  ]
5133
5319
  },
5134
- "asa:metrics": {
5320
+ "asa:negative-keywords:list": {
5135
5321
  "aliases": [],
5136
5322
  "args": {},
5137
- "description": "Query metrics for any level of the account over a date range\n\nOne row per entity, already aggregated server-side and sorted by --order-by, so a top-N question is one\ncall with --order-by and --page-size N — never sum pages yourself. Account-level totals are one call to\nasa metrics overview instead. The date window is capped by the finest --group-by period: 28 days when\nday is grouped, 90 with no period grouping, 180 by week, 365 by month and coarser — widen the window by\ncoarsening the grouping, not by splitting into more calls. Each page is also capped at a breakdown-row\ncount (entities × countries × periods); over it the call fails with 422 cli_response_too_large naming the\npage[size] that fits — coarsen the grouping, narrow the window, or reduce page[size].\n\nMoney columns are in the campaign group currency, not USD, and spend and local_spend carry the same\nfigure; the currency itself comes from asa orgs list. Rate budgets and the breakdown-row cap are set per\ncompany: read the current ones with asa whoami rather than assuming a default. meta.pagination.count is\nthe full entity count behind the filters, so take inventory from there instead of counting the rows on a\npage. meta.max_valid_day says how many days the youngest cohort in the window has lived — any --by-days\nwindow above it repeats the last real figure because that time has not passed yet, so treat those as\nunreached rather than as a plateau.\n\n--metric is required and every metric named is computed over the whole entity set, so ask for the\ncolumns you actually read. subscribers and paid_subscribers (and arppu / arpas, which derive from them)\ncount unique profiles per entity and cost roughly seventeen times the rest; whatever the --entity, they\nare refused unless --campaign or --ad-group scopes the call. Those scope flags are also the cheapest way\nto make any call fast, since cost follows the number of entities aggregated, not the page size.",
5323
+ "description": "List negative keywords; ad_group_id is empty for campaign-level ones",
5138
5324
  "examples": [
5139
- "<%= config.bin %> asa metrics --entity campaign --date-from 2026-07-01 --date-to 2026-07-31 --metric spend --metric adapty_installs",
5140
- "<%= config.bin %> asa metrics --entity campaign --date-from 2026-07-01 --date-to 2026-07-31 --metric spend --order-by spend --page-size 5",
5141
- "<%= config.bin %> asa metrics --entity campaign --date-from 2026-07-01 --date-to 2026-07-31 --metric spend --group-by country --page-size 1000",
5142
- "<%= config.bin %> asa metrics --entity keyword --date-from 2026-07-01 --date-to 2026-07-31 --metric spend --metric roas",
5143
- "<%= config.bin %> asa metrics --entity campaign --date-from 2026-07-01 --date-to 2026-07-31 --metric roas --by-days 7 --by-days 90",
5144
- "<%= config.bin %> asa metrics --entity keyword --date-from 2026-07-01 --date-to 2026-07-31 --metric arpas --campaign 0f0e..."
5325
+ "<%= config.bin %> asa negative-keywords list",
5326
+ "<%= config.bin %> asa negative-keywords list --campaign CAMPAIGN_UUID"
5145
5327
  ],
5146
5328
  "flags": {
5147
5329
  "json": {
@@ -5167,25 +5349,25 @@
5167
5349
  "multiple": false,
5168
5350
  "type": "option"
5169
5351
  },
5170
- "by-days": {
5171
- "description": "Renewal window in days for cohort metrics, repeatable; omit for the dashboard defaults",
5172
- "name": "by-days",
5352
+ "app": {
5353
+ "description": "Keep only rows in this app; repeatable",
5354
+ "name": "app",
5173
5355
  "hasDynamicHelp": false,
5174
5356
  "multiple": true,
5175
5357
  "type": "option"
5176
5358
  },
5177
- "ad-group": {
5178
- "description": "Keep only rows in this ad group; repeatable",
5179
- "name": "ad-group",
5359
+ "campaign-group": {
5360
+ "description": "Keep only rows in this campaign group; repeatable",
5361
+ "name": "campaign-group",
5180
5362
  "hasDynamicHelp": false,
5181
5363
  "multiple": true,
5182
5364
  "type": "option"
5183
5365
  },
5184
- "app": {
5185
- "description": "Keep only rows in this app; repeatable",
5186
- "name": "app",
5366
+ "search": {
5367
+ "description": "Case-insensitive substring match on the name",
5368
+ "name": "search",
5187
5369
  "hasDynamicHelp": false,
5188
- "multiple": true,
5370
+ "multiple": false,
5189
5371
  "type": "option"
5190
5372
  },
5191
5373
  "campaign": {
@@ -5195,81 +5377,183 @@
5195
5377
  "multiple": true,
5196
5378
  "type": "option"
5197
5379
  },
5198
- "date-from": {
5199
- "description": "Start of the period (YYYY-MM-DD)",
5200
- "name": "date-from",
5201
- "required": true,
5380
+ "ad-group": {
5381
+ "description": "Keep only rows in this ad group; repeatable",
5382
+ "name": "ad-group",
5383
+ "hasDynamicHelp": false,
5384
+ "multiple": true,
5385
+ "type": "option"
5386
+ },
5387
+ "campaign-level-only": {
5388
+ "description": "Keep only campaign-level rows (ad_group_id is null)",
5389
+ "name": "campaign-level-only",
5390
+ "allowNo": false,
5391
+ "type": "boolean"
5392
+ }
5393
+ },
5394
+ "hasDynamicHelp": false,
5395
+ "hiddenAliases": [],
5396
+ "id": "asa:negative-keywords:list",
5397
+ "pluginAlias": "adapty",
5398
+ "pluginName": "adapty",
5399
+ "pluginType": "core",
5400
+ "strict": true,
5401
+ "enableJsonFlag": true,
5402
+ "isESM": true,
5403
+ "relativePath": [
5404
+ "dist",
5405
+ "commands",
5406
+ "asa",
5407
+ "negative-keywords",
5408
+ "list.js"
5409
+ ]
5410
+ },
5411
+ "asa:orgs:list": {
5412
+ "aliases": [],
5413
+ "args": {},
5414
+ "description": "List the Apple Search Ads organizations this company can spend from",
5415
+ "examples": [
5416
+ "<%= config.bin %> asa orgs list"
5417
+ ],
5418
+ "flags": {
5419
+ "json": {
5420
+ "description": "Format output as json.",
5421
+ "helpGroup": "GLOBAL",
5422
+ "name": "json",
5423
+ "allowNo": false,
5424
+ "type": "boolean"
5425
+ },
5426
+ "page": {
5427
+ "description": "Page number",
5428
+ "name": "page",
5429
+ "default": 1,
5202
5430
  "hasDynamicHelp": false,
5203
5431
  "multiple": false,
5204
5432
  "type": "option"
5205
5433
  },
5206
- "date-to": {
5207
- "description": "End of the period (YYYY-MM-DD)",
5208
- "name": "date-to",
5209
- "required": true,
5434
+ "page-size": {
5435
+ "description": "Items per page (max 1000); prefer one big page over a pagination loop",
5436
+ "name": "page-size",
5437
+ "default": 100,
5210
5438
  "hasDynamicHelp": false,
5211
5439
  "multiple": false,
5212
5440
  "type": "option"
5441
+ }
5442
+ },
5443
+ "hasDynamicHelp": false,
5444
+ "hiddenAliases": [],
5445
+ "id": "asa:orgs:list",
5446
+ "pluginAlias": "adapty",
5447
+ "pluginName": "adapty",
5448
+ "pluginType": "core",
5449
+ "strict": true,
5450
+ "enableJsonFlag": true,
5451
+ "isESM": true,
5452
+ "relativePath": [
5453
+ "dist",
5454
+ "commands",
5455
+ "asa",
5456
+ "orgs",
5457
+ "list.js"
5458
+ ]
5459
+ },
5460
+ "asa:product-pages:list": {
5461
+ "aliases": [],
5462
+ "args": {},
5463
+ "description": "List custom product pages (read-only; authoring stays in App Store Connect)",
5464
+ "examples": [
5465
+ "<%= config.bin %> asa product-pages list",
5466
+ "<%= config.bin %> asa product-pages list --app APP_UUID"
5467
+ ],
5468
+ "flags": {
5469
+ "json": {
5470
+ "description": "Format output as json.",
5471
+ "helpGroup": "GLOBAL",
5472
+ "name": "json",
5473
+ "allowNo": false,
5474
+ "type": "boolean"
5213
5475
  },
5214
- "entity": {
5215
- "description": "What to report on",
5216
- "name": "entity",
5217
- "required": true,
5476
+ "page": {
5477
+ "description": "Page number",
5478
+ "name": "page",
5479
+ "default": 1,
5218
5480
  "hasDynamicHelp": false,
5219
5481
  "multiple": false,
5220
- "options": [
5221
- "ad",
5222
- "ad-group",
5223
- "campaign",
5224
- "keyword"
5225
- ],
5226
5482
  "type": "option"
5227
5483
  },
5228
- "group-by": {
5229
- "description": "Break the rows down by a dimension, repeatable",
5230
- "name": "group-by",
5484
+ "page-size": {
5485
+ "description": "Items per page (max 1000); prefer one big page over a pagination loop",
5486
+ "name": "page-size",
5487
+ "default": 100,
5231
5488
  "hasDynamicHelp": false,
5232
- "multiple": true,
5233
- "options": [
5234
- "country",
5235
- "day",
5236
- "month",
5237
- "quarter",
5238
- "week",
5239
- "year"
5240
- ],
5489
+ "multiple": false,
5241
5490
  "type": "option"
5242
5491
  },
5243
- "metric": {
5244
- "description": "Metric name (dashboard nomenclature, e.g. spend, taps, gross_roas), repeatable and required; every metric asked for is computed over the whole entity set, so list only what you read; a wrong name fails listing all valid ones",
5245
- "name": "metric",
5246
- "required": true,
5492
+ "app": {
5493
+ "description": "Keep only rows in this app; repeatable",
5494
+ "name": "app",
5247
5495
  "hasDynamicHelp": false,
5248
5496
  "multiple": true,
5249
5497
  "type": "option"
5250
5498
  },
5251
- "order": {
5252
- "description": "Sort direction",
5253
- "name": "order",
5254
- "default": "desc",
5499
+ "campaign-group": {
5500
+ "description": "Keep only rows in this campaign group; repeatable",
5501
+ "name": "campaign-group",
5255
5502
  "hasDynamicHelp": false,
5256
- "multiple": false,
5257
- "options": [
5258
- "asc",
5259
- "desc"
5260
- ],
5503
+ "multiple": true,
5261
5504
  "type": "option"
5505
+ }
5506
+ },
5507
+ "hasDynamicHelp": false,
5508
+ "hiddenAliases": [],
5509
+ "id": "asa:product-pages:list",
5510
+ "pluginAlias": "adapty",
5511
+ "pluginName": "adapty",
5512
+ "pluginType": "core",
5513
+ "strict": true,
5514
+ "enableJsonFlag": true,
5515
+ "isESM": true,
5516
+ "relativePath": [
5517
+ "dist",
5518
+ "commands",
5519
+ "asa",
5520
+ "product-pages",
5521
+ "list.js"
5522
+ ]
5523
+ },
5524
+ "asa:product-pages:sync": {
5525
+ "aliases": [],
5526
+ "args": {},
5527
+ "description": "Refresh custom product pages from Apple",
5528
+ "examples": [
5529
+ "<%= config.bin %> asa product-pages sync",
5530
+ "<%= config.bin %> asa product-pages sync --adam-id 123456"
5531
+ ],
5532
+ "flags": {
5533
+ "json": {
5534
+ "description": "Format output as json.",
5535
+ "helpGroup": "GLOBAL",
5536
+ "name": "json",
5537
+ "allowNo": false,
5538
+ "type": "boolean"
5262
5539
  },
5263
- "order-by": {
5264
- "description": "Metric or field to sort by; cohort metrics rank via their gross_/proceeds_/net_ names",
5265
- "name": "order-by",
5540
+ "yes": {
5541
+ "char": "y",
5542
+ "description": "Apply without asking; required when the output is piped or --json is used",
5543
+ "name": "yes",
5544
+ "allowNo": false,
5545
+ "type": "boolean"
5546
+ },
5547
+ "idempotency-key": {
5548
+ "description": "Idempotency key for this write; re-running with the same key replays the stored result instead of applying twice",
5549
+ "name": "idempotency-key",
5266
5550
  "hasDynamicHelp": false,
5267
5551
  "multiple": false,
5268
- "type": "option"
5269
- },
5270
- "order-by-day": {
5271
- "description": "Rank by a cohort metric at this renewal window; must be one of the --by-days values",
5272
- "name": "order-by-day",
5552
+ "type": "option"
5553
+ },
5554
+ "adam-id": {
5555
+ "description": "Limit the refresh to one app; omit to cover every app",
5556
+ "name": "adam-id",
5273
5557
  "hasDynamicHelp": false,
5274
5558
  "multiple": false,
5275
5559
  "type": "option"
@@ -5277,7 +5561,7 @@
5277
5561
  },
5278
5562
  "hasDynamicHelp": false,
5279
5563
  "hiddenAliases": [],
5280
- "id": "asa:metrics",
5564
+ "id": "asa:product-pages:sync",
5281
5565
  "pluginAlias": "adapty",
5282
5566
  "pluginName": "adapty",
5283
5567
  "pluginType": "core",
@@ -5288,17 +5572,17 @@
5288
5572
  "dist",
5289
5573
  "commands",
5290
5574
  "asa",
5291
- "metrics",
5292
- "index.js"
5575
+ "product-pages",
5576
+ "sync.js"
5293
5577
  ]
5294
5578
  },
5295
- "asa:metrics:overview": {
5579
+ "asa:search-terms:list": {
5296
5580
  "aliases": [],
5297
5581
  "args": {},
5298
- "description": "Totals for a period, optionally split into day, week or month buckets\n\nThe one-call answer to \"how much did I spend / earn overall\" and to any single-period trend question:\ntotals for the whole entity level plus a per-period series, no pagination, no client-side summing. The\ndate window is capped by --period-unit: 90 days at day, 180 by week, 365 by month and coarser. Shares\nthe 5-per-minute metrics budget with asa metrics.",
5582
+ "description": "List the search terms your ads matched, with their metrics",
5299
5583
  "examples": [
5300
- "<%= config.bin %> asa metrics overview --entity campaign --date-from 2026-07-01 --date-to 2026-07-31",
5301
- "<%= config.bin %> asa metrics overview --entity campaign --date-from 2026-07-01 --date-to 2026-07-31 --period-unit WEEK"
5584
+ "<%= config.bin %> asa search-terms list --date-from 2026-07-01 --date-to 2026-07-31",
5585
+ "<%= config.bin %> asa search-terms list --ad-group AD_GROUP_UUID"
5302
5586
  ],
5303
5587
  "flags": {
5304
5588
  "json": {
@@ -5308,69 +5592,75 @@
5308
5592
  "allowNo": false,
5309
5593
  "type": "boolean"
5310
5594
  },
5311
- "by-days": {
5312
- "description": "Renewal window in days for cohort metrics, repeatable; omit for the dashboard defaults",
5313
- "name": "by-days",
5595
+ "page": {
5596
+ "description": "Page number",
5597
+ "name": "page",
5598
+ "default": 1,
5314
5599
  "hasDynamicHelp": false,
5315
- "multiple": true,
5600
+ "multiple": false,
5601
+ "type": "option"
5602
+ },
5603
+ "page-size": {
5604
+ "description": "Items per page (max 1000); prefer one big page over a pagination loop",
5605
+ "name": "page-size",
5606
+ "default": 100,
5607
+ "hasDynamicHelp": false,
5608
+ "multiple": false,
5316
5609
  "type": "option"
5317
5610
  },
5318
5611
  "date-from": {
5319
- "description": "Start of the period (YYYY-MM-DD)",
5612
+ "description": "Start of the reporting period (YYYY-MM-DD), defaults to today",
5320
5613
  "name": "date-from",
5321
- "required": true,
5322
5614
  "hasDynamicHelp": false,
5323
5615
  "multiple": false,
5324
5616
  "type": "option"
5325
5617
  },
5326
5618
  "date-to": {
5327
- "description": "End of the period (YYYY-MM-DD)",
5619
+ "description": "End of the reporting period (YYYY-MM-DD), defaults to today",
5328
5620
  "name": "date-to",
5329
- "required": true,
5330
5621
  "hasDynamicHelp": false,
5331
5622
  "multiple": false,
5332
5623
  "type": "option"
5333
5624
  },
5334
- "entity": {
5335
- "description": "What to report on",
5336
- "name": "entity",
5337
- "required": true,
5625
+ "app": {
5626
+ "description": "Keep only rows in this app; repeatable",
5627
+ "name": "app",
5338
5628
  "hasDynamicHelp": false,
5339
- "multiple": false,
5340
- "options": [
5341
- "ad",
5342
- "ad-group",
5343
- "campaign",
5344
- "keyword"
5345
- ],
5629
+ "multiple": true,
5346
5630
  "type": "option"
5347
5631
  },
5348
- "metric": {
5349
- "description": "Metric name, repeatable; cohort roots only here (revenue, roas, arpu), not their gross_/proceeds_/net_ variants; omit for every metric",
5350
- "name": "metric",
5632
+ "campaign-group": {
5633
+ "description": "Keep only rows in this campaign group; repeatable",
5634
+ "name": "campaign-group",
5351
5635
  "hasDynamicHelp": false,
5352
5636
  "multiple": true,
5353
5637
  "type": "option"
5354
5638
  },
5355
- "period-unit": {
5356
- "description": "Bucket size",
5357
- "name": "period-unit",
5358
- "default": "day",
5639
+ "search": {
5640
+ "description": "Case-insensitive substring match on the name",
5641
+ "name": "search",
5359
5642
  "hasDynamicHelp": false,
5360
5643
  "multiple": false,
5361
- "options": [
5362
- "day",
5363
- "month",
5364
- "quarter",
5365
- "week",
5366
- "year"
5367
- ],
5644
+ "type": "option"
5645
+ },
5646
+ "campaign": {
5647
+ "description": "Keep only rows in this campaign; repeatable",
5648
+ "name": "campaign",
5649
+ "hasDynamicHelp": false,
5650
+ "multiple": true,
5651
+ "type": "option"
5652
+ },
5653
+ "ad-group": {
5654
+ "description": "Keep only rows in this ad group; repeatable",
5655
+ "name": "ad-group",
5656
+ "hasDynamicHelp": false,
5657
+ "multiple": true,
5368
5658
  "type": "option"
5369
5659
  }
5370
5660
  },
5371
5661
  "hasDynamicHelp": false,
5372
5662
  "hiddenAliases": [],
5373
- "id": "asa:metrics:overview",
5663
+ "id": "asa:search-terms:list",
5374
5664
  "pluginAlias": "adapty",
5375
5665
  "pluginName": "adapty",
5376
5666
  "pluginType": "core",
@@ -5381,18 +5671,18 @@
5381
5671
  "dist",
5382
5672
  "commands",
5383
5673
  "asa",
5384
- "metrics",
5385
- "overview.js"
5674
+ "search-terms",
5675
+ "list.js"
5386
5676
  ]
5387
5677
  },
5388
- "asa:negative-keywords:add": {
5678
+ "asa:ad-groups:create": {
5389
5679
  "aliases": [],
5390
5680
  "args": {},
5391
- "description": "Add negative keywords to an ad group or across a campaign",
5681
+ "description": "Create an ad group inside a campaign; --automated creates the automated ad group a Max Conversions campaign needs to run",
5392
5682
  "examples": [
5393
- "<%= config.bin %> asa negative-keywords add --ad-group UUID --text \"free\"",
5394
- "<%= config.bin %> asa negative-keywords add --campaign UUID --text \"free\" --text \"cheap\"",
5395
- "<%= config.bin %> asa negative-keywords add --campaign UUID --all-ad-groups --text \"free\""
5683
+ "<%= config.bin %> asa ad-groups create --campaign UUID --name \"Brand terms\" --default-bid 1.20",
5684
+ "<%= config.bin %> asa ad-groups create --campaign UUID --name \"Brand terms\" --default-bid 1.20 --start-time 2026-09-01 --pricing-model CPM",
5685
+ "<%= config.bin %> asa ad-groups create --campaign UUID --name \"Automated Max Conv\" --automated"
5396
5686
  ],
5397
5687
  "flags": {
5398
5688
  "json": {
@@ -5402,176 +5692,114 @@
5402
5692
  "allowNo": false,
5403
5693
  "type": "boolean"
5404
5694
  },
5405
- "yes": {
5406
- "char": "y",
5407
- "description": "Apply without asking; required when the output is piped or --json is used",
5408
- "name": "yes",
5409
- "allowNo": false,
5410
- "type": "boolean"
5411
- },
5412
- "idempotency-key": {
5413
- "description": "Idempotency key for this write; re-running with the same key replays the stored result instead of applying twice",
5414
- "name": "idempotency-key",
5695
+ "currency": {
5696
+ "description": "Currency code for the amounts in this call",
5697
+ "name": "currency",
5698
+ "default": "USD",
5415
5699
  "hasDynamicHelp": false,
5416
5700
  "multiple": false,
5417
5701
  "type": "option"
5418
5702
  },
5419
- "ad-group": {
5420
- "description": "Ad group ID (UUID) — the campaign is resolved from it",
5421
- "exclusive": [
5422
- "campaign"
5423
- ],
5424
- "name": "ad-group",
5703
+ "end-time": {
5704
+ "description": "Schedule end (YYYY-MM-DD)",
5705
+ "name": "end-time",
5425
5706
  "hasDynamicHelp": false,
5426
5707
  "multiple": false,
5427
5708
  "type": "option"
5428
5709
  },
5429
- "all-ad-groups": {
5430
- "dependsOn": [
5431
- "campaign"
5432
- ],
5433
- "description": "Apply to every ad group of the campaign instead of the campaign itself",
5434
- "name": "all-ad-groups",
5435
- "allowNo": false,
5436
- "type": "boolean"
5437
- },
5438
- "campaign": {
5439
- "description": "Campaign ID (UUID)",
5440
- "exclusive": [
5441
- "ad-group"
5442
- ],
5443
- "name": "campaign",
5710
+ "start-time": {
5711
+ "description": "Schedule start (YYYY-MM-DD), defaults to today",
5712
+ "name": "start-time",
5444
5713
  "hasDynamicHelp": false,
5445
5714
  "multiple": false,
5446
5715
  "type": "option"
5447
5716
  },
5448
- "match-type": {
5449
- "description": "Match type",
5450
- "name": "match-type",
5451
- "default": "EXACT",
5717
+ "pricing-model": {
5718
+ "description": "Pricing model; Apple requires one on every ad group",
5719
+ "name": "pricing-model",
5720
+ "default": "CPC",
5452
5721
  "hasDynamicHelp": false,
5453
5722
  "multiple": false,
5454
5723
  "options": [
5455
- "BROAD",
5456
- "EXACT"
5724
+ "CPC",
5725
+ "CPM"
5457
5726
  ],
5458
5727
  "type": "option"
5459
5728
  },
5460
- "status": {
5461
- "description": "Keyword status",
5462
- "name": "status",
5463
- "default": "ACTIVE",
5729
+ "yes": {
5730
+ "char": "y",
5731
+ "description": "Apply without asking; required when the output is piped or --json is used",
5732
+ "name": "yes",
5733
+ "allowNo": false,
5734
+ "type": "boolean"
5735
+ },
5736
+ "idempotency-key": {
5737
+ "description": "Idempotency key for this write; re-running with the same key replays the stored result instead of applying twice",
5738
+ "name": "idempotency-key",
5464
5739
  "hasDynamicHelp": false,
5465
5740
  "multiple": false,
5466
- "options": [
5467
- "ACTIVE",
5468
- "PAUSED"
5469
- ],
5470
5741
  "type": "option"
5471
5742
  },
5472
- "text": {
5473
- "description": "Keyword text, repeatable",
5474
- "name": "text",
5475
- "required": true,
5476
- "hasDynamicHelp": false,
5477
- "multiple": true,
5478
- "type": "option"
5479
- }
5480
- },
5481
- "hasDynamicHelp": false,
5482
- "hiddenAliases": [],
5483
- "id": "asa:negative-keywords:add",
5484
- "pluginAlias": "adapty",
5485
- "pluginName": "adapty",
5486
- "pluginType": "core",
5487
- "strict": true,
5488
- "enableJsonFlag": true,
5489
- "isESM": true,
5490
- "relativePath": [
5491
- "dist",
5492
- "commands",
5493
- "asa",
5494
- "negative-keywords",
5495
- "add.js"
5496
- ]
5497
- },
5498
- "asa:negative-keywords:list": {
5499
- "aliases": [],
5500
- "args": {},
5501
- "description": "List negative keywords; ad_group_id is empty for campaign-level ones",
5502
- "examples": [
5503
- "<%= config.bin %> asa negative-keywords list",
5504
- "<%= config.bin %> asa negative-keywords list --campaign CAMPAIGN_UUID"
5505
- ],
5506
- "flags": {
5507
- "json": {
5508
- "description": "Format output as json.",
5509
- "helpGroup": "GLOBAL",
5510
- "name": "json",
5743
+ "automated": {
5744
+ "description": "Create the automated ad group a Max Conversions campaign needs (no bid, no schedule, always ENABLED)",
5745
+ "exclusive": [
5746
+ "automated-keywords"
5747
+ ],
5748
+ "name": "automated",
5511
5749
  "allowNo": false,
5512
5750
  "type": "boolean"
5513
5751
  },
5514
- "page": {
5515
- "description": "Page number",
5516
- "name": "page",
5517
- "default": 1,
5518
- "hasDynamicHelp": false,
5519
- "multiple": false,
5520
- "type": "option"
5752
+ "automated-keywords": {
5753
+ "description": "Let Apple add keywords automatically",
5754
+ "name": "automated-keywords",
5755
+ "allowNo": true,
5756
+ "type": "boolean"
5521
5757
  },
5522
- "page-size": {
5523
- "description": "Items per page (max 1000); prefer one big page over a pagination loop",
5524
- "name": "page-size",
5525
- "default": 100,
5758
+ "campaign": {
5759
+ "description": "Campaign ID (UUID)",
5760
+ "name": "campaign",
5761
+ "required": true,
5526
5762
  "hasDynamicHelp": false,
5527
5763
  "multiple": false,
5528
5764
  "type": "option"
5529
5765
  },
5530
- "app": {
5531
- "description": "Keep only rows in this app; repeatable",
5532
- "name": "app",
5533
- "hasDynamicHelp": false,
5534
- "multiple": true,
5535
- "type": "option"
5536
- },
5537
- "campaign-group": {
5538
- "description": "Keep only rows in this campaign group; repeatable",
5539
- "name": "campaign-group",
5766
+ "cpa-goal": {
5767
+ "description": "CPA goal (amount, e.g. 50 or 12.50)",
5768
+ "name": "cpa-goal",
5540
5769
  "hasDynamicHelp": false,
5541
- "multiple": true,
5770
+ "multiple": false,
5542
5771
  "type": "option"
5543
5772
  },
5544
- "search": {
5545
- "description": "Case-insensitive substring match on the name",
5546
- "name": "search",
5773
+ "default-bid": {
5774
+ "description": "Default bid; required unless --automated is set (amount, e.g. 50 or 12.50)",
5775
+ "name": "default-bid",
5547
5776
  "hasDynamicHelp": false,
5548
5777
  "multiple": false,
5549
5778
  "type": "option"
5550
5779
  },
5551
- "campaign": {
5552
- "description": "Keep only rows in this campaign; repeatable",
5553
- "name": "campaign",
5780
+ "name": {
5781
+ "description": "Ad group name",
5782
+ "name": "name",
5783
+ "required": true,
5554
5784
  "hasDynamicHelp": false,
5555
- "multiple": true,
5785
+ "multiple": false,
5556
5786
  "type": "option"
5557
5787
  },
5558
- "ad-group": {
5559
- "description": "Keep only rows in this ad group; repeatable",
5560
- "name": "ad-group",
5788
+ "status": {
5789
+ "description": "Initial status",
5790
+ "name": "status",
5561
5791
  "hasDynamicHelp": false,
5562
- "multiple": true,
5792
+ "multiple": false,
5793
+ "options": [
5794
+ "ENABLED",
5795
+ "PAUSED"
5796
+ ],
5563
5797
  "type": "option"
5564
- },
5565
- "campaign-level-only": {
5566
- "description": "Keep only campaign-level rows (ad_group_id is null)",
5567
- "name": "campaign-level-only",
5568
- "allowNo": false,
5569
- "type": "boolean"
5570
5798
  }
5571
5799
  },
5572
5800
  "hasDynamicHelp": false,
5573
5801
  "hiddenAliases": [],
5574
- "id": "asa:negative-keywords:list",
5802
+ "id": "asa:ad-groups:create",
5575
5803
  "pluginAlias": "adapty",
5576
5804
  "pluginName": "adapty",
5577
5805
  "pluginType": "core",
@@ -5582,16 +5810,22 @@
5582
5810
  "dist",
5583
5811
  "commands",
5584
5812
  "asa",
5585
- "negative-keywords",
5586
- "list.js"
5813
+ "ad-groups",
5814
+ "create.js"
5587
5815
  ]
5588
5816
  },
5589
- "asa:orgs:list": {
5817
+ "asa:ad-groups:get": {
5590
5818
  "aliases": [],
5591
- "args": {},
5592
- "description": "List the Apple Search Ads organizations this company can spend from",
5819
+ "args": {
5820
+ "ad_group_id": {
5821
+ "description": "Ad group ID (UUID)",
5822
+ "name": "ad_group_id",
5823
+ "required": true
5824
+ }
5825
+ },
5826
+ "description": "Show one ad group; read numbers with asa metrics",
5593
5827
  "examples": [
5594
- "<%= config.bin %> asa orgs list"
5828
+ "<%= config.bin %> asa ad-groups get 550e8400-e29b-41d4-a716-446655440000"
5595
5829
  ],
5596
5830
  "flags": {
5597
5831
  "json": {
@@ -5600,27 +5834,11 @@
5600
5834
  "name": "json",
5601
5835
  "allowNo": false,
5602
5836
  "type": "boolean"
5603
- },
5604
- "page": {
5605
- "description": "Page number",
5606
- "name": "page",
5607
- "default": 1,
5608
- "hasDynamicHelp": false,
5609
- "multiple": false,
5610
- "type": "option"
5611
- },
5612
- "page-size": {
5613
- "description": "Items per page (max 1000); prefer one big page over a pagination loop",
5614
- "name": "page-size",
5615
- "default": 100,
5616
- "hasDynamicHelp": false,
5617
- "multiple": false,
5618
- "type": "option"
5619
5837
  }
5620
5838
  },
5621
5839
  "hasDynamicHelp": false,
5622
5840
  "hiddenAliases": [],
5623
- "id": "asa:orgs:list",
5841
+ "id": "asa:ad-groups:get",
5624
5842
  "pluginAlias": "adapty",
5625
5843
  "pluginName": "adapty",
5626
5844
  "pluginType": "core",
@@ -5631,17 +5849,17 @@
5631
5849
  "dist",
5632
5850
  "commands",
5633
5851
  "asa",
5634
- "orgs",
5635
- "list.js"
5852
+ "ad-groups",
5853
+ "get.js"
5636
5854
  ]
5637
5855
  },
5638
- "asa:product-pages:list": {
5856
+ "asa:ad-groups:list": {
5639
5857
  "aliases": [],
5640
5858
  "args": {},
5641
- "description": "List custom product pages (read-only; authoring stays in App Store Connect)",
5859
+ "description": "List ad groups; read numbers with asa metrics",
5642
5860
  "examples": [
5643
- "<%= config.bin %> asa product-pages list",
5644
- "<%= config.bin %> asa product-pages list --app APP_UUID"
5861
+ "<%= config.bin %> asa ad-groups list",
5862
+ "<%= config.bin %> asa ad-groups list --campaign CAMPAIGN_UUID"
5645
5863
  ],
5646
5864
  "flags": {
5647
5865
  "json": {
@@ -5680,66 +5898,36 @@
5680
5898
  "hasDynamicHelp": false,
5681
5899
  "multiple": true,
5682
5900
  "type": "option"
5683
- }
5684
- },
5685
- "hasDynamicHelp": false,
5686
- "hiddenAliases": [],
5687
- "id": "asa:product-pages:list",
5688
- "pluginAlias": "adapty",
5689
- "pluginName": "adapty",
5690
- "pluginType": "core",
5691
- "strict": true,
5692
- "enableJsonFlag": true,
5693
- "isESM": true,
5694
- "relativePath": [
5695
- "dist",
5696
- "commands",
5697
- "asa",
5698
- "product-pages",
5699
- "list.js"
5700
- ]
5701
- },
5702
- "asa:product-pages:sync": {
5703
- "aliases": [],
5704
- "args": {},
5705
- "description": "Refresh custom product pages from Apple",
5706
- "examples": [
5707
- "<%= config.bin %> asa product-pages sync",
5708
- "<%= config.bin %> asa product-pages sync --adam-id 123456"
5709
- ],
5710
- "flags": {
5711
- "json": {
5712
- "description": "Format output as json.",
5713
- "helpGroup": "GLOBAL",
5714
- "name": "json",
5715
- "allowNo": false,
5716
- "type": "boolean"
5717
- },
5718
- "yes": {
5719
- "char": "y",
5720
- "description": "Apply without asking; required when the output is piped or --json is used",
5721
- "name": "yes",
5722
- "allowNo": false,
5723
- "type": "boolean"
5724
5901
  },
5725
- "idempotency-key": {
5726
- "description": "Idempotency key for this write; re-running with the same key replays the stored result instead of applying twice",
5727
- "name": "idempotency-key",
5902
+ "search": {
5903
+ "description": "Case-insensitive substring match on the name",
5904
+ "name": "search",
5728
5905
  "hasDynamicHelp": false,
5729
5906
  "multiple": false,
5730
5907
  "type": "option"
5731
5908
  },
5732
- "adam-id": {
5733
- "description": "Limit the refresh to one app; omit to cover every app",
5734
- "name": "adam-id",
5909
+ "campaign": {
5910
+ "description": "Keep only rows in this campaign; repeatable",
5911
+ "name": "campaign",
5912
+ "hasDynamicHelp": false,
5913
+ "multiple": true,
5914
+ "type": "option"
5915
+ },
5916
+ "status": {
5917
+ "description": "Keep only rows in this state",
5918
+ "name": "status",
5735
5919
  "hasDynamicHelp": false,
5736
5920
  "multiple": false,
5921
+ "options": [
5922
+ "ENABLED",
5923
+ "PAUSED"
5924
+ ],
5737
5925
  "type": "option"
5738
5926
  }
5739
5927
  },
5740
5928
  "hasDynamicHelp": false,
5741
5929
  "hiddenAliases": [],
5742
- "id": "asa:product-pages:sync",
5930
+ "id": "asa:ad-groups:list",
5743
5931
  "pluginAlias": "adapty",
5744
5932
  "pluginName": "adapty",
5745
5933
  "pluginType": "core",
@@ -5750,17 +5938,23 @@
5750
5938
  "dist",
5751
5939
  "commands",
5752
5940
  "asa",
5753
- "product-pages",
5754
- "sync.js"
5941
+ "ad-groups",
5942
+ "list.js"
5755
5943
  ]
5756
5944
  },
5757
- "asa:search-terms:list": {
5945
+ "asa:ad-groups:update": {
5758
5946
  "aliases": [],
5759
- "args": {},
5760
- "description": "List the search terms your ads matched, with their metrics",
5947
+ "args": {
5948
+ "ad_group_id": {
5949
+ "description": "Ad group ID (UUID)",
5950
+ "name": "ad_group_id",
5951
+ "required": true
5952
+ }
5953
+ },
5954
+ "description": "Change an ad group: bid, CPA goal, status or schedule",
5761
5955
  "examples": [
5762
- "<%= config.bin %> asa search-terms list --date-from 2026-07-01 --date-to 2026-07-31",
5763
- "<%= config.bin %> asa search-terms list --ad-group AD_GROUP_UUID"
5956
+ "<%= config.bin %> asa ad-groups update UUID --default-bid 1.50",
5957
+ "<%= config.bin %> asa ad-groups update UUID --status PAUSED"
5764
5958
  ],
5765
5959
  "flags": {
5766
5960
  "json": {
@@ -5770,75 +5964,84 @@
5770
5964
  "allowNo": false,
5771
5965
  "type": "boolean"
5772
5966
  },
5773
- "page": {
5774
- "description": "Page number",
5775
- "name": "page",
5776
- "default": 1,
5967
+ "currency": {
5968
+ "description": "Currency code for the amounts in this call",
5969
+ "name": "currency",
5970
+ "default": "USD",
5777
5971
  "hasDynamicHelp": false,
5778
5972
  "multiple": false,
5779
5973
  "type": "option"
5780
5974
  },
5781
- "page-size": {
5782
- "description": "Items per page (max 1000); prefer one big page over a pagination loop",
5783
- "name": "page-size",
5784
- "default": 100,
5975
+ "end-time": {
5976
+ "description": "Schedule end (YYYY-MM-DD)",
5977
+ "name": "end-time",
5785
5978
  "hasDynamicHelp": false,
5786
5979
  "multiple": false,
5787
5980
  "type": "option"
5788
5981
  },
5789
- "date-from": {
5790
- "description": "Start of the reporting period (YYYY-MM-DD), defaults to today",
5791
- "name": "date-from",
5982
+ "start-time": {
5983
+ "description": "Schedule start (YYYY-MM-DD), defaults to today",
5984
+ "name": "start-time",
5792
5985
  "hasDynamicHelp": false,
5793
5986
  "multiple": false,
5794
5987
  "type": "option"
5795
5988
  },
5796
- "date-to": {
5797
- "description": "End of the reporting period (YYYY-MM-DD), defaults to today",
5798
- "name": "date-to",
5989
+ "yes": {
5990
+ "char": "y",
5991
+ "description": "Apply without asking; required when the output is piped or --json is used",
5992
+ "name": "yes",
5993
+ "allowNo": false,
5994
+ "type": "boolean"
5995
+ },
5996
+ "idempotency-key": {
5997
+ "description": "Idempotency key for this write; re-running with the same key replays the stored result instead of applying twice",
5998
+ "name": "idempotency-key",
5799
5999
  "hasDynamicHelp": false,
5800
6000
  "multiple": false,
5801
6001
  "type": "option"
5802
6002
  },
5803
- "app": {
5804
- "description": "Keep only rows in this app; repeatable",
5805
- "name": "app",
5806
- "hasDynamicHelp": false,
5807
- "multiple": true,
5808
- "type": "option"
6003
+ "automated-keywords": {
6004
+ "description": "Let Apple add keywords automatically",
6005
+ "name": "automated-keywords",
6006
+ "allowNo": true,
6007
+ "type": "boolean"
5809
6008
  },
5810
- "campaign-group": {
5811
- "description": "Keep only rows in this campaign group; repeatable",
5812
- "name": "campaign-group",
6009
+ "cpa-goal": {
6010
+ "description": "CPA goal (amount, e.g. 50 or 12.50)",
6011
+ "name": "cpa-goal",
5813
6012
  "hasDynamicHelp": false,
5814
- "multiple": true,
6013
+ "multiple": false,
5815
6014
  "type": "option"
5816
6015
  },
5817
- "search": {
5818
- "description": "Case-insensitive substring match on the name",
5819
- "name": "search",
6016
+ "default-bid": {
6017
+ "description": "Default bid (amount, e.g. 50 or 12.50)",
6018
+ "name": "default-bid",
5820
6019
  "hasDynamicHelp": false,
5821
6020
  "multiple": false,
5822
6021
  "type": "option"
5823
6022
  },
5824
- "campaign": {
5825
- "description": "Keep only rows in this campaign; repeatable",
5826
- "name": "campaign",
6023
+ "name": {
6024
+ "description": "Ad group name",
6025
+ "name": "name",
5827
6026
  "hasDynamicHelp": false,
5828
- "multiple": true,
6027
+ "multiple": false,
5829
6028
  "type": "option"
5830
6029
  },
5831
- "ad-group": {
5832
- "description": "Keep only rows in this ad group; repeatable",
5833
- "name": "ad-group",
6030
+ "status": {
6031
+ "description": "Ad group status",
6032
+ "name": "status",
5834
6033
  "hasDynamicHelp": false,
5835
- "multiple": true,
6034
+ "multiple": false,
6035
+ "options": [
6036
+ "ENABLED",
6037
+ "PAUSED"
6038
+ ],
5836
6039
  "type": "option"
5837
6040
  }
5838
6041
  },
5839
6042
  "hasDynamicHelp": false,
5840
6043
  "hiddenAliases": [],
5841
- "id": "asa:search-terms:list",
6044
+ "id": "asa:ad-groups:update",
5842
6045
  "pluginAlias": "adapty",
5843
6046
  "pluginName": "adapty",
5844
6047
  "pluginType": "core",
@@ -5849,8 +6052,8 @@
5849
6052
  "dist",
5850
6053
  "commands",
5851
6054
  "asa",
5852
- "search-terms",
5853
- "list.js"
6055
+ "ad-groups",
6056
+ "update.js"
5854
6057
  ]
5855
6058
  },
5856
6059
  "flows:config:get": {
@@ -6157,5 +6360,5 @@
6157
6360
  ]
6158
6361
  }
6159
6362
  },
6160
- "version": "0.9.3"
6363
+ "version": "0.9.4"
6161
6364
  }