@zernio/node 0.2.314 → 0.2.315
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/dist/index.d.mts +41 -2
- package/dist/index.d.ts +41 -2
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/types.gen.ts +41 -2
package/dist/index.d.mts
CHANGED
|
@@ -1246,8 +1246,11 @@ type budgetLevel = 'campaign' | 'adset';
|
|
|
1246
1246
|
* One day of metrics. Same fields as `AdMetrics` plus the `date` they
|
|
1247
1247
|
* apply to. Returned inside a node's `daily[]` when `GET /v1/ads/tree` is
|
|
1248
1248
|
* called with `timeIncrement=1`. Rate metrics (ctr/cpc/cpm/costPerConversion/
|
|
1249
|
-
* roas) are recomputed per day from that day's
|
|
1250
|
-
* fields across a node's `daily[]` reproduces
|
|
1249
|
+
* roas/videoAvgTimeWatchedActions) are recomputed per day from that day's
|
|
1250
|
+
* sums, so summing the additive fields across a node's `daily[]` reproduces
|
|
1251
|
+
* its aggregated `metrics` total. Do NOT sum or plain-average
|
|
1252
|
+
* `videoAvgTimeWatchedActions` across days: the range value is the
|
|
1253
|
+
* play-weighted average of the daily values.
|
|
1251
1254
|
*
|
|
1252
1255
|
*/
|
|
1253
1256
|
type AdDailyMetrics = AdMetrics & {
|
|
@@ -1302,6 +1305,42 @@ type AdMetrics = {
|
|
|
1302
1305
|
* Return on ad spend — derived as `purchaseValue / spend`. 0 when `spend` is 0. Equivalent to Meta's `purchase_roas` under default attribution. At ad-set and campaign levels this is recomputed from summed purchaseValue + spend (NOT averaged across children) so it's mathematically correct at every rollup level.
|
|
1303
1306
|
*/
|
|
1304
1307
|
roas?: number;
|
|
1308
|
+
/**
|
|
1309
|
+
* Meta video ads only (0 for non-video ads and other platforms), like all video* fields below. Number of times the video started playing (Meta `video_play_actions`), summed over the date range and across children at ad-set/campaign level.
|
|
1310
|
+
*/
|
|
1311
|
+
videoPlayActions?: number;
|
|
1312
|
+
/**
|
|
1313
|
+
* Views of at least 30 seconds (or to the end, for shorter videos). Meta `video_30_sec_watched_actions`.
|
|
1314
|
+
*/
|
|
1315
|
+
video30SecWatchedActions?: number;
|
|
1316
|
+
/**
|
|
1317
|
+
* ThruPlays (watched to completion, or at least 15 seconds). Meta `video_thruplay_watched_actions`.
|
|
1318
|
+
*/
|
|
1319
|
+
videoThruplayWatchedActions?: number;
|
|
1320
|
+
/**
|
|
1321
|
+
* Views reaching 25% of the video's length. With the other percentile fields, powers hook/hold/drop-off analysis (e.g. hook rate = videoP25WatchedActions / videoPlayActions). Meta `video_p25_watched_actions`.
|
|
1322
|
+
*/
|
|
1323
|
+
videoP25WatchedActions?: number;
|
|
1324
|
+
/**
|
|
1325
|
+
* Views reaching 50% of the video's length. Meta `video_p50_watched_actions`.
|
|
1326
|
+
*/
|
|
1327
|
+
videoP50WatchedActions?: number;
|
|
1328
|
+
/**
|
|
1329
|
+
* Views reaching 75% of the video's length. Meta `video_p75_watched_actions`.
|
|
1330
|
+
*/
|
|
1331
|
+
videoP75WatchedActions?: number;
|
|
1332
|
+
/**
|
|
1333
|
+
* Views reaching 95% of the video's length. Meta `video_p95_watched_actions`.
|
|
1334
|
+
*/
|
|
1335
|
+
videoP95WatchedActions?: number;
|
|
1336
|
+
/**
|
|
1337
|
+
* Views reaching 100% of the video's length. Meta `video_p100_watched_actions`.
|
|
1338
|
+
*/
|
|
1339
|
+
videoP100WatchedActions?: number;
|
|
1340
|
+
/**
|
|
1341
|
+
* Average seconds watched per play (Meta `video_avg_time_watched_actions`). Aggregated over date ranges and across children as a play-weighted average (total watch time / total plays), never a plain average of averages.
|
|
1342
|
+
*/
|
|
1343
|
+
videoAvgTimeWatchedActions?: number;
|
|
1305
1344
|
/**
|
|
1306
1345
|
* Present on individual ads only, not on campaign aggregations
|
|
1307
1346
|
*/
|
package/dist/index.d.ts
CHANGED
|
@@ -1246,8 +1246,11 @@ type budgetLevel = 'campaign' | 'adset';
|
|
|
1246
1246
|
* One day of metrics. Same fields as `AdMetrics` plus the `date` they
|
|
1247
1247
|
* apply to. Returned inside a node's `daily[]` when `GET /v1/ads/tree` is
|
|
1248
1248
|
* called with `timeIncrement=1`. Rate metrics (ctr/cpc/cpm/costPerConversion/
|
|
1249
|
-
* roas) are recomputed per day from that day's
|
|
1250
|
-
* fields across a node's `daily[]` reproduces
|
|
1249
|
+
* roas/videoAvgTimeWatchedActions) are recomputed per day from that day's
|
|
1250
|
+
* sums, so summing the additive fields across a node's `daily[]` reproduces
|
|
1251
|
+
* its aggregated `metrics` total. Do NOT sum or plain-average
|
|
1252
|
+
* `videoAvgTimeWatchedActions` across days: the range value is the
|
|
1253
|
+
* play-weighted average of the daily values.
|
|
1251
1254
|
*
|
|
1252
1255
|
*/
|
|
1253
1256
|
type AdDailyMetrics = AdMetrics & {
|
|
@@ -1302,6 +1305,42 @@ type AdMetrics = {
|
|
|
1302
1305
|
* Return on ad spend — derived as `purchaseValue / spend`. 0 when `spend` is 0. Equivalent to Meta's `purchase_roas` under default attribution. At ad-set and campaign levels this is recomputed from summed purchaseValue + spend (NOT averaged across children) so it's mathematically correct at every rollup level.
|
|
1303
1306
|
*/
|
|
1304
1307
|
roas?: number;
|
|
1308
|
+
/**
|
|
1309
|
+
* Meta video ads only (0 for non-video ads and other platforms), like all video* fields below. Number of times the video started playing (Meta `video_play_actions`), summed over the date range and across children at ad-set/campaign level.
|
|
1310
|
+
*/
|
|
1311
|
+
videoPlayActions?: number;
|
|
1312
|
+
/**
|
|
1313
|
+
* Views of at least 30 seconds (or to the end, for shorter videos). Meta `video_30_sec_watched_actions`.
|
|
1314
|
+
*/
|
|
1315
|
+
video30SecWatchedActions?: number;
|
|
1316
|
+
/**
|
|
1317
|
+
* ThruPlays (watched to completion, or at least 15 seconds). Meta `video_thruplay_watched_actions`.
|
|
1318
|
+
*/
|
|
1319
|
+
videoThruplayWatchedActions?: number;
|
|
1320
|
+
/**
|
|
1321
|
+
* Views reaching 25% of the video's length. With the other percentile fields, powers hook/hold/drop-off analysis (e.g. hook rate = videoP25WatchedActions / videoPlayActions). Meta `video_p25_watched_actions`.
|
|
1322
|
+
*/
|
|
1323
|
+
videoP25WatchedActions?: number;
|
|
1324
|
+
/**
|
|
1325
|
+
* Views reaching 50% of the video's length. Meta `video_p50_watched_actions`.
|
|
1326
|
+
*/
|
|
1327
|
+
videoP50WatchedActions?: number;
|
|
1328
|
+
/**
|
|
1329
|
+
* Views reaching 75% of the video's length. Meta `video_p75_watched_actions`.
|
|
1330
|
+
*/
|
|
1331
|
+
videoP75WatchedActions?: number;
|
|
1332
|
+
/**
|
|
1333
|
+
* Views reaching 95% of the video's length. Meta `video_p95_watched_actions`.
|
|
1334
|
+
*/
|
|
1335
|
+
videoP95WatchedActions?: number;
|
|
1336
|
+
/**
|
|
1337
|
+
* Views reaching 100% of the video's length. Meta `video_p100_watched_actions`.
|
|
1338
|
+
*/
|
|
1339
|
+
videoP100WatchedActions?: number;
|
|
1340
|
+
/**
|
|
1341
|
+
* Average seconds watched per play (Meta `video_avg_time_watched_actions`). Aggregated over date ranges and across children as a play-weighted average (total watch time / total plays), never a plain average of averages.
|
|
1342
|
+
*/
|
|
1343
|
+
videoAvgTimeWatchedActions?: number;
|
|
1305
1344
|
/**
|
|
1306
1345
|
* Present on individual ads only, not on campaign aggregations
|
|
1307
1346
|
*/
|
package/dist/index.js
CHANGED
|
@@ -36,7 +36,7 @@ module.exports = __toCommonJS(index_exports);
|
|
|
36
36
|
// package.json
|
|
37
37
|
var package_default = {
|
|
38
38
|
name: "@zernio/node",
|
|
39
|
-
version: "0.2.
|
|
39
|
+
version: "0.2.315",
|
|
40
40
|
description: "The official Node.js library for the Zernio API",
|
|
41
41
|
main: "dist/index.js",
|
|
42
42
|
module: "dist/index.mjs",
|
package/dist/index.mjs
CHANGED
|
@@ -5,7 +5,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
|
|
|
5
5
|
// package.json
|
|
6
6
|
var package_default = {
|
|
7
7
|
name: "@zernio/node",
|
|
8
|
-
version: "0.2.
|
|
8
|
+
version: "0.2.315",
|
|
9
9
|
description: "The official Node.js library for the Zernio API",
|
|
10
10
|
main: "dist/index.js",
|
|
11
11
|
module: "dist/index.mjs",
|
package/package.json
CHANGED
|
@@ -407,8 +407,11 @@ export type budgetLevel = 'campaign' | 'adset';
|
|
|
407
407
|
* One day of metrics. Same fields as `AdMetrics` plus the `date` they
|
|
408
408
|
* apply to. Returned inside a node's `daily[]` when `GET /v1/ads/tree` is
|
|
409
409
|
* called with `timeIncrement=1`. Rate metrics (ctr/cpc/cpm/costPerConversion/
|
|
410
|
-
* roas) are recomputed per day from that day's
|
|
411
|
-
* fields across a node's `daily[]` reproduces
|
|
410
|
+
* roas/videoAvgTimeWatchedActions) are recomputed per day from that day's
|
|
411
|
+
* sums, so summing the additive fields across a node's `daily[]` reproduces
|
|
412
|
+
* its aggregated `metrics` total. Do NOT sum or plain-average
|
|
413
|
+
* `videoAvgTimeWatchedActions` across days: the range value is the
|
|
414
|
+
* play-weighted average of the daily values.
|
|
412
415
|
*
|
|
413
416
|
*/
|
|
414
417
|
export type AdDailyMetrics = AdMetrics & {
|
|
@@ -464,6 +467,42 @@ export type AdMetrics = {
|
|
|
464
467
|
* Return on ad spend — derived as `purchaseValue / spend`. 0 when `spend` is 0. Equivalent to Meta's `purchase_roas` under default attribution. At ad-set and campaign levels this is recomputed from summed purchaseValue + spend (NOT averaged across children) so it's mathematically correct at every rollup level.
|
|
465
468
|
*/
|
|
466
469
|
roas?: number;
|
|
470
|
+
/**
|
|
471
|
+
* Meta video ads only (0 for non-video ads and other platforms), like all video* fields below. Number of times the video started playing (Meta `video_play_actions`), summed over the date range and across children at ad-set/campaign level.
|
|
472
|
+
*/
|
|
473
|
+
videoPlayActions?: number;
|
|
474
|
+
/**
|
|
475
|
+
* Views of at least 30 seconds (or to the end, for shorter videos). Meta `video_30_sec_watched_actions`.
|
|
476
|
+
*/
|
|
477
|
+
video30SecWatchedActions?: number;
|
|
478
|
+
/**
|
|
479
|
+
* ThruPlays (watched to completion, or at least 15 seconds). Meta `video_thruplay_watched_actions`.
|
|
480
|
+
*/
|
|
481
|
+
videoThruplayWatchedActions?: number;
|
|
482
|
+
/**
|
|
483
|
+
* Views reaching 25% of the video's length. With the other percentile fields, powers hook/hold/drop-off analysis (e.g. hook rate = videoP25WatchedActions / videoPlayActions). Meta `video_p25_watched_actions`.
|
|
484
|
+
*/
|
|
485
|
+
videoP25WatchedActions?: number;
|
|
486
|
+
/**
|
|
487
|
+
* Views reaching 50% of the video's length. Meta `video_p50_watched_actions`.
|
|
488
|
+
*/
|
|
489
|
+
videoP50WatchedActions?: number;
|
|
490
|
+
/**
|
|
491
|
+
* Views reaching 75% of the video's length. Meta `video_p75_watched_actions`.
|
|
492
|
+
*/
|
|
493
|
+
videoP75WatchedActions?: number;
|
|
494
|
+
/**
|
|
495
|
+
* Views reaching 95% of the video's length. Meta `video_p95_watched_actions`.
|
|
496
|
+
*/
|
|
497
|
+
videoP95WatchedActions?: number;
|
|
498
|
+
/**
|
|
499
|
+
* Views reaching 100% of the video's length. Meta `video_p100_watched_actions`.
|
|
500
|
+
*/
|
|
501
|
+
videoP100WatchedActions?: number;
|
|
502
|
+
/**
|
|
503
|
+
* Average seconds watched per play (Meta `video_avg_time_watched_actions`). Aggregated over date ranges and across children as a play-weighted average (total watch time / total plays), never a plain average of averages.
|
|
504
|
+
*/
|
|
505
|
+
videoAvgTimeWatchedActions?: number;
|
|
467
506
|
/**
|
|
468
507
|
* Present on individual ads only, not on campaign aggregations
|
|
469
508
|
*/
|