@zernio/node 0.2.104 → 0.2.106

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
@@ -13050,7 +13050,7 @@ type CreateStandaloneAdData = {
13050
13050
  adAccountId: string;
13051
13051
  name: string;
13052
13052
  /**
13053
- * Required on legacy + multi-creative shapes. Inherited from the ad set on the attach shape. Available goals vary by platform.
13053
+ * Required on legacy + multi-creative shapes. Inherited from the ad set on the attach shape. Available goals vary by platform. Meta-specific: `conversions` requires `promotedObject.pixelId` + `promotedObject.customEventType`; `app_promotion` requires `promotedObject.applicationId` + `promotedObject.objectStoreUrl`; `lead_generation` accepts an optional `promotedObject.pageId` (auto-filled from the connected Page when omitted).
13054
13054
  */
13055
13055
  goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'conversions' | 'app_promotion';
13056
13056
  /**
@@ -13075,7 +13075,7 @@ type CreateStandaloneAdData = {
13075
13075
  */
13076
13076
  body?: string;
13077
13077
  /**
13078
- * Required on legacy + attach shapes. Meta only.
13078
+ * Required on legacy + attach shapes for Meta. Honoured on TikTok too — passes through to the Spark Ad creative's `call_to_action`. Ignored by other platforms.
13079
13079
  */
13080
13080
  callToAction?: 'LEARN_MORE' | 'SHOP_NOW' | 'SIGN_UP' | 'BOOK_TRAVEL' | 'CONTACT_US' | 'DOWNLOAD' | 'GET_OFFER' | 'GET_QUOTE' | 'SUBSCRIBE' | 'WATCH_MORE';
13081
13081
  /**
@@ -13232,6 +13232,58 @@ type CreateStandaloneAdData = {
13232
13232
  *
13233
13233
  */
13234
13234
  dsaPayor?: string;
13235
+ /**
13236
+ * Meta only. Forwarded to the ad set's `promoted_object` (snake-cased).
13237
+ *
13238
+ * Required for goals whose ad-set optimization_goal points at a specific
13239
+ * event/page/app — without it Meta rejects the ad-set create with
13240
+ * `error_subcode: 1815430` "Please select a promoted object for your ad set":
13241
+ * - `goal: conversions` (OFFSITE_CONVERSIONS) — requires `pixelId` + `customEventType`
13242
+ * - `goal: app_promotion` (APP_INSTALLS) — requires `applicationId` + `objectStoreUrl`
13243
+ * - `goal: lead_generation` (LEAD_GENERATION) — `pageId` is auto-filled from the connected Page when omitted
13244
+ *
13245
+ * Other goals (engagement, traffic, awareness, video_views) ignore this field.
13246
+ *
13247
+ */
13248
+ promotedObject?: {
13249
+ /**
13250
+ * Facebook Pixel ID. Required for `goal: conversions`.
13251
+ */
13252
+ pixelId?: string;
13253
+ /**
13254
+ * Standard event the campaign optimises against, e.g. `PURCHASE`, `LEAD`,
13255
+ * `COMPLETE_REGISTRATION`, `ADD_TO_CART`. Uppercased internally so callers
13256
+ * can pass any case. Required for `goal: conversions`.
13257
+ *
13258
+ */
13259
+ customEventType?: string;
13260
+ /**
13261
+ * Facebook Page ID. Used by `goal: lead_generation`. Auto-filled from the
13262
+ * connected Page when omitted.
13263
+ *
13264
+ */
13265
+ pageId?: string;
13266
+ /**
13267
+ * App ID. Required for `goal: app_promotion`.
13268
+ */
13269
+ applicationId?: string;
13270
+ /**
13271
+ * App Store / Play Store listing URL. Required for `goal: app_promotion`.
13272
+ */
13273
+ objectStoreUrl?: string;
13274
+ /**
13275
+ * Custom Conversion ID, when optimising against one instead of a standard event.
13276
+ */
13277
+ customConversionId?: string;
13278
+ /**
13279
+ * Catalog ID for catalog/Advantage+ Shopping campaigns.
13280
+ */
13281
+ productCatalogId?: string;
13282
+ /**
13283
+ * Product Set ID inside the catalog.
13284
+ */
13285
+ productSetId?: string;
13286
+ };
13235
13287
  };
13236
13288
  };
13237
13289
  type CreateStandaloneAdResponse = (({
package/dist/index.d.ts CHANGED
@@ -13050,7 +13050,7 @@ type CreateStandaloneAdData = {
13050
13050
  adAccountId: string;
13051
13051
  name: string;
13052
13052
  /**
13053
- * Required on legacy + multi-creative shapes. Inherited from the ad set on the attach shape. Available goals vary by platform.
13053
+ * Required on legacy + multi-creative shapes. Inherited from the ad set on the attach shape. Available goals vary by platform. Meta-specific: `conversions` requires `promotedObject.pixelId` + `promotedObject.customEventType`; `app_promotion` requires `promotedObject.applicationId` + `promotedObject.objectStoreUrl`; `lead_generation` accepts an optional `promotedObject.pageId` (auto-filled from the connected Page when omitted).
13054
13054
  */
13055
13055
  goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'conversions' | 'app_promotion';
13056
13056
  /**
@@ -13075,7 +13075,7 @@ type CreateStandaloneAdData = {
13075
13075
  */
13076
13076
  body?: string;
13077
13077
  /**
13078
- * Required on legacy + attach shapes. Meta only.
13078
+ * Required on legacy + attach shapes for Meta. Honoured on TikTok too — passes through to the Spark Ad creative's `call_to_action`. Ignored by other platforms.
13079
13079
  */
13080
13080
  callToAction?: 'LEARN_MORE' | 'SHOP_NOW' | 'SIGN_UP' | 'BOOK_TRAVEL' | 'CONTACT_US' | 'DOWNLOAD' | 'GET_OFFER' | 'GET_QUOTE' | 'SUBSCRIBE' | 'WATCH_MORE';
13081
13081
  /**
@@ -13232,6 +13232,58 @@ type CreateStandaloneAdData = {
13232
13232
  *
13233
13233
  */
13234
13234
  dsaPayor?: string;
13235
+ /**
13236
+ * Meta only. Forwarded to the ad set's `promoted_object` (snake-cased).
13237
+ *
13238
+ * Required for goals whose ad-set optimization_goal points at a specific
13239
+ * event/page/app — without it Meta rejects the ad-set create with
13240
+ * `error_subcode: 1815430` "Please select a promoted object for your ad set":
13241
+ * - `goal: conversions` (OFFSITE_CONVERSIONS) — requires `pixelId` + `customEventType`
13242
+ * - `goal: app_promotion` (APP_INSTALLS) — requires `applicationId` + `objectStoreUrl`
13243
+ * - `goal: lead_generation` (LEAD_GENERATION) — `pageId` is auto-filled from the connected Page when omitted
13244
+ *
13245
+ * Other goals (engagement, traffic, awareness, video_views) ignore this field.
13246
+ *
13247
+ */
13248
+ promotedObject?: {
13249
+ /**
13250
+ * Facebook Pixel ID. Required for `goal: conversions`.
13251
+ */
13252
+ pixelId?: string;
13253
+ /**
13254
+ * Standard event the campaign optimises against, e.g. `PURCHASE`, `LEAD`,
13255
+ * `COMPLETE_REGISTRATION`, `ADD_TO_CART`. Uppercased internally so callers
13256
+ * can pass any case. Required for `goal: conversions`.
13257
+ *
13258
+ */
13259
+ customEventType?: string;
13260
+ /**
13261
+ * Facebook Page ID. Used by `goal: lead_generation`. Auto-filled from the
13262
+ * connected Page when omitted.
13263
+ *
13264
+ */
13265
+ pageId?: string;
13266
+ /**
13267
+ * App ID. Required for `goal: app_promotion`.
13268
+ */
13269
+ applicationId?: string;
13270
+ /**
13271
+ * App Store / Play Store listing URL. Required for `goal: app_promotion`.
13272
+ */
13273
+ objectStoreUrl?: string;
13274
+ /**
13275
+ * Custom Conversion ID, when optimising against one instead of a standard event.
13276
+ */
13277
+ customConversionId?: string;
13278
+ /**
13279
+ * Catalog ID for catalog/Advantage+ Shopping campaigns.
13280
+ */
13281
+ productCatalogId?: string;
13282
+ /**
13283
+ * Product Set ID inside the catalog.
13284
+ */
13285
+ productSetId?: string;
13286
+ };
13235
13287
  };
13236
13288
  };
13237
13289
  type CreateStandaloneAdResponse = (({
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zernio/node",
3
- "version": "0.2.104",
3
+ "version": "0.2.106",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -13384,7 +13384,7 @@ export type CreateStandaloneAdData = {
13384
13384
  adAccountId: string;
13385
13385
  name: string;
13386
13386
  /**
13387
- * Required on legacy + multi-creative shapes. Inherited from the ad set on the attach shape. Available goals vary by platform.
13387
+ * Required on legacy + multi-creative shapes. Inherited from the ad set on the attach shape. Available goals vary by platform. Meta-specific: `conversions` requires `promotedObject.pixelId` + `promotedObject.customEventType`; `app_promotion` requires `promotedObject.applicationId` + `promotedObject.objectStoreUrl`; `lead_generation` accepts an optional `promotedObject.pageId` (auto-filled from the connected Page when omitted).
13388
13388
  */
13389
13389
  goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'conversions' | 'app_promotion';
13390
13390
  /**
@@ -13409,7 +13409,7 @@ export type CreateStandaloneAdData = {
13409
13409
  */
13410
13410
  body?: string;
13411
13411
  /**
13412
- * Required on legacy + attach shapes. Meta only.
13412
+ * Required on legacy + attach shapes for Meta. Honoured on TikTok too — passes through to the Spark Ad creative's `call_to_action`. Ignored by other platforms.
13413
13413
  */
13414
13414
  callToAction?: 'LEARN_MORE' | 'SHOP_NOW' | 'SIGN_UP' | 'BOOK_TRAVEL' | 'CONTACT_US' | 'DOWNLOAD' | 'GET_OFFER' | 'GET_QUOTE' | 'SUBSCRIBE' | 'WATCH_MORE';
13415
13415
  /**
@@ -13566,6 +13566,58 @@ export type CreateStandaloneAdData = {
13566
13566
  *
13567
13567
  */
13568
13568
  dsaPayor?: string;
13569
+ /**
13570
+ * Meta only. Forwarded to the ad set's `promoted_object` (snake-cased).
13571
+ *
13572
+ * Required for goals whose ad-set optimization_goal points at a specific
13573
+ * event/page/app — without it Meta rejects the ad-set create with
13574
+ * `error_subcode: 1815430` "Please select a promoted object for your ad set":
13575
+ * - `goal: conversions` (OFFSITE_CONVERSIONS) — requires `pixelId` + `customEventType`
13576
+ * - `goal: app_promotion` (APP_INSTALLS) — requires `applicationId` + `objectStoreUrl`
13577
+ * - `goal: lead_generation` (LEAD_GENERATION) — `pageId` is auto-filled from the connected Page when omitted
13578
+ *
13579
+ * Other goals (engagement, traffic, awareness, video_views) ignore this field.
13580
+ *
13581
+ */
13582
+ promotedObject?: {
13583
+ /**
13584
+ * Facebook Pixel ID. Required for `goal: conversions`.
13585
+ */
13586
+ pixelId?: string;
13587
+ /**
13588
+ * Standard event the campaign optimises against, e.g. `PURCHASE`, `LEAD`,
13589
+ * `COMPLETE_REGISTRATION`, `ADD_TO_CART`. Uppercased internally so callers
13590
+ * can pass any case. Required for `goal: conversions`.
13591
+ *
13592
+ */
13593
+ customEventType?: string;
13594
+ /**
13595
+ * Facebook Page ID. Used by `goal: lead_generation`. Auto-filled from the
13596
+ * connected Page when omitted.
13597
+ *
13598
+ */
13599
+ pageId?: string;
13600
+ /**
13601
+ * App ID. Required for `goal: app_promotion`.
13602
+ */
13603
+ applicationId?: string;
13604
+ /**
13605
+ * App Store / Play Store listing URL. Required for `goal: app_promotion`.
13606
+ */
13607
+ objectStoreUrl?: string;
13608
+ /**
13609
+ * Custom Conversion ID, when optimising against one instead of a standard event.
13610
+ */
13611
+ customConversionId?: string;
13612
+ /**
13613
+ * Catalog ID for catalog/Advantage+ Shopping campaigns.
13614
+ */
13615
+ productCatalogId?: string;
13616
+ /**
13617
+ * Product Set ID inside the catalog.
13618
+ */
13619
+ productSetId?: string;
13620
+ };
13569
13621
  };
13570
13622
  };
13571
13623