@getlatedev/node 0.2.490 → 0.2.492
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 +49 -20
- package/dist/index.d.ts +49 -20
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/types.gen.ts +49 -20
package/dist/index.d.mts
CHANGED
|
@@ -27205,11 +27205,25 @@ type BoostPostData = {
|
|
|
27205
27205
|
advantage_audience?: 0 | 1;
|
|
27206
27206
|
};
|
|
27207
27207
|
/**
|
|
27208
|
-
* Meta only. A
|
|
27209
|
-
* `{ "geo_locations": { "cities": [{ "key": "...", "radius": 15, "distance_unit": "kilometer" }] } }`)
|
|
27210
|
-
* forwarded unchanged.
|
|
27211
|
-
*
|
|
27212
|
-
*
|
|
27208
|
+
* Meta only. A Meta-native targeting spec (e.g.
|
|
27209
|
+
* `{ "geo_locations": { "cities": [{ "key": "...", "radius": 15, "distance_unit": "kilometer" }] } }`).
|
|
27210
|
+
* Sent alone it is forwarded unchanged. Use for advanced fields the structured
|
|
27211
|
+
* object does not expose (flexible_spec, excluded audiences, business places,
|
|
27212
|
+
* user_os, wireless_carrier).
|
|
27213
|
+
*
|
|
27214
|
+
* Can be combined with `targeting`: rawTargeting is the BASE layer and the
|
|
27215
|
+
* built camelCase spec is merged on top, key by key (camelCase wins on
|
|
27216
|
+
* collision). The merge goes one level deep inside `geo_locations` and
|
|
27217
|
+
* `excluded_geo_locations` (built sub-keys win; raw-only sub-keys such as
|
|
27218
|
+
* `location_types` survive). Array values (`flexible_spec`, ...) are replaced
|
|
27219
|
+
* as a whole key, never element-merged.
|
|
27220
|
+
*
|
|
27221
|
+
* When `rawTargeting` is present the `advantage_audience: 0` default that
|
|
27222
|
+
* Zernio normally applies is no longer emitted, so it cannot clobber a
|
|
27223
|
+
* `targeting_automation` sent in the raw spec. Meta requires
|
|
27224
|
+
* `targeting_automation` on ad set creation, so include it in the raw spec,
|
|
27225
|
+
* or send `targeting.advantage_audience` (0 or 1), which is merged over raw
|
|
27226
|
+
* as `targeting_automation`.
|
|
27213
27227
|
*
|
|
27214
27228
|
*/
|
|
27215
27229
|
rawTargeting?: {
|
|
@@ -27449,7 +27463,7 @@ type CreateStandaloneAdData = {
|
|
|
27449
27463
|
*/
|
|
27450
27464
|
linkUrl?: string;
|
|
27451
27465
|
/**
|
|
27452
|
-
* Meta Lead Gen forms only (facebook/instagram). The leadgen_forms ID to attach to the ad's creative — create one via POST /v1/ads/lead-forms. REQUIRED when `goal` is `lead_generation`, and on every ATTACH (`adSetId`) call that targets a lead ad set (the form attaches per-ad; Meta rejects a formless ad in a lead ad set). Ignored otherwise. The ad set's promoted_object.page_id + LEAD_GENERATION optimization + destination_type ON_AD are derived automatically from the goal. Both `placementAssets` (per-placement creative) and `dynamicCreative` (multi-text / multi-asset pool, e.g. multiple headlines and primary texts) ARE supported on instant-form lead ads — the form is attached for you, and for `dynamicCreative` the ad set is created as a Dynamic Creative ad set automatically (Meta requires that for any multi-text feed; there is no non-DCO multi-text path). Send a single `imageUrls` entry plus your text variations to get Meta's "Multiple Text Options" behavior on a lead ad.
|
|
27466
|
+
* Meta Lead Gen forms only (facebook/instagram). The leadgen_forms ID to attach to the ad's creative — create one via POST /v1/ads/lead-forms. REQUIRED when `goal` is `lead_generation`, and on every ATTACH (`adSetId`) call that targets a lead ad set (the form attaches per-ad; Meta rejects a formless ad in a lead ad set). Ignored otherwise. The ad set's promoted_object.page_id + LEAD_GENERATION optimization + destination_type ON_AD are derived automatically from the goal. Both `placementAssets` (per-placement creative) and `dynamicCreative` (multi-text / multi-asset pool, e.g. multiple headlines and primary texts) ARE supported on instant-form lead ads — the form is attached for you, and for `dynamicCreative` the ad set is created as a Dynamic Creative ad set automatically (Meta requires that for any multi-text feed; there is no non-DCO multi-text path). Send a single `imageUrls` (or `videoUrls`) entry plus your text variations to get Meta's "Multiple Text Options" behavior on a lead ad.
|
|
27453
27467
|
*/
|
|
27454
27468
|
leadGenFormId?: string;
|
|
27455
27469
|
/**
|
|
@@ -27719,14 +27733,24 @@ type CreateStandaloneAdData = {
|
|
|
27719
27733
|
*/
|
|
27720
27734
|
savedTargetingId?: string;
|
|
27721
27735
|
/**
|
|
27722
|
-
* Meta only. A raw Meta-native targeting spec
|
|
27723
|
-
* `
|
|
27724
|
-
* business places, etc.) — exactly the shape `GET /v1/ads/{adId}` returns for
|
|
27725
|
-
*
|
|
27726
|
-
*
|
|
27727
|
-
*
|
|
27728
|
-
*
|
|
27729
|
-
*
|
|
27736
|
+
* Meta only. A raw Meta-native targeting spec (snake_case: `geo_locations`, `age_min`,
|
|
27737
|
+
* `excluded_custom_audiences`, `flexible_spec`, `targeting_automation`, `user_os`,
|
|
27738
|
+
* `wireless_carrier`, business places, etc.) — exactly the shape `GET /v1/ads/{adId}` returns for
|
|
27739
|
+
* external ads. Sent alone it reaches the ad set VERBATIM (the clone-a-campaign's-targeting-exactly
|
|
27740
|
+
* path). Meta validates and surfaces any errors.
|
|
27741
|
+
*
|
|
27742
|
+
* Can be combined with the camelCase targeting fields (countries/regions/cities/interests/ageMin/...,
|
|
27743
|
+
* `targeting`, `savedTargetingId`, `audienceId`): rawTargeting is the BASE layer and the built
|
|
27744
|
+
* camelCase spec is merged on top, key by key, with the camelCase side winning on collision (the
|
|
27745
|
+
* camelCase precedence chain stays `savedTargetingId` < `targeting` < flat fields). The merge goes
|
|
27746
|
+
* one level deep inside `geo_locations` and `excluded_geo_locations`: built sub-keys win, raw-only
|
|
27747
|
+
* sub-keys such as `location_types` survive alongside built `countries`. Array values
|
|
27748
|
+
* (`flexible_spec`, ...) are replaced as a WHOLE key when the camelCase spec builds them, never
|
|
27749
|
+
* element-merged. When rawTargeting is present the defaults the camelCase builder normally injects
|
|
27750
|
+
* (US geo, `targeting_automation.advantage_audience: 0`) are suppressed, so raw's values are not
|
|
27751
|
+
* clobbered — include `targeting_automation` in the raw spec (or send `advantageAudience`) as Meta
|
|
27752
|
+
* requires it on create. If cloning an EU campaign, also pass `dsaBeneficiary` / `dsaPayor` (those
|
|
27753
|
+
* are separate fields, not part of targeting).
|
|
27730
27754
|
*
|
|
27731
27755
|
*/
|
|
27732
27756
|
rawTargeting?: {
|
|
@@ -27771,15 +27795,20 @@ type CreateStandaloneAdData = {
|
|
|
27771
27795
|
* optimises them into the best-performing variations within a single ad (mapped to the
|
|
27772
27796
|
* creative's `asset_feed_spec`). When set, the top-level single-creative fields
|
|
27773
27797
|
* (`imageUrl`, `headline`, `body`, `linkUrl`, `callToAction`) are ignored. Mutually
|
|
27774
|
-
* exclusive with the `creatives[]` multi-creative shape.
|
|
27775
|
-
*
|
|
27798
|
+
* exclusive with the `creatives[]` multi-creative shape. Exactly ONE of `imageUrls` /
|
|
27799
|
+
* `videoUrls` is required (Meta allows one ad format per asset feed; sending both →
|
|
27800
|
+
* 400). Meta limits: ≤10 images or ≤10 videos, ≤5 bodies / titles / descriptions.
|
|
27776
27801
|
*
|
|
27777
27802
|
*/
|
|
27778
27803
|
dynamicCreative?: {
|
|
27779
27804
|
/**
|
|
27780
|
-
* Pool of image URLs (1-10). Uploaded to the ad account and referenced by hash in the asset feed.
|
|
27805
|
+
* Pool of image URLs (1-10). Uploaded to the ad account and referenced by hash in the asset feed. Mutually exclusive with `videoUrls`.
|
|
27781
27806
|
*/
|
|
27782
|
-
imageUrls
|
|
27807
|
+
imageUrls?: Array<(string)>;
|
|
27808
|
+
/**
|
|
27809
|
+
* Pool of video URLs (1-10). Uploaded to the ad account and referenced by video id in the asset feed. No thumbnails are needed: Meta auto-generates a poster per video. Mutually exclusive with `imageUrls`; `adFormat` defaults to SINGLE_VIDEO.
|
|
27810
|
+
*/
|
|
27811
|
+
videoUrls?: Array<(string)>;
|
|
27783
27812
|
/**
|
|
27784
27813
|
* Primary-text variations (the body copy).
|
|
27785
27814
|
*/
|
|
@@ -27801,9 +27830,9 @@ type CreateStandaloneAdData = {
|
|
|
27801
27830
|
*/
|
|
27802
27831
|
callToActionTypes?: Array<('LEARN_MORE' | 'SHOP_NOW' | 'SIGN_UP' | 'BOOK_TRAVEL' | 'CONTACT_US' | 'DOWNLOAD' | 'GET_OFFER' | 'GET_QUOTE' | 'SUBSCRIBE' | 'WATCH_MORE' | 'ADD_TO_CART' | 'APPLY_NOW' | 'BOOK_NOW' | 'BUY_TICKETS' | 'DONATE' | 'DONATE_NOW' | 'GET_DIRECTIONS' | 'GET_SHOWTIMES' | 'LISTEN_NOW' | 'ORDER_NOW' | 'PLAY_GAME' | 'REQUEST_TIME' | 'SEE_MENU' | 'START_ORDER' | 'INSTALL_MOBILE_APP' | 'USE_APP' | 'REGISTER' | 'JOIN' | 'ATTEND' | 'REQUEST_DEMO' | 'VIEW_QUOTE' | 'APPLY' | 'SEE_MORE' | 'BUY_NOW')>;
|
|
27803
27832
|
/**
|
|
27804
|
-
* Asset-feed ad format. Defaults to SINGLE_IMAGE
|
|
27833
|
+
* Asset-feed ad format. Must match the pool: SINGLE_IMAGE / CAROUSEL_IMAGE require `imageUrls`, SINGLE_VIDEO requires `videoUrls` (400 otherwise). Defaults to SINGLE_IMAGE with `imageUrls`, SINGLE_VIDEO with `videoUrls`.
|
|
27805
27834
|
*/
|
|
27806
|
-
adFormat?: 'SINGLE_IMAGE' | 'CAROUSEL_IMAGE';
|
|
27835
|
+
adFormat?: 'SINGLE_IMAGE' | 'CAROUSEL_IMAGE' | 'SINGLE_VIDEO';
|
|
27807
27836
|
};
|
|
27808
27837
|
/**
|
|
27809
27838
|
* Meta only. Hand-built carousel: 2-10 authored cards in DETERMINISTIC order, mapped to
|
package/dist/index.d.ts
CHANGED
|
@@ -27205,11 +27205,25 @@ type BoostPostData = {
|
|
|
27205
27205
|
advantage_audience?: 0 | 1;
|
|
27206
27206
|
};
|
|
27207
27207
|
/**
|
|
27208
|
-
* Meta only. A
|
|
27209
|
-
* `{ "geo_locations": { "cities": [{ "key": "...", "radius": 15, "distance_unit": "kilometer" }] } }`)
|
|
27210
|
-
* forwarded unchanged.
|
|
27211
|
-
*
|
|
27212
|
-
*
|
|
27208
|
+
* Meta only. A Meta-native targeting spec (e.g.
|
|
27209
|
+
* `{ "geo_locations": { "cities": [{ "key": "...", "radius": 15, "distance_unit": "kilometer" }] } }`).
|
|
27210
|
+
* Sent alone it is forwarded unchanged. Use for advanced fields the structured
|
|
27211
|
+
* object does not expose (flexible_spec, excluded audiences, business places,
|
|
27212
|
+
* user_os, wireless_carrier).
|
|
27213
|
+
*
|
|
27214
|
+
* Can be combined with `targeting`: rawTargeting is the BASE layer and the
|
|
27215
|
+
* built camelCase spec is merged on top, key by key (camelCase wins on
|
|
27216
|
+
* collision). The merge goes one level deep inside `geo_locations` and
|
|
27217
|
+
* `excluded_geo_locations` (built sub-keys win; raw-only sub-keys such as
|
|
27218
|
+
* `location_types` survive). Array values (`flexible_spec`, ...) are replaced
|
|
27219
|
+
* as a whole key, never element-merged.
|
|
27220
|
+
*
|
|
27221
|
+
* When `rawTargeting` is present the `advantage_audience: 0` default that
|
|
27222
|
+
* Zernio normally applies is no longer emitted, so it cannot clobber a
|
|
27223
|
+
* `targeting_automation` sent in the raw spec. Meta requires
|
|
27224
|
+
* `targeting_automation` on ad set creation, so include it in the raw spec,
|
|
27225
|
+
* or send `targeting.advantage_audience` (0 or 1), which is merged over raw
|
|
27226
|
+
* as `targeting_automation`.
|
|
27213
27227
|
*
|
|
27214
27228
|
*/
|
|
27215
27229
|
rawTargeting?: {
|
|
@@ -27449,7 +27463,7 @@ type CreateStandaloneAdData = {
|
|
|
27449
27463
|
*/
|
|
27450
27464
|
linkUrl?: string;
|
|
27451
27465
|
/**
|
|
27452
|
-
* Meta Lead Gen forms only (facebook/instagram). The leadgen_forms ID to attach to the ad's creative — create one via POST /v1/ads/lead-forms. REQUIRED when `goal` is `lead_generation`, and on every ATTACH (`adSetId`) call that targets a lead ad set (the form attaches per-ad; Meta rejects a formless ad in a lead ad set). Ignored otherwise. The ad set's promoted_object.page_id + LEAD_GENERATION optimization + destination_type ON_AD are derived automatically from the goal. Both `placementAssets` (per-placement creative) and `dynamicCreative` (multi-text / multi-asset pool, e.g. multiple headlines and primary texts) ARE supported on instant-form lead ads — the form is attached for you, and for `dynamicCreative` the ad set is created as a Dynamic Creative ad set automatically (Meta requires that for any multi-text feed; there is no non-DCO multi-text path). Send a single `imageUrls` entry plus your text variations to get Meta's "Multiple Text Options" behavior on a lead ad.
|
|
27466
|
+
* Meta Lead Gen forms only (facebook/instagram). The leadgen_forms ID to attach to the ad's creative — create one via POST /v1/ads/lead-forms. REQUIRED when `goal` is `lead_generation`, and on every ATTACH (`adSetId`) call that targets a lead ad set (the form attaches per-ad; Meta rejects a formless ad in a lead ad set). Ignored otherwise. The ad set's promoted_object.page_id + LEAD_GENERATION optimization + destination_type ON_AD are derived automatically from the goal. Both `placementAssets` (per-placement creative) and `dynamicCreative` (multi-text / multi-asset pool, e.g. multiple headlines and primary texts) ARE supported on instant-form lead ads — the form is attached for you, and for `dynamicCreative` the ad set is created as a Dynamic Creative ad set automatically (Meta requires that for any multi-text feed; there is no non-DCO multi-text path). Send a single `imageUrls` (or `videoUrls`) entry plus your text variations to get Meta's "Multiple Text Options" behavior on a lead ad.
|
|
27453
27467
|
*/
|
|
27454
27468
|
leadGenFormId?: string;
|
|
27455
27469
|
/**
|
|
@@ -27719,14 +27733,24 @@ type CreateStandaloneAdData = {
|
|
|
27719
27733
|
*/
|
|
27720
27734
|
savedTargetingId?: string;
|
|
27721
27735
|
/**
|
|
27722
|
-
* Meta only. A raw Meta-native targeting spec
|
|
27723
|
-
* `
|
|
27724
|
-
* business places, etc.) — exactly the shape `GET /v1/ads/{adId}` returns for
|
|
27725
|
-
*
|
|
27726
|
-
*
|
|
27727
|
-
*
|
|
27728
|
-
*
|
|
27729
|
-
*
|
|
27736
|
+
* Meta only. A raw Meta-native targeting spec (snake_case: `geo_locations`, `age_min`,
|
|
27737
|
+
* `excluded_custom_audiences`, `flexible_spec`, `targeting_automation`, `user_os`,
|
|
27738
|
+
* `wireless_carrier`, business places, etc.) — exactly the shape `GET /v1/ads/{adId}` returns for
|
|
27739
|
+
* external ads. Sent alone it reaches the ad set VERBATIM (the clone-a-campaign's-targeting-exactly
|
|
27740
|
+
* path). Meta validates and surfaces any errors.
|
|
27741
|
+
*
|
|
27742
|
+
* Can be combined with the camelCase targeting fields (countries/regions/cities/interests/ageMin/...,
|
|
27743
|
+
* `targeting`, `savedTargetingId`, `audienceId`): rawTargeting is the BASE layer and the built
|
|
27744
|
+
* camelCase spec is merged on top, key by key, with the camelCase side winning on collision (the
|
|
27745
|
+
* camelCase precedence chain stays `savedTargetingId` < `targeting` < flat fields). The merge goes
|
|
27746
|
+
* one level deep inside `geo_locations` and `excluded_geo_locations`: built sub-keys win, raw-only
|
|
27747
|
+
* sub-keys such as `location_types` survive alongside built `countries`. Array values
|
|
27748
|
+
* (`flexible_spec`, ...) are replaced as a WHOLE key when the camelCase spec builds them, never
|
|
27749
|
+
* element-merged. When rawTargeting is present the defaults the camelCase builder normally injects
|
|
27750
|
+
* (US geo, `targeting_automation.advantage_audience: 0`) are suppressed, so raw's values are not
|
|
27751
|
+
* clobbered — include `targeting_automation` in the raw spec (or send `advantageAudience`) as Meta
|
|
27752
|
+
* requires it on create. If cloning an EU campaign, also pass `dsaBeneficiary` / `dsaPayor` (those
|
|
27753
|
+
* are separate fields, not part of targeting).
|
|
27730
27754
|
*
|
|
27731
27755
|
*/
|
|
27732
27756
|
rawTargeting?: {
|
|
@@ -27771,15 +27795,20 @@ type CreateStandaloneAdData = {
|
|
|
27771
27795
|
* optimises them into the best-performing variations within a single ad (mapped to the
|
|
27772
27796
|
* creative's `asset_feed_spec`). When set, the top-level single-creative fields
|
|
27773
27797
|
* (`imageUrl`, `headline`, `body`, `linkUrl`, `callToAction`) are ignored. Mutually
|
|
27774
|
-
* exclusive with the `creatives[]` multi-creative shape.
|
|
27775
|
-
*
|
|
27798
|
+
* exclusive with the `creatives[]` multi-creative shape. Exactly ONE of `imageUrls` /
|
|
27799
|
+
* `videoUrls` is required (Meta allows one ad format per asset feed; sending both →
|
|
27800
|
+
* 400). Meta limits: ≤10 images or ≤10 videos, ≤5 bodies / titles / descriptions.
|
|
27776
27801
|
*
|
|
27777
27802
|
*/
|
|
27778
27803
|
dynamicCreative?: {
|
|
27779
27804
|
/**
|
|
27780
|
-
* Pool of image URLs (1-10). Uploaded to the ad account and referenced by hash in the asset feed.
|
|
27805
|
+
* Pool of image URLs (1-10). Uploaded to the ad account and referenced by hash in the asset feed. Mutually exclusive with `videoUrls`.
|
|
27781
27806
|
*/
|
|
27782
|
-
imageUrls
|
|
27807
|
+
imageUrls?: Array<(string)>;
|
|
27808
|
+
/**
|
|
27809
|
+
* Pool of video URLs (1-10). Uploaded to the ad account and referenced by video id in the asset feed. No thumbnails are needed: Meta auto-generates a poster per video. Mutually exclusive with `imageUrls`; `adFormat` defaults to SINGLE_VIDEO.
|
|
27810
|
+
*/
|
|
27811
|
+
videoUrls?: Array<(string)>;
|
|
27783
27812
|
/**
|
|
27784
27813
|
* Primary-text variations (the body copy).
|
|
27785
27814
|
*/
|
|
@@ -27801,9 +27830,9 @@ type CreateStandaloneAdData = {
|
|
|
27801
27830
|
*/
|
|
27802
27831
|
callToActionTypes?: Array<('LEARN_MORE' | 'SHOP_NOW' | 'SIGN_UP' | 'BOOK_TRAVEL' | 'CONTACT_US' | 'DOWNLOAD' | 'GET_OFFER' | 'GET_QUOTE' | 'SUBSCRIBE' | 'WATCH_MORE' | 'ADD_TO_CART' | 'APPLY_NOW' | 'BOOK_NOW' | 'BUY_TICKETS' | 'DONATE' | 'DONATE_NOW' | 'GET_DIRECTIONS' | 'GET_SHOWTIMES' | 'LISTEN_NOW' | 'ORDER_NOW' | 'PLAY_GAME' | 'REQUEST_TIME' | 'SEE_MENU' | 'START_ORDER' | 'INSTALL_MOBILE_APP' | 'USE_APP' | 'REGISTER' | 'JOIN' | 'ATTEND' | 'REQUEST_DEMO' | 'VIEW_QUOTE' | 'APPLY' | 'SEE_MORE' | 'BUY_NOW')>;
|
|
27803
27832
|
/**
|
|
27804
|
-
* Asset-feed ad format. Defaults to SINGLE_IMAGE
|
|
27833
|
+
* Asset-feed ad format. Must match the pool: SINGLE_IMAGE / CAROUSEL_IMAGE require `imageUrls`, SINGLE_VIDEO requires `videoUrls` (400 otherwise). Defaults to SINGLE_IMAGE with `imageUrls`, SINGLE_VIDEO with `videoUrls`.
|
|
27805
27834
|
*/
|
|
27806
|
-
adFormat?: 'SINGLE_IMAGE' | 'CAROUSEL_IMAGE';
|
|
27835
|
+
adFormat?: 'SINGLE_IMAGE' | 'CAROUSEL_IMAGE' | 'SINGLE_VIDEO';
|
|
27807
27836
|
};
|
|
27808
27837
|
/**
|
|
27809
27838
|
* Meta only. Hand-built carousel: 2-10 authored cards in DETERMINISTIC order, mapped to
|
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: "@getlatedev/node",
|
|
39
|
-
version: "0.2.
|
|
39
|
+
version: "0.2.492",
|
|
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: "@getlatedev/node",
|
|
8
|
-
version: "0.2.
|
|
8
|
+
version: "0.2.492",
|
|
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
|
@@ -27732,11 +27732,25 @@ export type BoostPostData = {
|
|
|
27732
27732
|
advantage_audience?: 0 | 1;
|
|
27733
27733
|
};
|
|
27734
27734
|
/**
|
|
27735
|
-
* Meta only. A
|
|
27736
|
-
* `{ "geo_locations": { "cities": [{ "key": "...", "radius": 15, "distance_unit": "kilometer" }] } }`)
|
|
27737
|
-
* forwarded unchanged.
|
|
27738
|
-
*
|
|
27739
|
-
*
|
|
27735
|
+
* Meta only. A Meta-native targeting spec (e.g.
|
|
27736
|
+
* `{ "geo_locations": { "cities": [{ "key": "...", "radius": 15, "distance_unit": "kilometer" }] } }`).
|
|
27737
|
+
* Sent alone it is forwarded unchanged. Use for advanced fields the structured
|
|
27738
|
+
* object does not expose (flexible_spec, excluded audiences, business places,
|
|
27739
|
+
* user_os, wireless_carrier).
|
|
27740
|
+
*
|
|
27741
|
+
* Can be combined with `targeting`: rawTargeting is the BASE layer and the
|
|
27742
|
+
* built camelCase spec is merged on top, key by key (camelCase wins on
|
|
27743
|
+
* collision). The merge goes one level deep inside `geo_locations` and
|
|
27744
|
+
* `excluded_geo_locations` (built sub-keys win; raw-only sub-keys such as
|
|
27745
|
+
* `location_types` survive). Array values (`flexible_spec`, ...) are replaced
|
|
27746
|
+
* as a whole key, never element-merged.
|
|
27747
|
+
*
|
|
27748
|
+
* When `rawTargeting` is present the `advantage_audience: 0` default that
|
|
27749
|
+
* Zernio normally applies is no longer emitted, so it cannot clobber a
|
|
27750
|
+
* `targeting_automation` sent in the raw spec. Meta requires
|
|
27751
|
+
* `targeting_automation` on ad set creation, so include it in the raw spec,
|
|
27752
|
+
* or send `targeting.advantage_audience` (0 or 1), which is merged over raw
|
|
27753
|
+
* as `targeting_automation`.
|
|
27740
27754
|
*
|
|
27741
27755
|
*/
|
|
27742
27756
|
rawTargeting?: {
|
|
@@ -27979,7 +27993,7 @@ export type CreateStandaloneAdData = {
|
|
|
27979
27993
|
*/
|
|
27980
27994
|
linkUrl?: string;
|
|
27981
27995
|
/**
|
|
27982
|
-
* Meta Lead Gen forms only (facebook/instagram). The leadgen_forms ID to attach to the ad's creative — create one via POST /v1/ads/lead-forms. REQUIRED when `goal` is `lead_generation`, and on every ATTACH (`adSetId`) call that targets a lead ad set (the form attaches per-ad; Meta rejects a formless ad in a lead ad set). Ignored otherwise. The ad set's promoted_object.page_id + LEAD_GENERATION optimization + destination_type ON_AD are derived automatically from the goal. Both `placementAssets` (per-placement creative) and `dynamicCreative` (multi-text / multi-asset pool, e.g. multiple headlines and primary texts) ARE supported on instant-form lead ads — the form is attached for you, and for `dynamicCreative` the ad set is created as a Dynamic Creative ad set automatically (Meta requires that for any multi-text feed; there is no non-DCO multi-text path). Send a single `imageUrls` entry plus your text variations to get Meta's "Multiple Text Options" behavior on a lead ad.
|
|
27996
|
+
* Meta Lead Gen forms only (facebook/instagram). The leadgen_forms ID to attach to the ad's creative — create one via POST /v1/ads/lead-forms. REQUIRED when `goal` is `lead_generation`, and on every ATTACH (`adSetId`) call that targets a lead ad set (the form attaches per-ad; Meta rejects a formless ad in a lead ad set). Ignored otherwise. The ad set's promoted_object.page_id + LEAD_GENERATION optimization + destination_type ON_AD are derived automatically from the goal. Both `placementAssets` (per-placement creative) and `dynamicCreative` (multi-text / multi-asset pool, e.g. multiple headlines and primary texts) ARE supported on instant-form lead ads — the form is attached for you, and for `dynamicCreative` the ad set is created as a Dynamic Creative ad set automatically (Meta requires that for any multi-text feed; there is no non-DCO multi-text path). Send a single `imageUrls` (or `videoUrls`) entry plus your text variations to get Meta's "Multiple Text Options" behavior on a lead ad.
|
|
27983
27997
|
*/
|
|
27984
27998
|
leadGenFormId?: string;
|
|
27985
27999
|
/**
|
|
@@ -28249,14 +28263,24 @@ export type CreateStandaloneAdData = {
|
|
|
28249
28263
|
*/
|
|
28250
28264
|
savedTargetingId?: string;
|
|
28251
28265
|
/**
|
|
28252
|
-
* Meta only. A raw Meta-native targeting spec
|
|
28253
|
-
* `
|
|
28254
|
-
* business places, etc.) — exactly the shape `GET /v1/ads/{adId}` returns for
|
|
28255
|
-
*
|
|
28256
|
-
*
|
|
28257
|
-
*
|
|
28258
|
-
*
|
|
28259
|
-
*
|
|
28266
|
+
* Meta only. A raw Meta-native targeting spec (snake_case: `geo_locations`, `age_min`,
|
|
28267
|
+
* `excluded_custom_audiences`, `flexible_spec`, `targeting_automation`, `user_os`,
|
|
28268
|
+
* `wireless_carrier`, business places, etc.) — exactly the shape `GET /v1/ads/{adId}` returns for
|
|
28269
|
+
* external ads. Sent alone it reaches the ad set VERBATIM (the clone-a-campaign's-targeting-exactly
|
|
28270
|
+
* path). Meta validates and surfaces any errors.
|
|
28271
|
+
*
|
|
28272
|
+
* Can be combined with the camelCase targeting fields (countries/regions/cities/interests/ageMin/...,
|
|
28273
|
+
* `targeting`, `savedTargetingId`, `audienceId`): rawTargeting is the BASE layer and the built
|
|
28274
|
+
* camelCase spec is merged on top, key by key, with the camelCase side winning on collision (the
|
|
28275
|
+
* camelCase precedence chain stays `savedTargetingId` < `targeting` < flat fields). The merge goes
|
|
28276
|
+
* one level deep inside `geo_locations` and `excluded_geo_locations`: built sub-keys win, raw-only
|
|
28277
|
+
* sub-keys such as `location_types` survive alongside built `countries`. Array values
|
|
28278
|
+
* (`flexible_spec`, ...) are replaced as a WHOLE key when the camelCase spec builds them, never
|
|
28279
|
+
* element-merged. When rawTargeting is present the defaults the camelCase builder normally injects
|
|
28280
|
+
* (US geo, `targeting_automation.advantage_audience: 0`) are suppressed, so raw's values are not
|
|
28281
|
+
* clobbered — include `targeting_automation` in the raw spec (or send `advantageAudience`) as Meta
|
|
28282
|
+
* requires it on create. If cloning an EU campaign, also pass `dsaBeneficiary` / `dsaPayor` (those
|
|
28283
|
+
* are separate fields, not part of targeting).
|
|
28260
28284
|
*
|
|
28261
28285
|
*/
|
|
28262
28286
|
rawTargeting?: {
|
|
@@ -28301,15 +28325,20 @@ export type CreateStandaloneAdData = {
|
|
|
28301
28325
|
* optimises them into the best-performing variations within a single ad (mapped to the
|
|
28302
28326
|
* creative's `asset_feed_spec`). When set, the top-level single-creative fields
|
|
28303
28327
|
* (`imageUrl`, `headline`, `body`, `linkUrl`, `callToAction`) are ignored. Mutually
|
|
28304
|
-
* exclusive with the `creatives[]` multi-creative shape.
|
|
28305
|
-
*
|
|
28328
|
+
* exclusive with the `creatives[]` multi-creative shape. Exactly ONE of `imageUrls` /
|
|
28329
|
+
* `videoUrls` is required (Meta allows one ad format per asset feed; sending both →
|
|
28330
|
+
* 400). Meta limits: ≤10 images or ≤10 videos, ≤5 bodies / titles / descriptions.
|
|
28306
28331
|
*
|
|
28307
28332
|
*/
|
|
28308
28333
|
dynamicCreative?: {
|
|
28309
28334
|
/**
|
|
28310
|
-
* Pool of image URLs (1-10). Uploaded to the ad account and referenced by hash in the asset feed.
|
|
28335
|
+
* Pool of image URLs (1-10). Uploaded to the ad account and referenced by hash in the asset feed. Mutually exclusive with `videoUrls`.
|
|
28311
28336
|
*/
|
|
28312
|
-
imageUrls
|
|
28337
|
+
imageUrls?: Array<(string)>;
|
|
28338
|
+
/**
|
|
28339
|
+
* Pool of video URLs (1-10). Uploaded to the ad account and referenced by video id in the asset feed. No thumbnails are needed: Meta auto-generates a poster per video. Mutually exclusive with `imageUrls`; `adFormat` defaults to SINGLE_VIDEO.
|
|
28340
|
+
*/
|
|
28341
|
+
videoUrls?: Array<(string)>;
|
|
28313
28342
|
/**
|
|
28314
28343
|
* Primary-text variations (the body copy).
|
|
28315
28344
|
*/
|
|
@@ -28331,9 +28360,9 @@ export type CreateStandaloneAdData = {
|
|
|
28331
28360
|
*/
|
|
28332
28361
|
callToActionTypes?: Array<('LEARN_MORE' | 'SHOP_NOW' | 'SIGN_UP' | 'BOOK_TRAVEL' | 'CONTACT_US' | 'DOWNLOAD' | 'GET_OFFER' | 'GET_QUOTE' | 'SUBSCRIBE' | 'WATCH_MORE' | 'ADD_TO_CART' | 'APPLY_NOW' | 'BOOK_NOW' | 'BUY_TICKETS' | 'DONATE' | 'DONATE_NOW' | 'GET_DIRECTIONS' | 'GET_SHOWTIMES' | 'LISTEN_NOW' | 'ORDER_NOW' | 'PLAY_GAME' | 'REQUEST_TIME' | 'SEE_MENU' | 'START_ORDER' | 'INSTALL_MOBILE_APP' | 'USE_APP' | 'REGISTER' | 'JOIN' | 'ATTEND' | 'REQUEST_DEMO' | 'VIEW_QUOTE' | 'APPLY' | 'SEE_MORE' | 'BUY_NOW')>;
|
|
28333
28362
|
/**
|
|
28334
|
-
* Asset-feed ad format. Defaults to SINGLE_IMAGE
|
|
28363
|
+
* Asset-feed ad format. Must match the pool: SINGLE_IMAGE / CAROUSEL_IMAGE require `imageUrls`, SINGLE_VIDEO requires `videoUrls` (400 otherwise). Defaults to SINGLE_IMAGE with `imageUrls`, SINGLE_VIDEO with `videoUrls`.
|
|
28335
28364
|
*/
|
|
28336
|
-
adFormat?: 'SINGLE_IMAGE' | 'CAROUSEL_IMAGE';
|
|
28365
|
+
adFormat?: 'SINGLE_IMAGE' | 'CAROUSEL_IMAGE' | 'SINGLE_VIDEO';
|
|
28337
28366
|
};
|
|
28338
28367
|
/**
|
|
28339
28368
|
* Meta only. Hand-built carousel: 2-10 authored cards in DETERMINISTIC order, mapped to
|