@zernio/node 0.2.553 → 0.2.555
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 +31 -8
- package/dist/index.d.ts +31 -8
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/types.gen.ts +31 -8
package/dist/index.d.mts
CHANGED
|
@@ -1790,20 +1790,24 @@ type AdDailyMetrics = AdMetrics & {
|
|
|
1790
1790
|
* Use these fields when you need a specific interaction, and `engagement`
|
|
1791
1791
|
* only as the coarse total it has always been.
|
|
1792
1792
|
*
|
|
1793
|
-
* Meta
|
|
1793
|
+
* Populated for Meta and, since 2026-08, TikTok (`reactions` = paid
|
|
1794
|
+
* likes, `comments`, `shares`; TikTok's `follow` count lives in
|
|
1795
|
+
* `actions.follow`, not here). Other platforms leave these at 0.
|
|
1796
|
+
* TikTok history note: paused TikTok ads are not re-synced, so
|
|
1797
|
+
* campaigns that ended before the rollout keep 0s here.
|
|
1794
1798
|
*
|
|
1795
1799
|
*/
|
|
1796
1800
|
type AdEngagementCounts = {
|
|
1797
1801
|
/**
|
|
1798
|
-
* Meta's own post-engagement total (`post_engagement`).
|
|
1802
|
+
* Meta's own post-engagement total (`post_engagement`). Meta-only.
|
|
1799
1803
|
*/
|
|
1800
1804
|
postEngagement?: number;
|
|
1801
1805
|
/**
|
|
1802
|
-
* Meta's own page-engagement total (`page_engagement`).
|
|
1806
|
+
* Meta's own page-engagement total (`page_engagement`). Meta-only.
|
|
1803
1807
|
*/
|
|
1804
1808
|
pageEngagement?: number;
|
|
1805
1809
|
/**
|
|
1806
|
-
* Reactions on the ad's post (`post_reaction`).
|
|
1810
|
+
* Reactions on the ad's post (`post_reaction`). For TikTok these are its paid likes.
|
|
1807
1811
|
*/
|
|
1808
1812
|
reactions?: number;
|
|
1809
1813
|
/**
|
|
@@ -1811,7 +1815,7 @@ type AdEngagementCounts = {
|
|
|
1811
1815
|
*/
|
|
1812
1816
|
comments?: number;
|
|
1813
1817
|
/**
|
|
1814
|
-
* Shares of the ad's post. Meta reports these under the action type literally named `post`.
|
|
1818
|
+
* Shares of the ad's post. Meta reports these under the action type literally named `post`; TikTok under `share`.
|
|
1815
1819
|
*/
|
|
1816
1820
|
shares?: number;
|
|
1817
1821
|
/**
|
|
@@ -1933,7 +1937,7 @@ type AdMetrics = {
|
|
|
1933
1937
|
*/
|
|
1934
1938
|
costPerConversion?: number;
|
|
1935
1939
|
/**
|
|
1936
|
-
* Per-action-type counts summed over the date range, keyed by the platform's action-type names. Meta: raw Insights action_type keys (link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped, ...) — both engagement and conversion events. X: conversion types (purchase, sign_up, site_visit, download, custom). LinkedIn: conversion types (post_click, post_view, lead_gen). Google returns {} (its per-action names aren't synced per ad). Empty object when no actions are reported. NOTE: keys differ by platform, so branch on the ad's platform when interpreting them.
|
|
1940
|
+
* Per-action-type counts summed over the date range, keyed by the platform's action-type names. Meta: raw Insights action_type keys (link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped, ...) — both engagement and conversion events. TikTok: pixel conversions (purchase, add_to_cart, initiate_checkout, view_content, complete_payment, lead) plus the paid-engagement family (follow, post_reaction for paid likes, comment, share) — follow is how FOLLOWERS-goal campaigns report their result. X: conversion types (purchase, sign_up, site_visit, download, custom). LinkedIn: conversion types (post_click, post_view, lead_gen). Google returns {} (its per-action names aren't synced per ad). Empty object when no actions are reported. NOTE: keys differ by platform, so branch on the ad's platform when interpreting them.
|
|
1937
1941
|
*/
|
|
1938
1942
|
actions?: {
|
|
1939
1943
|
[key: string]: (number);
|
|
@@ -30102,6 +30106,22 @@ type CreateStandaloneAdData = {
|
|
|
30102
30106
|
*
|
|
30103
30107
|
*/
|
|
30104
30108
|
identityType?: 'TT_USER' | 'CUSTOMIZED_USER';
|
|
30109
|
+
/**
|
|
30110
|
+
* TikTok only. Creates the ad as a TikTok Upgraded Smart+
|
|
30111
|
+
* campaign: TikTok automates targeting, bidding and delivery. Supports goals
|
|
30112
|
+
* `conversions` (Smart+ Web Conversions), `lead_generation` (Smart+ Lead
|
|
30113
|
+
* Generation with a website form on `linkUrl`; TikTok Instant Forms not supported)
|
|
30114
|
+
* and `app_promotion` (Smart+ App installs; the ad's destination is the app store,
|
|
30115
|
+
* so `linkUrl` is not used). The web goals require `promotedObject.pixelId` AND
|
|
30116
|
+
* `promotedObject.customEventType`; `app_promotion` requires
|
|
30117
|
+
* `promotedObject.applicationId` instead.
|
|
30118
|
+
* Targeting works like on any TikTok ad (defaults to `countries: ["US"]` when
|
|
30119
|
+
* omitted); TikTok automates delivery within it.
|
|
30120
|
+
* The budget lives on the Smart+ campaign (Campaign Budget Optimization); a `lifetime`
|
|
30121
|
+
* budget additionally requires `endDate`. Cannot be combined with `adSetId`.
|
|
30122
|
+
*
|
|
30123
|
+
*/
|
|
30124
|
+
smartPlus?: boolean;
|
|
30105
30125
|
/**
|
|
30106
30126
|
* What the ad optimises against. Behaviour depends on the platform.
|
|
30107
30127
|
*
|
|
@@ -30115,12 +30135,15 @@ type CreateStandaloneAdData = {
|
|
|
30115
30135
|
*
|
|
30116
30136
|
* Other Meta goals (engagement, traffic, awareness, video_views) ignore this field.
|
|
30117
30137
|
*
|
|
30118
|
-
* **TikTok**:
|
|
30138
|
+
* **TikTok**: used by `goal: conversions` and the Smart+ goals (`smartPlus: true`).
|
|
30119
30139
|
* - `pixelId` maps to the ad group's `pixel_id`. Required: a TikTok website-conversion
|
|
30120
30140
|
* ad group without a pixel is rejected with `40002: Please select a pixel`.
|
|
30121
30141
|
* - `customEventType` maps to the ad group's `optimization_event` (the pixel event to
|
|
30122
|
-
* optimise for). Optional
|
|
30142
|
+
* optimise for). Optional on the regular conversions flow, required on Smart+.
|
|
30123
30143
|
* See the `customEventType` field below for the valid TikTok codes.
|
|
30144
|
+
* - `applicationId` (Smart+ `goal: app_promotion` only) maps to the ad group's `app_id`:
|
|
30145
|
+
* the App ID of an app registered on the TikTok Ads account (Assets → Events →
|
|
30146
|
+
* App Events). Install optimization needs the app's MMP tracking configured.
|
|
30124
30147
|
*
|
|
30125
30148
|
* The remaining `promotedObject.*` fields are Meta-only. Platforms other than
|
|
30126
30149
|
* Meta and TikTok ignore `promotedObject` entirely.
|
package/dist/index.d.ts
CHANGED
|
@@ -1790,20 +1790,24 @@ type AdDailyMetrics = AdMetrics & {
|
|
|
1790
1790
|
* Use these fields when you need a specific interaction, and `engagement`
|
|
1791
1791
|
* only as the coarse total it has always been.
|
|
1792
1792
|
*
|
|
1793
|
-
* Meta
|
|
1793
|
+
* Populated for Meta and, since 2026-08, TikTok (`reactions` = paid
|
|
1794
|
+
* likes, `comments`, `shares`; TikTok's `follow` count lives in
|
|
1795
|
+
* `actions.follow`, not here). Other platforms leave these at 0.
|
|
1796
|
+
* TikTok history note: paused TikTok ads are not re-synced, so
|
|
1797
|
+
* campaigns that ended before the rollout keep 0s here.
|
|
1794
1798
|
*
|
|
1795
1799
|
*/
|
|
1796
1800
|
type AdEngagementCounts = {
|
|
1797
1801
|
/**
|
|
1798
|
-
* Meta's own post-engagement total (`post_engagement`).
|
|
1802
|
+
* Meta's own post-engagement total (`post_engagement`). Meta-only.
|
|
1799
1803
|
*/
|
|
1800
1804
|
postEngagement?: number;
|
|
1801
1805
|
/**
|
|
1802
|
-
* Meta's own page-engagement total (`page_engagement`).
|
|
1806
|
+
* Meta's own page-engagement total (`page_engagement`). Meta-only.
|
|
1803
1807
|
*/
|
|
1804
1808
|
pageEngagement?: number;
|
|
1805
1809
|
/**
|
|
1806
|
-
* Reactions on the ad's post (`post_reaction`).
|
|
1810
|
+
* Reactions on the ad's post (`post_reaction`). For TikTok these are its paid likes.
|
|
1807
1811
|
*/
|
|
1808
1812
|
reactions?: number;
|
|
1809
1813
|
/**
|
|
@@ -1811,7 +1815,7 @@ type AdEngagementCounts = {
|
|
|
1811
1815
|
*/
|
|
1812
1816
|
comments?: number;
|
|
1813
1817
|
/**
|
|
1814
|
-
* Shares of the ad's post. Meta reports these under the action type literally named `post`.
|
|
1818
|
+
* Shares of the ad's post. Meta reports these under the action type literally named `post`; TikTok under `share`.
|
|
1815
1819
|
*/
|
|
1816
1820
|
shares?: number;
|
|
1817
1821
|
/**
|
|
@@ -1933,7 +1937,7 @@ type AdMetrics = {
|
|
|
1933
1937
|
*/
|
|
1934
1938
|
costPerConversion?: number;
|
|
1935
1939
|
/**
|
|
1936
|
-
* Per-action-type counts summed over the date range, keyed by the platform's action-type names. Meta: raw Insights action_type keys (link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped, ...) — both engagement and conversion events. X: conversion types (purchase, sign_up, site_visit, download, custom). LinkedIn: conversion types (post_click, post_view, lead_gen). Google returns {} (its per-action names aren't synced per ad). Empty object when no actions are reported. NOTE: keys differ by platform, so branch on the ad's platform when interpreting them.
|
|
1940
|
+
* Per-action-type counts summed over the date range, keyed by the platform's action-type names. Meta: raw Insights action_type keys (link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped, ...) — both engagement and conversion events. TikTok: pixel conversions (purchase, add_to_cart, initiate_checkout, view_content, complete_payment, lead) plus the paid-engagement family (follow, post_reaction for paid likes, comment, share) — follow is how FOLLOWERS-goal campaigns report their result. X: conversion types (purchase, sign_up, site_visit, download, custom). LinkedIn: conversion types (post_click, post_view, lead_gen). Google returns {} (its per-action names aren't synced per ad). Empty object when no actions are reported. NOTE: keys differ by platform, so branch on the ad's platform when interpreting them.
|
|
1937
1941
|
*/
|
|
1938
1942
|
actions?: {
|
|
1939
1943
|
[key: string]: (number);
|
|
@@ -30102,6 +30106,22 @@ type CreateStandaloneAdData = {
|
|
|
30102
30106
|
*
|
|
30103
30107
|
*/
|
|
30104
30108
|
identityType?: 'TT_USER' | 'CUSTOMIZED_USER';
|
|
30109
|
+
/**
|
|
30110
|
+
* TikTok only. Creates the ad as a TikTok Upgraded Smart+
|
|
30111
|
+
* campaign: TikTok automates targeting, bidding and delivery. Supports goals
|
|
30112
|
+
* `conversions` (Smart+ Web Conversions), `lead_generation` (Smart+ Lead
|
|
30113
|
+
* Generation with a website form on `linkUrl`; TikTok Instant Forms not supported)
|
|
30114
|
+
* and `app_promotion` (Smart+ App installs; the ad's destination is the app store,
|
|
30115
|
+
* so `linkUrl` is not used). The web goals require `promotedObject.pixelId` AND
|
|
30116
|
+
* `promotedObject.customEventType`; `app_promotion` requires
|
|
30117
|
+
* `promotedObject.applicationId` instead.
|
|
30118
|
+
* Targeting works like on any TikTok ad (defaults to `countries: ["US"]` when
|
|
30119
|
+
* omitted); TikTok automates delivery within it.
|
|
30120
|
+
* The budget lives on the Smart+ campaign (Campaign Budget Optimization); a `lifetime`
|
|
30121
|
+
* budget additionally requires `endDate`. Cannot be combined with `adSetId`.
|
|
30122
|
+
*
|
|
30123
|
+
*/
|
|
30124
|
+
smartPlus?: boolean;
|
|
30105
30125
|
/**
|
|
30106
30126
|
* What the ad optimises against. Behaviour depends on the platform.
|
|
30107
30127
|
*
|
|
@@ -30115,12 +30135,15 @@ type CreateStandaloneAdData = {
|
|
|
30115
30135
|
*
|
|
30116
30136
|
* Other Meta goals (engagement, traffic, awareness, video_views) ignore this field.
|
|
30117
30137
|
*
|
|
30118
|
-
* **TikTok**:
|
|
30138
|
+
* **TikTok**: used by `goal: conversions` and the Smart+ goals (`smartPlus: true`).
|
|
30119
30139
|
* - `pixelId` maps to the ad group's `pixel_id`. Required: a TikTok website-conversion
|
|
30120
30140
|
* ad group without a pixel is rejected with `40002: Please select a pixel`.
|
|
30121
30141
|
* - `customEventType` maps to the ad group's `optimization_event` (the pixel event to
|
|
30122
|
-
* optimise for). Optional
|
|
30142
|
+
* optimise for). Optional on the regular conversions flow, required on Smart+.
|
|
30123
30143
|
* See the `customEventType` field below for the valid TikTok codes.
|
|
30144
|
+
* - `applicationId` (Smart+ `goal: app_promotion` only) maps to the ad group's `app_id`:
|
|
30145
|
+
* the App ID of an app registered on the TikTok Ads account (Assets → Events →
|
|
30146
|
+
* App Events). Install optimization needs the app's MMP tracking configured.
|
|
30124
30147
|
*
|
|
30125
30148
|
* The remaining `promotedObject.*` fields are Meta-only. Platforms other than
|
|
30126
30149
|
* Meta and TikTok ignore `promotedObject` entirely.
|
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.555",
|
|
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.555",
|
|
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
|
@@ -538,20 +538,24 @@ export type AdDailyMetrics = AdMetrics & {
|
|
|
538
538
|
* Use these fields when you need a specific interaction, and `engagement`
|
|
539
539
|
* only as the coarse total it has always been.
|
|
540
540
|
*
|
|
541
|
-
* Meta
|
|
541
|
+
* Populated for Meta and, since 2026-08, TikTok (`reactions` = paid
|
|
542
|
+
* likes, `comments`, `shares`; TikTok's `follow` count lives in
|
|
543
|
+
* `actions.follow`, not here). Other platforms leave these at 0.
|
|
544
|
+
* TikTok history note: paused TikTok ads are not re-synced, so
|
|
545
|
+
* campaigns that ended before the rollout keep 0s here.
|
|
542
546
|
*
|
|
543
547
|
*/
|
|
544
548
|
export type AdEngagementCounts = {
|
|
545
549
|
/**
|
|
546
|
-
* Meta's own post-engagement total (`post_engagement`).
|
|
550
|
+
* Meta's own post-engagement total (`post_engagement`). Meta-only.
|
|
547
551
|
*/
|
|
548
552
|
postEngagement?: number;
|
|
549
553
|
/**
|
|
550
|
-
* Meta's own page-engagement total (`page_engagement`).
|
|
554
|
+
* Meta's own page-engagement total (`page_engagement`). Meta-only.
|
|
551
555
|
*/
|
|
552
556
|
pageEngagement?: number;
|
|
553
557
|
/**
|
|
554
|
-
* Reactions on the ad's post (`post_reaction`).
|
|
558
|
+
* Reactions on the ad's post (`post_reaction`). For TikTok these are its paid likes.
|
|
555
559
|
*/
|
|
556
560
|
reactions?: number;
|
|
557
561
|
/**
|
|
@@ -559,7 +563,7 @@ export type AdEngagementCounts = {
|
|
|
559
563
|
*/
|
|
560
564
|
comments?: number;
|
|
561
565
|
/**
|
|
562
|
-
* Shares of the ad's post. Meta reports these under the action type literally named `post`.
|
|
566
|
+
* Shares of the ad's post. Meta reports these under the action type literally named `post`; TikTok under `share`.
|
|
563
567
|
*/
|
|
564
568
|
shares?: number;
|
|
565
569
|
/**
|
|
@@ -683,7 +687,7 @@ export type AdMetrics = {
|
|
|
683
687
|
*/
|
|
684
688
|
costPerConversion?: number;
|
|
685
689
|
/**
|
|
686
|
-
* Per-action-type counts summed over the date range, keyed by the platform's action-type names. Meta: raw Insights action_type keys (link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped, ...) — both engagement and conversion events. X: conversion types (purchase, sign_up, site_visit, download, custom). LinkedIn: conversion types (post_click, post_view, lead_gen). Google returns {} (its per-action names aren't synced per ad). Empty object when no actions are reported. NOTE: keys differ by platform, so branch on the ad's platform when interpreting them.
|
|
690
|
+
* Per-action-type counts summed over the date range, keyed by the platform's action-type names. Meta: raw Insights action_type keys (link_click, offsite_conversion.fb_pixel_purchase, onsite_conversion.lead_grouped, ...) — both engagement and conversion events. TikTok: pixel conversions (purchase, add_to_cart, initiate_checkout, view_content, complete_payment, lead) plus the paid-engagement family (follow, post_reaction for paid likes, comment, share) — follow is how FOLLOWERS-goal campaigns report their result. X: conversion types (purchase, sign_up, site_visit, download, custom). LinkedIn: conversion types (post_click, post_view, lead_gen). Google returns {} (its per-action names aren't synced per ad). Empty object when no actions are reported. NOTE: keys differ by platform, so branch on the ad's platform when interpreting them.
|
|
687
691
|
*/
|
|
688
692
|
actions?: {
|
|
689
693
|
[key: string]: (number);
|
|
@@ -30638,6 +30642,22 @@ export type CreateStandaloneAdData = {
|
|
|
30638
30642
|
*
|
|
30639
30643
|
*/
|
|
30640
30644
|
identityType?: 'TT_USER' | 'CUSTOMIZED_USER';
|
|
30645
|
+
/**
|
|
30646
|
+
* TikTok only. Creates the ad as a TikTok Upgraded Smart+
|
|
30647
|
+
* campaign: TikTok automates targeting, bidding and delivery. Supports goals
|
|
30648
|
+
* `conversions` (Smart+ Web Conversions), `lead_generation` (Smart+ Lead
|
|
30649
|
+
* Generation with a website form on `linkUrl`; TikTok Instant Forms not supported)
|
|
30650
|
+
* and `app_promotion` (Smart+ App installs; the ad's destination is the app store,
|
|
30651
|
+
* so `linkUrl` is not used). The web goals require `promotedObject.pixelId` AND
|
|
30652
|
+
* `promotedObject.customEventType`; `app_promotion` requires
|
|
30653
|
+
* `promotedObject.applicationId` instead.
|
|
30654
|
+
* Targeting works like on any TikTok ad (defaults to `countries: ["US"]` when
|
|
30655
|
+
* omitted); TikTok automates delivery within it.
|
|
30656
|
+
* The budget lives on the Smart+ campaign (Campaign Budget Optimization); a `lifetime`
|
|
30657
|
+
* budget additionally requires `endDate`. Cannot be combined with `adSetId`.
|
|
30658
|
+
*
|
|
30659
|
+
*/
|
|
30660
|
+
smartPlus?: boolean;
|
|
30641
30661
|
/**
|
|
30642
30662
|
* What the ad optimises against. Behaviour depends on the platform.
|
|
30643
30663
|
*
|
|
@@ -30651,12 +30671,15 @@ export type CreateStandaloneAdData = {
|
|
|
30651
30671
|
*
|
|
30652
30672
|
* Other Meta goals (engagement, traffic, awareness, video_views) ignore this field.
|
|
30653
30673
|
*
|
|
30654
|
-
* **TikTok**:
|
|
30674
|
+
* **TikTok**: used by `goal: conversions` and the Smart+ goals (`smartPlus: true`).
|
|
30655
30675
|
* - `pixelId` maps to the ad group's `pixel_id`. Required: a TikTok website-conversion
|
|
30656
30676
|
* ad group without a pixel is rejected with `40002: Please select a pixel`.
|
|
30657
30677
|
* - `customEventType` maps to the ad group's `optimization_event` (the pixel event to
|
|
30658
|
-
* optimise for). Optional
|
|
30678
|
+
* optimise for). Optional on the regular conversions flow, required on Smart+.
|
|
30659
30679
|
* See the `customEventType` field below for the valid TikTok codes.
|
|
30680
|
+
* - `applicationId` (Smart+ `goal: app_promotion` only) maps to the ad group's `app_id`:
|
|
30681
|
+
* the App ID of an app registered on the TikTok Ads account (Assets → Events →
|
|
30682
|
+
* App Events). Install optimization needs the app's MMP tracking configured.
|
|
30660
30683
|
*
|
|
30661
30684
|
* The remaining `promotedObject.*` fields are Meta-only. Platforms other than
|
|
30662
30685
|
* Meta and TikTok ignore `promotedObject` entirely.
|