@zernio/node 0.2.511 → 0.2.512

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
@@ -25837,6 +25837,10 @@ type UpdateAdSetData = {
25837
25837
  promotedObject?: {
25838
25838
  pixelId?: string;
25839
25839
  customEventType?: string;
25840
+ /**
25841
+ * Pixel custom-event name (custom_event_str); requires customEventType OTHER. Same pairing rules as /v1/ads/create.
25842
+ */
25843
+ customEventStr?: string;
25840
25844
  pageId?: string;
25841
25845
  applicationId?: string;
25842
25846
  objectStoreUrl?: string;
@@ -27939,7 +27943,7 @@ type CreateStandaloneAdData = {
27939
27943
  * Required on legacy and multi-creative shapes; the attach shape inherits it from the ad set. Available goals vary by platform.
27940
27944
  *
27941
27945
  * **Meta**
27942
- * - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL, or `promotedObject.customConversionId` to optimise against a Custom Conversion instead.
27946
+ * - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL, or `promotedObject.customConversionId` to optimise against a Custom Conversion, or `customEventType: OTHER` + `customEventStr` to optimise against a pixel custom event.
27943
27947
  * - `lead_conversion`: OUTCOME_LEADS optimizing website pixel leads. Same pixel and event fields, but with a leads-class event such as LEAD, SUBMIT_APPLICATION, SCHEDULE or CONTACT (or `promotedObject.customConversionId` to optimise against a Custom Conversion instead). Meta gates conversion events by objective, so leads-class events are rejected under `conversions`.
27944
27948
  * - `lead_generation`: OUTCOME_LEADS with instant forms. Requires `leadGenFormId`. `promotedObject.pageId` is optional and auto-filled from the connected Page.
27945
27949
  * - `app_promotion`: requires `promotedObject.applicationId` and `promotedObject.objectStoreUrl`.
@@ -28739,7 +28743,7 @@ type CreateStandaloneAdData = {
28739
28743
  * Required for goals whose ad-set optimization_goal points at a specific
28740
28744
  * event/page/app (without it Meta rejects the ad-set create with
28741
28745
  * `error_subcode: 1815430` "Please select a promoted object for your ad set"):
28742
- * - `goal: conversions` / `lead_conversion` (OFFSITE_CONVERSIONS): requires `pixelId` + `customEventType`, or `customConversionId` when optimising against a Custom Conversion (the conversion carries its own event definition)
28746
+ * - `goal: conversions` / `lead_conversion` (OFFSITE_CONVERSIONS): requires `pixelId` + `customEventType`, or `customConversionId` when optimising against a Custom Conversion (the conversion carries its own event definition). For a pixel CUSTOM event (one you named yourself in CAPI/Events Manager), send `customEventType: OTHER` + `customEventStr` with the event name.
28743
28747
  * - `goal: app_promotion` (APP_INSTALLS): requires `applicationId` + `objectStoreUrl`
28744
28748
  * - `goal: lead_generation` (LEAD_GENERATION): `pageId` is auto-filled from the connected Page when omitted
28745
28749
  *
@@ -28788,6 +28792,17 @@ type CreateStandaloneAdData = {
28788
28792
  *
28789
28793
  */
28790
28794
  customEventType?: string;
28795
+ /**
28796
+ * Meta only. Pixel custom-event name to optimise against (Meta's
28797
+ * `custom_event_str`), exactly as it appears in Events Manager and in your
28798
+ * CAPI payloads (case-sensitive, not uppercased). Requires
28799
+ * `customEventType: OTHER`, and `OTHER` requires this field (400 either way).
28800
+ * The same as picking a custom event in Ads Manager's conversion-event
28801
+ * dropdown. For rule-based Custom Conversions use `customConversionId`
28802
+ * instead.
28803
+ *
28804
+ */
28805
+ customEventStr?: string;
28791
28806
  /**
28792
28807
  * Facebook Page ID. Used by `goal: lead_generation`. Auto-filled from the
28793
28808
  * connected Page when omitted.
package/dist/index.d.ts CHANGED
@@ -25837,6 +25837,10 @@ type UpdateAdSetData = {
25837
25837
  promotedObject?: {
25838
25838
  pixelId?: string;
25839
25839
  customEventType?: string;
25840
+ /**
25841
+ * Pixel custom-event name (custom_event_str); requires customEventType OTHER. Same pairing rules as /v1/ads/create.
25842
+ */
25843
+ customEventStr?: string;
25840
25844
  pageId?: string;
25841
25845
  applicationId?: string;
25842
25846
  objectStoreUrl?: string;
@@ -27939,7 +27943,7 @@ type CreateStandaloneAdData = {
27939
27943
  * Required on legacy and multi-creative shapes; the attach shape inherits it from the ad set. Available goals vary by platform.
27940
27944
  *
27941
27945
  * **Meta**
27942
- * - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL, or `promotedObject.customConversionId` to optimise against a Custom Conversion instead.
27946
+ * - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL, or `promotedObject.customConversionId` to optimise against a Custom Conversion, or `customEventType: OTHER` + `customEventStr` to optimise against a pixel custom event.
27943
27947
  * - `lead_conversion`: OUTCOME_LEADS optimizing website pixel leads. Same pixel and event fields, but with a leads-class event such as LEAD, SUBMIT_APPLICATION, SCHEDULE or CONTACT (or `promotedObject.customConversionId` to optimise against a Custom Conversion instead). Meta gates conversion events by objective, so leads-class events are rejected under `conversions`.
27944
27948
  * - `lead_generation`: OUTCOME_LEADS with instant forms. Requires `leadGenFormId`. `promotedObject.pageId` is optional and auto-filled from the connected Page.
27945
27949
  * - `app_promotion`: requires `promotedObject.applicationId` and `promotedObject.objectStoreUrl`.
@@ -28739,7 +28743,7 @@ type CreateStandaloneAdData = {
28739
28743
  * Required for goals whose ad-set optimization_goal points at a specific
28740
28744
  * event/page/app (without it Meta rejects the ad-set create with
28741
28745
  * `error_subcode: 1815430` "Please select a promoted object for your ad set"):
28742
- * - `goal: conversions` / `lead_conversion` (OFFSITE_CONVERSIONS): requires `pixelId` + `customEventType`, or `customConversionId` when optimising against a Custom Conversion (the conversion carries its own event definition)
28746
+ * - `goal: conversions` / `lead_conversion` (OFFSITE_CONVERSIONS): requires `pixelId` + `customEventType`, or `customConversionId` when optimising against a Custom Conversion (the conversion carries its own event definition). For a pixel CUSTOM event (one you named yourself in CAPI/Events Manager), send `customEventType: OTHER` + `customEventStr` with the event name.
28743
28747
  * - `goal: app_promotion` (APP_INSTALLS): requires `applicationId` + `objectStoreUrl`
28744
28748
  * - `goal: lead_generation` (LEAD_GENERATION): `pageId` is auto-filled from the connected Page when omitted
28745
28749
  *
@@ -28788,6 +28792,17 @@ type CreateStandaloneAdData = {
28788
28792
  *
28789
28793
  */
28790
28794
  customEventType?: string;
28795
+ /**
28796
+ * Meta only. Pixel custom-event name to optimise against (Meta's
28797
+ * `custom_event_str`), exactly as it appears in Events Manager and in your
28798
+ * CAPI payloads (case-sensitive, not uppercased). Requires
28799
+ * `customEventType: OTHER`, and `OTHER` requires this field (400 either way).
28800
+ * The same as picking a custom event in Ads Manager's conversion-event
28801
+ * dropdown. For rule-based Custom Conversions use `customConversionId`
28802
+ * instead.
28803
+ *
28804
+ */
28805
+ customEventStr?: string;
28791
28806
  /**
28792
28807
  * Facebook Page ID. Used by `goal: lead_generation`. Auto-filled from the
28793
28808
  * connected Page when omitted.
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.511",
39
+ version: "0.2.512",
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.511",
8
+ version: "0.2.512",
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.511",
3
+ "version": "0.2.512",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -26237,6 +26237,10 @@ export type UpdateAdSetData = {
26237
26237
  promotedObject?: {
26238
26238
  pixelId?: string;
26239
26239
  customEventType?: string;
26240
+ /**
26241
+ * Pixel custom-event name (custom_event_str); requires customEventType OTHER. Same pairing rules as /v1/ads/create.
26242
+ */
26243
+ customEventStr?: string;
26240
26244
  pageId?: string;
26241
26245
  applicationId?: string;
26242
26246
  objectStoreUrl?: string;
@@ -28477,7 +28481,7 @@ export type CreateStandaloneAdData = {
28477
28481
  * Required on legacy and multi-creative shapes; the attach shape inherits it from the ad set. Available goals vary by platform.
28478
28482
  *
28479
28483
  * **Meta**
28480
- * - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL, or `promotedObject.customConversionId` to optimise against a Custom Conversion instead.
28484
+ * - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL, or `promotedObject.customConversionId` to optimise against a Custom Conversion, or `customEventType: OTHER` + `customEventStr` to optimise against a pixel custom event.
28481
28485
  * - `lead_conversion`: OUTCOME_LEADS optimizing website pixel leads. Same pixel and event fields, but with a leads-class event such as LEAD, SUBMIT_APPLICATION, SCHEDULE or CONTACT (or `promotedObject.customConversionId` to optimise against a Custom Conversion instead). Meta gates conversion events by objective, so leads-class events are rejected under `conversions`.
28482
28486
  * - `lead_generation`: OUTCOME_LEADS with instant forms. Requires `leadGenFormId`. `promotedObject.pageId` is optional and auto-filled from the connected Page.
28483
28487
  * - `app_promotion`: requires `promotedObject.applicationId` and `promotedObject.objectStoreUrl`.
@@ -29277,7 +29281,7 @@ export type CreateStandaloneAdData = {
29277
29281
  * Required for goals whose ad-set optimization_goal points at a specific
29278
29282
  * event/page/app (without it Meta rejects the ad-set create with
29279
29283
  * `error_subcode: 1815430` "Please select a promoted object for your ad set"):
29280
- * - `goal: conversions` / `lead_conversion` (OFFSITE_CONVERSIONS): requires `pixelId` + `customEventType`, or `customConversionId` when optimising against a Custom Conversion (the conversion carries its own event definition)
29284
+ * - `goal: conversions` / `lead_conversion` (OFFSITE_CONVERSIONS): requires `pixelId` + `customEventType`, or `customConversionId` when optimising against a Custom Conversion (the conversion carries its own event definition). For a pixel CUSTOM event (one you named yourself in CAPI/Events Manager), send `customEventType: OTHER` + `customEventStr` with the event name.
29281
29285
  * - `goal: app_promotion` (APP_INSTALLS): requires `applicationId` + `objectStoreUrl`
29282
29286
  * - `goal: lead_generation` (LEAD_GENERATION): `pageId` is auto-filled from the connected Page when omitted
29283
29287
  *
@@ -29326,6 +29330,17 @@ export type CreateStandaloneAdData = {
29326
29330
  *
29327
29331
  */
29328
29332
  customEventType?: string;
29333
+ /**
29334
+ * Meta only. Pixel custom-event name to optimise against (Meta's
29335
+ * `custom_event_str`), exactly as it appears in Events Manager and in your
29336
+ * CAPI payloads (case-sensitive, not uppercased). Requires
29337
+ * `customEventType: OTHER`, and `OTHER` requires this field (400 either way).
29338
+ * The same as picking a custom event in Ads Manager's conversion-event
29339
+ * dropdown. For rule-based Custom Conversions use `customConversionId`
29340
+ * instead.
29341
+ *
29342
+ */
29343
+ customEventStr?: string;
29329
29344
  /**
29330
29345
  * Facebook Page ID. Used by `goal: lead_generation`. Auto-filled from the
29331
29346
  * connected Page when omitted.