@getlatedev/node 0.2.376 → 0.2.378
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 +85 -2
- package/dist/index.d.ts +85 -2
- 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 +85 -2
package/dist/index.d.mts
CHANGED
|
@@ -10411,6 +10411,16 @@ type GetGoogleBusinessReviewsResponse = ({
|
|
|
10411
10411
|
comment?: string;
|
|
10412
10412
|
updateTime?: string;
|
|
10413
10413
|
} | null;
|
|
10414
|
+
/**
|
|
10415
|
+
* Number of photos attached to the review (photos only, videos are not counted)
|
|
10416
|
+
*/
|
|
10417
|
+
photoCount?: number;
|
|
10418
|
+
/**
|
|
10419
|
+
* Photos attached to the review by the reviewer
|
|
10420
|
+
*/
|
|
10421
|
+
photos?: Array<{
|
|
10422
|
+
url?: string;
|
|
10423
|
+
}>;
|
|
10414
10424
|
}>;
|
|
10415
10425
|
/**
|
|
10416
10426
|
* Overall average rating
|
|
@@ -16342,6 +16352,12 @@ type ListInboxReviewsResponse = ({
|
|
|
16342
16352
|
* Number of photos attached to the review (photos only; videos are not counted). Google Business only; 0 for other platforms.
|
|
16343
16353
|
*/
|
|
16344
16354
|
photoCount?: number;
|
|
16355
|
+
/**
|
|
16356
|
+
* Photos attached to the review. Google Business only; always an empty array for other platforms.
|
|
16357
|
+
*/
|
|
16358
|
+
photos?: Array<{
|
|
16359
|
+
url?: string;
|
|
16360
|
+
}>;
|
|
16345
16361
|
reply?: {
|
|
16346
16362
|
id?: string;
|
|
16347
16363
|
text?: string;
|
|
@@ -22489,9 +22505,21 @@ type UpdateAdCampaignData = {
|
|
|
22489
22505
|
*/
|
|
22490
22506
|
bidStrategy?: (BidStrategy);
|
|
22491
22507
|
/**
|
|
22492
|
-
* Rename the campaign (Meta only; other platforms return 501). At least one of budget/bidStrategy/name is required.
|
|
22508
|
+
* Rename the campaign (Meta only; other platforms return 501). At least one of budget/bidStrategy/name/platformSpecificData is required.
|
|
22493
22509
|
*/
|
|
22494
22510
|
name?: string;
|
|
22511
|
+
/**
|
|
22512
|
+
* Platform-specific campaign settings. The platform is implied by the `platform`
|
|
22513
|
+
* body param (same convention as platformSpecificData on POST /v1/ads/create).
|
|
22514
|
+
* Meta (facebook/instagram) only; other platforms return 400.
|
|
22515
|
+
*
|
|
22516
|
+
*/
|
|
22517
|
+
platformSpecificData?: {
|
|
22518
|
+
/**
|
|
22519
|
+
* Campaign lifetime spend cap, in the ad account's currency (Meta `spend_cap`). Pass null to remove the cap (0 is rejected by Meta).
|
|
22520
|
+
*/
|
|
22521
|
+
spendCap?: (number) | null;
|
|
22522
|
+
};
|
|
22495
22523
|
};
|
|
22496
22524
|
path: {
|
|
22497
22525
|
/**
|
|
@@ -22505,6 +22533,9 @@ type UpdateAdCampaignResponse = ({
|
|
|
22505
22533
|
budget?: AdBudget;
|
|
22506
22534
|
budgetLevel?: 'campaign';
|
|
22507
22535
|
bidStrategy?: BidStrategy;
|
|
22536
|
+
platformSpecificData?: {
|
|
22537
|
+
[key: string]: unknown;
|
|
22538
|
+
};
|
|
22508
22539
|
});
|
|
22509
22540
|
type UpdateAdCampaignError = (unknown | {
|
|
22510
22541
|
error?: string;
|
|
@@ -22645,6 +22676,42 @@ type UpdateAdSetData = {
|
|
|
22645
22676
|
*
|
|
22646
22677
|
*/
|
|
22647
22678
|
roasAverageFloor?: number;
|
|
22679
|
+
/**
|
|
22680
|
+
* Platform-specific post-launch delivery settings. The platform is implied by the
|
|
22681
|
+
* `platform` body param. Meta only; other platforms return 400. Unknown keys are rejected.
|
|
22682
|
+
*
|
|
22683
|
+
*/
|
|
22684
|
+
platformSpecificData?: {
|
|
22685
|
+
/**
|
|
22686
|
+
* Meta ad-set optimization_goal (e.g. OFFSITE_CONVERSIONS, LANDING_PAGE_VIEWS).
|
|
22687
|
+
*/
|
|
22688
|
+
optimizationGoal?: string;
|
|
22689
|
+
/**
|
|
22690
|
+
* Meta ad-set billing_event (e.g. IMPRESSIONS, LINK_CLICKS, THRUPLAY).
|
|
22691
|
+
*/
|
|
22692
|
+
billingEvent?: string;
|
|
22693
|
+
/**
|
|
22694
|
+
* Ad set start_time (ISO 8601).
|
|
22695
|
+
*/
|
|
22696
|
+
startDate?: string;
|
|
22697
|
+
/**
|
|
22698
|
+
* Ad set end_time (ISO 8601).
|
|
22699
|
+
*/
|
|
22700
|
+
endDate?: string;
|
|
22701
|
+
/**
|
|
22702
|
+
* Meta ad-set promoted_object, forwarded verbatim (same shape as /v1/ads/create).
|
|
22703
|
+
*/
|
|
22704
|
+
promotedObject?: {
|
|
22705
|
+
pixelId?: string;
|
|
22706
|
+
customEventType?: string;
|
|
22707
|
+
pageId?: string;
|
|
22708
|
+
applicationId?: string;
|
|
22709
|
+
objectStoreUrl?: string;
|
|
22710
|
+
customConversionId?: string;
|
|
22711
|
+
productCatalogId?: string;
|
|
22712
|
+
productSetId?: string;
|
|
22713
|
+
};
|
|
22714
|
+
};
|
|
22648
22715
|
};
|
|
22649
22716
|
path: {
|
|
22650
22717
|
/**
|
|
@@ -22662,6 +22729,9 @@ type UpdateAdSetResponse = ({
|
|
|
22662
22729
|
bidStrategy?: BidStrategy;
|
|
22663
22730
|
bidAmount?: (number) | null;
|
|
22664
22731
|
roasAverageFloor?: (number) | null;
|
|
22732
|
+
platformSpecificData?: {
|
|
22733
|
+
[key: string]: unknown;
|
|
22734
|
+
};
|
|
22665
22735
|
});
|
|
22666
22736
|
type UpdateAdSetError = (unknown | {
|
|
22667
22737
|
error?: string;
|
|
@@ -23668,6 +23738,10 @@ type CreateStandaloneAdData = {
|
|
|
23668
23738
|
* 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
23739
|
*/
|
|
23670
23740
|
optimizationGoal?: string;
|
|
23741
|
+
/**
|
|
23742
|
+
* Meta only. Explicit ad-set `billing_event`. Defaults to `IMPRESSIONS`. Forwarded verbatim to Meta, which validates compatibility with the optimization goal.
|
|
23743
|
+
*/
|
|
23744
|
+
billingEvent?: string;
|
|
23671
23745
|
/**
|
|
23672
23746
|
* Required on legacy + multi-creative shapes. Inherited on attach.
|
|
23673
23747
|
*/
|
|
@@ -23854,7 +23928,16 @@ type CreateStandaloneAdData = {
|
|
|
23854
23928
|
*/
|
|
23855
23929
|
organizationId?: string;
|
|
23856
23930
|
/**
|
|
23857
|
-
*
|
|
23931
|
+
* Nested targeting object — the same TargetingSpec shape as `POST /v1/ads/boost`,
|
|
23932
|
+
* `POST /v1/ads/targeting/reach-estimate`, and `saved_targeting` audiences. Merged
|
|
23933
|
+
* UNDER the flat inline targeting fields below: `savedTargetingId` < `targeting` <
|
|
23934
|
+
* flat fields (a flat field present on the body replaces the nested value entirely).
|
|
23935
|
+
* Both forms are equivalent; use whichever your integration already builds.
|
|
23936
|
+
*
|
|
23937
|
+
*/
|
|
23938
|
+
targeting?: (TargetingSpec);
|
|
23939
|
+
/**
|
|
23940
|
+
* ISO 3166-1 alpha-2 country codes (e.g. ['NL']). Defaults to ['US'] when no other geo targeting (flat or nested `targeting`) is provided. (LinkedIn currently honours country-level targeting only.)
|
|
23858
23941
|
*/
|
|
23859
23942
|
countries?: Array<(string)>;
|
|
23860
23943
|
/**
|
package/dist/index.d.ts
CHANGED
|
@@ -10411,6 +10411,16 @@ type GetGoogleBusinessReviewsResponse = ({
|
|
|
10411
10411
|
comment?: string;
|
|
10412
10412
|
updateTime?: string;
|
|
10413
10413
|
} | null;
|
|
10414
|
+
/**
|
|
10415
|
+
* Number of photos attached to the review (photos only, videos are not counted)
|
|
10416
|
+
*/
|
|
10417
|
+
photoCount?: number;
|
|
10418
|
+
/**
|
|
10419
|
+
* Photos attached to the review by the reviewer
|
|
10420
|
+
*/
|
|
10421
|
+
photos?: Array<{
|
|
10422
|
+
url?: string;
|
|
10423
|
+
}>;
|
|
10414
10424
|
}>;
|
|
10415
10425
|
/**
|
|
10416
10426
|
* Overall average rating
|
|
@@ -16342,6 +16352,12 @@ type ListInboxReviewsResponse = ({
|
|
|
16342
16352
|
* Number of photos attached to the review (photos only; videos are not counted). Google Business only; 0 for other platforms.
|
|
16343
16353
|
*/
|
|
16344
16354
|
photoCount?: number;
|
|
16355
|
+
/**
|
|
16356
|
+
* Photos attached to the review. Google Business only; always an empty array for other platforms.
|
|
16357
|
+
*/
|
|
16358
|
+
photos?: Array<{
|
|
16359
|
+
url?: string;
|
|
16360
|
+
}>;
|
|
16345
16361
|
reply?: {
|
|
16346
16362
|
id?: string;
|
|
16347
16363
|
text?: string;
|
|
@@ -22489,9 +22505,21 @@ type UpdateAdCampaignData = {
|
|
|
22489
22505
|
*/
|
|
22490
22506
|
bidStrategy?: (BidStrategy);
|
|
22491
22507
|
/**
|
|
22492
|
-
* Rename the campaign (Meta only; other platforms return 501). At least one of budget/bidStrategy/name is required.
|
|
22508
|
+
* Rename the campaign (Meta only; other platforms return 501). At least one of budget/bidStrategy/name/platformSpecificData is required.
|
|
22493
22509
|
*/
|
|
22494
22510
|
name?: string;
|
|
22511
|
+
/**
|
|
22512
|
+
* Platform-specific campaign settings. The platform is implied by the `platform`
|
|
22513
|
+
* body param (same convention as platformSpecificData on POST /v1/ads/create).
|
|
22514
|
+
* Meta (facebook/instagram) only; other platforms return 400.
|
|
22515
|
+
*
|
|
22516
|
+
*/
|
|
22517
|
+
platformSpecificData?: {
|
|
22518
|
+
/**
|
|
22519
|
+
* Campaign lifetime spend cap, in the ad account's currency (Meta `spend_cap`). Pass null to remove the cap (0 is rejected by Meta).
|
|
22520
|
+
*/
|
|
22521
|
+
spendCap?: (number) | null;
|
|
22522
|
+
};
|
|
22495
22523
|
};
|
|
22496
22524
|
path: {
|
|
22497
22525
|
/**
|
|
@@ -22505,6 +22533,9 @@ type UpdateAdCampaignResponse = ({
|
|
|
22505
22533
|
budget?: AdBudget;
|
|
22506
22534
|
budgetLevel?: 'campaign';
|
|
22507
22535
|
bidStrategy?: BidStrategy;
|
|
22536
|
+
platformSpecificData?: {
|
|
22537
|
+
[key: string]: unknown;
|
|
22538
|
+
};
|
|
22508
22539
|
});
|
|
22509
22540
|
type UpdateAdCampaignError = (unknown | {
|
|
22510
22541
|
error?: string;
|
|
@@ -22645,6 +22676,42 @@ type UpdateAdSetData = {
|
|
|
22645
22676
|
*
|
|
22646
22677
|
*/
|
|
22647
22678
|
roasAverageFloor?: number;
|
|
22679
|
+
/**
|
|
22680
|
+
* Platform-specific post-launch delivery settings. The platform is implied by the
|
|
22681
|
+
* `platform` body param. Meta only; other platforms return 400. Unknown keys are rejected.
|
|
22682
|
+
*
|
|
22683
|
+
*/
|
|
22684
|
+
platformSpecificData?: {
|
|
22685
|
+
/**
|
|
22686
|
+
* Meta ad-set optimization_goal (e.g. OFFSITE_CONVERSIONS, LANDING_PAGE_VIEWS).
|
|
22687
|
+
*/
|
|
22688
|
+
optimizationGoal?: string;
|
|
22689
|
+
/**
|
|
22690
|
+
* Meta ad-set billing_event (e.g. IMPRESSIONS, LINK_CLICKS, THRUPLAY).
|
|
22691
|
+
*/
|
|
22692
|
+
billingEvent?: string;
|
|
22693
|
+
/**
|
|
22694
|
+
* Ad set start_time (ISO 8601).
|
|
22695
|
+
*/
|
|
22696
|
+
startDate?: string;
|
|
22697
|
+
/**
|
|
22698
|
+
* Ad set end_time (ISO 8601).
|
|
22699
|
+
*/
|
|
22700
|
+
endDate?: string;
|
|
22701
|
+
/**
|
|
22702
|
+
* Meta ad-set promoted_object, forwarded verbatim (same shape as /v1/ads/create).
|
|
22703
|
+
*/
|
|
22704
|
+
promotedObject?: {
|
|
22705
|
+
pixelId?: string;
|
|
22706
|
+
customEventType?: string;
|
|
22707
|
+
pageId?: string;
|
|
22708
|
+
applicationId?: string;
|
|
22709
|
+
objectStoreUrl?: string;
|
|
22710
|
+
customConversionId?: string;
|
|
22711
|
+
productCatalogId?: string;
|
|
22712
|
+
productSetId?: string;
|
|
22713
|
+
};
|
|
22714
|
+
};
|
|
22648
22715
|
};
|
|
22649
22716
|
path: {
|
|
22650
22717
|
/**
|
|
@@ -22662,6 +22729,9 @@ type UpdateAdSetResponse = ({
|
|
|
22662
22729
|
bidStrategy?: BidStrategy;
|
|
22663
22730
|
bidAmount?: (number) | null;
|
|
22664
22731
|
roasAverageFloor?: (number) | null;
|
|
22732
|
+
platformSpecificData?: {
|
|
22733
|
+
[key: string]: unknown;
|
|
22734
|
+
};
|
|
22665
22735
|
});
|
|
22666
22736
|
type UpdateAdSetError = (unknown | {
|
|
22667
22737
|
error?: string;
|
|
@@ -23668,6 +23738,10 @@ type CreateStandaloneAdData = {
|
|
|
23668
23738
|
* 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
23739
|
*/
|
|
23670
23740
|
optimizationGoal?: string;
|
|
23741
|
+
/**
|
|
23742
|
+
* Meta only. Explicit ad-set `billing_event`. Defaults to `IMPRESSIONS`. Forwarded verbatim to Meta, which validates compatibility with the optimization goal.
|
|
23743
|
+
*/
|
|
23744
|
+
billingEvent?: string;
|
|
23671
23745
|
/**
|
|
23672
23746
|
* Required on legacy + multi-creative shapes. Inherited on attach.
|
|
23673
23747
|
*/
|
|
@@ -23854,7 +23928,16 @@ type CreateStandaloneAdData = {
|
|
|
23854
23928
|
*/
|
|
23855
23929
|
organizationId?: string;
|
|
23856
23930
|
/**
|
|
23857
|
-
*
|
|
23931
|
+
* Nested targeting object — the same TargetingSpec shape as `POST /v1/ads/boost`,
|
|
23932
|
+
* `POST /v1/ads/targeting/reach-estimate`, and `saved_targeting` audiences. Merged
|
|
23933
|
+
* UNDER the flat inline targeting fields below: `savedTargetingId` < `targeting` <
|
|
23934
|
+
* flat fields (a flat field present on the body replaces the nested value entirely).
|
|
23935
|
+
* Both forms are equivalent; use whichever your integration already builds.
|
|
23936
|
+
*
|
|
23937
|
+
*/
|
|
23938
|
+
targeting?: (TargetingSpec);
|
|
23939
|
+
/**
|
|
23940
|
+
* ISO 3166-1 alpha-2 country codes (e.g. ['NL']). Defaults to ['US'] when no other geo targeting (flat or nested `targeting`) is provided. (LinkedIn currently honours country-level targeting only.)
|
|
23858
23941
|
*/
|
|
23859
23942
|
countries?: Array<(string)>;
|
|
23860
23943
|
/**
|
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.378",
|
|
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.378",
|
|
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.
|
|
@@ -10033,6 +10033,16 @@ export type GetGoogleBusinessReviewsResponse = ({
|
|
|
10033
10033
|
comment?: string;
|
|
10034
10034
|
updateTime?: string;
|
|
10035
10035
|
} | null;
|
|
10036
|
+
/**
|
|
10037
|
+
* Number of photos attached to the review (photos only, videos are not counted)
|
|
10038
|
+
*/
|
|
10039
|
+
photoCount?: number;
|
|
10040
|
+
/**
|
|
10041
|
+
* Photos attached to the review by the reviewer
|
|
10042
|
+
*/
|
|
10043
|
+
photos?: Array<{
|
|
10044
|
+
url?: string;
|
|
10045
|
+
}>;
|
|
10036
10046
|
}>;
|
|
10037
10047
|
/**
|
|
10038
10048
|
* Overall average rating
|
|
@@ -16383,6 +16393,12 @@ export type ListInboxReviewsResponse = ({
|
|
|
16383
16393
|
* Number of photos attached to the review (photos only; videos are not counted). Google Business only; 0 for other platforms.
|
|
16384
16394
|
*/
|
|
16385
16395
|
photoCount?: number;
|
|
16396
|
+
/**
|
|
16397
|
+
* Photos attached to the review. Google Business only; always an empty array for other platforms.
|
|
16398
|
+
*/
|
|
16399
|
+
photos?: Array<{
|
|
16400
|
+
url?: string;
|
|
16401
|
+
}>;
|
|
16386
16402
|
reply?: {
|
|
16387
16403
|
id?: string;
|
|
16388
16404
|
text?: string;
|
|
@@ -23082,9 +23098,21 @@ export type UpdateAdCampaignData = {
|
|
|
23082
23098
|
*/
|
|
23083
23099
|
bidStrategy?: (BidStrategy);
|
|
23084
23100
|
/**
|
|
23085
|
-
* Rename the campaign (Meta only; other platforms return 501). At least one of budget/bidStrategy/name is required.
|
|
23101
|
+
* Rename the campaign (Meta only; other platforms return 501). At least one of budget/bidStrategy/name/platformSpecificData is required.
|
|
23086
23102
|
*/
|
|
23087
23103
|
name?: string;
|
|
23104
|
+
/**
|
|
23105
|
+
* Platform-specific campaign settings. The platform is implied by the `platform`
|
|
23106
|
+
* body param (same convention as platformSpecificData on POST /v1/ads/create).
|
|
23107
|
+
* Meta (facebook/instagram) only; other platforms return 400.
|
|
23108
|
+
*
|
|
23109
|
+
*/
|
|
23110
|
+
platformSpecificData?: {
|
|
23111
|
+
/**
|
|
23112
|
+
* Campaign lifetime spend cap, in the ad account's currency (Meta `spend_cap`). Pass null to remove the cap (0 is rejected by Meta).
|
|
23113
|
+
*/
|
|
23114
|
+
spendCap?: (number) | null;
|
|
23115
|
+
};
|
|
23088
23116
|
};
|
|
23089
23117
|
path: {
|
|
23090
23118
|
/**
|
|
@@ -23099,6 +23127,9 @@ export type UpdateAdCampaignResponse = ({
|
|
|
23099
23127
|
budget?: AdBudget;
|
|
23100
23128
|
budgetLevel?: 'campaign';
|
|
23101
23129
|
bidStrategy?: BidStrategy;
|
|
23130
|
+
platformSpecificData?: {
|
|
23131
|
+
[key: string]: unknown;
|
|
23132
|
+
};
|
|
23102
23133
|
});
|
|
23103
23134
|
|
|
23104
23135
|
export type UpdateAdCampaignError = (unknown | {
|
|
@@ -23250,6 +23281,42 @@ export type UpdateAdSetData = {
|
|
|
23250
23281
|
*
|
|
23251
23282
|
*/
|
|
23252
23283
|
roasAverageFloor?: number;
|
|
23284
|
+
/**
|
|
23285
|
+
* Platform-specific post-launch delivery settings. The platform is implied by the
|
|
23286
|
+
* `platform` body param. Meta only; other platforms return 400. Unknown keys are rejected.
|
|
23287
|
+
*
|
|
23288
|
+
*/
|
|
23289
|
+
platformSpecificData?: {
|
|
23290
|
+
/**
|
|
23291
|
+
* Meta ad-set optimization_goal (e.g. OFFSITE_CONVERSIONS, LANDING_PAGE_VIEWS).
|
|
23292
|
+
*/
|
|
23293
|
+
optimizationGoal?: string;
|
|
23294
|
+
/**
|
|
23295
|
+
* Meta ad-set billing_event (e.g. IMPRESSIONS, LINK_CLICKS, THRUPLAY).
|
|
23296
|
+
*/
|
|
23297
|
+
billingEvent?: string;
|
|
23298
|
+
/**
|
|
23299
|
+
* Ad set start_time (ISO 8601).
|
|
23300
|
+
*/
|
|
23301
|
+
startDate?: string;
|
|
23302
|
+
/**
|
|
23303
|
+
* Ad set end_time (ISO 8601).
|
|
23304
|
+
*/
|
|
23305
|
+
endDate?: string;
|
|
23306
|
+
/**
|
|
23307
|
+
* Meta ad-set promoted_object, forwarded verbatim (same shape as /v1/ads/create).
|
|
23308
|
+
*/
|
|
23309
|
+
promotedObject?: {
|
|
23310
|
+
pixelId?: string;
|
|
23311
|
+
customEventType?: string;
|
|
23312
|
+
pageId?: string;
|
|
23313
|
+
applicationId?: string;
|
|
23314
|
+
objectStoreUrl?: string;
|
|
23315
|
+
customConversionId?: string;
|
|
23316
|
+
productCatalogId?: string;
|
|
23317
|
+
productSetId?: string;
|
|
23318
|
+
};
|
|
23319
|
+
};
|
|
23253
23320
|
};
|
|
23254
23321
|
path: {
|
|
23255
23322
|
/**
|
|
@@ -23268,6 +23335,9 @@ export type UpdateAdSetResponse = ({
|
|
|
23268
23335
|
bidStrategy?: BidStrategy;
|
|
23269
23336
|
bidAmount?: (number) | null;
|
|
23270
23337
|
roasAverageFloor?: (number) | null;
|
|
23338
|
+
platformSpecificData?: {
|
|
23339
|
+
[key: string]: unknown;
|
|
23340
|
+
};
|
|
23271
23341
|
});
|
|
23272
23342
|
|
|
23273
23343
|
export type UpdateAdSetError = (unknown | {
|
|
@@ -24330,6 +24400,10 @@ export type CreateStandaloneAdData = {
|
|
|
24330
24400
|
* 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
24401
|
*/
|
|
24332
24402
|
optimizationGoal?: string;
|
|
24403
|
+
/**
|
|
24404
|
+
* Meta only. Explicit ad-set `billing_event`. Defaults to `IMPRESSIONS`. Forwarded verbatim to Meta, which validates compatibility with the optimization goal.
|
|
24405
|
+
*/
|
|
24406
|
+
billingEvent?: string;
|
|
24333
24407
|
/**
|
|
24334
24408
|
* Required on legacy + multi-creative shapes. Inherited on attach.
|
|
24335
24409
|
*/
|
|
@@ -24516,7 +24590,16 @@ export type CreateStandaloneAdData = {
|
|
|
24516
24590
|
*/
|
|
24517
24591
|
organizationId?: string;
|
|
24518
24592
|
/**
|
|
24519
|
-
*
|
|
24593
|
+
* Nested targeting object — the same TargetingSpec shape as `POST /v1/ads/boost`,
|
|
24594
|
+
* `POST /v1/ads/targeting/reach-estimate`, and `saved_targeting` audiences. Merged
|
|
24595
|
+
* UNDER the flat inline targeting fields below: `savedTargetingId` < `targeting` <
|
|
24596
|
+
* flat fields (a flat field present on the body replaces the nested value entirely).
|
|
24597
|
+
* Both forms are equivalent; use whichever your integration already builds.
|
|
24598
|
+
*
|
|
24599
|
+
*/
|
|
24600
|
+
targeting?: (TargetingSpec);
|
|
24601
|
+
/**
|
|
24602
|
+
* ISO 3166-1 alpha-2 country codes (e.g. ['NL']). Defaults to ['US'] when no other geo targeting (flat or nested `targeting`) is provided. (LinkedIn currently honours country-level targeting only.)
|
|
24520
24603
|
*/
|
|
24521
24604
|
countries?: Array<(string)>;
|
|
24522
24605
|
/**
|