@zernio/node 0.2.868 → 0.2.870

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 CHANGED
@@ -39090,7 +39090,7 @@ type BoostPostData = {
39090
39090
  */
39091
39091
  postId?: string;
39092
39092
  /**
39093
- * Platform post ID (alternative to postId)
39093
+ * Platform post ID (alternative to postId). Meta: a Page post id (`<pageId>_<postId>` or the bare post id) or an Instagram media id. On a Meta Ads business-login connection (platform metaads) the id is resolved live: an Instagram media id is boosted as that media, running as the Instagram account that owns it.
39094
39094
  */
39095
39095
  platformPostId?: string;
39096
39096
  /**
@@ -39457,29 +39457,43 @@ type BoostPostData = {
39457
39457
  minimumPurchaseCurrency?: string;
39458
39458
  }>;
39459
39459
  /**
39460
- * TikTok-only on this endpoint. The pixel a Website Conversion ad group
39461
- * optimizes toward, so a Spark Ad built from an existing organic post can
39462
- * optimize for a conversion instead of only engagement or traffic.
39460
+ * Meta and TikTok. What the conversion ad set optimizes toward, so a boost
39461
+ * of an existing organic post can run for a conversion instead of only
39462
+ * engagement or traffic. Required when `goal` is `conversions` (Meta also
39463
+ * `lead_conversion`); ignored on goals that do not optimize for a conversion.
39463
39464
  *
39464
- * Required when `goal` is `conversions`, and BOTH fields are required:
39465
- * TikTok refuses a conversion ad group with no pixel ("Please select a
39466
- * pixel") and equally one that has a pixel but no event ("Select a pixel
39467
- * event."), because the event is what the ad group optimizes toward. Ignored
39468
- * on every other goal, since only a WEB_CONVERSIONS ad group accepts them.
39465
+ * Meta: `pixelId` + `customEventType` (a commerce event such as PURCHASE
39466
+ * under `conversions`, a leads-class event such as LEAD under
39467
+ * `lead_conversion`), or `customConversionId` to optimize against a Custom
39468
+ * Conversion, or `customEventType: OTHER` + `customEventStr` for a pixel
39469
+ * custom event. Becomes the ad set `promoted_object`; without it Meta
39470
+ * rejects the ad set ("Please select a promoted object", subcode 1815430).
39471
+ * With `adSetId` the existing ad set already carries it.
39469
39472
  *
39470
- * Combine freely with `platformPostId` + `sparkAuthCode`: the pixel lives on
39471
- * the ad group and the Spark item on the creative, so they never conflict.
39473
+ * TikTok: BOTH `pixelId` and `customEventType` are required. TikTok refuses
39474
+ * a conversion ad group with no pixel ("Please select a pixel") and one
39475
+ * with a pixel but no event ("Select a pixel event."). Combine freely with
39476
+ * `platformPostId` + `sparkAuthCode`: the pixel lives on the ad group and
39477
+ * the Spark item on the creative.
39472
39478
  *
39473
39479
  */
39474
39480
  promotedObject?: {
39475
39481
  /**
39476
- * TikTok Pixel. Either the numeric pixel id or the alphanumeric pixel code from Events Manager, which is resolved for you.
39482
+ * Meta Pixel id, or TikTok Pixel (numeric id or the alphanumeric pixel code from Events Manager, resolved for you).
39477
39483
  */
39478
- pixelId: string;
39484
+ pixelId?: string;
39485
+ /**
39486
+ * Meta: standard pixel event (PURCHASE, LEAD, ...) or OTHER with customEventStr. TikTok: optimization_event code (e.g. ON_WEB_ORDER, SHOPPING, FORM) or the exact event name shown in Events Manager, resolved to its code; the event must already exist on that pixel.
39487
+ */
39488
+ customEventType?: string;
39489
+ /**
39490
+ * Meta only. Pixel custom event name as it appears in Events Manager; requires customEventType OTHER.
39491
+ */
39492
+ customEventStr?: string;
39479
39493
  /**
39480
- * Optimization event, as a TikTok optimization_event code (e.g. ON_WEB_ORDER, SHOPPING, FORM) or the exact event name shown in Events Manager, which is resolved to its code. The event must already exist on that pixel, or TikTok rejects the ad group.
39494
+ * Meta only. Custom Conversion to optimize against, instead of pixelId + customEventType.
39481
39495
  */
39482
- customEventType: string;
39496
+ customConversionId?: string;
39483
39497
  };
39484
39498
  /**
39485
39499
  * Legal entity that benefits from the ad. Required when targeting EU users
package/dist/index.d.ts CHANGED
@@ -39090,7 +39090,7 @@ type BoostPostData = {
39090
39090
  */
39091
39091
  postId?: string;
39092
39092
  /**
39093
- * Platform post ID (alternative to postId)
39093
+ * Platform post ID (alternative to postId). Meta: a Page post id (`<pageId>_<postId>` or the bare post id) or an Instagram media id. On a Meta Ads business-login connection (platform metaads) the id is resolved live: an Instagram media id is boosted as that media, running as the Instagram account that owns it.
39094
39094
  */
39095
39095
  platformPostId?: string;
39096
39096
  /**
@@ -39457,29 +39457,43 @@ type BoostPostData = {
39457
39457
  minimumPurchaseCurrency?: string;
39458
39458
  }>;
39459
39459
  /**
39460
- * TikTok-only on this endpoint. The pixel a Website Conversion ad group
39461
- * optimizes toward, so a Spark Ad built from an existing organic post can
39462
- * optimize for a conversion instead of only engagement or traffic.
39460
+ * Meta and TikTok. What the conversion ad set optimizes toward, so a boost
39461
+ * of an existing organic post can run for a conversion instead of only
39462
+ * engagement or traffic. Required when `goal` is `conversions` (Meta also
39463
+ * `lead_conversion`); ignored on goals that do not optimize for a conversion.
39463
39464
  *
39464
- * Required when `goal` is `conversions`, and BOTH fields are required:
39465
- * TikTok refuses a conversion ad group with no pixel ("Please select a
39466
- * pixel") and equally one that has a pixel but no event ("Select a pixel
39467
- * event."), because the event is what the ad group optimizes toward. Ignored
39468
- * on every other goal, since only a WEB_CONVERSIONS ad group accepts them.
39465
+ * Meta: `pixelId` + `customEventType` (a commerce event such as PURCHASE
39466
+ * under `conversions`, a leads-class event such as LEAD under
39467
+ * `lead_conversion`), or `customConversionId` to optimize against a Custom
39468
+ * Conversion, or `customEventType: OTHER` + `customEventStr` for a pixel
39469
+ * custom event. Becomes the ad set `promoted_object`; without it Meta
39470
+ * rejects the ad set ("Please select a promoted object", subcode 1815430).
39471
+ * With `adSetId` the existing ad set already carries it.
39469
39472
  *
39470
- * Combine freely with `platformPostId` + `sparkAuthCode`: the pixel lives on
39471
- * the ad group and the Spark item on the creative, so they never conflict.
39473
+ * TikTok: BOTH `pixelId` and `customEventType` are required. TikTok refuses
39474
+ * a conversion ad group with no pixel ("Please select a pixel") and one
39475
+ * with a pixel but no event ("Select a pixel event."). Combine freely with
39476
+ * `platformPostId` + `sparkAuthCode`: the pixel lives on the ad group and
39477
+ * the Spark item on the creative.
39472
39478
  *
39473
39479
  */
39474
39480
  promotedObject?: {
39475
39481
  /**
39476
- * TikTok Pixel. Either the numeric pixel id or the alphanumeric pixel code from Events Manager, which is resolved for you.
39482
+ * Meta Pixel id, or TikTok Pixel (numeric id or the alphanumeric pixel code from Events Manager, resolved for you).
39477
39483
  */
39478
- pixelId: string;
39484
+ pixelId?: string;
39485
+ /**
39486
+ * Meta: standard pixel event (PURCHASE, LEAD, ...) or OTHER with customEventStr. TikTok: optimization_event code (e.g. ON_WEB_ORDER, SHOPPING, FORM) or the exact event name shown in Events Manager, resolved to its code; the event must already exist on that pixel.
39487
+ */
39488
+ customEventType?: string;
39489
+ /**
39490
+ * Meta only. Pixel custom event name as it appears in Events Manager; requires customEventType OTHER.
39491
+ */
39492
+ customEventStr?: string;
39479
39493
  /**
39480
- * Optimization event, as a TikTok optimization_event code (e.g. ON_WEB_ORDER, SHOPPING, FORM) or the exact event name shown in Events Manager, which is resolved to its code. The event must already exist on that pixel, or TikTok rejects the ad group.
39494
+ * Meta only. Custom Conversion to optimize against, instead of pixelId + customEventType.
39481
39495
  */
39482
- customEventType: string;
39496
+ customConversionId?: string;
39483
39497
  };
39484
39498
  /**
39485
39499
  * Legal entity that benefits from the ad. Required when targeting EU users
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.868",
39
+ version: "0.2.870",
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.868",
8
+ version: "0.2.870",
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
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zernio/node",
3
- "version": "0.2.868",
3
+ "version": "0.2.870",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -39735,7 +39735,7 @@ export type BoostPostData = {
39735
39735
  */
39736
39736
  postId?: string;
39737
39737
  /**
39738
- * Platform post ID (alternative to postId)
39738
+ * Platform post ID (alternative to postId). Meta: a Page post id (`<pageId>_<postId>` or the bare post id) or an Instagram media id. On a Meta Ads business-login connection (platform metaads) the id is resolved live: an Instagram media id is boosted as that media, running as the Instagram account that owns it.
39739
39739
  */
39740
39740
  platformPostId?: string;
39741
39741
  /**
@@ -40102,29 +40102,43 @@ export type BoostPostData = {
40102
40102
  minimumPurchaseCurrency?: string;
40103
40103
  }>;
40104
40104
  /**
40105
- * TikTok-only on this endpoint. The pixel a Website Conversion ad group
40106
- * optimizes toward, so a Spark Ad built from an existing organic post can
40107
- * optimize for a conversion instead of only engagement or traffic.
40105
+ * Meta and TikTok. What the conversion ad set optimizes toward, so a boost
40106
+ * of an existing organic post can run for a conversion instead of only
40107
+ * engagement or traffic. Required when `goal` is `conversions` (Meta also
40108
+ * `lead_conversion`); ignored on goals that do not optimize for a conversion.
40108
40109
  *
40109
- * Required when `goal` is `conversions`, and BOTH fields are required:
40110
- * TikTok refuses a conversion ad group with no pixel ("Please select a
40111
- * pixel") and equally one that has a pixel but no event ("Select a pixel
40112
- * event."), because the event is what the ad group optimizes toward. Ignored
40113
- * on every other goal, since only a WEB_CONVERSIONS ad group accepts them.
40110
+ * Meta: `pixelId` + `customEventType` (a commerce event such as PURCHASE
40111
+ * under `conversions`, a leads-class event such as LEAD under
40112
+ * `lead_conversion`), or `customConversionId` to optimize against a Custom
40113
+ * Conversion, or `customEventType: OTHER` + `customEventStr` for a pixel
40114
+ * custom event. Becomes the ad set `promoted_object`; without it Meta
40115
+ * rejects the ad set ("Please select a promoted object", subcode 1815430).
40116
+ * With `adSetId` the existing ad set already carries it.
40114
40117
  *
40115
- * Combine freely with `platformPostId` + `sparkAuthCode`: the pixel lives on
40116
- * the ad group and the Spark item on the creative, so they never conflict.
40118
+ * TikTok: BOTH `pixelId` and `customEventType` are required. TikTok refuses
40119
+ * a conversion ad group with no pixel ("Please select a pixel") and one
40120
+ * with a pixel but no event ("Select a pixel event."). Combine freely with
40121
+ * `platformPostId` + `sparkAuthCode`: the pixel lives on the ad group and
40122
+ * the Spark item on the creative.
40117
40123
  *
40118
40124
  */
40119
40125
  promotedObject?: {
40120
40126
  /**
40121
- * TikTok Pixel. Either the numeric pixel id or the alphanumeric pixel code from Events Manager, which is resolved for you.
40127
+ * Meta Pixel id, or TikTok Pixel (numeric id or the alphanumeric pixel code from Events Manager, resolved for you).
40122
40128
  */
40123
- pixelId: string;
40129
+ pixelId?: string;
40130
+ /**
40131
+ * Meta: standard pixel event (PURCHASE, LEAD, ...) or OTHER with customEventStr. TikTok: optimization_event code (e.g. ON_WEB_ORDER, SHOPPING, FORM) or the exact event name shown in Events Manager, resolved to its code; the event must already exist on that pixel.
40132
+ */
40133
+ customEventType?: string;
40134
+ /**
40135
+ * Meta only. Pixel custom event name as it appears in Events Manager; requires customEventType OTHER.
40136
+ */
40137
+ customEventStr?: string;
40124
40138
  /**
40125
- * Optimization event, as a TikTok optimization_event code (e.g. ON_WEB_ORDER, SHOPPING, FORM) or the exact event name shown in Events Manager, which is resolved to its code. The event must already exist on that pixel, or TikTok rejects the ad group.
40139
+ * Meta only. Custom Conversion to optimize against, instead of pixelId + customEventType.
40126
40140
  */
40127
- customEventType: string;
40141
+ customConversionId?: string;
40128
40142
  };
40129
40143
  /**
40130
40144
  * Legal entity that benefits from the ad. Required when targeting EU users