@zernio/node 0.2.541 → 0.2.543
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 +26 -8
- package/dist/index.d.ts +26 -8
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +4 -0
- package/src/generated/types.gen.ts +26 -8
package/dist/index.d.mts
CHANGED
|
@@ -5036,11 +5036,11 @@ type MediaUploadResponse = {
|
|
|
5036
5036
|
type MetaAdsPlatformData = {
|
|
5037
5037
|
bidStrategy?: BidStrategy;
|
|
5038
5038
|
/**
|
|
5039
|
-
* Whole currency units (USD: 5 = $5.00). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP.
|
|
5039
|
+
* Whole currency units (USD: 5 = $5.00). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. May also be sent alone, WITHOUT bidStrategy, to set the cap on an ad set joining a COST_CAP / LOWEST_COST_WITH_BID_CAP campaign (the strategy is inherited from the campaign). On POST /v1/ads/create that shape requires existingCampaignId and is a 400 otherwise; on POST /v1/ads/boost it is promoted to LOWEST_COST_WITH_BID_CAP.
|
|
5040
5040
|
*/
|
|
5041
5041
|
bidAmount?: number;
|
|
5042
5042
|
/**
|
|
5043
|
-
* Decimal ROAS multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS.
|
|
5043
|
+
* Decimal ROAS multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS; sending it without bidStrategy is a 400.
|
|
5044
5044
|
*/
|
|
5045
5045
|
roasAverageFloor?: number;
|
|
5046
5046
|
};
|
|
@@ -24810,6 +24810,10 @@ type ListBroadcastRecipientsResponse = ({
|
|
|
24810
24810
|
* Plain-language translation of errorCode (e.g. for 131026, that the recipient has likely opted out of marketing messages). Null for unmapped codes; fall back to error.
|
|
24811
24811
|
*/
|
|
24812
24812
|
errorExplanation?: (string) | null;
|
|
24813
|
+
/**
|
|
24814
|
+
* Meta trace id (fbtrace_id) for the failed send. Quote this when escalating to Meta Direct Support. Only populated for status=failed on Meta platforms.
|
|
24815
|
+
*/
|
|
24816
|
+
errorTraceId?: (string) | null;
|
|
24813
24817
|
sentAt?: string;
|
|
24814
24818
|
deliveredAt?: string;
|
|
24815
24819
|
readAt?: string;
|
|
@@ -26407,7 +26411,7 @@ type CreateAdCampaignData = {
|
|
|
26407
26411
|
*/
|
|
26408
26412
|
bidStrategy?: 'LOWEST_COST_WITHOUT_CAP' | 'LOWEST_COST_WITH_BID_CAP' | 'COST_CAP' | 'LOWEST_COST_WITH_MIN_ROAS';
|
|
26409
26413
|
/**
|
|
26410
|
-
* Whole currency units (USD: 5 = $5.00). Required for LOWEST_COST_WITH_BID_CAP and COST_CAP; ignored otherwise.
|
|
26414
|
+
* Whole currency units (USD: 5 = $5.00). Required for LOWEST_COST_WITH_BID_CAP and COST_CAP; ignored otherwise. Validated here but NOT stored by Meta: the campaign object has no bid_amount field, only bid_strategy lives on it. The amount takes effect once an ad set joins this campaign (existingCampaignId on POST /v1/ads/create) and supplies its own bidAmount there.
|
|
26411
26415
|
*/
|
|
26412
26416
|
bidAmount?: number;
|
|
26413
26417
|
/**
|
|
@@ -26794,7 +26798,10 @@ type UpdateAdSetData = {
|
|
|
26794
26798
|
/**
|
|
26795
26799
|
* Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when
|
|
26796
26800
|
* bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. Internally converted to Meta's
|
|
26797
|
-
* smallest-denomination integer, or (on OpenAI) to micros (× 1,000,000).
|
|
26801
|
+
* smallest-denomination integer, or (on OpenAI) to micros (× 1,000,000). Meta only:
|
|
26802
|
+
* may be sent alone, WITHOUT bidStrategy, to update the cap amount on an ad set whose
|
|
26803
|
+
* parent campaign is COST_CAP or LOWEST_COST_WITH_BID_CAP (the strategy is inherited
|
|
26804
|
+
* from the campaign and is left untouched).
|
|
26798
26805
|
*
|
|
26799
26806
|
*/
|
|
26800
26807
|
bidAmount?: number;
|
|
@@ -29747,7 +29754,14 @@ type CreateStandaloneAdData = {
|
|
|
29747
29754
|
* Deprecated: send it inside `platformSpecificData` instead (Meta today; TikTok's nested shape is planned). The flat field keeps working during the deprecation window; sending both shapes returns a 400.
|
|
29748
29755
|
*
|
|
29749
29756
|
* Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when
|
|
29750
|
-
* `bidStrategy` is `LOWEST_COST_WITH_BID_CAP` or `COST_CAP`.
|
|
29757
|
+
* `bidStrategy` is `LOWEST_COST_WITH_BID_CAP` or `COST_CAP`. Meta only: sending
|
|
29758
|
+
* `bidAmount` WITHOUT `bidStrategy` requires `existingCampaignId` (400 otherwise),
|
|
29759
|
+
* and sets the new ad set's cap under the joined campaign's COST_CAP /
|
|
29760
|
+
* LOWEST_COST_WITH_BID_CAP parent. The strategy itself is inherited from the
|
|
29761
|
+
* campaign. Restating bidStrategy here is accepted but has no effect on the ad set.
|
|
29762
|
+
*
|
|
29763
|
+
* Rejected with 400 in `adSetId` attach mode: that shape inherits its cap from
|
|
29764
|
+
* the platform. Use `PUT /v1/ads/ad-sets/{adSetId}` there instead.
|
|
29751
29765
|
*
|
|
29752
29766
|
* @deprecated
|
|
29753
29767
|
*/
|
|
@@ -29756,8 +29770,11 @@ type CreateStandaloneAdData = {
|
|
|
29756
29770
|
* Deprecated: send it inside `platformSpecificData` instead (Meta today; TikTok's nested shape is planned). The flat field keeps working during the deprecation window; sending both shapes returns a 400.
|
|
29757
29771
|
*
|
|
29758
29772
|
* Minimum ROAS as a decimal multiplier (e.g. 2.0 = 2.0x ROAS). Required when
|
|
29759
|
-
* `bidStrategy` is `LOWEST_COST_WITH_MIN_ROAS`.
|
|
29760
|
-
*
|
|
29773
|
+
* `bidStrategy` is `LOWEST_COST_WITH_MIN_ROAS`. Sending it without `bidStrategy`
|
|
29774
|
+
* is a 400. Sent to Meta as
|
|
29775
|
+
* `bid_constraints.roas_average_floor` × 10000. Known gap: a CBO campaign's
|
|
29776
|
+
* ROAS floor lives on the campaign only (set via `POST /v1/ads/campaigns`);
|
|
29777
|
+
* there is no supported way to set it while joining a CBO campaign here.
|
|
29761
29778
|
*
|
|
29762
29779
|
* @deprecated
|
|
29763
29780
|
*/
|
|
@@ -29797,7 +29814,8 @@ type CreateStandaloneAdData = {
|
|
|
29797
29814
|
* **Meta**: `bidStrategy`, `bidAmount` and `roasAverageFloor` may be
|
|
29798
29815
|
* sent here instead of at the root — the preferred home going forward.
|
|
29799
29816
|
* Sending the bid fields in BOTH places returns a 400
|
|
29800
|
-
* (`mutually_exclusive_fields`)
|
|
29817
|
+
* (`mutually_exclusive_fields`), and sending any of them in
|
|
29818
|
+
* `adSetId` attach mode is a 400 too (the ad set already has its bid).
|
|
29801
29819
|
*
|
|
29802
29820
|
*/
|
|
29803
29821
|
platformSpecificData?: (LinkedInAdsPlatformData | MetaAdsPlatformData);
|
package/dist/index.d.ts
CHANGED
|
@@ -5036,11 +5036,11 @@ type MediaUploadResponse = {
|
|
|
5036
5036
|
type MetaAdsPlatformData = {
|
|
5037
5037
|
bidStrategy?: BidStrategy;
|
|
5038
5038
|
/**
|
|
5039
|
-
* Whole currency units (USD: 5 = $5.00). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP.
|
|
5039
|
+
* Whole currency units (USD: 5 = $5.00). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. May also be sent alone, WITHOUT bidStrategy, to set the cap on an ad set joining a COST_CAP / LOWEST_COST_WITH_BID_CAP campaign (the strategy is inherited from the campaign). On POST /v1/ads/create that shape requires existingCampaignId and is a 400 otherwise; on POST /v1/ads/boost it is promoted to LOWEST_COST_WITH_BID_CAP.
|
|
5040
5040
|
*/
|
|
5041
5041
|
bidAmount?: number;
|
|
5042
5042
|
/**
|
|
5043
|
-
* Decimal ROAS multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS.
|
|
5043
|
+
* Decimal ROAS multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS; sending it without bidStrategy is a 400.
|
|
5044
5044
|
*/
|
|
5045
5045
|
roasAverageFloor?: number;
|
|
5046
5046
|
};
|
|
@@ -24810,6 +24810,10 @@ type ListBroadcastRecipientsResponse = ({
|
|
|
24810
24810
|
* Plain-language translation of errorCode (e.g. for 131026, that the recipient has likely opted out of marketing messages). Null for unmapped codes; fall back to error.
|
|
24811
24811
|
*/
|
|
24812
24812
|
errorExplanation?: (string) | null;
|
|
24813
|
+
/**
|
|
24814
|
+
* Meta trace id (fbtrace_id) for the failed send. Quote this when escalating to Meta Direct Support. Only populated for status=failed on Meta platforms.
|
|
24815
|
+
*/
|
|
24816
|
+
errorTraceId?: (string) | null;
|
|
24813
24817
|
sentAt?: string;
|
|
24814
24818
|
deliveredAt?: string;
|
|
24815
24819
|
readAt?: string;
|
|
@@ -26407,7 +26411,7 @@ type CreateAdCampaignData = {
|
|
|
26407
26411
|
*/
|
|
26408
26412
|
bidStrategy?: 'LOWEST_COST_WITHOUT_CAP' | 'LOWEST_COST_WITH_BID_CAP' | 'COST_CAP' | 'LOWEST_COST_WITH_MIN_ROAS';
|
|
26409
26413
|
/**
|
|
26410
|
-
* Whole currency units (USD: 5 = $5.00). Required for LOWEST_COST_WITH_BID_CAP and COST_CAP; ignored otherwise.
|
|
26414
|
+
* Whole currency units (USD: 5 = $5.00). Required for LOWEST_COST_WITH_BID_CAP and COST_CAP; ignored otherwise. Validated here but NOT stored by Meta: the campaign object has no bid_amount field, only bid_strategy lives on it. The amount takes effect once an ad set joins this campaign (existingCampaignId on POST /v1/ads/create) and supplies its own bidAmount there.
|
|
26411
26415
|
*/
|
|
26412
26416
|
bidAmount?: number;
|
|
26413
26417
|
/**
|
|
@@ -26794,7 +26798,10 @@ type UpdateAdSetData = {
|
|
|
26794
26798
|
/**
|
|
26795
26799
|
* Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when
|
|
26796
26800
|
* bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. Internally converted to Meta's
|
|
26797
|
-
* smallest-denomination integer, or (on OpenAI) to micros (× 1,000,000).
|
|
26801
|
+
* smallest-denomination integer, or (on OpenAI) to micros (× 1,000,000). Meta only:
|
|
26802
|
+
* may be sent alone, WITHOUT bidStrategy, to update the cap amount on an ad set whose
|
|
26803
|
+
* parent campaign is COST_CAP or LOWEST_COST_WITH_BID_CAP (the strategy is inherited
|
|
26804
|
+
* from the campaign and is left untouched).
|
|
26798
26805
|
*
|
|
26799
26806
|
*/
|
|
26800
26807
|
bidAmount?: number;
|
|
@@ -29747,7 +29754,14 @@ type CreateStandaloneAdData = {
|
|
|
29747
29754
|
* Deprecated: send it inside `platformSpecificData` instead (Meta today; TikTok's nested shape is planned). The flat field keeps working during the deprecation window; sending both shapes returns a 400.
|
|
29748
29755
|
*
|
|
29749
29756
|
* Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when
|
|
29750
|
-
* `bidStrategy` is `LOWEST_COST_WITH_BID_CAP` or `COST_CAP`.
|
|
29757
|
+
* `bidStrategy` is `LOWEST_COST_WITH_BID_CAP` or `COST_CAP`. Meta only: sending
|
|
29758
|
+
* `bidAmount` WITHOUT `bidStrategy` requires `existingCampaignId` (400 otherwise),
|
|
29759
|
+
* and sets the new ad set's cap under the joined campaign's COST_CAP /
|
|
29760
|
+
* LOWEST_COST_WITH_BID_CAP parent. The strategy itself is inherited from the
|
|
29761
|
+
* campaign. Restating bidStrategy here is accepted but has no effect on the ad set.
|
|
29762
|
+
*
|
|
29763
|
+
* Rejected with 400 in `adSetId` attach mode: that shape inherits its cap from
|
|
29764
|
+
* the platform. Use `PUT /v1/ads/ad-sets/{adSetId}` there instead.
|
|
29751
29765
|
*
|
|
29752
29766
|
* @deprecated
|
|
29753
29767
|
*/
|
|
@@ -29756,8 +29770,11 @@ type CreateStandaloneAdData = {
|
|
|
29756
29770
|
* Deprecated: send it inside `platformSpecificData` instead (Meta today; TikTok's nested shape is planned). The flat field keeps working during the deprecation window; sending both shapes returns a 400.
|
|
29757
29771
|
*
|
|
29758
29772
|
* Minimum ROAS as a decimal multiplier (e.g. 2.0 = 2.0x ROAS). Required when
|
|
29759
|
-
* `bidStrategy` is `LOWEST_COST_WITH_MIN_ROAS`.
|
|
29760
|
-
*
|
|
29773
|
+
* `bidStrategy` is `LOWEST_COST_WITH_MIN_ROAS`. Sending it without `bidStrategy`
|
|
29774
|
+
* is a 400. Sent to Meta as
|
|
29775
|
+
* `bid_constraints.roas_average_floor` × 10000. Known gap: a CBO campaign's
|
|
29776
|
+
* ROAS floor lives on the campaign only (set via `POST /v1/ads/campaigns`);
|
|
29777
|
+
* there is no supported way to set it while joining a CBO campaign here.
|
|
29761
29778
|
*
|
|
29762
29779
|
* @deprecated
|
|
29763
29780
|
*/
|
|
@@ -29797,7 +29814,8 @@ type CreateStandaloneAdData = {
|
|
|
29797
29814
|
* **Meta**: `bidStrategy`, `bidAmount` and `roasAverageFloor` may be
|
|
29798
29815
|
* sent here instead of at the root — the preferred home going forward.
|
|
29799
29816
|
* Sending the bid fields in BOTH places returns a 400
|
|
29800
|
-
* (`mutually_exclusive_fields`)
|
|
29817
|
+
* (`mutually_exclusive_fields`), and sending any of them in
|
|
29818
|
+
* `adSetId` attach mode is a 400 too (the ad set already has its bid).
|
|
29801
29819
|
*
|
|
29802
29820
|
*/
|
|
29803
29821
|
platformSpecificData?: (LinkedInAdsPlatformData | MetaAdsPlatformData);
|
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.543",
|
|
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.543",
|
|
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
|
@@ -7175,6 +7175,10 @@ export const getAdSetDetails = <ThrowOnError extends boolean = false>(options: O
|
|
|
7175
7175
|
* - `LOWEST_COST_WITHOUT_CAP`: no `bidAmount`, no `roasAverageFloor`.
|
|
7176
7176
|
* - `LOWEST_COST_WITH_BID_CAP` / `COST_CAP`: `bidAmount` REQUIRED (whole currency units).
|
|
7177
7177
|
* - `LOWEST_COST_WITH_MIN_ROAS`: `roasAverageFloor` REQUIRED (decimal multiplier, e.g. 2.0 = 2.0x ROAS).
|
|
7178
|
+
* - Meta only: send `bidAmount` WITHOUT `bidStrategy` to change the cap amount on an ad set
|
|
7179
|
+
* under a COST_CAP / LOWEST_COST_WITH_BID_CAP parent campaign, leaving the strategy itself
|
|
7180
|
+
* (inherited from the campaign) untouched. `roasAverageFloor` without `bidStrategy` is
|
|
7181
|
+
* rejected (it has no meaning outside LOWEST_COST_WITH_MIN_ROAS).
|
|
7178
7182
|
*
|
|
7179
7183
|
* Delivery settings are validated by Meta against the campaign objective;
|
|
7180
7184
|
* incompatible combinations (e.g. a billingEvent the optimization goal
|
|
@@ -3921,11 +3921,11 @@ export type MediaUploadResponse = {
|
|
|
3921
3921
|
export type MetaAdsPlatformData = {
|
|
3922
3922
|
bidStrategy?: BidStrategy;
|
|
3923
3923
|
/**
|
|
3924
|
-
* Whole currency units (USD: 5 = $5.00). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP.
|
|
3924
|
+
* Whole currency units (USD: 5 = $5.00). Required when bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. May also be sent alone, WITHOUT bidStrategy, to set the cap on an ad set joining a COST_CAP / LOWEST_COST_WITH_BID_CAP campaign (the strategy is inherited from the campaign). On POST /v1/ads/create that shape requires existingCampaignId and is a 400 otherwise; on POST /v1/ads/boost it is promoted to LOWEST_COST_WITH_BID_CAP.
|
|
3925
3925
|
*/
|
|
3926
3926
|
bidAmount?: number;
|
|
3927
3927
|
/**
|
|
3928
|
-
* Decimal ROAS multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS.
|
|
3928
|
+
* Decimal ROAS multiplier (2.0 = 2.0x). Required when bidStrategy is LOWEST_COST_WITH_MIN_ROAS; sending it without bidStrategy is a 400.
|
|
3929
3929
|
*/
|
|
3930
3930
|
roasAverageFloor?: number;
|
|
3931
3931
|
};
|
|
@@ -25081,6 +25081,10 @@ export type ListBroadcastRecipientsResponse = ({
|
|
|
25081
25081
|
* Plain-language translation of errorCode (e.g. for 131026, that the recipient has likely opted out of marketing messages). Null for unmapped codes; fall back to error.
|
|
25082
25082
|
*/
|
|
25083
25083
|
errorExplanation?: (string) | null;
|
|
25084
|
+
/**
|
|
25085
|
+
* Meta trace id (fbtrace_id) for the failed send. Quote this when escalating to Meta Direct Support. Only populated for status=failed on Meta platforms.
|
|
25086
|
+
*/
|
|
25087
|
+
errorTraceId?: (string) | null;
|
|
25084
25088
|
sentAt?: string;
|
|
25085
25089
|
deliveredAt?: string;
|
|
25086
25090
|
readAt?: string;
|
|
@@ -26785,7 +26789,7 @@ export type CreateAdCampaignData = {
|
|
|
26785
26789
|
*/
|
|
26786
26790
|
bidStrategy?: 'LOWEST_COST_WITHOUT_CAP' | 'LOWEST_COST_WITH_BID_CAP' | 'COST_CAP' | 'LOWEST_COST_WITH_MIN_ROAS';
|
|
26787
26791
|
/**
|
|
26788
|
-
* Whole currency units (USD: 5 = $5.00). Required for LOWEST_COST_WITH_BID_CAP and COST_CAP; ignored otherwise.
|
|
26792
|
+
* Whole currency units (USD: 5 = $5.00). Required for LOWEST_COST_WITH_BID_CAP and COST_CAP; ignored otherwise. Validated here but NOT stored by Meta: the campaign object has no bid_amount field, only bid_strategy lives on it. The amount takes effect once an ad set joins this campaign (existingCampaignId on POST /v1/ads/create) and supplies its own bidAmount there.
|
|
26789
26793
|
*/
|
|
26790
26794
|
bidAmount?: number;
|
|
26791
26795
|
/**
|
|
@@ -27199,7 +27203,10 @@ export type UpdateAdSetData = {
|
|
|
27199
27203
|
/**
|
|
27200
27204
|
* Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when
|
|
27201
27205
|
* bidStrategy is LOWEST_COST_WITH_BID_CAP or COST_CAP. Internally converted to Meta's
|
|
27202
|
-
* smallest-denomination integer, or (on OpenAI) to micros (× 1,000,000).
|
|
27206
|
+
* smallest-denomination integer, or (on OpenAI) to micros (× 1,000,000). Meta only:
|
|
27207
|
+
* may be sent alone, WITHOUT bidStrategy, to update the cap amount on an ad set whose
|
|
27208
|
+
* parent campaign is COST_CAP or LOWEST_COST_WITH_BID_CAP (the strategy is inherited
|
|
27209
|
+
* from the campaign and is left untouched).
|
|
27203
27210
|
*
|
|
27204
27211
|
*/
|
|
27205
27212
|
bidAmount?: number;
|
|
@@ -30293,7 +30300,14 @@ export type CreateStandaloneAdData = {
|
|
|
30293
30300
|
* Deprecated: send it inside `platformSpecificData` instead (Meta today; TikTok's nested shape is planned). The flat field keeps working during the deprecation window; sending both shapes returns a 400.
|
|
30294
30301
|
*
|
|
30295
30302
|
* Bid cap in WHOLE currency units (USD: 5 = $5.00; JPY: 100 = ¥100). Required when
|
|
30296
|
-
* `bidStrategy` is `LOWEST_COST_WITH_BID_CAP` or `COST_CAP`.
|
|
30303
|
+
* `bidStrategy` is `LOWEST_COST_WITH_BID_CAP` or `COST_CAP`. Meta only: sending
|
|
30304
|
+
* `bidAmount` WITHOUT `bidStrategy` requires `existingCampaignId` (400 otherwise),
|
|
30305
|
+
* and sets the new ad set's cap under the joined campaign's COST_CAP /
|
|
30306
|
+
* LOWEST_COST_WITH_BID_CAP parent. The strategy itself is inherited from the
|
|
30307
|
+
* campaign. Restating bidStrategy here is accepted but has no effect on the ad set.
|
|
30308
|
+
*
|
|
30309
|
+
* Rejected with 400 in `adSetId` attach mode: that shape inherits its cap from
|
|
30310
|
+
* the platform. Use `PUT /v1/ads/ad-sets/{adSetId}` there instead.
|
|
30297
30311
|
*
|
|
30298
30312
|
* @deprecated
|
|
30299
30313
|
*/
|
|
@@ -30302,8 +30316,11 @@ export type CreateStandaloneAdData = {
|
|
|
30302
30316
|
* Deprecated: send it inside `platformSpecificData` instead (Meta today; TikTok's nested shape is planned). The flat field keeps working during the deprecation window; sending both shapes returns a 400.
|
|
30303
30317
|
*
|
|
30304
30318
|
* Minimum ROAS as a decimal multiplier (e.g. 2.0 = 2.0x ROAS). Required when
|
|
30305
|
-
* `bidStrategy` is `LOWEST_COST_WITH_MIN_ROAS`.
|
|
30306
|
-
*
|
|
30319
|
+
* `bidStrategy` is `LOWEST_COST_WITH_MIN_ROAS`. Sending it without `bidStrategy`
|
|
30320
|
+
* is a 400. Sent to Meta as
|
|
30321
|
+
* `bid_constraints.roas_average_floor` × 10000. Known gap: a CBO campaign's
|
|
30322
|
+
* ROAS floor lives on the campaign only (set via `POST /v1/ads/campaigns`);
|
|
30323
|
+
* there is no supported way to set it while joining a CBO campaign here.
|
|
30307
30324
|
*
|
|
30308
30325
|
* @deprecated
|
|
30309
30326
|
*/
|
|
@@ -30343,7 +30360,8 @@ export type CreateStandaloneAdData = {
|
|
|
30343
30360
|
* **Meta**: `bidStrategy`, `bidAmount` and `roasAverageFloor` may be
|
|
30344
30361
|
* sent here instead of at the root — the preferred home going forward.
|
|
30345
30362
|
* Sending the bid fields in BOTH places returns a 400
|
|
30346
|
-
* (`mutually_exclusive_fields`)
|
|
30363
|
+
* (`mutually_exclusive_fields`), and sending any of them in
|
|
30364
|
+
* `adSetId` attach mode is a 400 too (the ad set already has its bid).
|
|
30347
30365
|
*
|
|
30348
30366
|
*/
|
|
30349
30367
|
platformSpecificData?: (LinkedInAdsPlatformData | MetaAdsPlatformData);
|