@happyvertical/smrt-ads 0.57.36 → 0.57.37
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.
- package/AGENTS.md +1 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +180 -77
- package/dist/index.js.map +1 -1
- package/dist/manifest.json +359 -24
- package/dist/models/AdDeliveryTier.d.ts.map +1 -1
- package/dist/models/AdFormat.d.ts.map +1 -1
- package/dist/models/AdGroup.d.ts.map +1 -1
- package/dist/models/AdVariation.d.ts.map +1 -1
- package/dist/recipes.d.ts +192 -0
- package/dist/recipes.d.ts.map +1 -0
- package/dist/smrt-knowledge.json +286 -33
- package/package.json +6 -6
package/dist/manifest.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"version": "1.0.0",
|
|
3
3
|
"timestamp": 0,
|
|
4
4
|
"packageName": "@happyvertical/smrt-ads",
|
|
5
|
-
"packageVersion": "0.57.
|
|
5
|
+
"packageVersion": "0.57.37",
|
|
6
6
|
"objects": {
|
|
7
7
|
"@happyvertical/smrt-ads:AdDeliveryTierCollection": {
|
|
8
8
|
"name": "addeliverytiercollection",
|
|
@@ -1348,16 +1348,28 @@
|
|
|
1348
1348
|
"name": {
|
|
1349
1349
|
"type": "text",
|
|
1350
1350
|
"required": false,
|
|
1351
|
-
"default": ""
|
|
1351
|
+
"default": "",
|
|
1352
|
+
"description": "What the tier is called, for example Sponsorship, Standard or House.",
|
|
1353
|
+
"_meta": {
|
|
1354
|
+
"description": "What the tier is called, for example Sponsorship, Standard or House."
|
|
1355
|
+
}
|
|
1352
1356
|
},
|
|
1353
1357
|
"priority": {
|
|
1354
1358
|
"type": "integer",
|
|
1355
1359
|
"required": false,
|
|
1356
|
-
"default": 0
|
|
1360
|
+
"default": 0,
|
|
1361
|
+
"description": "The order tiers are tried in: 1 is tried first, then 2, and so on.",
|
|
1362
|
+
"_meta": {
|
|
1363
|
+
"description": "The order tiers are tried in: 1 is tried first, then 2, and so on."
|
|
1364
|
+
}
|
|
1357
1365
|
},
|
|
1358
1366
|
"pricingModel": {
|
|
1359
1367
|
"type": "text",
|
|
1360
1368
|
"required": false,
|
|
1369
|
+
"description": "How ads in this tier are charged: a fixed price, per thousand showings, per click, or per sale.",
|
|
1370
|
+
"_meta": {
|
|
1371
|
+
"description": "How ads in this tier are charged: a fixed price, per thousand showings, per click, or per sale."
|
|
1372
|
+
},
|
|
1361
1373
|
"enum": [
|
|
1362
1374
|
"fixed",
|
|
1363
1375
|
"cpm",
|
|
@@ -1368,7 +1380,11 @@
|
|
|
1368
1380
|
"description": {
|
|
1369
1381
|
"type": "text",
|
|
1370
1382
|
"required": false,
|
|
1371
|
-
"default": ""
|
|
1383
|
+
"default": "",
|
|
1384
|
+
"description": "A note about what this tier is for.",
|
|
1385
|
+
"_meta": {
|
|
1386
|
+
"description": "A note about what this tier is for."
|
|
1387
|
+
}
|
|
1372
1388
|
}
|
|
1373
1389
|
},
|
|
1374
1390
|
"methods": {
|
|
@@ -1773,21 +1789,37 @@
|
|
|
1773
1789
|
"name": {
|
|
1774
1790
|
"type": "text",
|
|
1775
1791
|
"required": false,
|
|
1776
|
-
"default": ""
|
|
1792
|
+
"default": "",
|
|
1793
|
+
"description": "What the size is called, for example Leaderboard.",
|
|
1794
|
+
"_meta": {
|
|
1795
|
+
"description": "What the size is called, for example Leaderboard."
|
|
1796
|
+
}
|
|
1777
1797
|
},
|
|
1778
1798
|
"width": {
|
|
1779
1799
|
"type": "integer",
|
|
1780
1800
|
"required": false,
|
|
1781
|
-
"default": 0
|
|
1801
|
+
"default": 0,
|
|
1802
|
+
"description": "How wide the ad is, in pixels.",
|
|
1803
|
+
"_meta": {
|
|
1804
|
+
"description": "How wide the ad is, in pixels."
|
|
1805
|
+
}
|
|
1782
1806
|
},
|
|
1783
1807
|
"height": {
|
|
1784
1808
|
"type": "integer",
|
|
1785
1809
|
"required": false,
|
|
1786
|
-
"default": 0
|
|
1810
|
+
"default": 0,
|
|
1811
|
+
"description": "How tall the ad is, in pixels.",
|
|
1812
|
+
"_meta": {
|
|
1813
|
+
"description": "How tall the ad is, in pixels."
|
|
1814
|
+
}
|
|
1787
1815
|
},
|
|
1788
1816
|
"formatType": {
|
|
1789
1817
|
"type": "text",
|
|
1790
1818
|
"required": false,
|
|
1819
|
+
"description": "What kind of ad fits this size: a picture, a piece written to look like your own content, or a video.",
|
|
1820
|
+
"_meta": {
|
|
1821
|
+
"description": "What kind of ad fits this size: a picture, a piece written to look like your own content, or a video."
|
|
1822
|
+
},
|
|
1791
1823
|
"enum": [
|
|
1792
1824
|
"banner",
|
|
1793
1825
|
"native",
|
|
@@ -1797,7 +1829,11 @@
|
|
|
1797
1829
|
"description": {
|
|
1798
1830
|
"type": "text",
|
|
1799
1831
|
"required": false,
|
|
1800
|
-
"default": ""
|
|
1832
|
+
"default": "",
|
|
1833
|
+
"description": "A note about where this size is usually used.",
|
|
1834
|
+
"_meta": {
|
|
1835
|
+
"description": "A note about where this size is usually used."
|
|
1836
|
+
}
|
|
1801
1837
|
}
|
|
1802
1838
|
},
|
|
1803
1839
|
"methods": {
|
|
@@ -1970,24 +2006,38 @@
|
|
|
1970
2006
|
"type": "crossPackageRef",
|
|
1971
2007
|
"required": false,
|
|
1972
2008
|
"related": "@happyvertical/smrt-commerce:SalesContract",
|
|
2009
|
+
"description": "The sales contract this campaign is sold under, if there is one.",
|
|
1973
2010
|
"_meta": {
|
|
2011
|
+
"description": "The sales contract this campaign is sold under, if there is one.",
|
|
1974
2012
|
"validateSubtype": true
|
|
1975
2013
|
}
|
|
1976
2014
|
},
|
|
1977
2015
|
"tierId": {
|
|
1978
2016
|
"type": "foreignKey",
|
|
1979
2017
|
"required": false,
|
|
1980
|
-
"related": "AdDeliveryTier"
|
|
2018
|
+
"related": "AdDeliveryTier",
|
|
2019
|
+
"description": "The priority tier the campaign runs in. Tiers are tried in order when more than one campaign could show.",
|
|
2020
|
+
"_meta": {
|
|
2021
|
+
"description": "The priority tier the campaign runs in. Tiers are tried in order when more than one campaign could show."
|
|
2022
|
+
}
|
|
1981
2023
|
},
|
|
1982
2024
|
"name": {
|
|
1983
2025
|
"type": "text",
|
|
1984
2026
|
"required": false,
|
|
1985
|
-
"default": ""
|
|
2027
|
+
"default": "",
|
|
2028
|
+
"description": "What you call the campaign, for example Summer sale.",
|
|
2029
|
+
"_meta": {
|
|
2030
|
+
"description": "What you call the campaign, for example Summer sale."
|
|
2031
|
+
}
|
|
1986
2032
|
},
|
|
1987
2033
|
"verticalSlug": {
|
|
1988
2034
|
"type": "text",
|
|
1989
2035
|
"required": false,
|
|
1990
|
-
"default": ""
|
|
2036
|
+
"default": "",
|
|
2037
|
+
"description": "The category the campaign belongs to, such as retail.",
|
|
2038
|
+
"_meta": {
|
|
2039
|
+
"description": "The category the campaign belongs to, such as retail."
|
|
2040
|
+
}
|
|
1991
2041
|
},
|
|
1992
2042
|
"targeting": {
|
|
1993
2043
|
"type": "text",
|
|
@@ -2001,25 +2051,45 @@
|
|
|
2001
2051
|
},
|
|
2002
2052
|
"startDate": {
|
|
2003
2053
|
"type": "datetime",
|
|
2004
|
-
"required": false
|
|
2054
|
+
"required": false,
|
|
2055
|
+
"description": "The first day the campaign can show.",
|
|
2056
|
+
"_meta": {
|
|
2057
|
+
"description": "The first day the campaign can show."
|
|
2058
|
+
}
|
|
2005
2059
|
},
|
|
2006
2060
|
"endDate": {
|
|
2007
2061
|
"type": "datetime",
|
|
2008
|
-
"required": false
|
|
2062
|
+
"required": false,
|
|
2063
|
+
"description": "The last day the campaign can show.",
|
|
2064
|
+
"_meta": {
|
|
2065
|
+
"description": "The last day the campaign can show."
|
|
2066
|
+
}
|
|
2009
2067
|
},
|
|
2010
2068
|
"dailyBudget": {
|
|
2011
2069
|
"type": "decimal",
|
|
2012
2070
|
"required": false,
|
|
2013
|
-
"default": 0
|
|
2071
|
+
"default": 0,
|
|
2072
|
+
"description": "The most to spend in one day. The app shows this but does not stop the campaign by itself.",
|
|
2073
|
+
"_meta": {
|
|
2074
|
+
"description": "The most to spend in one day. The app shows this but does not stop the campaign by itself."
|
|
2075
|
+
}
|
|
2014
2076
|
},
|
|
2015
2077
|
"totalBudget": {
|
|
2016
2078
|
"type": "decimal",
|
|
2017
2079
|
"required": false,
|
|
2018
|
-
"default": 0
|
|
2080
|
+
"default": 0,
|
|
2081
|
+
"description": "The most to spend over the whole campaign.",
|
|
2082
|
+
"_meta": {
|
|
2083
|
+
"description": "The most to spend over the whole campaign."
|
|
2084
|
+
}
|
|
2019
2085
|
},
|
|
2020
2086
|
"status": {
|
|
2021
2087
|
"type": "text",
|
|
2022
2088
|
"required": false,
|
|
2089
|
+
"description": "Where the campaign stands: draft, active, paused or completed. Only active campaigns show ads.",
|
|
2090
|
+
"_meta": {
|
|
2091
|
+
"description": "Where the campaign stands: draft, active, paused or completed. Only active campaigns show ads."
|
|
2092
|
+
},
|
|
2023
2093
|
"enum": [
|
|
2024
2094
|
"draft",
|
|
2025
2095
|
"active",
|
|
@@ -2379,41 +2449,73 @@
|
|
|
2379
2449
|
"groupId": {
|
|
2380
2450
|
"type": "foreignKey",
|
|
2381
2451
|
"required": false,
|
|
2382
|
-
"related": "AdGroup"
|
|
2452
|
+
"related": "AdGroup",
|
|
2453
|
+
"description": "The campaign this ad belongs to.",
|
|
2454
|
+
"_meta": {
|
|
2455
|
+
"description": "The campaign this ad belongs to."
|
|
2456
|
+
}
|
|
2383
2457
|
},
|
|
2384
2458
|
"formatId": {
|
|
2385
2459
|
"type": "foreignKey",
|
|
2386
2460
|
"required": false,
|
|
2387
|
-
"related": "AdFormat"
|
|
2461
|
+
"related": "AdFormat",
|
|
2462
|
+
"description": "The ad size this ad is made for.",
|
|
2463
|
+
"_meta": {
|
|
2464
|
+
"description": "The ad size this ad is made for."
|
|
2465
|
+
}
|
|
2388
2466
|
},
|
|
2389
2467
|
"assetId": {
|
|
2390
2468
|
"type": "crossPackageRef",
|
|
2391
2469
|
"required": false,
|
|
2392
|
-
"related": "@happyvertical/smrt-assets:Asset"
|
|
2470
|
+
"related": "@happyvertical/smrt-assets:Asset",
|
|
2471
|
+
"description": "The picture people see.",
|
|
2472
|
+
"_meta": {
|
|
2473
|
+
"description": "The picture people see."
|
|
2474
|
+
}
|
|
2393
2475
|
},
|
|
2394
2476
|
"name": {
|
|
2395
2477
|
"type": "text",
|
|
2396
2478
|
"required": false,
|
|
2397
|
-
"default": ""
|
|
2479
|
+
"default": "",
|
|
2480
|
+
"description": "What you call this ad, for example Version A, blue button.",
|
|
2481
|
+
"_meta": {
|
|
2482
|
+
"description": "What you call this ad, for example Version A, blue button."
|
|
2483
|
+
}
|
|
2398
2484
|
},
|
|
2399
2485
|
"clickUrl": {
|
|
2400
2486
|
"type": "text",
|
|
2401
2487
|
"required": false,
|
|
2402
|
-
"default": ""
|
|
2488
|
+
"default": "",
|
|
2489
|
+
"description": "The web address people go to when they tap the ad.",
|
|
2490
|
+
"_meta": {
|
|
2491
|
+
"description": "The web address people go to when they tap the ad."
|
|
2492
|
+
}
|
|
2403
2493
|
},
|
|
2404
2494
|
"altText": {
|
|
2405
2495
|
"type": "text",
|
|
2406
2496
|
"required": false,
|
|
2407
|
-
"default": ""
|
|
2497
|
+
"default": "",
|
|
2498
|
+
"description": "A few words that describe the picture for people who cannot see it.",
|
|
2499
|
+
"_meta": {
|
|
2500
|
+
"description": "A few words that describe the picture for people who cannot see it."
|
|
2501
|
+
}
|
|
2408
2502
|
},
|
|
2409
2503
|
"weight": {
|
|
2410
2504
|
"type": "integer",
|
|
2411
2505
|
"required": false,
|
|
2412
|
-
"default": 1
|
|
2506
|
+
"default": 1,
|
|
2507
|
+
"description": "How often this ad shows compared with the others in its campaign: an ad with weight 2 shows twice as often as one with weight 1.",
|
|
2508
|
+
"_meta": {
|
|
2509
|
+
"description": "How often this ad shows compared with the others in its campaign: an ad with weight 2 shows twice as often as one with weight 1."
|
|
2510
|
+
}
|
|
2413
2511
|
},
|
|
2414
2512
|
"status": {
|
|
2415
2513
|
"type": "text",
|
|
2416
2514
|
"required": false,
|
|
2515
|
+
"description": "Where the ad stands: draft, active or paused. Only active ads show.",
|
|
2516
|
+
"_meta": {
|
|
2517
|
+
"description": "Where the ad stands: draft, active or paused. Only active ads show."
|
|
2518
|
+
},
|
|
2417
2519
|
"enum": [
|
|
2418
2520
|
"draft",
|
|
2419
2521
|
"active",
|
|
@@ -2423,12 +2525,20 @@
|
|
|
2423
2525
|
"impressions": {
|
|
2424
2526
|
"type": "integer",
|
|
2425
2527
|
"required": false,
|
|
2426
|
-
"default": 0
|
|
2528
|
+
"default": 0,
|
|
2529
|
+
"description": "How many times the ad has been shown. The app counts this as it serves ads and refreshes it a little later.",
|
|
2530
|
+
"_meta": {
|
|
2531
|
+
"description": "How many times the ad has been shown. The app counts this as it serves ads and refreshes it a little later."
|
|
2532
|
+
}
|
|
2427
2533
|
},
|
|
2428
2534
|
"clicks": {
|
|
2429
2535
|
"type": "integer",
|
|
2430
2536
|
"required": false,
|
|
2431
|
-
"default": 0
|
|
2537
|
+
"default": 0,
|
|
2538
|
+
"description": "How many times the ad has been tapped. The app counts this as it serves ads and refreshes it a little later.",
|
|
2539
|
+
"_meta": {
|
|
2540
|
+
"description": "How many times the ad has been tapped. The app counts this as it serves ads and refreshes it a little later."
|
|
2541
|
+
}
|
|
2432
2542
|
}
|
|
2433
2543
|
},
|
|
2434
2544
|
"methods": {
|
|
@@ -2669,6 +2779,231 @@
|
|
|
2669
2779
|
}
|
|
2670
2780
|
},
|
|
2671
2781
|
"moduleType": "smrt",
|
|
2782
|
+
"recipes": [
|
|
2783
|
+
{
|
|
2784
|
+
"id": "ads.campaigns",
|
|
2785
|
+
"className": "AdsCampaignsRecipe",
|
|
2786
|
+
"label": "Ads",
|
|
2787
|
+
"summary": "Run ad campaigns on your site, choose which ads show where, and see which ones get clicked.",
|
|
2788
|
+
"synonyms": [
|
|
2789
|
+
"ads",
|
|
2790
|
+
"advertising",
|
|
2791
|
+
"ad campaigns",
|
|
2792
|
+
"banner ads",
|
|
2793
|
+
"advertisements",
|
|
2794
|
+
"display ads"
|
|
2795
|
+
],
|
|
2796
|
+
"models": [
|
|
2797
|
+
"@happyvertical/smrt-ads:AdGroup",
|
|
2798
|
+
"@happyvertical/smrt-ads:AdVariation",
|
|
2799
|
+
"@happyvertical/smrt-ads:AdFormat",
|
|
2800
|
+
"@happyvertical/smrt-ads:AdDeliveryTier"
|
|
2801
|
+
],
|
|
2802
|
+
"nav": [
|
|
2803
|
+
{
|
|
2804
|
+
"label": "Ad campaigns",
|
|
2805
|
+
"model": "@happyvertical/smrt-ads:AdGroup",
|
|
2806
|
+
"icon": "tag",
|
|
2807
|
+
"description": "Each campaign you run, with its dates, budget and where it stands.",
|
|
2808
|
+
"noun": "ad campaign"
|
|
2809
|
+
},
|
|
2810
|
+
{
|
|
2811
|
+
"label": "Ads",
|
|
2812
|
+
"model": "@happyvertical/smrt-ads:AdVariation",
|
|
2813
|
+
"icon": "fileText",
|
|
2814
|
+
"description": "The ads inside each campaign, how often each shows and how many clicks it got.",
|
|
2815
|
+
"noun": "ad"
|
|
2816
|
+
},
|
|
2817
|
+
{
|
|
2818
|
+
"label": "Ad sizes",
|
|
2819
|
+
"model": "@happyvertical/smrt-ads:AdFormat",
|
|
2820
|
+
"icon": "layers",
|
|
2821
|
+
"description": "The shapes and sizes an ad can be, shared by every campaign.",
|
|
2822
|
+
"noun": "ad size"
|
|
2823
|
+
},
|
|
2824
|
+
{
|
|
2825
|
+
"label": "Priority tiers",
|
|
2826
|
+
"model": "@happyvertical/smrt-ads:AdDeliveryTier",
|
|
2827
|
+
"icon": "settings",
|
|
2828
|
+
"description": "The order campaigns are tried in when more than one could show.",
|
|
2829
|
+
"noun": "tier"
|
|
2830
|
+
}
|
|
2831
|
+
],
|
|
2832
|
+
"requires": [],
|
|
2833
|
+
"section": {
|
|
2834
|
+
"id": "grow",
|
|
2835
|
+
"label": "Grow",
|
|
2836
|
+
"icon": "tag",
|
|
2837
|
+
"description": "Bring in new customers and reward the people who help."
|
|
2838
|
+
},
|
|
2839
|
+
"options": {
|
|
2840
|
+
"@happyvertical/smrt-ads:AdGroup": {
|
|
2841
|
+
"fields": {
|
|
2842
|
+
"name": {
|
|
2843
|
+
"order": 1
|
|
2844
|
+
},
|
|
2845
|
+
"status": {
|
|
2846
|
+
"order": 2
|
|
2847
|
+
},
|
|
2848
|
+
"tierId": {
|
|
2849
|
+
"label": "Priority tier",
|
|
2850
|
+
"order": 3
|
|
2851
|
+
},
|
|
2852
|
+
"startDate": {
|
|
2853
|
+
"label": "Starts on",
|
|
2854
|
+
"order": 4
|
|
2855
|
+
},
|
|
2856
|
+
"endDate": {
|
|
2857
|
+
"label": "Ends on",
|
|
2858
|
+
"order": 5
|
|
2859
|
+
},
|
|
2860
|
+
"dailyBudget": {
|
|
2861
|
+
"label": "Daily budget",
|
|
2862
|
+
"order": 6
|
|
2863
|
+
},
|
|
2864
|
+
"totalBudget": {
|
|
2865
|
+
"label": "Total budget",
|
|
2866
|
+
"order": 7
|
|
2867
|
+
},
|
|
2868
|
+
"tenantId": {
|
|
2869
|
+
"visibility": "hidden"
|
|
2870
|
+
},
|
|
2871
|
+
"contractId": {
|
|
2872
|
+
"label": "Sales contract",
|
|
2873
|
+
"visibility": "advanced"
|
|
2874
|
+
},
|
|
2875
|
+
"verticalSlug": {
|
|
2876
|
+
"label": "Category",
|
|
2877
|
+
"visibility": "advanced"
|
|
2878
|
+
},
|
|
2879
|
+
"targeting": {
|
|
2880
|
+
"visibility": "hidden"
|
|
2881
|
+
},
|
|
2882
|
+
"zoneIds": {
|
|
2883
|
+
"visibility": "hidden"
|
|
2884
|
+
}
|
|
2885
|
+
}
|
|
2886
|
+
},
|
|
2887
|
+
"@happyvertical/smrt-ads:AdVariation": {
|
|
2888
|
+
"fields": {
|
|
2889
|
+
"name": {
|
|
2890
|
+
"order": 1
|
|
2891
|
+
},
|
|
2892
|
+
"groupId": {
|
|
2893
|
+
"label": "Ad campaign",
|
|
2894
|
+
"order": 2
|
|
2895
|
+
},
|
|
2896
|
+
"formatId": {
|
|
2897
|
+
"label": "Ad size",
|
|
2898
|
+
"order": 3
|
|
2899
|
+
},
|
|
2900
|
+
"assetId": {
|
|
2901
|
+
"label": "Picture",
|
|
2902
|
+
"order": 4
|
|
2903
|
+
},
|
|
2904
|
+
"clickUrl": {
|
|
2905
|
+
"label": "Link to",
|
|
2906
|
+
"order": 5
|
|
2907
|
+
},
|
|
2908
|
+
"altText": {
|
|
2909
|
+
"label": "Words for the picture",
|
|
2910
|
+
"order": 6
|
|
2911
|
+
},
|
|
2912
|
+
"weight": {
|
|
2913
|
+
"order": 7
|
|
2914
|
+
},
|
|
2915
|
+
"status": {
|
|
2916
|
+
"order": 8
|
|
2917
|
+
},
|
|
2918
|
+
"tenantId": {
|
|
2919
|
+
"visibility": "hidden"
|
|
2920
|
+
},
|
|
2921
|
+
"impressions": {
|
|
2922
|
+
"label": "Times shown",
|
|
2923
|
+
"locked": true,
|
|
2924
|
+
"visibility": "advanced"
|
|
2925
|
+
},
|
|
2926
|
+
"clicks": {
|
|
2927
|
+
"locked": true,
|
|
2928
|
+
"visibility": "advanced"
|
|
2929
|
+
}
|
|
2930
|
+
}
|
|
2931
|
+
},
|
|
2932
|
+
"@happyvertical/smrt-ads:AdFormat": {
|
|
2933
|
+
"fields": {
|
|
2934
|
+
"name": {
|
|
2935
|
+
"order": 1
|
|
2936
|
+
},
|
|
2937
|
+
"width": {
|
|
2938
|
+
"order": 2
|
|
2939
|
+
},
|
|
2940
|
+
"height": {
|
|
2941
|
+
"order": 3
|
|
2942
|
+
},
|
|
2943
|
+
"formatType": {
|
|
2944
|
+
"label": "Kind",
|
|
2945
|
+
"order": 4
|
|
2946
|
+
},
|
|
2947
|
+
"description": {
|
|
2948
|
+
"order": 5
|
|
2949
|
+
}
|
|
2950
|
+
}
|
|
2951
|
+
},
|
|
2952
|
+
"@happyvertical/smrt-ads:AdDeliveryTier": {
|
|
2953
|
+
"fields": {
|
|
2954
|
+
"name": {
|
|
2955
|
+
"order": 1
|
|
2956
|
+
},
|
|
2957
|
+
"priority": {
|
|
2958
|
+
"order": 2
|
|
2959
|
+
},
|
|
2960
|
+
"pricingModel": {
|
|
2961
|
+
"label": "How it is charged",
|
|
2962
|
+
"order": 3
|
|
2963
|
+
},
|
|
2964
|
+
"description": {
|
|
2965
|
+
"order": 4
|
|
2966
|
+
}
|
|
2967
|
+
}
|
|
2968
|
+
}
|
|
2969
|
+
},
|
|
2970
|
+
"help": {
|
|
2971
|
+
"markdown": "## Overview\n\nAds is where you run advertising on your own site. An ad campaign sets the\ndates, the budget and the priority tier; the ads inside it are the pictures\npeople actually see, each with a link. When a campaign has more than one ad,\nthe app shares the showings between them by weight, so you can try two\nversions and see which gets more clicks.\n\nAd sizes and priority tiers are shared lists. Set them up once; every campaign\npicks from them. When more than one campaign could show in the same place, the\ntier decides which is tried first.\n\nThe app counts every showing and click as it serves the ads. Those counts are\nrefreshed on the ad a little later; you read them, you do not type them.\n\n## Tasks\n\n### Add an ad size\n\n1. Open the ad sizes and choose **New**.\n2. Type the **{field:AdFormat.name}**, for example \"Leaderboard\".\n3. Enter the **{field:AdFormat.width}** and **{field:AdFormat.height}**.\n4. Pick the **{field:AdFormat.formatType}**: a picture, a piece written to look like your own content, or a video.\n5. Save. The usual sizes are 728 by 90, 300 by 250 and 320 by 50.\n\n### Set up the priority tiers\n\n1. Open the priority tiers and choose **New**.\n2. Type the **{field:AdDeliveryTier.name}**, for example \"Sponsorship\", \"Standard\" or \"House\".\n3. Set the **{field:AdDeliveryTier.priority}**: 1 is tried first, then 2, then 3.\n4. Pick **{field:AdDeliveryTier.pricingModel}** to say how ads in this tier are charged.\n5. Save. A \"House\" tier with the last priority is a good place for your own ads, so something always shows.\n\n### Start an ad campaign\n\n1. Open the ad campaigns and choose **New**.\n2. Type the **{field:AdGroup.name}**, for example \"Summer sale\".\n3. Pick the **{field:AdGroup.tierId}** it runs in.\n4. Set when it **{field:AdGroup.startDate}** and **{field:AdGroup.endDate}**.\n5. Enter the **{field:AdGroup.dailyBudget}** and the **{field:AdGroup.totalBudget}**. The app does not stop a campaign at its budget by itself; keep an eye on the counts.\n6. Leave the **{field:AdGroup.status}** as draft until the ads are ready, then set it to active.\n7. Save.\n\n### Add an ad to a campaign\n\n1. Open the ads and choose **New**.\n2. Type the **{field:AdVariation.name}**, for example \"Version A, blue button\".\n3. Pick the **{field:AdVariation.groupId}** it belongs to and the **{field:AdVariation.formatId}** it is made for.\n4. Choose the **{field:AdVariation.assetId}** people will see.\n5. Enter the web address it should **{field:AdVariation.clickUrl}** when someone taps it.\n6. Write a few **{field:AdVariation.altText}** for people who cannot see the picture.\n7. Set the **{field:AdVariation.weight}**. An ad with weight 2 shows twice as often as one with weight 1 in the same campaign.\n8. Set the **{field:AdVariation.status}** to active when it is ready to show.\n9. Save.\n\n### Pause or finish a campaign\n\n1. Open the ad campaign.\n2. Change the **{field:AdGroup.status}** to paused to stop it for now, or to completed when it is over.\n3. Save. The ads in it stop showing straight away.\n\n### See which ad is doing better\n\n1. Open the ads and find the ads in one campaign.\n2. Compare the **{field:AdVariation.impressions}** and **{field:AdVariation.clicks}** of each. These are counted by the app as it serves the ads and refreshed a little later.\n3. Give the better ad a higher **{field:AdVariation.weight}**, or pause the weaker one by changing its **{field:AdVariation.status}**.\n",
|
|
2972
|
+
"fieldRefs": [
|
|
2973
|
+
"AdDeliveryTier.name",
|
|
2974
|
+
"AdDeliveryTier.pricingModel",
|
|
2975
|
+
"AdDeliveryTier.priority",
|
|
2976
|
+
"AdFormat.formatType",
|
|
2977
|
+
"AdFormat.height",
|
|
2978
|
+
"AdFormat.name",
|
|
2979
|
+
"AdFormat.width",
|
|
2980
|
+
"AdGroup.dailyBudget",
|
|
2981
|
+
"AdGroup.endDate",
|
|
2982
|
+
"AdGroup.name",
|
|
2983
|
+
"AdGroup.startDate",
|
|
2984
|
+
"AdGroup.status",
|
|
2985
|
+
"AdGroup.tierId",
|
|
2986
|
+
"AdGroup.totalBudget",
|
|
2987
|
+
"AdVariation.altText",
|
|
2988
|
+
"AdVariation.assetId",
|
|
2989
|
+
"AdVariation.clickUrl",
|
|
2990
|
+
"AdVariation.clicks",
|
|
2991
|
+
"AdVariation.formatId",
|
|
2992
|
+
"AdVariation.groupId",
|
|
2993
|
+
"AdVariation.impressions",
|
|
2994
|
+
"AdVariation.name",
|
|
2995
|
+
"AdVariation.status",
|
|
2996
|
+
"AdVariation.weight"
|
|
2997
|
+
]
|
|
2998
|
+
},
|
|
2999
|
+
"demo": {
|
|
3000
|
+
"mode": "server",
|
|
3001
|
+
"reasons": [
|
|
3002
|
+
"Needs a server because its package depends on @happyvertical/smrt-tenancy, which do not build for a browser (#3624)."
|
|
3003
|
+
]
|
|
3004
|
+
}
|
|
3005
|
+
}
|
|
3006
|
+
],
|
|
2672
3007
|
"smrtDependencies": [
|
|
2673
3008
|
"@happyvertical/smrt-commerce",
|
|
2674
3009
|
"@happyvertical/smrt-core",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AdDeliveryTier.d.ts","sourceRoot":"","sources":["../../src/models/AdDeliveryTier.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,
|
|
1
|
+
{"version":3,"file":"AdDeliveryTier.d.ts","sourceRoot":"","sources":["../../src/models/AdDeliveryTier.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEL,UAAU,EACV,KAAK,iBAAiB,EAEvB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,iBAAiB;IAC9D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;GAiBG;AAQH,qBAKa,cAAe,SAAQ,UAAU;IAC5C;;OAEG;IAKH,IAAI,EAAE,MAAM,CAAM;IAElB;;OAEG;IAKH,QAAQ,EAAE,MAAM,CAAK;IAErB;;OAEG;IAKH,YAAY,EAAE,YAAY,CAAoB;IAE9C;;OAEG;IAEH,WAAW,EAAE,MAAM,CAAM;gBAEb,OAAO,GAAE,qBAA0B;IAU/C;;OAEG;IACH,oBAAoB,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO;IAIpD;;OAEG;IACH,cAAc,IAAI,OAAO;IAIzB;;OAEG;IACH,kBAAkB,IAAI,OAAO;CAM9B;AAED,eAAe,cAAc,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AdFormat.d.ts","sourceRoot":"","sources":["../../src/models/AdFormat.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,
|
|
1
|
+
{"version":3,"file":"AdFormat.d.ts","sourceRoot":"","sources":["../../src/models/AdFormat.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAEL,UAAU,EACV,KAAK,iBAAiB,EAEvB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEjD;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,iBAAiB;IACxD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,YAAY,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;GAYG;AAOH,qBAKa,QAAS,SAAQ,UAAU;IACtC;;OAEG;IAEH,IAAI,EAAE,MAAM,CAAM;IAElB;;OAEG;IAEH,KAAK,EAAE,MAAM,CAAK;IAElB;;OAEG;IAEH,MAAM,EAAE,MAAM,CAAK;IAEnB;;OAEG;IAKH,UAAU,EAAE,YAAY,CAAuB;IAE/C;;OAEG;IAEH,WAAW,EAAE,MAAM,CAAM;gBAEb,OAAO,GAAE,eAAoB;IAUzC;;OAEG;IACH,aAAa,IAAI,MAAM;IAIvB;;OAEG;IACH,iBAAiB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO;CAG1D;AAED,eAAe,QAAQ,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AdGroup.d.ts","sourceRoot":"","sources":["../../src/models/AdGroup.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,
|
|
1
|
+
{"version":3,"file":"AdGroup.d.ts","sourceRoot":"","sources":["../../src/models/AdGroup.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAIL,UAAU,EACV,KAAK,iBAAiB,EAEvB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,iBAAiB;IACvD,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACxB,OAAO,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,aAAa,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,qBAOa,OAAQ,SAAQ,UAAU;IACrC;;OAEG;IAEH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAQ;IAE/B;;OAEG;IAQH,UAAU,EAAE,MAAM,CAAM;IAExB;;OAEG;IAMH,MAAM,EAAE,MAAM,CAAM;IAEpB;;OAEG;IAIH,IAAI,EAAE,MAAM,CAAM;IAElB;;OAEG;IAIH,YAAY,EAAE,MAAM,CAAM;IAE1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAM;IAEvB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAM;IAErB;;OAEG;IAEH,SAAS,EAAE,IAAI,GAAG,IAAI,CAAQ;IAE9B;;OAEG;IAEH,OAAO,EAAE,IAAI,GAAG,IAAI,CAAQ;IAE5B;;OAEG;IAKH,WAAW,EAAE,MAAM,CAAO;IAE1B;;OAEG;IAEH,WAAW,EAAE,MAAM,CAAO;IAE1B;;OAEG;IAKH,MAAM,EAAE,aAAa,CAAuB;gBAEhC,OAAO,GAAE,cAAmB;IAmBxC;;OAEG;IACH,UAAU,IAAI,MAAM,EAAE;IAStB;;OAEG;IACH,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,IAAI;IAI/B;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAQ/B;;OAEG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAKlC;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAIlC;;OAEG;IACH,YAAY,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IASvC;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAIlD;;OAEG;IACH,QAAQ,IAAI,OAAO;IAQnB;;OAEG;IACH,OAAO,IAAI,OAAO;IAIlB;;OAEG;IACH,QAAQ,IAAI,OAAO;IAInB;;OAEG;IACH,WAAW,IAAI,OAAO;IAItB;;OAEG;IACH,QAAQ,IAAI,OAAO;IAKnB;;OAEG;IACH,UAAU,IAAI,OAAO;CAItB;AAED,eAAe,OAAO,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AdVariation.d.ts","sourceRoot":"","sources":["../../src/models/AdVariation.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,
|
|
1
|
+
{"version":3,"file":"AdVariation.d.ts","sourceRoot":"","sources":["../../src/models/AdVariation.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAIL,UAAU,EACV,KAAK,iBAAiB,EAEvB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEtD;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,iBAAiB;IAC3D,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAOa,WAAY,SAAQ,UAAU;IACzC;;OAEG;IAEH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAQ;IAE/B;;OAEG;IAGH,OAAO,EAAE,MAAM,CAAM;IAErB;;OAEG;IAGH,QAAQ,EAAE,MAAM,CAAM;IAEtB;;OAEG;IAGH,OAAO,EAAE,MAAM,CAAM;IAErB;;OAEG;IAIH,IAAI,EAAE,MAAM,CAAM;IAElB;;OAEG;IAEH,QAAQ,EAAE,MAAM,CAAM;IAEtB;;OAEG;IAKH,OAAO,EAAE,MAAM,CAAM;IAErB;;OAEG;IAKH,MAAM,EAAE,MAAM,CAAK;IAEnB;;OAEG;IAKH,MAAM,EAAE,iBAAiB,CAA2B;IAEpD;;OAEG;IAKH,WAAW,EAAE,MAAM,CAAK;IAExB;;OAEG;IAKH,MAAM,EAAE,MAAM,CAAK;gBAEP,OAAO,GAAE,kBAAuB;IAgB5C;;OAEG;IACH,QAAQ,IAAI,OAAO;IAInB;;OAEG;IACH,OAAO,IAAI,OAAO;IAIlB;;OAEG;IACH,QAAQ,IAAI,OAAO;IAInB;;OAEG;IACH,MAAM,IAAI,MAAM;IAKhB;;OAEG;IACH,gBAAgB,IAAI,IAAI;IAIxB;;OAEG;IACH,WAAW,IAAI,IAAI;CAGpB;AAED,eAAe,WAAW,CAAC"}
|