@zernio/node 0.2.1519 → 0.2.1520
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 +29 -1
- package/dist/index.d.ts +29 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/types.gen.ts +29 -1
package/dist/index.d.mts
CHANGED
|
@@ -61939,7 +61939,7 @@ type CreateStandaloneAdData = {
|
|
|
61939
61939
|
* - `app_promotion`: requires `promotedObject.applicationId` and `promotedObject.objectStoreUrl`.
|
|
61940
61940
|
* - `catalog_sales`: Advantage+ catalog ads (e.g. vehicle inventory). Requires `promotedObject.productSetId`, `promotedObject.pixelId` and `promotedObject.customEventType`. Builds a catalog TEMPLATE creative from the copy fields, which may carry template tags like {{product.name}} or {{vehicle.make}}.
|
|
61941
61941
|
* - `catalog_sales` visuals: no imageUrl or video is sent; Meta renders them per catalog item (an imageUrl or video sent is ignored, not uploaded). Find catalogs via GET /v1/ads/catalogs and product sets via GET /v1/ads/catalogs/{catalogId}/product-sets.
|
|
61942
|
-
* - `catalog_sales` shape: single shape only, no creatives[], dynamicCreative, placementAssets, existingCreativeId or carouselCards. Works with `existingCampaignId`, and with `adSetId` to add to an existing ad set (then only `promotedObject.productSetId` is required). Pick the format with `catalogFormat`.
|
|
61942
|
+
* - `catalog_sales` shape: single shape only, no creatives[], dynamicCreative, placementAssets, existingCreativeId or carouselCards. Works with `existingCampaignId`, and with `adSetId` to add to an existing ad set (then only `promotedObject.productSetId` is required). Pick the format with `catalogFormat`, and open the carousel with `catalogIntroCards`.
|
|
61943
61943
|
* - `traffic` with `promotedObject.productSetId`: a catalog ad without a pixel (OUTCOME_TRAFFIC, `optimizationGoal` LINK_CLICKS by default or LANDING_PAGE_VIEWS). The product set goes on the template creative only, never the ad set's promoted_object. No `pixelId` or `customEventType` needed. Same creative rules as `catalog_sales`.
|
|
61944
61944
|
* - `page_likes`: Page Likes under OUTCOME_ENGAGEMENT (destination_type ON_PAGE, optimization PAGE_LIKES). `promotedObject.pageId` is optional and auto-filled. The CTA is fixed to LIKE_PAGE for that Page; headline / body / linkUrl / callToAction / imageUrl / video are all optional (Meta derives them from the Page).
|
|
61945
61945
|
* - `page_visits`: "Page visits and followers" under OUTCOME_TRAFFIC (destination_type FACEBOOK_PAGE, optimization PROFILE_VISIT). `promotedObject.pageId` is optional and auto-filled; `linkUrl` defaults to the Page. Accounts Meta has not enabled are refused with "This account isn't eligible to use Profile Visit ads yet".
|
|
@@ -62045,6 +62045,34 @@ type CreateStandaloneAdData = {
|
|
|
62045
62045
|
*
|
|
62046
62046
|
*/
|
|
62047
62047
|
catalogFormat?: 'single_image' | 'carousel_images_multi_items' | 'carousel_images_single_item' | 'carousel_slideshows';
|
|
62048
|
+
/**
|
|
62049
|
+
* Meta only. Static cards shown before the catalog products in a catalog carousel, for example a brand or offer slide. Valid only with goal `catalog_sales` and `catalogFormat` omitted or `carousel_images_multi_items`; a 400 otherwise.
|
|
62050
|
+
*
|
|
62051
|
+
* Sent in order as `object_story_spec.template_data.child_attachments` with `static_card: true`, followed by one catalog card built from the top-level `headline`, `description` and `callToAction`.
|
|
62052
|
+
*
|
|
62053
|
+
*/
|
|
62054
|
+
catalogIntroCards?: Array<{
|
|
62055
|
+
/**
|
|
62056
|
+
* Card image; uploaded to the ad account and referenced by hash.
|
|
62057
|
+
*/
|
|
62058
|
+
imageUrl: string;
|
|
62059
|
+
/**
|
|
62060
|
+
* Card headline. Meta does not show it on Instagram.
|
|
62061
|
+
*/
|
|
62062
|
+
headline: string;
|
|
62063
|
+
/**
|
|
62064
|
+
* Card description. Meta does not show it on Instagram.
|
|
62065
|
+
*/
|
|
62066
|
+
description?: string;
|
|
62067
|
+
/**
|
|
62068
|
+
* Card destination URL. Defaults to the top-level linkUrl.
|
|
62069
|
+
*/
|
|
62070
|
+
linkUrl?: string;
|
|
62071
|
+
/**
|
|
62072
|
+
* Card CTA override. Defaults to the top-level callToAction; same enum.
|
|
62073
|
+
*/
|
|
62074
|
+
callToAction?: string;
|
|
62075
|
+
}>;
|
|
62048
62076
|
/**
|
|
62049
62077
|
* Meta only. Multi-advertiser ads: whether Meta may show this ad alongside other advertisers' in one unit. Meta auto-enrols since Aug 2024, so send OPT_OUT to leave. It is a top-level creative field, NOT a `creativeFeatures` key, and Meta rejects it there.
|
|
62050
62078
|
*/
|
package/dist/index.d.ts
CHANGED
|
@@ -61939,7 +61939,7 @@ type CreateStandaloneAdData = {
|
|
|
61939
61939
|
* - `app_promotion`: requires `promotedObject.applicationId` and `promotedObject.objectStoreUrl`.
|
|
61940
61940
|
* - `catalog_sales`: Advantage+ catalog ads (e.g. vehicle inventory). Requires `promotedObject.productSetId`, `promotedObject.pixelId` and `promotedObject.customEventType`. Builds a catalog TEMPLATE creative from the copy fields, which may carry template tags like {{product.name}} or {{vehicle.make}}.
|
|
61941
61941
|
* - `catalog_sales` visuals: no imageUrl or video is sent; Meta renders them per catalog item (an imageUrl or video sent is ignored, not uploaded). Find catalogs via GET /v1/ads/catalogs and product sets via GET /v1/ads/catalogs/{catalogId}/product-sets.
|
|
61942
|
-
* - `catalog_sales` shape: single shape only, no creatives[], dynamicCreative, placementAssets, existingCreativeId or carouselCards. Works with `existingCampaignId`, and with `adSetId` to add to an existing ad set (then only `promotedObject.productSetId` is required). Pick the format with `catalogFormat`.
|
|
61942
|
+
* - `catalog_sales` shape: single shape only, no creatives[], dynamicCreative, placementAssets, existingCreativeId or carouselCards. Works with `existingCampaignId`, and with `adSetId` to add to an existing ad set (then only `promotedObject.productSetId` is required). Pick the format with `catalogFormat`, and open the carousel with `catalogIntroCards`.
|
|
61943
61943
|
* - `traffic` with `promotedObject.productSetId`: a catalog ad without a pixel (OUTCOME_TRAFFIC, `optimizationGoal` LINK_CLICKS by default or LANDING_PAGE_VIEWS). The product set goes on the template creative only, never the ad set's promoted_object. No `pixelId` or `customEventType` needed. Same creative rules as `catalog_sales`.
|
|
61944
61944
|
* - `page_likes`: Page Likes under OUTCOME_ENGAGEMENT (destination_type ON_PAGE, optimization PAGE_LIKES). `promotedObject.pageId` is optional and auto-filled. The CTA is fixed to LIKE_PAGE for that Page; headline / body / linkUrl / callToAction / imageUrl / video are all optional (Meta derives them from the Page).
|
|
61945
61945
|
* - `page_visits`: "Page visits and followers" under OUTCOME_TRAFFIC (destination_type FACEBOOK_PAGE, optimization PROFILE_VISIT). `promotedObject.pageId` is optional and auto-filled; `linkUrl` defaults to the Page. Accounts Meta has not enabled are refused with "This account isn't eligible to use Profile Visit ads yet".
|
|
@@ -62045,6 +62045,34 @@ type CreateStandaloneAdData = {
|
|
|
62045
62045
|
*
|
|
62046
62046
|
*/
|
|
62047
62047
|
catalogFormat?: 'single_image' | 'carousel_images_multi_items' | 'carousel_images_single_item' | 'carousel_slideshows';
|
|
62048
|
+
/**
|
|
62049
|
+
* Meta only. Static cards shown before the catalog products in a catalog carousel, for example a brand or offer slide. Valid only with goal `catalog_sales` and `catalogFormat` omitted or `carousel_images_multi_items`; a 400 otherwise.
|
|
62050
|
+
*
|
|
62051
|
+
* Sent in order as `object_story_spec.template_data.child_attachments` with `static_card: true`, followed by one catalog card built from the top-level `headline`, `description` and `callToAction`.
|
|
62052
|
+
*
|
|
62053
|
+
*/
|
|
62054
|
+
catalogIntroCards?: Array<{
|
|
62055
|
+
/**
|
|
62056
|
+
* Card image; uploaded to the ad account and referenced by hash.
|
|
62057
|
+
*/
|
|
62058
|
+
imageUrl: string;
|
|
62059
|
+
/**
|
|
62060
|
+
* Card headline. Meta does not show it on Instagram.
|
|
62061
|
+
*/
|
|
62062
|
+
headline: string;
|
|
62063
|
+
/**
|
|
62064
|
+
* Card description. Meta does not show it on Instagram.
|
|
62065
|
+
*/
|
|
62066
|
+
description?: string;
|
|
62067
|
+
/**
|
|
62068
|
+
* Card destination URL. Defaults to the top-level linkUrl.
|
|
62069
|
+
*/
|
|
62070
|
+
linkUrl?: string;
|
|
62071
|
+
/**
|
|
62072
|
+
* Card CTA override. Defaults to the top-level callToAction; same enum.
|
|
62073
|
+
*/
|
|
62074
|
+
callToAction?: string;
|
|
62075
|
+
}>;
|
|
62048
62076
|
/**
|
|
62049
62077
|
* Meta only. Multi-advertiser ads: whether Meta may show this ad alongside other advertisers' in one unit. Meta auto-enrols since Aug 2024, so send OPT_OUT to leave. It is a top-level creative field, NOT a `creativeFeatures` key, and Meta rejects it there.
|
|
62050
62078
|
*/
|
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.1520",
|
|
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.1520",
|
|
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
|
@@ -63297,7 +63297,7 @@ export type CreateStandaloneAdData = {
|
|
|
63297
63297
|
* - `app_promotion`: requires `promotedObject.applicationId` and `promotedObject.objectStoreUrl`.
|
|
63298
63298
|
* - `catalog_sales`: Advantage+ catalog ads (e.g. vehicle inventory). Requires `promotedObject.productSetId`, `promotedObject.pixelId` and `promotedObject.customEventType`. Builds a catalog TEMPLATE creative from the copy fields, which may carry template tags like {{product.name}} or {{vehicle.make}}.
|
|
63299
63299
|
* - `catalog_sales` visuals: no imageUrl or video is sent; Meta renders them per catalog item (an imageUrl or video sent is ignored, not uploaded). Find catalogs via GET /v1/ads/catalogs and product sets via GET /v1/ads/catalogs/{catalogId}/product-sets.
|
|
63300
|
-
* - `catalog_sales` shape: single shape only, no creatives[], dynamicCreative, placementAssets, existingCreativeId or carouselCards. Works with `existingCampaignId`, and with `adSetId` to add to an existing ad set (then only `promotedObject.productSetId` is required). Pick the format with `catalogFormat`.
|
|
63300
|
+
* - `catalog_sales` shape: single shape only, no creatives[], dynamicCreative, placementAssets, existingCreativeId or carouselCards. Works with `existingCampaignId`, and with `adSetId` to add to an existing ad set (then only `promotedObject.productSetId` is required). Pick the format with `catalogFormat`, and open the carousel with `catalogIntroCards`.
|
|
63301
63301
|
* - `traffic` with `promotedObject.productSetId`: a catalog ad without a pixel (OUTCOME_TRAFFIC, `optimizationGoal` LINK_CLICKS by default or LANDING_PAGE_VIEWS). The product set goes on the template creative only, never the ad set's promoted_object. No `pixelId` or `customEventType` needed. Same creative rules as `catalog_sales`.
|
|
63302
63302
|
* - `page_likes`: Page Likes under OUTCOME_ENGAGEMENT (destination_type ON_PAGE, optimization PAGE_LIKES). `promotedObject.pageId` is optional and auto-filled. The CTA is fixed to LIKE_PAGE for that Page; headline / body / linkUrl / callToAction / imageUrl / video are all optional (Meta derives them from the Page).
|
|
63303
63303
|
* - `page_visits`: "Page visits and followers" under OUTCOME_TRAFFIC (destination_type FACEBOOK_PAGE, optimization PROFILE_VISIT). `promotedObject.pageId` is optional and auto-filled; `linkUrl` defaults to the Page. Accounts Meta has not enabled are refused with "This account isn't eligible to use Profile Visit ads yet".
|
|
@@ -63403,6 +63403,34 @@ export type CreateStandaloneAdData = {
|
|
|
63403
63403
|
*
|
|
63404
63404
|
*/
|
|
63405
63405
|
catalogFormat?: 'single_image' | 'carousel_images_multi_items' | 'carousel_images_single_item' | 'carousel_slideshows';
|
|
63406
|
+
/**
|
|
63407
|
+
* Meta only. Static cards shown before the catalog products in a catalog carousel, for example a brand or offer slide. Valid only with goal `catalog_sales` and `catalogFormat` omitted or `carousel_images_multi_items`; a 400 otherwise.
|
|
63408
|
+
*
|
|
63409
|
+
* Sent in order as `object_story_spec.template_data.child_attachments` with `static_card: true`, followed by one catalog card built from the top-level `headline`, `description` and `callToAction`.
|
|
63410
|
+
*
|
|
63411
|
+
*/
|
|
63412
|
+
catalogIntroCards?: Array<{
|
|
63413
|
+
/**
|
|
63414
|
+
* Card image; uploaded to the ad account and referenced by hash.
|
|
63415
|
+
*/
|
|
63416
|
+
imageUrl: string;
|
|
63417
|
+
/**
|
|
63418
|
+
* Card headline. Meta does not show it on Instagram.
|
|
63419
|
+
*/
|
|
63420
|
+
headline: string;
|
|
63421
|
+
/**
|
|
63422
|
+
* Card description. Meta does not show it on Instagram.
|
|
63423
|
+
*/
|
|
63424
|
+
description?: string;
|
|
63425
|
+
/**
|
|
63426
|
+
* Card destination URL. Defaults to the top-level linkUrl.
|
|
63427
|
+
*/
|
|
63428
|
+
linkUrl?: string;
|
|
63429
|
+
/**
|
|
63430
|
+
* Card CTA override. Defaults to the top-level callToAction; same enum.
|
|
63431
|
+
*/
|
|
63432
|
+
callToAction?: string;
|
|
63433
|
+
}>;
|
|
63406
63434
|
/**
|
|
63407
63435
|
* Meta only. Multi-advertiser ads: whether Meta may show this ad alongside other advertisers' in one unit. Meta auto-enrols since Aug 2024, so send OPT_OUT to leave. It is a top-level creative field, NOT a `creativeFeatures` key, and Meta rejects it there.
|
|
63408
63436
|
*/
|