@getlatedev/node 0.2.376 → 0.2.377
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 +59 -1
- package/dist/index.d.ts +59 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +10 -3
- package/src/generated/types.gen.ts +59 -1
package/dist/index.d.mts
CHANGED
|
@@ -22489,9 +22489,21 @@ type UpdateAdCampaignData = {
|
|
|
22489
22489
|
*/
|
|
22490
22490
|
bidStrategy?: (BidStrategy);
|
|
22491
22491
|
/**
|
|
22492
|
-
* Rename the campaign (Meta only; other platforms return 501). At least one of budget/bidStrategy/name is required.
|
|
22492
|
+
* Rename the campaign (Meta only; other platforms return 501). At least one of budget/bidStrategy/name/platformSpecificData is required.
|
|
22493
22493
|
*/
|
|
22494
22494
|
name?: string;
|
|
22495
|
+
/**
|
|
22496
|
+
* Platform-specific campaign settings. The platform is implied by the `platform`
|
|
22497
|
+
* body param (same convention as platformSpecificData on POST /v1/ads/create).
|
|
22498
|
+
* Meta (facebook/instagram) only; other platforms return 400.
|
|
22499
|
+
*
|
|
22500
|
+
*/
|
|
22501
|
+
platformSpecificData?: {
|
|
22502
|
+
/**
|
|
22503
|
+
* Campaign lifetime spend cap, in the ad account's currency (Meta `spend_cap`). Pass null to remove the cap (0 is rejected by Meta).
|
|
22504
|
+
*/
|
|
22505
|
+
spendCap?: (number) | null;
|
|
22506
|
+
};
|
|
22495
22507
|
};
|
|
22496
22508
|
path: {
|
|
22497
22509
|
/**
|
|
@@ -22505,6 +22517,9 @@ type UpdateAdCampaignResponse = ({
|
|
|
22505
22517
|
budget?: AdBudget;
|
|
22506
22518
|
budgetLevel?: 'campaign';
|
|
22507
22519
|
bidStrategy?: BidStrategy;
|
|
22520
|
+
platformSpecificData?: {
|
|
22521
|
+
[key: string]: unknown;
|
|
22522
|
+
};
|
|
22508
22523
|
});
|
|
22509
22524
|
type UpdateAdCampaignError = (unknown | {
|
|
22510
22525
|
error?: string;
|
|
@@ -22645,6 +22660,42 @@ type UpdateAdSetData = {
|
|
|
22645
22660
|
*
|
|
22646
22661
|
*/
|
|
22647
22662
|
roasAverageFloor?: number;
|
|
22663
|
+
/**
|
|
22664
|
+
* Platform-specific post-launch delivery settings. The platform is implied by the
|
|
22665
|
+
* `platform` body param. Meta only; other platforms return 400. Unknown keys are rejected.
|
|
22666
|
+
*
|
|
22667
|
+
*/
|
|
22668
|
+
platformSpecificData?: {
|
|
22669
|
+
/**
|
|
22670
|
+
* Meta ad-set optimization_goal (e.g. OFFSITE_CONVERSIONS, LANDING_PAGE_VIEWS).
|
|
22671
|
+
*/
|
|
22672
|
+
optimizationGoal?: string;
|
|
22673
|
+
/**
|
|
22674
|
+
* Meta ad-set billing_event (e.g. IMPRESSIONS, LINK_CLICKS, THRUPLAY).
|
|
22675
|
+
*/
|
|
22676
|
+
billingEvent?: string;
|
|
22677
|
+
/**
|
|
22678
|
+
* Ad set start_time (ISO 8601).
|
|
22679
|
+
*/
|
|
22680
|
+
startDate?: string;
|
|
22681
|
+
/**
|
|
22682
|
+
* Ad set end_time (ISO 8601).
|
|
22683
|
+
*/
|
|
22684
|
+
endDate?: string;
|
|
22685
|
+
/**
|
|
22686
|
+
* Meta ad-set promoted_object, forwarded verbatim (same shape as /v1/ads/create).
|
|
22687
|
+
*/
|
|
22688
|
+
promotedObject?: {
|
|
22689
|
+
pixelId?: string;
|
|
22690
|
+
customEventType?: string;
|
|
22691
|
+
pageId?: string;
|
|
22692
|
+
applicationId?: string;
|
|
22693
|
+
objectStoreUrl?: string;
|
|
22694
|
+
customConversionId?: string;
|
|
22695
|
+
productCatalogId?: string;
|
|
22696
|
+
productSetId?: string;
|
|
22697
|
+
};
|
|
22698
|
+
};
|
|
22648
22699
|
};
|
|
22649
22700
|
path: {
|
|
22650
22701
|
/**
|
|
@@ -22662,6 +22713,9 @@ type UpdateAdSetResponse = ({
|
|
|
22662
22713
|
bidStrategy?: BidStrategy;
|
|
22663
22714
|
bidAmount?: (number) | null;
|
|
22664
22715
|
roasAverageFloor?: (number) | null;
|
|
22716
|
+
platformSpecificData?: {
|
|
22717
|
+
[key: string]: unknown;
|
|
22718
|
+
};
|
|
22665
22719
|
});
|
|
22666
22720
|
type UpdateAdSetError = (unknown | {
|
|
22667
22721
|
error?: string;
|
|
@@ -23668,6 +23722,10 @@ type CreateStandaloneAdData = {
|
|
|
23668
23722
|
* Meta only. Explicit ad-set `optimization_goal` (e.g. `LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `REACH`, `IMPRESSIONS`, `OFFSITE_CONVERSIONS`, `THRUPLAY`, `LEAD_GENERATION`). Overrides the default derived from `goal` (e.g. `traffic` defaults to `LINK_CLICKS`). Forwarded verbatim to Meta, which validates compatibility with the campaign objective and rejects incompatible combinations.
|
|
23669
23723
|
*/
|
|
23670
23724
|
optimizationGoal?: string;
|
|
23725
|
+
/**
|
|
23726
|
+
* Meta only. Explicit ad-set `billing_event`. Defaults to `IMPRESSIONS`. Forwarded verbatim to Meta, which validates compatibility with the optimization goal.
|
|
23727
|
+
*/
|
|
23728
|
+
billingEvent?: string;
|
|
23671
23729
|
/**
|
|
23672
23730
|
* Required on legacy + multi-creative shapes. Inherited on attach.
|
|
23673
23731
|
*/
|
package/dist/index.d.ts
CHANGED
|
@@ -22489,9 +22489,21 @@ type UpdateAdCampaignData = {
|
|
|
22489
22489
|
*/
|
|
22490
22490
|
bidStrategy?: (BidStrategy);
|
|
22491
22491
|
/**
|
|
22492
|
-
* Rename the campaign (Meta only; other platforms return 501). At least one of budget/bidStrategy/name is required.
|
|
22492
|
+
* Rename the campaign (Meta only; other platforms return 501). At least one of budget/bidStrategy/name/platformSpecificData is required.
|
|
22493
22493
|
*/
|
|
22494
22494
|
name?: string;
|
|
22495
|
+
/**
|
|
22496
|
+
* Platform-specific campaign settings. The platform is implied by the `platform`
|
|
22497
|
+
* body param (same convention as platformSpecificData on POST /v1/ads/create).
|
|
22498
|
+
* Meta (facebook/instagram) only; other platforms return 400.
|
|
22499
|
+
*
|
|
22500
|
+
*/
|
|
22501
|
+
platformSpecificData?: {
|
|
22502
|
+
/**
|
|
22503
|
+
* Campaign lifetime spend cap, in the ad account's currency (Meta `spend_cap`). Pass null to remove the cap (0 is rejected by Meta).
|
|
22504
|
+
*/
|
|
22505
|
+
spendCap?: (number) | null;
|
|
22506
|
+
};
|
|
22495
22507
|
};
|
|
22496
22508
|
path: {
|
|
22497
22509
|
/**
|
|
@@ -22505,6 +22517,9 @@ type UpdateAdCampaignResponse = ({
|
|
|
22505
22517
|
budget?: AdBudget;
|
|
22506
22518
|
budgetLevel?: 'campaign';
|
|
22507
22519
|
bidStrategy?: BidStrategy;
|
|
22520
|
+
platformSpecificData?: {
|
|
22521
|
+
[key: string]: unknown;
|
|
22522
|
+
};
|
|
22508
22523
|
});
|
|
22509
22524
|
type UpdateAdCampaignError = (unknown | {
|
|
22510
22525
|
error?: string;
|
|
@@ -22645,6 +22660,42 @@ type UpdateAdSetData = {
|
|
|
22645
22660
|
*
|
|
22646
22661
|
*/
|
|
22647
22662
|
roasAverageFloor?: number;
|
|
22663
|
+
/**
|
|
22664
|
+
* Platform-specific post-launch delivery settings. The platform is implied by the
|
|
22665
|
+
* `platform` body param. Meta only; other platforms return 400. Unknown keys are rejected.
|
|
22666
|
+
*
|
|
22667
|
+
*/
|
|
22668
|
+
platformSpecificData?: {
|
|
22669
|
+
/**
|
|
22670
|
+
* Meta ad-set optimization_goal (e.g. OFFSITE_CONVERSIONS, LANDING_PAGE_VIEWS).
|
|
22671
|
+
*/
|
|
22672
|
+
optimizationGoal?: string;
|
|
22673
|
+
/**
|
|
22674
|
+
* Meta ad-set billing_event (e.g. IMPRESSIONS, LINK_CLICKS, THRUPLAY).
|
|
22675
|
+
*/
|
|
22676
|
+
billingEvent?: string;
|
|
22677
|
+
/**
|
|
22678
|
+
* Ad set start_time (ISO 8601).
|
|
22679
|
+
*/
|
|
22680
|
+
startDate?: string;
|
|
22681
|
+
/**
|
|
22682
|
+
* Ad set end_time (ISO 8601).
|
|
22683
|
+
*/
|
|
22684
|
+
endDate?: string;
|
|
22685
|
+
/**
|
|
22686
|
+
* Meta ad-set promoted_object, forwarded verbatim (same shape as /v1/ads/create).
|
|
22687
|
+
*/
|
|
22688
|
+
promotedObject?: {
|
|
22689
|
+
pixelId?: string;
|
|
22690
|
+
customEventType?: string;
|
|
22691
|
+
pageId?: string;
|
|
22692
|
+
applicationId?: string;
|
|
22693
|
+
objectStoreUrl?: string;
|
|
22694
|
+
customConversionId?: string;
|
|
22695
|
+
productCatalogId?: string;
|
|
22696
|
+
productSetId?: string;
|
|
22697
|
+
};
|
|
22698
|
+
};
|
|
22648
22699
|
};
|
|
22649
22700
|
path: {
|
|
22650
22701
|
/**
|
|
@@ -22662,6 +22713,9 @@ type UpdateAdSetResponse = ({
|
|
|
22662
22713
|
bidStrategy?: BidStrategy;
|
|
22663
22714
|
bidAmount?: (number) | null;
|
|
22664
22715
|
roasAverageFloor?: (number) | null;
|
|
22716
|
+
platformSpecificData?: {
|
|
22717
|
+
[key: string]: unknown;
|
|
22718
|
+
};
|
|
22665
22719
|
});
|
|
22666
22720
|
type UpdateAdSetError = (unknown | {
|
|
22667
22721
|
error?: string;
|
|
@@ -23668,6 +23722,10 @@ type CreateStandaloneAdData = {
|
|
|
23668
23722
|
* Meta only. Explicit ad-set `optimization_goal` (e.g. `LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `REACH`, `IMPRESSIONS`, `OFFSITE_CONVERSIONS`, `THRUPLAY`, `LEAD_GENERATION`). Overrides the default derived from `goal` (e.g. `traffic` defaults to `LINK_CLICKS`). Forwarded verbatim to Meta, which validates compatibility with the campaign objective and rejects incompatible combinations.
|
|
23669
23723
|
*/
|
|
23670
23724
|
optimizationGoal?: string;
|
|
23725
|
+
/**
|
|
23726
|
+
* Meta only. Explicit ad-set `billing_event`. Defaults to `IMPRESSIONS`. Forwarded verbatim to Meta, which validates compatibility with the optimization goal.
|
|
23727
|
+
*/
|
|
23728
|
+
billingEvent?: string;
|
|
23671
23729
|
/**
|
|
23672
23730
|
* Required on legacy + multi-creative shapes. Inherited on attach.
|
|
23673
23731
|
*/
|
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: "@getlatedev/node",
|
|
39
|
-
version: "0.2.
|
|
39
|
+
version: "0.2.377",
|
|
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: "@getlatedev/node",
|
|
8
|
-
version: "0.2.
|
|
8
|
+
version: "0.2.377",
|
|
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
package/src/generated/sdk.gen.ts
CHANGED
|
@@ -6198,13 +6198,15 @@ export const updateAdCampaignStatus = <ThrowOnError extends boolean = false>(opt
|
|
|
6198
6198
|
|
|
6199
6199
|
/**
|
|
6200
6200
|
* Update a campaign
|
|
6201
|
-
* Campaign-level edits. At least one of `budget` or `
|
|
6201
|
+
* Campaign-level edits. At least one of `budget`, `bidStrategy`, `name` or `platformSpecificData` is required.
|
|
6202
6202
|
*
|
|
6203
6203
|
* - `budget` updates the CBO (Campaign Budget Optimization) budget. For ABO campaigns
|
|
6204
6204
|
* (where the budget lives on the ad set), use PUT /v1/ads/ad-sets/{adSetId} instead — this endpoint
|
|
6205
6205
|
* will return 409 with code BUDGET_LEVEL_MISMATCH.
|
|
6206
6206
|
* - `bidStrategy` sets the campaign-level default bid strategy. Per Meta's spec, `bid_amount` and
|
|
6207
6207
|
* `bid_constraints` do NOT exist at the campaign level — pass them via PUT /v1/ads/ad-sets/{adSetId}.
|
|
6208
|
+
* - `platformSpecificData.spendCap` (Meta only) sets the campaign's lifetime spend cap, in the ad
|
|
6209
|
+
* account's currency.
|
|
6208
6210
|
*
|
|
6209
6211
|
* Meta-only for now. Other platforms return 501 Not Implemented.
|
|
6210
6212
|
*
|
|
@@ -6290,14 +6292,19 @@ export const duplicateAdCampaign = <ThrowOnError extends boolean = false>(option
|
|
|
6290
6292
|
/**
|
|
6291
6293
|
* Update an ad set
|
|
6292
6294
|
* Ad-set-level writes. Use this for ABO budget updates, ad-set-scoped
|
|
6293
|
-
* pause/resume,
|
|
6294
|
-
*
|
|
6295
|
+
* pause/resume, bid-strategy edits, and Meta-only post-launch delivery
|
|
6296
|
+
* settings via `platformSpecificData`. At least one updatable field
|
|
6297
|
+
* is required.
|
|
6295
6298
|
*
|
|
6296
6299
|
* Bid strategy compatibility (per Meta's spec):
|
|
6297
6300
|
* - `LOWEST_COST_WITHOUT_CAP`: no `bidAmount`, no `roasAverageFloor`.
|
|
6298
6301
|
* - `LOWEST_COST_WITH_BID_CAP` / `COST_CAP`: `bidAmount` REQUIRED (whole currency units).
|
|
6299
6302
|
* - `LOWEST_COST_WITH_MIN_ROAS`: `roasAverageFloor` REQUIRED (decimal multiplier, e.g. 2.0 = 2.0x ROAS).
|
|
6300
6303
|
*
|
|
6304
|
+
* Delivery settings are validated by Meta against the campaign objective;
|
|
6305
|
+
* incompatible combinations (e.g. a billingEvent the optimization goal
|
|
6306
|
+
* doesn't allow) surface as 400s from Meta.
|
|
6307
|
+
*
|
|
6301
6308
|
* When updating `budget` on an ABO campaign: if the parent campaign is
|
|
6302
6309
|
* CBO, the response is 409 with code BUDGET_LEVEL_MISMATCH — route to
|
|
6303
6310
|
* PUT /v1/ads/campaigns/{campaignId} instead.
|
|
@@ -23082,9 +23082,21 @@ export type UpdateAdCampaignData = {
|
|
|
23082
23082
|
*/
|
|
23083
23083
|
bidStrategy?: (BidStrategy);
|
|
23084
23084
|
/**
|
|
23085
|
-
* Rename the campaign (Meta only; other platforms return 501). At least one of budget/bidStrategy/name is required.
|
|
23085
|
+
* Rename the campaign (Meta only; other platforms return 501). At least one of budget/bidStrategy/name/platformSpecificData is required.
|
|
23086
23086
|
*/
|
|
23087
23087
|
name?: string;
|
|
23088
|
+
/**
|
|
23089
|
+
* Platform-specific campaign settings. The platform is implied by the `platform`
|
|
23090
|
+
* body param (same convention as platformSpecificData on POST /v1/ads/create).
|
|
23091
|
+
* Meta (facebook/instagram) only; other platforms return 400.
|
|
23092
|
+
*
|
|
23093
|
+
*/
|
|
23094
|
+
platformSpecificData?: {
|
|
23095
|
+
/**
|
|
23096
|
+
* Campaign lifetime spend cap, in the ad account's currency (Meta `spend_cap`). Pass null to remove the cap (0 is rejected by Meta).
|
|
23097
|
+
*/
|
|
23098
|
+
spendCap?: (number) | null;
|
|
23099
|
+
};
|
|
23088
23100
|
};
|
|
23089
23101
|
path: {
|
|
23090
23102
|
/**
|
|
@@ -23099,6 +23111,9 @@ export type UpdateAdCampaignResponse = ({
|
|
|
23099
23111
|
budget?: AdBudget;
|
|
23100
23112
|
budgetLevel?: 'campaign';
|
|
23101
23113
|
bidStrategy?: BidStrategy;
|
|
23114
|
+
platformSpecificData?: {
|
|
23115
|
+
[key: string]: unknown;
|
|
23116
|
+
};
|
|
23102
23117
|
});
|
|
23103
23118
|
|
|
23104
23119
|
export type UpdateAdCampaignError = (unknown | {
|
|
@@ -23250,6 +23265,42 @@ export type UpdateAdSetData = {
|
|
|
23250
23265
|
*
|
|
23251
23266
|
*/
|
|
23252
23267
|
roasAverageFloor?: number;
|
|
23268
|
+
/**
|
|
23269
|
+
* Platform-specific post-launch delivery settings. The platform is implied by the
|
|
23270
|
+
* `platform` body param. Meta only; other platforms return 400. Unknown keys are rejected.
|
|
23271
|
+
*
|
|
23272
|
+
*/
|
|
23273
|
+
platformSpecificData?: {
|
|
23274
|
+
/**
|
|
23275
|
+
* Meta ad-set optimization_goal (e.g. OFFSITE_CONVERSIONS, LANDING_PAGE_VIEWS).
|
|
23276
|
+
*/
|
|
23277
|
+
optimizationGoal?: string;
|
|
23278
|
+
/**
|
|
23279
|
+
* Meta ad-set billing_event (e.g. IMPRESSIONS, LINK_CLICKS, THRUPLAY).
|
|
23280
|
+
*/
|
|
23281
|
+
billingEvent?: string;
|
|
23282
|
+
/**
|
|
23283
|
+
* Ad set start_time (ISO 8601).
|
|
23284
|
+
*/
|
|
23285
|
+
startDate?: string;
|
|
23286
|
+
/**
|
|
23287
|
+
* Ad set end_time (ISO 8601).
|
|
23288
|
+
*/
|
|
23289
|
+
endDate?: string;
|
|
23290
|
+
/**
|
|
23291
|
+
* Meta ad-set promoted_object, forwarded verbatim (same shape as /v1/ads/create).
|
|
23292
|
+
*/
|
|
23293
|
+
promotedObject?: {
|
|
23294
|
+
pixelId?: string;
|
|
23295
|
+
customEventType?: string;
|
|
23296
|
+
pageId?: string;
|
|
23297
|
+
applicationId?: string;
|
|
23298
|
+
objectStoreUrl?: string;
|
|
23299
|
+
customConversionId?: string;
|
|
23300
|
+
productCatalogId?: string;
|
|
23301
|
+
productSetId?: string;
|
|
23302
|
+
};
|
|
23303
|
+
};
|
|
23253
23304
|
};
|
|
23254
23305
|
path: {
|
|
23255
23306
|
/**
|
|
@@ -23268,6 +23319,9 @@ export type UpdateAdSetResponse = ({
|
|
|
23268
23319
|
bidStrategy?: BidStrategy;
|
|
23269
23320
|
bidAmount?: (number) | null;
|
|
23270
23321
|
roasAverageFloor?: (number) | null;
|
|
23322
|
+
platformSpecificData?: {
|
|
23323
|
+
[key: string]: unknown;
|
|
23324
|
+
};
|
|
23271
23325
|
});
|
|
23272
23326
|
|
|
23273
23327
|
export type UpdateAdSetError = (unknown | {
|
|
@@ -24330,6 +24384,10 @@ export type CreateStandaloneAdData = {
|
|
|
24330
24384
|
* Meta only. Explicit ad-set `optimization_goal` (e.g. `LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `REACH`, `IMPRESSIONS`, `OFFSITE_CONVERSIONS`, `THRUPLAY`, `LEAD_GENERATION`). Overrides the default derived from `goal` (e.g. `traffic` defaults to `LINK_CLICKS`). Forwarded verbatim to Meta, which validates compatibility with the campaign objective and rejects incompatible combinations.
|
|
24331
24385
|
*/
|
|
24332
24386
|
optimizationGoal?: string;
|
|
24387
|
+
/**
|
|
24388
|
+
* Meta only. Explicit ad-set `billing_event`. Defaults to `IMPRESSIONS`. Forwarded verbatim to Meta, which validates compatibility with the optimization goal.
|
|
24389
|
+
*/
|
|
24390
|
+
billingEvent?: string;
|
|
24333
24391
|
/**
|
|
24334
24392
|
* Required on legacy + multi-creative shapes. Inherited on attach.
|
|
24335
24393
|
*/
|