@zernio/node 0.2.558 → 0.2.559
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 +17 -1
- package/dist/index.d.ts +17 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/types.gen.ts +17 -1
package/dist/index.d.mts
CHANGED
|
@@ -26872,11 +26872,19 @@ type ListAdCampaignsData = {
|
|
|
26872
26872
|
* Start of metrics date range (YYYY-MM-DD, inclusive). Defaults to 90 days ago when both date params are omitted.
|
|
26873
26873
|
*/
|
|
26874
26874
|
fromDate?: string;
|
|
26875
|
+
/**
|
|
26876
|
+
* Return only campaigns that delivered between `fromDate` and `toDate` — spend above zero, or impressions served at zero spend. Unlike `status`, which reads a campaign's CURRENT state, this filters on what happened inside the window. Filters the campaign set itself, so `pagination.total` counts only matching campaigns. Mirrors the same filter on /v1/ads/tree.
|
|
26877
|
+
*/
|
|
26878
|
+
hasDelivery?: boolean;
|
|
26875
26879
|
/**
|
|
26876
26880
|
* Meta only. Campaign reads aggregate over ad documents, so a campaign with ZERO ads is normally invisible here — the state the two-step create (campaign, then ads via `existingCampaignId`) leaves behind whenever Meta rejects the ad step. Set true to list those too, with `adCount: 0` and zeroed metrics. Requires `accountId` and `adAccountId`, since an empty campaign has no ad row to resolve a token or ad account from.
|
|
26877
26881
|
*/
|
|
26878
26882
|
includeEmpty?: boolean;
|
|
26879
26883
|
limit?: number;
|
|
26884
|
+
/**
|
|
26885
|
+
* Return only campaigns whose spend between `fromDate` and `toDate` reaches this amount, in each campaign's OWN currency (the `currency` field on the campaign). Implies `hasDelivery`; `minSpend=0` applies no filter. Mirrors the same filter on /v1/ads/tree.
|
|
26886
|
+
*/
|
|
26887
|
+
minSpend?: number;
|
|
26880
26888
|
/**
|
|
26881
26889
|
* Page number (1-based)
|
|
26882
26890
|
*/
|
|
@@ -27459,13 +27467,21 @@ type GetAdTreeData = {
|
|
|
27459
27467
|
*/
|
|
27460
27468
|
dailyLevel?: 'campaign' | 'adset' | 'ad';
|
|
27461
27469
|
/**
|
|
27462
|
-
* Start of the METRICS date range (YYYY-MM-DD).
|
|
27470
|
+
* Start of the METRICS date range (YYYY-MM-DD). On its own it affects only the spend/impression numbers overlaid on each node, not which campaigns are returned — pass `hasDelivery` or `minSpend` to also filter the campaign set to this window. Defaults to 90 days ago.
|
|
27463
27471
|
*/
|
|
27464
27472
|
fromDate?: string;
|
|
27473
|
+
/**
|
|
27474
|
+
* Return only campaigns that delivered between `fromDate` and `toDate` — spend above zero, or impressions served at zero spend. Unlike `status`, which reads a campaign's CURRENT state, this filters on what happened inside the window, so a campaign that spent then and is paused today is still returned. Filters the campaign set itself, so `pagination.total` counts only matching campaigns.
|
|
27475
|
+
*/
|
|
27476
|
+
hasDelivery?: boolean;
|
|
27465
27477
|
/**
|
|
27466
27478
|
* Campaigns per page
|
|
27467
27479
|
*/
|
|
27468
27480
|
limit?: number;
|
|
27481
|
+
/**
|
|
27482
|
+
* Return only campaigns whose spend between `fromDate` and `toDate` reaches this amount. Expressed in each campaign's OWN currency (the `currency` field on the campaign node): spend is stored per ad account in its native currency and one response can span several. Implies `hasDelivery`; `minSpend=0` applies no filter.
|
|
27483
|
+
*/
|
|
27484
|
+
minSpend?: number;
|
|
27469
27485
|
/**
|
|
27470
27486
|
* Page number (1-based)
|
|
27471
27487
|
*/
|
package/dist/index.d.ts
CHANGED
|
@@ -26872,11 +26872,19 @@ type ListAdCampaignsData = {
|
|
|
26872
26872
|
* Start of metrics date range (YYYY-MM-DD, inclusive). Defaults to 90 days ago when both date params are omitted.
|
|
26873
26873
|
*/
|
|
26874
26874
|
fromDate?: string;
|
|
26875
|
+
/**
|
|
26876
|
+
* Return only campaigns that delivered between `fromDate` and `toDate` — spend above zero, or impressions served at zero spend. Unlike `status`, which reads a campaign's CURRENT state, this filters on what happened inside the window. Filters the campaign set itself, so `pagination.total` counts only matching campaigns. Mirrors the same filter on /v1/ads/tree.
|
|
26877
|
+
*/
|
|
26878
|
+
hasDelivery?: boolean;
|
|
26875
26879
|
/**
|
|
26876
26880
|
* Meta only. Campaign reads aggregate over ad documents, so a campaign with ZERO ads is normally invisible here — the state the two-step create (campaign, then ads via `existingCampaignId`) leaves behind whenever Meta rejects the ad step. Set true to list those too, with `adCount: 0` and zeroed metrics. Requires `accountId` and `adAccountId`, since an empty campaign has no ad row to resolve a token or ad account from.
|
|
26877
26881
|
*/
|
|
26878
26882
|
includeEmpty?: boolean;
|
|
26879
26883
|
limit?: number;
|
|
26884
|
+
/**
|
|
26885
|
+
* Return only campaigns whose spend between `fromDate` and `toDate` reaches this amount, in each campaign's OWN currency (the `currency` field on the campaign). Implies `hasDelivery`; `minSpend=0` applies no filter. Mirrors the same filter on /v1/ads/tree.
|
|
26886
|
+
*/
|
|
26887
|
+
minSpend?: number;
|
|
26880
26888
|
/**
|
|
26881
26889
|
* Page number (1-based)
|
|
26882
26890
|
*/
|
|
@@ -27459,13 +27467,21 @@ type GetAdTreeData = {
|
|
|
27459
27467
|
*/
|
|
27460
27468
|
dailyLevel?: 'campaign' | 'adset' | 'ad';
|
|
27461
27469
|
/**
|
|
27462
|
-
* Start of the METRICS date range (YYYY-MM-DD).
|
|
27470
|
+
* Start of the METRICS date range (YYYY-MM-DD). On its own it affects only the spend/impression numbers overlaid on each node, not which campaigns are returned — pass `hasDelivery` or `minSpend` to also filter the campaign set to this window. Defaults to 90 days ago.
|
|
27463
27471
|
*/
|
|
27464
27472
|
fromDate?: string;
|
|
27473
|
+
/**
|
|
27474
|
+
* Return only campaigns that delivered between `fromDate` and `toDate` — spend above zero, or impressions served at zero spend. Unlike `status`, which reads a campaign's CURRENT state, this filters on what happened inside the window, so a campaign that spent then and is paused today is still returned. Filters the campaign set itself, so `pagination.total` counts only matching campaigns.
|
|
27475
|
+
*/
|
|
27476
|
+
hasDelivery?: boolean;
|
|
27465
27477
|
/**
|
|
27466
27478
|
* Campaigns per page
|
|
27467
27479
|
*/
|
|
27468
27480
|
limit?: number;
|
|
27481
|
+
/**
|
|
27482
|
+
* Return only campaigns whose spend between `fromDate` and `toDate` reaches this amount. Expressed in each campaign's OWN currency (the `currency` field on the campaign node): spend is stored per ad account in its native currency and one response can span several. Implies `hasDelivery`; `minSpend=0` applies no filter.
|
|
27483
|
+
*/
|
|
27484
|
+
minSpend?: number;
|
|
27469
27485
|
/**
|
|
27470
27486
|
* Page number (1-based)
|
|
27471
27487
|
*/
|
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.559",
|
|
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.559",
|
|
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
|
@@ -27237,11 +27237,19 @@ export type ListAdCampaignsData = {
|
|
|
27237
27237
|
* Start of metrics date range (YYYY-MM-DD, inclusive). Defaults to 90 days ago when both date params are omitted.
|
|
27238
27238
|
*/
|
|
27239
27239
|
fromDate?: string;
|
|
27240
|
+
/**
|
|
27241
|
+
* Return only campaigns that delivered between `fromDate` and `toDate` — spend above zero, or impressions served at zero spend. Unlike `status`, which reads a campaign's CURRENT state, this filters on what happened inside the window. Filters the campaign set itself, so `pagination.total` counts only matching campaigns. Mirrors the same filter on /v1/ads/tree.
|
|
27242
|
+
*/
|
|
27243
|
+
hasDelivery?: boolean;
|
|
27240
27244
|
/**
|
|
27241
27245
|
* Meta only. Campaign reads aggregate over ad documents, so a campaign with ZERO ads is normally invisible here — the state the two-step create (campaign, then ads via `existingCampaignId`) leaves behind whenever Meta rejects the ad step. Set true to list those too, with `adCount: 0` and zeroed metrics. Requires `accountId` and `adAccountId`, since an empty campaign has no ad row to resolve a token or ad account from.
|
|
27242
27246
|
*/
|
|
27243
27247
|
includeEmpty?: boolean;
|
|
27244
27248
|
limit?: number;
|
|
27249
|
+
/**
|
|
27250
|
+
* Return only campaigns whose spend between `fromDate` and `toDate` reaches this amount, in each campaign's OWN currency (the `currency` field on the campaign). Implies `hasDelivery`; `minSpend=0` applies no filter. Mirrors the same filter on /v1/ads/tree.
|
|
27251
|
+
*/
|
|
27252
|
+
minSpend?: number;
|
|
27245
27253
|
/**
|
|
27246
27254
|
* Page number (1-based)
|
|
27247
27255
|
*/
|
|
@@ -27860,13 +27868,21 @@ export type GetAdTreeData = {
|
|
|
27860
27868
|
*/
|
|
27861
27869
|
dailyLevel?: 'campaign' | 'adset' | 'ad';
|
|
27862
27870
|
/**
|
|
27863
|
-
* Start of the METRICS date range (YYYY-MM-DD).
|
|
27871
|
+
* Start of the METRICS date range (YYYY-MM-DD). On its own it affects only the spend/impression numbers overlaid on each node, not which campaigns are returned — pass `hasDelivery` or `minSpend` to also filter the campaign set to this window. Defaults to 90 days ago.
|
|
27864
27872
|
*/
|
|
27865
27873
|
fromDate?: string;
|
|
27874
|
+
/**
|
|
27875
|
+
* Return only campaigns that delivered between `fromDate` and `toDate` — spend above zero, or impressions served at zero spend. Unlike `status`, which reads a campaign's CURRENT state, this filters on what happened inside the window, so a campaign that spent then and is paused today is still returned. Filters the campaign set itself, so `pagination.total` counts only matching campaigns.
|
|
27876
|
+
*/
|
|
27877
|
+
hasDelivery?: boolean;
|
|
27866
27878
|
/**
|
|
27867
27879
|
* Campaigns per page
|
|
27868
27880
|
*/
|
|
27869
27881
|
limit?: number;
|
|
27882
|
+
/**
|
|
27883
|
+
* Return only campaigns whose spend between `fromDate` and `toDate` reaches this amount. Expressed in each campaign's OWN currency (the `currency` field on the campaign node): spend is stored per ad account in its native currency and one response can span several. Implies `hasDelivery`; `minSpend=0` applies no filter.
|
|
27884
|
+
*/
|
|
27885
|
+
minSpend?: number;
|
|
27870
27886
|
/**
|
|
27871
27887
|
* Page number (1-based)
|
|
27872
27888
|
*/
|