@getlatedev/node 0.2.1384 → 0.2.1386
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 +39 -10
- package/dist/index.d.ts +39 -10
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/types.gen.ts +39 -10
package/dist/index.d.mts
CHANGED
|
@@ -2569,13 +2569,41 @@ type Ad = {
|
|
|
2569
2569
|
*/
|
|
2570
2570
|
assetGroupResourceName?: string;
|
|
2571
2571
|
/**
|
|
2572
|
-
* Google RSA
|
|
2572
|
+
* Google RSA: the headline assets as objects (3 to 15). Meta: every title variation of the creative (`asset_feed_spec.titles`) as strings, the same shape as the `headlines` create input. Present only with 2 or more titles; a single title is `headline`.
|
|
2573
2573
|
*/
|
|
2574
|
-
headlines?: Array<GoogleRsaHeadline>;
|
|
2574
|
+
headlines?: Array<(string | GoogleRsaHeadline)>;
|
|
2575
2575
|
/**
|
|
2576
|
-
* Google RSA
|
|
2576
|
+
* Google RSA: the description assets as objects (2 to 4). Meta: every description variation of the creative (`asset_feed_spec.descriptions`) as strings, the same shape as the `descriptions` create input. Present only with 2 or more descriptions; a single one is `description`.
|
|
2577
2577
|
*/
|
|
2578
|
-
descriptions?: Array<GoogleRsaDescription>;
|
|
2578
|
+
descriptions?: Array<(string | GoogleRsaDescription)>;
|
|
2579
|
+
/**
|
|
2580
|
+
* Meta: the creative's title (`link_data.name`, `video_data.title`, or the first `asset_feed_spec.titles` entry). Absent when the creative has none.
|
|
2581
|
+
*/
|
|
2582
|
+
headline?: string;
|
|
2583
|
+
/**
|
|
2584
|
+
* Meta: every primary text variation of the creative (`asset_feed_spec.bodies`), the same shape as the `bodies` create input. Present only with 2 or more texts; a single text is `body`.
|
|
2585
|
+
*/
|
|
2586
|
+
bodies?: Array<(string)>;
|
|
2587
|
+
/**
|
|
2588
|
+
* Meta: the creative's description under the title (`link_data.description`, `video_data.link_description`, or the first `asset_feed_spec.descriptions` entry).
|
|
2589
|
+
*/
|
|
2590
|
+
description?: string;
|
|
2591
|
+
/**
|
|
2592
|
+
* Meta: the call to action type (`call_to_action.type`, or the first `asset_feed_spec.call_to_action_types` entry), e.g. LEARN_MORE or SIGN_UP.
|
|
2593
|
+
*/
|
|
2594
|
+
callToAction?: string;
|
|
2595
|
+
/**
|
|
2596
|
+
* Meta: the instant form the call to action opens (`call_to_action.value.lead_gen_form_id`), the same value as the `leadGenFormId` create input. Absent on ads without a lead form.
|
|
2597
|
+
*/
|
|
2598
|
+
leadGenFormId?: string;
|
|
2599
|
+
/**
|
|
2600
|
+
* Meta: the ad image hash (`image_hash`), reusable as `imageHash` on POST /v1/ads/create within the same ad account. `thumbnailUrl` and `mediaUrls` carry its stable full resolution permalink when Meta resolves it.
|
|
2601
|
+
*/
|
|
2602
|
+
imageHash?: string;
|
|
2603
|
+
/**
|
|
2604
|
+
* Meta: the creative's `url_tags` query string appended to the destination URL.
|
|
2605
|
+
*/
|
|
2606
|
+
urlTags?: (string) | null;
|
|
2579
2607
|
/**
|
|
2580
2608
|
* Google RSA only. Replaces final URLs. Omitted lists stay unchanged.
|
|
2581
2609
|
*/
|
|
@@ -2624,7 +2652,7 @@ type Ad = {
|
|
|
2624
2652
|
*/
|
|
2625
2653
|
videoUrl?: (string) | null;
|
|
2626
2654
|
/**
|
|
2627
|
-
* Meta ad creative id backing this ad. Reusable via existingCreativeId on POST /v1/ads/create.
|
|
2655
|
+
* Meta ad creative id backing this ad, refreshed from Meta on every sync. Reusable via existingCreativeId on POST /v1/ads/create, and readable raw through GET /v1/ads/creatives/{creativeId}. Ads synced from Meta also carry it as the legacy `id` key.
|
|
2628
2656
|
*/
|
|
2629
2657
|
creativeId?: (string) | null;
|
|
2630
2658
|
/**
|
|
@@ -28391,7 +28419,8 @@ type GetConnectUrlData = {
|
|
|
28391
28419
|
/**
|
|
28392
28420
|
* Connect through one of your own OAuth apps (see /v1/connect/oauth-apps), so the consent screen shows your app and the platform's limits are your app's. Without it the connect runs on Zernio's app, whatever apps the workspace has saved.
|
|
28393
28421
|
*
|
|
28394
|
-
* - Only platforms listed in `platforms` of GET /v1/connect/oauth-apps accept an app. Any other returns 400, and so do ads connects (`adsConnect=true` in the redirect URL)
|
|
28422
|
+
* - Only platforms listed in `platforms` of GET /v1/connect/oauth-apps accept an app. Any other returns 400, and so do ads connects (`adsConnect=true` in the redirect URL).
|
|
28423
|
+
* - Connects that end on a destination picker also return 400, except Facebook Pages, Google Business locations, Pinterest boards and Snapchat public profiles (Instagram through Facebook Login, for example).
|
|
28395
28424
|
* - A LinkedIn connect through an app saves the member's own profile: organization pages, and mention lookups, stay on Zernio's app.
|
|
28396
28425
|
* - The connect requests the app's `scopeAreas`. `scopes` may narrow them but not add an area the app does not enable (400).
|
|
28397
28426
|
* - If the user does not grant every requested area, the account still connects and the redirect carries `missing_permissions=<areas>` (the headless POST returns `missingPermissions`).
|
|
@@ -57329,13 +57358,13 @@ type CreateStandaloneAdData = {
|
|
|
57329
57358
|
/**
|
|
57330
57359
|
* The ad's call-to-action button.
|
|
57331
57360
|
*
|
|
57332
|
-
* - **Meta:** required on legacy + attach shapes.
|
|
57361
|
+
* - **Meta:** required on legacy + attach shapes. Accepts every call to action type Meta itself accepts (the enum lists them), including values such as SEE_DETAILS that ads synced from Meta carry.
|
|
57333
57362
|
* - **TikTok:** honoured, passed through to the Spark Ad creative's `call_to_action`.
|
|
57334
57363
|
* - **LinkedIn:** the CTA button on the ad; defaults to LEARN_MORE when `linkUrl` is set. Accepts LEARN_MORE, SIGN_UP, DOWNLOAD, SUBSCRIBE, REGISTER, JOIN, ATTEND, REQUEST_DEMO, VIEW_QUOTE, APPLY, SEE_MORE, SHOP_NOW, BUY_NOW.
|
|
57335
57364
|
* - **Reddit** (image, video and carousel ads): accepts LEARN_MORE, SHOP_NOW, SIGN_UP, CONTACT_US, DOWNLOAD, GET_QUOTE, SUBSCRIBE, APPLY_NOW, BOOK_NOW, BUY_TICKETS, DONATE_NOW, GET_DIRECTIONS, GET_SHOWTIMES, LISTEN_NOW, ORDER_NOW, SEE_MENU, INSTALL_MOBILE_APP. Other values return 400.
|
|
57336
57365
|
* - **Google, Pinterest, and X:** ignored.
|
|
57337
57366
|
*/
|
|
57338
|
-
callToAction?: 'LEARN_MORE' | 'SHOP_NOW' | 'SIGN_UP' | '
|
|
57367
|
+
callToAction?: 'BOOK_TRAVEL' | 'CONTACT_US' | 'DONATE' | 'DONATE_NOW' | 'DOWNLOAD' | 'GET_DIRECTIONS' | 'GO_LIVE' | 'INTERESTED' | 'LEARN_MORE' | 'SEE_DETAILS' | 'LIKE_PAGE' | 'MESSAGE_PAGE' | 'RAISE_MONEY' | 'SAVE' | 'SEND_TIP' | 'SHOP_NOW' | 'SIGN_UP' | 'VIEW_INSTAGRAM_PROFILE' | 'INSTAGRAM_MESSAGE' | 'LOYALTY_LEARN_MORE' | 'PURCHASE_GIFT_CARDS' | 'PAY_TO_ACCESS' | 'SEE_MORE' | 'TRY_IN_CAMERA' | 'WHATSAPP_LINK' | 'GET_IN_TOUCH' | 'TRY_NOW' | 'ASK_A_QUESTION' | 'START_A_CHAT' | 'CHAT_NOW' | 'ASK_US' | 'CHAT_WITH_US' | 'SHOP_ON_RETAILER' | 'BOOK_NOW' | 'CHECK_AVAILABILITY' | 'ORDER_NOW' | 'WHATSAPP_MESSAGE' | 'GET_MOBILE_APP' | 'INSTALL_MOBILE_APP' | 'USE_MOBILE_APP' | 'INSTALL_APP' | 'USE_APP' | 'PLAY_GAME' | 'TRY_DEMO' | 'WATCH_VIDEO' | 'WATCH_MORE' | 'OPEN_LINK' | 'NO_BUTTON' | 'LISTEN_MUSIC' | 'MOBILE_DOWNLOAD' | 'GET_OFFER' | 'GET_OFFER_VIEW' | 'BUY_NOW' | 'BUY_TICKETS' | 'UPDATE_APP' | 'BET_NOW' | 'ADD_TO_CART' | 'SELL_NOW' | 'GET_SHOWTIMES' | 'LISTEN_NOW' | 'GET_EVENT_TICKETS' | 'REMIND_ME' | 'SEARCH_MORE' | 'PRE_REGISTER' | 'SWIPE_UP_PRODUCT' | 'SWIPE_UP_SHOP' | 'PLAY_GAME_ON_FACEBOOK' | 'VISIT_WORLD' | 'OPEN_INSTANT_APP' | 'JOIN_GROUP' | 'GET_PROMOTIONS' | 'SEND_UPDATES' | 'INQUIRE_NOW' | 'VISIT_PROFILE' | 'CHAT_ON_WHATSAPP' | 'EXPLORE_MORE' | 'CONFIRM' | 'JOIN_CHANNEL' | 'MAKE_AN_APPOINTMENT' | 'ASK_ABOUT_SERVICES' | 'BOOK_A_CONSULTATION' | 'GET_A_QUOTE' | 'BUY_VIA_MESSAGE' | 'ASK_FOR_MORE_INFO' | 'VIEW_PRODUCT' | 'VIEW_CHANNEL' | 'WATCH_LIVE_VIDEO' | 'JOIN_LIVE_VIDEO' | 'IMAGINE' | 'WATCH_NOW' | 'STREAM_NOW' | 'BUY_ACTIVITY_TICKETS' | 'CALL' | 'MISSED_CALL' | 'CALL_NOW' | 'CALL_ME' | 'APPLY_NOW' | 'BUY' | 'GET_QUOTE' | 'SUBSCRIBE' | 'RECORD_NOW' | 'VOTE_NOW' | 'GIVE_FREE_RIDES' | 'REGISTER_NOW' | 'OPEN_MESSENGER_EXT' | 'EVENT_RSVP' | 'CIVIC_ACTION' | 'SEND_INVITES' | 'REFER_FRIENDS' | 'REQUEST_TIME' | 'SEE_MENU' | 'SEARCH' | 'TRY_IT' | 'TRY_ON' | 'LINK_CARD' | 'DIAL_CODE' | 'FIND_YOUR_GROUPS' | 'START_ORDER' | 'REGISTER' | 'JOIN' | 'ATTEND' | 'REQUEST_DEMO' | 'VIEW_QUOTE' | 'APPLY';
|
|
57339
57368
|
/**
|
|
57340
57369
|
* The ad's destination URL. Required on legacy + attach shapes (skip for multi-creative). NOT required when `goal` is `lead_generation` (the ad opens a Lead Gen form instead).
|
|
57341
57370
|
*
|
|
@@ -57443,7 +57472,7 @@ type CreateStandaloneAdData = {
|
|
|
57443
57472
|
thumbnailUrl?: string;
|
|
57444
57473
|
};
|
|
57445
57474
|
linkUrl: string;
|
|
57446
|
-
callToAction: 'LEARN_MORE' | 'SHOP_NOW' | 'SIGN_UP' | '
|
|
57475
|
+
callToAction: 'BOOK_TRAVEL' | 'CONTACT_US' | 'DONATE' | 'DONATE_NOW' | 'DOWNLOAD' | 'GET_DIRECTIONS' | 'GO_LIVE' | 'INTERESTED' | 'LEARN_MORE' | 'SEE_DETAILS' | 'LIKE_PAGE' | 'MESSAGE_PAGE' | 'RAISE_MONEY' | 'SAVE' | 'SEND_TIP' | 'SHOP_NOW' | 'SIGN_UP' | 'VIEW_INSTAGRAM_PROFILE' | 'INSTAGRAM_MESSAGE' | 'LOYALTY_LEARN_MORE' | 'PURCHASE_GIFT_CARDS' | 'PAY_TO_ACCESS' | 'SEE_MORE' | 'TRY_IN_CAMERA' | 'WHATSAPP_LINK' | 'GET_IN_TOUCH' | 'TRY_NOW' | 'ASK_A_QUESTION' | 'START_A_CHAT' | 'CHAT_NOW' | 'ASK_US' | 'CHAT_WITH_US' | 'SHOP_ON_RETAILER' | 'BOOK_NOW' | 'CHECK_AVAILABILITY' | 'ORDER_NOW' | 'WHATSAPP_MESSAGE' | 'GET_MOBILE_APP' | 'INSTALL_MOBILE_APP' | 'USE_MOBILE_APP' | 'INSTALL_APP' | 'USE_APP' | 'PLAY_GAME' | 'TRY_DEMO' | 'WATCH_VIDEO' | 'WATCH_MORE' | 'OPEN_LINK' | 'NO_BUTTON' | 'LISTEN_MUSIC' | 'MOBILE_DOWNLOAD' | 'GET_OFFER' | 'GET_OFFER_VIEW' | 'BUY_NOW' | 'BUY_TICKETS' | 'UPDATE_APP' | 'BET_NOW' | 'ADD_TO_CART' | 'SELL_NOW' | 'GET_SHOWTIMES' | 'LISTEN_NOW' | 'GET_EVENT_TICKETS' | 'REMIND_ME' | 'SEARCH_MORE' | 'PRE_REGISTER' | 'SWIPE_UP_PRODUCT' | 'SWIPE_UP_SHOP' | 'PLAY_GAME_ON_FACEBOOK' | 'VISIT_WORLD' | 'OPEN_INSTANT_APP' | 'JOIN_GROUP' | 'GET_PROMOTIONS' | 'SEND_UPDATES' | 'INQUIRE_NOW' | 'VISIT_PROFILE' | 'CHAT_ON_WHATSAPP' | 'EXPLORE_MORE' | 'CONFIRM' | 'JOIN_CHANNEL' | 'MAKE_AN_APPOINTMENT' | 'ASK_ABOUT_SERVICES' | 'BOOK_A_CONSULTATION' | 'GET_A_QUOTE' | 'BUY_VIA_MESSAGE' | 'ASK_FOR_MORE_INFO' | 'VIEW_PRODUCT' | 'VIEW_CHANNEL' | 'WATCH_LIVE_VIDEO' | 'JOIN_LIVE_VIDEO' | 'IMAGINE' | 'WATCH_NOW' | 'STREAM_NOW' | 'BUY_ACTIVITY_TICKETS' | 'CALL' | 'MISSED_CALL' | 'CALL_NOW' | 'CALL_ME' | 'APPLY_NOW' | 'BUY' | 'GET_QUOTE' | 'SUBSCRIBE' | 'RECORD_NOW' | 'VOTE_NOW' | 'GIVE_FREE_RIDES' | 'REGISTER_NOW' | 'OPEN_MESSENGER_EXT' | 'EVENT_RSVP' | 'CIVIC_ACTION' | 'SEND_INVITES' | 'REFER_FRIENDS' | 'REQUEST_TIME' | 'SEE_MENU' | 'SEARCH' | 'TRY_IT' | 'TRY_ON' | 'LINK_CARD' | 'DIAL_CODE' | 'FIND_YOUR_GROUPS' | 'START_ORDER';
|
|
57447
57476
|
}>;
|
|
57448
57477
|
/**
|
|
57449
57478
|
* When present, switches to the attach shape: adds one new ad to this existing ad set without creating a new campaign. Mutually exclusive with `creatives[]`.
|
|
@@ -57859,7 +57888,7 @@ type CreateStandaloneAdData = {
|
|
|
57859
57888
|
/**
|
|
57860
57889
|
* CTA-button variations. Required.
|
|
57861
57890
|
*/
|
|
57862
|
-
callToActionTypes?: Array<('LEARN_MORE' | 'SHOP_NOW' | 'SIGN_UP' | '
|
|
57891
|
+
callToActionTypes?: Array<('BOOK_TRAVEL' | 'CONTACT_US' | 'DONATE' | 'DONATE_NOW' | 'DOWNLOAD' | 'GET_DIRECTIONS' | 'GO_LIVE' | 'INTERESTED' | 'LEARN_MORE' | 'SEE_DETAILS' | 'LIKE_PAGE' | 'MESSAGE_PAGE' | 'RAISE_MONEY' | 'SAVE' | 'SEND_TIP' | 'SHOP_NOW' | 'SIGN_UP' | 'VIEW_INSTAGRAM_PROFILE' | 'INSTAGRAM_MESSAGE' | 'LOYALTY_LEARN_MORE' | 'PURCHASE_GIFT_CARDS' | 'PAY_TO_ACCESS' | 'SEE_MORE' | 'TRY_IN_CAMERA' | 'WHATSAPP_LINK' | 'GET_IN_TOUCH' | 'TRY_NOW' | 'ASK_A_QUESTION' | 'START_A_CHAT' | 'CHAT_NOW' | 'ASK_US' | 'CHAT_WITH_US' | 'SHOP_ON_RETAILER' | 'BOOK_NOW' | 'CHECK_AVAILABILITY' | 'ORDER_NOW' | 'WHATSAPP_MESSAGE' | 'GET_MOBILE_APP' | 'INSTALL_MOBILE_APP' | 'USE_MOBILE_APP' | 'INSTALL_APP' | 'USE_APP' | 'PLAY_GAME' | 'TRY_DEMO' | 'WATCH_VIDEO' | 'WATCH_MORE' | 'OPEN_LINK' | 'NO_BUTTON' | 'LISTEN_MUSIC' | 'MOBILE_DOWNLOAD' | 'GET_OFFER' | 'GET_OFFER_VIEW' | 'BUY_NOW' | 'BUY_TICKETS' | 'UPDATE_APP' | 'BET_NOW' | 'ADD_TO_CART' | 'SELL_NOW' | 'GET_SHOWTIMES' | 'LISTEN_NOW' | 'GET_EVENT_TICKETS' | 'REMIND_ME' | 'SEARCH_MORE' | 'PRE_REGISTER' | 'SWIPE_UP_PRODUCT' | 'SWIPE_UP_SHOP' | 'PLAY_GAME_ON_FACEBOOK' | 'VISIT_WORLD' | 'OPEN_INSTANT_APP' | 'JOIN_GROUP' | 'GET_PROMOTIONS' | 'SEND_UPDATES' | 'INQUIRE_NOW' | 'VISIT_PROFILE' | 'CHAT_ON_WHATSAPP' | 'EXPLORE_MORE' | 'CONFIRM' | 'JOIN_CHANNEL' | 'MAKE_AN_APPOINTMENT' | 'ASK_ABOUT_SERVICES' | 'BOOK_A_CONSULTATION' | 'GET_A_QUOTE' | 'BUY_VIA_MESSAGE' | 'ASK_FOR_MORE_INFO' | 'VIEW_PRODUCT' | 'VIEW_CHANNEL' | 'WATCH_LIVE_VIDEO' | 'JOIN_LIVE_VIDEO' | 'IMAGINE' | 'WATCH_NOW' | 'STREAM_NOW' | 'BUY_ACTIVITY_TICKETS' | 'CALL' | 'MISSED_CALL' | 'CALL_NOW' | 'CALL_ME' | 'APPLY_NOW' | 'BUY' | 'GET_QUOTE' | 'SUBSCRIBE' | 'RECORD_NOW' | 'VOTE_NOW' | 'GIVE_FREE_RIDES' | 'REGISTER_NOW' | 'OPEN_MESSENGER_EXT' | 'EVENT_RSVP' | 'CIVIC_ACTION' | 'SEND_INVITES' | 'REFER_FRIENDS' | 'REQUEST_TIME' | 'SEE_MENU' | 'SEARCH' | 'TRY_IT' | 'TRY_ON' | 'LINK_CARD' | 'DIAL_CODE' | 'FIND_YOUR_GROUPS' | 'START_ORDER')>;
|
|
57863
57892
|
/**
|
|
57864
57893
|
* 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`.
|
|
57865
57894
|
*/
|
package/dist/index.d.ts
CHANGED
|
@@ -2569,13 +2569,41 @@ type Ad = {
|
|
|
2569
2569
|
*/
|
|
2570
2570
|
assetGroupResourceName?: string;
|
|
2571
2571
|
/**
|
|
2572
|
-
* Google RSA
|
|
2572
|
+
* Google RSA: the headline assets as objects (3 to 15). Meta: every title variation of the creative (`asset_feed_spec.titles`) as strings, the same shape as the `headlines` create input. Present only with 2 or more titles; a single title is `headline`.
|
|
2573
2573
|
*/
|
|
2574
|
-
headlines?: Array<GoogleRsaHeadline>;
|
|
2574
|
+
headlines?: Array<(string | GoogleRsaHeadline)>;
|
|
2575
2575
|
/**
|
|
2576
|
-
* Google RSA
|
|
2576
|
+
* Google RSA: the description assets as objects (2 to 4). Meta: every description variation of the creative (`asset_feed_spec.descriptions`) as strings, the same shape as the `descriptions` create input. Present only with 2 or more descriptions; a single one is `description`.
|
|
2577
2577
|
*/
|
|
2578
|
-
descriptions?: Array<GoogleRsaDescription>;
|
|
2578
|
+
descriptions?: Array<(string | GoogleRsaDescription)>;
|
|
2579
|
+
/**
|
|
2580
|
+
* Meta: the creative's title (`link_data.name`, `video_data.title`, or the first `asset_feed_spec.titles` entry). Absent when the creative has none.
|
|
2581
|
+
*/
|
|
2582
|
+
headline?: string;
|
|
2583
|
+
/**
|
|
2584
|
+
* Meta: every primary text variation of the creative (`asset_feed_spec.bodies`), the same shape as the `bodies` create input. Present only with 2 or more texts; a single text is `body`.
|
|
2585
|
+
*/
|
|
2586
|
+
bodies?: Array<(string)>;
|
|
2587
|
+
/**
|
|
2588
|
+
* Meta: the creative's description under the title (`link_data.description`, `video_data.link_description`, or the first `asset_feed_spec.descriptions` entry).
|
|
2589
|
+
*/
|
|
2590
|
+
description?: string;
|
|
2591
|
+
/**
|
|
2592
|
+
* Meta: the call to action type (`call_to_action.type`, or the first `asset_feed_spec.call_to_action_types` entry), e.g. LEARN_MORE or SIGN_UP.
|
|
2593
|
+
*/
|
|
2594
|
+
callToAction?: string;
|
|
2595
|
+
/**
|
|
2596
|
+
* Meta: the instant form the call to action opens (`call_to_action.value.lead_gen_form_id`), the same value as the `leadGenFormId` create input. Absent on ads without a lead form.
|
|
2597
|
+
*/
|
|
2598
|
+
leadGenFormId?: string;
|
|
2599
|
+
/**
|
|
2600
|
+
* Meta: the ad image hash (`image_hash`), reusable as `imageHash` on POST /v1/ads/create within the same ad account. `thumbnailUrl` and `mediaUrls` carry its stable full resolution permalink when Meta resolves it.
|
|
2601
|
+
*/
|
|
2602
|
+
imageHash?: string;
|
|
2603
|
+
/**
|
|
2604
|
+
* Meta: the creative's `url_tags` query string appended to the destination URL.
|
|
2605
|
+
*/
|
|
2606
|
+
urlTags?: (string) | null;
|
|
2579
2607
|
/**
|
|
2580
2608
|
* Google RSA only. Replaces final URLs. Omitted lists stay unchanged.
|
|
2581
2609
|
*/
|
|
@@ -2624,7 +2652,7 @@ type Ad = {
|
|
|
2624
2652
|
*/
|
|
2625
2653
|
videoUrl?: (string) | null;
|
|
2626
2654
|
/**
|
|
2627
|
-
* Meta ad creative id backing this ad. Reusable via existingCreativeId on POST /v1/ads/create.
|
|
2655
|
+
* Meta ad creative id backing this ad, refreshed from Meta on every sync. Reusable via existingCreativeId on POST /v1/ads/create, and readable raw through GET /v1/ads/creatives/{creativeId}. Ads synced from Meta also carry it as the legacy `id` key.
|
|
2628
2656
|
*/
|
|
2629
2657
|
creativeId?: (string) | null;
|
|
2630
2658
|
/**
|
|
@@ -28391,7 +28419,8 @@ type GetConnectUrlData = {
|
|
|
28391
28419
|
/**
|
|
28392
28420
|
* Connect through one of your own OAuth apps (see /v1/connect/oauth-apps), so the consent screen shows your app and the platform's limits are your app's. Without it the connect runs on Zernio's app, whatever apps the workspace has saved.
|
|
28393
28421
|
*
|
|
28394
|
-
* - Only platforms listed in `platforms` of GET /v1/connect/oauth-apps accept an app. Any other returns 400, and so do ads connects (`adsConnect=true` in the redirect URL)
|
|
28422
|
+
* - Only platforms listed in `platforms` of GET /v1/connect/oauth-apps accept an app. Any other returns 400, and so do ads connects (`adsConnect=true` in the redirect URL).
|
|
28423
|
+
* - Connects that end on a destination picker also return 400, except Facebook Pages, Google Business locations, Pinterest boards and Snapchat public profiles (Instagram through Facebook Login, for example).
|
|
28395
28424
|
* - A LinkedIn connect through an app saves the member's own profile: organization pages, and mention lookups, stay on Zernio's app.
|
|
28396
28425
|
* - The connect requests the app's `scopeAreas`. `scopes` may narrow them but not add an area the app does not enable (400).
|
|
28397
28426
|
* - If the user does not grant every requested area, the account still connects and the redirect carries `missing_permissions=<areas>` (the headless POST returns `missingPermissions`).
|
|
@@ -57329,13 +57358,13 @@ type CreateStandaloneAdData = {
|
|
|
57329
57358
|
/**
|
|
57330
57359
|
* The ad's call-to-action button.
|
|
57331
57360
|
*
|
|
57332
|
-
* - **Meta:** required on legacy + attach shapes.
|
|
57361
|
+
* - **Meta:** required on legacy + attach shapes. Accepts every call to action type Meta itself accepts (the enum lists them), including values such as SEE_DETAILS that ads synced from Meta carry.
|
|
57333
57362
|
* - **TikTok:** honoured, passed through to the Spark Ad creative's `call_to_action`.
|
|
57334
57363
|
* - **LinkedIn:** the CTA button on the ad; defaults to LEARN_MORE when `linkUrl` is set. Accepts LEARN_MORE, SIGN_UP, DOWNLOAD, SUBSCRIBE, REGISTER, JOIN, ATTEND, REQUEST_DEMO, VIEW_QUOTE, APPLY, SEE_MORE, SHOP_NOW, BUY_NOW.
|
|
57335
57364
|
* - **Reddit** (image, video and carousel ads): accepts LEARN_MORE, SHOP_NOW, SIGN_UP, CONTACT_US, DOWNLOAD, GET_QUOTE, SUBSCRIBE, APPLY_NOW, BOOK_NOW, BUY_TICKETS, DONATE_NOW, GET_DIRECTIONS, GET_SHOWTIMES, LISTEN_NOW, ORDER_NOW, SEE_MENU, INSTALL_MOBILE_APP. Other values return 400.
|
|
57336
57365
|
* - **Google, Pinterest, and X:** ignored.
|
|
57337
57366
|
*/
|
|
57338
|
-
callToAction?: 'LEARN_MORE' | 'SHOP_NOW' | 'SIGN_UP' | '
|
|
57367
|
+
callToAction?: 'BOOK_TRAVEL' | 'CONTACT_US' | 'DONATE' | 'DONATE_NOW' | 'DOWNLOAD' | 'GET_DIRECTIONS' | 'GO_LIVE' | 'INTERESTED' | 'LEARN_MORE' | 'SEE_DETAILS' | 'LIKE_PAGE' | 'MESSAGE_PAGE' | 'RAISE_MONEY' | 'SAVE' | 'SEND_TIP' | 'SHOP_NOW' | 'SIGN_UP' | 'VIEW_INSTAGRAM_PROFILE' | 'INSTAGRAM_MESSAGE' | 'LOYALTY_LEARN_MORE' | 'PURCHASE_GIFT_CARDS' | 'PAY_TO_ACCESS' | 'SEE_MORE' | 'TRY_IN_CAMERA' | 'WHATSAPP_LINK' | 'GET_IN_TOUCH' | 'TRY_NOW' | 'ASK_A_QUESTION' | 'START_A_CHAT' | 'CHAT_NOW' | 'ASK_US' | 'CHAT_WITH_US' | 'SHOP_ON_RETAILER' | 'BOOK_NOW' | 'CHECK_AVAILABILITY' | 'ORDER_NOW' | 'WHATSAPP_MESSAGE' | 'GET_MOBILE_APP' | 'INSTALL_MOBILE_APP' | 'USE_MOBILE_APP' | 'INSTALL_APP' | 'USE_APP' | 'PLAY_GAME' | 'TRY_DEMO' | 'WATCH_VIDEO' | 'WATCH_MORE' | 'OPEN_LINK' | 'NO_BUTTON' | 'LISTEN_MUSIC' | 'MOBILE_DOWNLOAD' | 'GET_OFFER' | 'GET_OFFER_VIEW' | 'BUY_NOW' | 'BUY_TICKETS' | 'UPDATE_APP' | 'BET_NOW' | 'ADD_TO_CART' | 'SELL_NOW' | 'GET_SHOWTIMES' | 'LISTEN_NOW' | 'GET_EVENT_TICKETS' | 'REMIND_ME' | 'SEARCH_MORE' | 'PRE_REGISTER' | 'SWIPE_UP_PRODUCT' | 'SWIPE_UP_SHOP' | 'PLAY_GAME_ON_FACEBOOK' | 'VISIT_WORLD' | 'OPEN_INSTANT_APP' | 'JOIN_GROUP' | 'GET_PROMOTIONS' | 'SEND_UPDATES' | 'INQUIRE_NOW' | 'VISIT_PROFILE' | 'CHAT_ON_WHATSAPP' | 'EXPLORE_MORE' | 'CONFIRM' | 'JOIN_CHANNEL' | 'MAKE_AN_APPOINTMENT' | 'ASK_ABOUT_SERVICES' | 'BOOK_A_CONSULTATION' | 'GET_A_QUOTE' | 'BUY_VIA_MESSAGE' | 'ASK_FOR_MORE_INFO' | 'VIEW_PRODUCT' | 'VIEW_CHANNEL' | 'WATCH_LIVE_VIDEO' | 'JOIN_LIVE_VIDEO' | 'IMAGINE' | 'WATCH_NOW' | 'STREAM_NOW' | 'BUY_ACTIVITY_TICKETS' | 'CALL' | 'MISSED_CALL' | 'CALL_NOW' | 'CALL_ME' | 'APPLY_NOW' | 'BUY' | 'GET_QUOTE' | 'SUBSCRIBE' | 'RECORD_NOW' | 'VOTE_NOW' | 'GIVE_FREE_RIDES' | 'REGISTER_NOW' | 'OPEN_MESSENGER_EXT' | 'EVENT_RSVP' | 'CIVIC_ACTION' | 'SEND_INVITES' | 'REFER_FRIENDS' | 'REQUEST_TIME' | 'SEE_MENU' | 'SEARCH' | 'TRY_IT' | 'TRY_ON' | 'LINK_CARD' | 'DIAL_CODE' | 'FIND_YOUR_GROUPS' | 'START_ORDER' | 'REGISTER' | 'JOIN' | 'ATTEND' | 'REQUEST_DEMO' | 'VIEW_QUOTE' | 'APPLY';
|
|
57339
57368
|
/**
|
|
57340
57369
|
* The ad's destination URL. Required on legacy + attach shapes (skip for multi-creative). NOT required when `goal` is `lead_generation` (the ad opens a Lead Gen form instead).
|
|
57341
57370
|
*
|
|
@@ -57443,7 +57472,7 @@ type CreateStandaloneAdData = {
|
|
|
57443
57472
|
thumbnailUrl?: string;
|
|
57444
57473
|
};
|
|
57445
57474
|
linkUrl: string;
|
|
57446
|
-
callToAction: 'LEARN_MORE' | 'SHOP_NOW' | 'SIGN_UP' | '
|
|
57475
|
+
callToAction: 'BOOK_TRAVEL' | 'CONTACT_US' | 'DONATE' | 'DONATE_NOW' | 'DOWNLOAD' | 'GET_DIRECTIONS' | 'GO_LIVE' | 'INTERESTED' | 'LEARN_MORE' | 'SEE_DETAILS' | 'LIKE_PAGE' | 'MESSAGE_PAGE' | 'RAISE_MONEY' | 'SAVE' | 'SEND_TIP' | 'SHOP_NOW' | 'SIGN_UP' | 'VIEW_INSTAGRAM_PROFILE' | 'INSTAGRAM_MESSAGE' | 'LOYALTY_LEARN_MORE' | 'PURCHASE_GIFT_CARDS' | 'PAY_TO_ACCESS' | 'SEE_MORE' | 'TRY_IN_CAMERA' | 'WHATSAPP_LINK' | 'GET_IN_TOUCH' | 'TRY_NOW' | 'ASK_A_QUESTION' | 'START_A_CHAT' | 'CHAT_NOW' | 'ASK_US' | 'CHAT_WITH_US' | 'SHOP_ON_RETAILER' | 'BOOK_NOW' | 'CHECK_AVAILABILITY' | 'ORDER_NOW' | 'WHATSAPP_MESSAGE' | 'GET_MOBILE_APP' | 'INSTALL_MOBILE_APP' | 'USE_MOBILE_APP' | 'INSTALL_APP' | 'USE_APP' | 'PLAY_GAME' | 'TRY_DEMO' | 'WATCH_VIDEO' | 'WATCH_MORE' | 'OPEN_LINK' | 'NO_BUTTON' | 'LISTEN_MUSIC' | 'MOBILE_DOWNLOAD' | 'GET_OFFER' | 'GET_OFFER_VIEW' | 'BUY_NOW' | 'BUY_TICKETS' | 'UPDATE_APP' | 'BET_NOW' | 'ADD_TO_CART' | 'SELL_NOW' | 'GET_SHOWTIMES' | 'LISTEN_NOW' | 'GET_EVENT_TICKETS' | 'REMIND_ME' | 'SEARCH_MORE' | 'PRE_REGISTER' | 'SWIPE_UP_PRODUCT' | 'SWIPE_UP_SHOP' | 'PLAY_GAME_ON_FACEBOOK' | 'VISIT_WORLD' | 'OPEN_INSTANT_APP' | 'JOIN_GROUP' | 'GET_PROMOTIONS' | 'SEND_UPDATES' | 'INQUIRE_NOW' | 'VISIT_PROFILE' | 'CHAT_ON_WHATSAPP' | 'EXPLORE_MORE' | 'CONFIRM' | 'JOIN_CHANNEL' | 'MAKE_AN_APPOINTMENT' | 'ASK_ABOUT_SERVICES' | 'BOOK_A_CONSULTATION' | 'GET_A_QUOTE' | 'BUY_VIA_MESSAGE' | 'ASK_FOR_MORE_INFO' | 'VIEW_PRODUCT' | 'VIEW_CHANNEL' | 'WATCH_LIVE_VIDEO' | 'JOIN_LIVE_VIDEO' | 'IMAGINE' | 'WATCH_NOW' | 'STREAM_NOW' | 'BUY_ACTIVITY_TICKETS' | 'CALL' | 'MISSED_CALL' | 'CALL_NOW' | 'CALL_ME' | 'APPLY_NOW' | 'BUY' | 'GET_QUOTE' | 'SUBSCRIBE' | 'RECORD_NOW' | 'VOTE_NOW' | 'GIVE_FREE_RIDES' | 'REGISTER_NOW' | 'OPEN_MESSENGER_EXT' | 'EVENT_RSVP' | 'CIVIC_ACTION' | 'SEND_INVITES' | 'REFER_FRIENDS' | 'REQUEST_TIME' | 'SEE_MENU' | 'SEARCH' | 'TRY_IT' | 'TRY_ON' | 'LINK_CARD' | 'DIAL_CODE' | 'FIND_YOUR_GROUPS' | 'START_ORDER';
|
|
57447
57476
|
}>;
|
|
57448
57477
|
/**
|
|
57449
57478
|
* When present, switches to the attach shape: adds one new ad to this existing ad set without creating a new campaign. Mutually exclusive with `creatives[]`.
|
|
@@ -57859,7 +57888,7 @@ type CreateStandaloneAdData = {
|
|
|
57859
57888
|
/**
|
|
57860
57889
|
* CTA-button variations. Required.
|
|
57861
57890
|
*/
|
|
57862
|
-
callToActionTypes?: Array<('LEARN_MORE' | 'SHOP_NOW' | 'SIGN_UP' | '
|
|
57891
|
+
callToActionTypes?: Array<('BOOK_TRAVEL' | 'CONTACT_US' | 'DONATE' | 'DONATE_NOW' | 'DOWNLOAD' | 'GET_DIRECTIONS' | 'GO_LIVE' | 'INTERESTED' | 'LEARN_MORE' | 'SEE_DETAILS' | 'LIKE_PAGE' | 'MESSAGE_PAGE' | 'RAISE_MONEY' | 'SAVE' | 'SEND_TIP' | 'SHOP_NOW' | 'SIGN_UP' | 'VIEW_INSTAGRAM_PROFILE' | 'INSTAGRAM_MESSAGE' | 'LOYALTY_LEARN_MORE' | 'PURCHASE_GIFT_CARDS' | 'PAY_TO_ACCESS' | 'SEE_MORE' | 'TRY_IN_CAMERA' | 'WHATSAPP_LINK' | 'GET_IN_TOUCH' | 'TRY_NOW' | 'ASK_A_QUESTION' | 'START_A_CHAT' | 'CHAT_NOW' | 'ASK_US' | 'CHAT_WITH_US' | 'SHOP_ON_RETAILER' | 'BOOK_NOW' | 'CHECK_AVAILABILITY' | 'ORDER_NOW' | 'WHATSAPP_MESSAGE' | 'GET_MOBILE_APP' | 'INSTALL_MOBILE_APP' | 'USE_MOBILE_APP' | 'INSTALL_APP' | 'USE_APP' | 'PLAY_GAME' | 'TRY_DEMO' | 'WATCH_VIDEO' | 'WATCH_MORE' | 'OPEN_LINK' | 'NO_BUTTON' | 'LISTEN_MUSIC' | 'MOBILE_DOWNLOAD' | 'GET_OFFER' | 'GET_OFFER_VIEW' | 'BUY_NOW' | 'BUY_TICKETS' | 'UPDATE_APP' | 'BET_NOW' | 'ADD_TO_CART' | 'SELL_NOW' | 'GET_SHOWTIMES' | 'LISTEN_NOW' | 'GET_EVENT_TICKETS' | 'REMIND_ME' | 'SEARCH_MORE' | 'PRE_REGISTER' | 'SWIPE_UP_PRODUCT' | 'SWIPE_UP_SHOP' | 'PLAY_GAME_ON_FACEBOOK' | 'VISIT_WORLD' | 'OPEN_INSTANT_APP' | 'JOIN_GROUP' | 'GET_PROMOTIONS' | 'SEND_UPDATES' | 'INQUIRE_NOW' | 'VISIT_PROFILE' | 'CHAT_ON_WHATSAPP' | 'EXPLORE_MORE' | 'CONFIRM' | 'JOIN_CHANNEL' | 'MAKE_AN_APPOINTMENT' | 'ASK_ABOUT_SERVICES' | 'BOOK_A_CONSULTATION' | 'GET_A_QUOTE' | 'BUY_VIA_MESSAGE' | 'ASK_FOR_MORE_INFO' | 'VIEW_PRODUCT' | 'VIEW_CHANNEL' | 'WATCH_LIVE_VIDEO' | 'JOIN_LIVE_VIDEO' | 'IMAGINE' | 'WATCH_NOW' | 'STREAM_NOW' | 'BUY_ACTIVITY_TICKETS' | 'CALL' | 'MISSED_CALL' | 'CALL_NOW' | 'CALL_ME' | 'APPLY_NOW' | 'BUY' | 'GET_QUOTE' | 'SUBSCRIBE' | 'RECORD_NOW' | 'VOTE_NOW' | 'GIVE_FREE_RIDES' | 'REGISTER_NOW' | 'OPEN_MESSENGER_EXT' | 'EVENT_RSVP' | 'CIVIC_ACTION' | 'SEND_INVITES' | 'REFER_FRIENDS' | 'REQUEST_TIME' | 'SEE_MENU' | 'SEARCH' | 'TRY_IT' | 'TRY_ON' | 'LINK_CARD' | 'DIAL_CODE' | 'FIND_YOUR_GROUPS' | 'START_ORDER')>;
|
|
57863
57892
|
/**
|
|
57864
57893
|
* 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`.
|
|
57865
57894
|
*/
|
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.1386",
|
|
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.1386",
|
|
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
|
@@ -325,13 +325,41 @@ export type Ad = {
|
|
|
325
325
|
*/
|
|
326
326
|
assetGroupResourceName?: string;
|
|
327
327
|
/**
|
|
328
|
-
* Google RSA
|
|
328
|
+
* Google RSA: the headline assets as objects (3 to 15). Meta: every title variation of the creative (`asset_feed_spec.titles`) as strings, the same shape as the `headlines` create input. Present only with 2 or more titles; a single title is `headline`.
|
|
329
329
|
*/
|
|
330
|
-
headlines?: Array<GoogleRsaHeadline>;
|
|
330
|
+
headlines?: Array<(string | GoogleRsaHeadline)>;
|
|
331
331
|
/**
|
|
332
|
-
* Google RSA
|
|
332
|
+
* Google RSA: the description assets as objects (2 to 4). Meta: every description variation of the creative (`asset_feed_spec.descriptions`) as strings, the same shape as the `descriptions` create input. Present only with 2 or more descriptions; a single one is `description`.
|
|
333
333
|
*/
|
|
334
|
-
descriptions?: Array<GoogleRsaDescription>;
|
|
334
|
+
descriptions?: Array<(string | GoogleRsaDescription)>;
|
|
335
|
+
/**
|
|
336
|
+
* Meta: the creative's title (`link_data.name`, `video_data.title`, or the first `asset_feed_spec.titles` entry). Absent when the creative has none.
|
|
337
|
+
*/
|
|
338
|
+
headline?: string;
|
|
339
|
+
/**
|
|
340
|
+
* Meta: every primary text variation of the creative (`asset_feed_spec.bodies`), the same shape as the `bodies` create input. Present only with 2 or more texts; a single text is `body`.
|
|
341
|
+
*/
|
|
342
|
+
bodies?: Array<(string)>;
|
|
343
|
+
/**
|
|
344
|
+
* Meta: the creative's description under the title (`link_data.description`, `video_data.link_description`, or the first `asset_feed_spec.descriptions` entry).
|
|
345
|
+
*/
|
|
346
|
+
description?: string;
|
|
347
|
+
/**
|
|
348
|
+
* Meta: the call to action type (`call_to_action.type`, or the first `asset_feed_spec.call_to_action_types` entry), e.g. LEARN_MORE or SIGN_UP.
|
|
349
|
+
*/
|
|
350
|
+
callToAction?: string;
|
|
351
|
+
/**
|
|
352
|
+
* Meta: the instant form the call to action opens (`call_to_action.value.lead_gen_form_id`), the same value as the `leadGenFormId` create input. Absent on ads without a lead form.
|
|
353
|
+
*/
|
|
354
|
+
leadGenFormId?: string;
|
|
355
|
+
/**
|
|
356
|
+
* Meta: the ad image hash (`image_hash`), reusable as `imageHash` on POST /v1/ads/create within the same ad account. `thumbnailUrl` and `mediaUrls` carry its stable full resolution permalink when Meta resolves it.
|
|
357
|
+
*/
|
|
358
|
+
imageHash?: string;
|
|
359
|
+
/**
|
|
360
|
+
* Meta: the creative's `url_tags` query string appended to the destination URL.
|
|
361
|
+
*/
|
|
362
|
+
urlTags?: (string) | null;
|
|
335
363
|
/**
|
|
336
364
|
* Google RSA only. Replaces final URLs. Omitted lists stay unchanged.
|
|
337
365
|
*/
|
|
@@ -380,7 +408,7 @@ export type Ad = {
|
|
|
380
408
|
*/
|
|
381
409
|
videoUrl?: (string) | null;
|
|
382
410
|
/**
|
|
383
|
-
* Meta ad creative id backing this ad. Reusable via existingCreativeId on POST /v1/ads/create.
|
|
411
|
+
* Meta ad creative id backing this ad, refreshed from Meta on every sync. Reusable via existingCreativeId on POST /v1/ads/create, and readable raw through GET /v1/ads/creatives/{creativeId}. Ads synced from Meta also carry it as the legacy `id` key.
|
|
384
412
|
*/
|
|
385
413
|
creativeId?: (string) | null;
|
|
386
414
|
/**
|
|
@@ -27437,7 +27465,8 @@ export type GetConnectUrlData = {
|
|
|
27437
27465
|
/**
|
|
27438
27466
|
* Connect through one of your own OAuth apps (see /v1/connect/oauth-apps), so the consent screen shows your app and the platform's limits are your app's. Without it the connect runs on Zernio's app, whatever apps the workspace has saved.
|
|
27439
27467
|
*
|
|
27440
|
-
* - Only platforms listed in `platforms` of GET /v1/connect/oauth-apps accept an app. Any other returns 400, and so do ads connects (`adsConnect=true` in the redirect URL)
|
|
27468
|
+
* - Only platforms listed in `platforms` of GET /v1/connect/oauth-apps accept an app. Any other returns 400, and so do ads connects (`adsConnect=true` in the redirect URL).
|
|
27469
|
+
* - Connects that end on a destination picker also return 400, except Facebook Pages, Google Business locations, Pinterest boards and Snapchat public profiles (Instagram through Facebook Login, for example).
|
|
27441
27470
|
* - A LinkedIn connect through an app saves the member's own profile: organization pages, and mention lookups, stay on Zernio's app.
|
|
27442
27471
|
* - The connect requests the app's `scopeAreas`. `scopes` may narrow them but not add an area the app does not enable (400).
|
|
27443
27472
|
* - If the user does not grant every requested area, the account still connects and the redirect carries `missing_permissions=<areas>` (the headless POST returns `missingPermissions`).
|
|
@@ -58493,13 +58522,13 @@ export type CreateStandaloneAdData = {
|
|
|
58493
58522
|
/**
|
|
58494
58523
|
* The ad's call-to-action button.
|
|
58495
58524
|
*
|
|
58496
|
-
* - **Meta:** required on legacy + attach shapes.
|
|
58525
|
+
* - **Meta:** required on legacy + attach shapes. Accepts every call to action type Meta itself accepts (the enum lists them), including values such as SEE_DETAILS that ads synced from Meta carry.
|
|
58497
58526
|
* - **TikTok:** honoured, passed through to the Spark Ad creative's `call_to_action`.
|
|
58498
58527
|
* - **LinkedIn:** the CTA button on the ad; defaults to LEARN_MORE when `linkUrl` is set. Accepts LEARN_MORE, SIGN_UP, DOWNLOAD, SUBSCRIBE, REGISTER, JOIN, ATTEND, REQUEST_DEMO, VIEW_QUOTE, APPLY, SEE_MORE, SHOP_NOW, BUY_NOW.
|
|
58499
58528
|
* - **Reddit** (image, video and carousel ads): accepts LEARN_MORE, SHOP_NOW, SIGN_UP, CONTACT_US, DOWNLOAD, GET_QUOTE, SUBSCRIBE, APPLY_NOW, BOOK_NOW, BUY_TICKETS, DONATE_NOW, GET_DIRECTIONS, GET_SHOWTIMES, LISTEN_NOW, ORDER_NOW, SEE_MENU, INSTALL_MOBILE_APP. Other values return 400.
|
|
58500
58529
|
* - **Google, Pinterest, and X:** ignored.
|
|
58501
58530
|
*/
|
|
58502
|
-
callToAction?: 'LEARN_MORE' | 'SHOP_NOW' | 'SIGN_UP' | '
|
|
58531
|
+
callToAction?: 'BOOK_TRAVEL' | 'CONTACT_US' | 'DONATE' | 'DONATE_NOW' | 'DOWNLOAD' | 'GET_DIRECTIONS' | 'GO_LIVE' | 'INTERESTED' | 'LEARN_MORE' | 'SEE_DETAILS' | 'LIKE_PAGE' | 'MESSAGE_PAGE' | 'RAISE_MONEY' | 'SAVE' | 'SEND_TIP' | 'SHOP_NOW' | 'SIGN_UP' | 'VIEW_INSTAGRAM_PROFILE' | 'INSTAGRAM_MESSAGE' | 'LOYALTY_LEARN_MORE' | 'PURCHASE_GIFT_CARDS' | 'PAY_TO_ACCESS' | 'SEE_MORE' | 'TRY_IN_CAMERA' | 'WHATSAPP_LINK' | 'GET_IN_TOUCH' | 'TRY_NOW' | 'ASK_A_QUESTION' | 'START_A_CHAT' | 'CHAT_NOW' | 'ASK_US' | 'CHAT_WITH_US' | 'SHOP_ON_RETAILER' | 'BOOK_NOW' | 'CHECK_AVAILABILITY' | 'ORDER_NOW' | 'WHATSAPP_MESSAGE' | 'GET_MOBILE_APP' | 'INSTALL_MOBILE_APP' | 'USE_MOBILE_APP' | 'INSTALL_APP' | 'USE_APP' | 'PLAY_GAME' | 'TRY_DEMO' | 'WATCH_VIDEO' | 'WATCH_MORE' | 'OPEN_LINK' | 'NO_BUTTON' | 'LISTEN_MUSIC' | 'MOBILE_DOWNLOAD' | 'GET_OFFER' | 'GET_OFFER_VIEW' | 'BUY_NOW' | 'BUY_TICKETS' | 'UPDATE_APP' | 'BET_NOW' | 'ADD_TO_CART' | 'SELL_NOW' | 'GET_SHOWTIMES' | 'LISTEN_NOW' | 'GET_EVENT_TICKETS' | 'REMIND_ME' | 'SEARCH_MORE' | 'PRE_REGISTER' | 'SWIPE_UP_PRODUCT' | 'SWIPE_UP_SHOP' | 'PLAY_GAME_ON_FACEBOOK' | 'VISIT_WORLD' | 'OPEN_INSTANT_APP' | 'JOIN_GROUP' | 'GET_PROMOTIONS' | 'SEND_UPDATES' | 'INQUIRE_NOW' | 'VISIT_PROFILE' | 'CHAT_ON_WHATSAPP' | 'EXPLORE_MORE' | 'CONFIRM' | 'JOIN_CHANNEL' | 'MAKE_AN_APPOINTMENT' | 'ASK_ABOUT_SERVICES' | 'BOOK_A_CONSULTATION' | 'GET_A_QUOTE' | 'BUY_VIA_MESSAGE' | 'ASK_FOR_MORE_INFO' | 'VIEW_PRODUCT' | 'VIEW_CHANNEL' | 'WATCH_LIVE_VIDEO' | 'JOIN_LIVE_VIDEO' | 'IMAGINE' | 'WATCH_NOW' | 'STREAM_NOW' | 'BUY_ACTIVITY_TICKETS' | 'CALL' | 'MISSED_CALL' | 'CALL_NOW' | 'CALL_ME' | 'APPLY_NOW' | 'BUY' | 'GET_QUOTE' | 'SUBSCRIBE' | 'RECORD_NOW' | 'VOTE_NOW' | 'GIVE_FREE_RIDES' | 'REGISTER_NOW' | 'OPEN_MESSENGER_EXT' | 'EVENT_RSVP' | 'CIVIC_ACTION' | 'SEND_INVITES' | 'REFER_FRIENDS' | 'REQUEST_TIME' | 'SEE_MENU' | 'SEARCH' | 'TRY_IT' | 'TRY_ON' | 'LINK_CARD' | 'DIAL_CODE' | 'FIND_YOUR_GROUPS' | 'START_ORDER' | 'REGISTER' | 'JOIN' | 'ATTEND' | 'REQUEST_DEMO' | 'VIEW_QUOTE' | 'APPLY';
|
|
58503
58532
|
/**
|
|
58504
58533
|
* The ad's destination URL. Required on legacy + attach shapes (skip for multi-creative). NOT required when `goal` is `lead_generation` (the ad opens a Lead Gen form instead).
|
|
58505
58534
|
*
|
|
@@ -58607,7 +58636,7 @@ export type CreateStandaloneAdData = {
|
|
|
58607
58636
|
thumbnailUrl?: string;
|
|
58608
58637
|
};
|
|
58609
58638
|
linkUrl: string;
|
|
58610
|
-
callToAction: 'LEARN_MORE' | 'SHOP_NOW' | 'SIGN_UP' | '
|
|
58639
|
+
callToAction: 'BOOK_TRAVEL' | 'CONTACT_US' | 'DONATE' | 'DONATE_NOW' | 'DOWNLOAD' | 'GET_DIRECTIONS' | 'GO_LIVE' | 'INTERESTED' | 'LEARN_MORE' | 'SEE_DETAILS' | 'LIKE_PAGE' | 'MESSAGE_PAGE' | 'RAISE_MONEY' | 'SAVE' | 'SEND_TIP' | 'SHOP_NOW' | 'SIGN_UP' | 'VIEW_INSTAGRAM_PROFILE' | 'INSTAGRAM_MESSAGE' | 'LOYALTY_LEARN_MORE' | 'PURCHASE_GIFT_CARDS' | 'PAY_TO_ACCESS' | 'SEE_MORE' | 'TRY_IN_CAMERA' | 'WHATSAPP_LINK' | 'GET_IN_TOUCH' | 'TRY_NOW' | 'ASK_A_QUESTION' | 'START_A_CHAT' | 'CHAT_NOW' | 'ASK_US' | 'CHAT_WITH_US' | 'SHOP_ON_RETAILER' | 'BOOK_NOW' | 'CHECK_AVAILABILITY' | 'ORDER_NOW' | 'WHATSAPP_MESSAGE' | 'GET_MOBILE_APP' | 'INSTALL_MOBILE_APP' | 'USE_MOBILE_APP' | 'INSTALL_APP' | 'USE_APP' | 'PLAY_GAME' | 'TRY_DEMO' | 'WATCH_VIDEO' | 'WATCH_MORE' | 'OPEN_LINK' | 'NO_BUTTON' | 'LISTEN_MUSIC' | 'MOBILE_DOWNLOAD' | 'GET_OFFER' | 'GET_OFFER_VIEW' | 'BUY_NOW' | 'BUY_TICKETS' | 'UPDATE_APP' | 'BET_NOW' | 'ADD_TO_CART' | 'SELL_NOW' | 'GET_SHOWTIMES' | 'LISTEN_NOW' | 'GET_EVENT_TICKETS' | 'REMIND_ME' | 'SEARCH_MORE' | 'PRE_REGISTER' | 'SWIPE_UP_PRODUCT' | 'SWIPE_UP_SHOP' | 'PLAY_GAME_ON_FACEBOOK' | 'VISIT_WORLD' | 'OPEN_INSTANT_APP' | 'JOIN_GROUP' | 'GET_PROMOTIONS' | 'SEND_UPDATES' | 'INQUIRE_NOW' | 'VISIT_PROFILE' | 'CHAT_ON_WHATSAPP' | 'EXPLORE_MORE' | 'CONFIRM' | 'JOIN_CHANNEL' | 'MAKE_AN_APPOINTMENT' | 'ASK_ABOUT_SERVICES' | 'BOOK_A_CONSULTATION' | 'GET_A_QUOTE' | 'BUY_VIA_MESSAGE' | 'ASK_FOR_MORE_INFO' | 'VIEW_PRODUCT' | 'VIEW_CHANNEL' | 'WATCH_LIVE_VIDEO' | 'JOIN_LIVE_VIDEO' | 'IMAGINE' | 'WATCH_NOW' | 'STREAM_NOW' | 'BUY_ACTIVITY_TICKETS' | 'CALL' | 'MISSED_CALL' | 'CALL_NOW' | 'CALL_ME' | 'APPLY_NOW' | 'BUY' | 'GET_QUOTE' | 'SUBSCRIBE' | 'RECORD_NOW' | 'VOTE_NOW' | 'GIVE_FREE_RIDES' | 'REGISTER_NOW' | 'OPEN_MESSENGER_EXT' | 'EVENT_RSVP' | 'CIVIC_ACTION' | 'SEND_INVITES' | 'REFER_FRIENDS' | 'REQUEST_TIME' | 'SEE_MENU' | 'SEARCH' | 'TRY_IT' | 'TRY_ON' | 'LINK_CARD' | 'DIAL_CODE' | 'FIND_YOUR_GROUPS' | 'START_ORDER';
|
|
58611
58640
|
}>;
|
|
58612
58641
|
/**
|
|
58613
58642
|
* When present, switches to the attach shape: adds one new ad to this existing ad set without creating a new campaign. Mutually exclusive with `creatives[]`.
|
|
@@ -59023,7 +59052,7 @@ export type CreateStandaloneAdData = {
|
|
|
59023
59052
|
/**
|
|
59024
59053
|
* CTA-button variations. Required.
|
|
59025
59054
|
*/
|
|
59026
|
-
callToActionTypes?: Array<('LEARN_MORE' | 'SHOP_NOW' | 'SIGN_UP' | '
|
|
59055
|
+
callToActionTypes?: Array<('BOOK_TRAVEL' | 'CONTACT_US' | 'DONATE' | 'DONATE_NOW' | 'DOWNLOAD' | 'GET_DIRECTIONS' | 'GO_LIVE' | 'INTERESTED' | 'LEARN_MORE' | 'SEE_DETAILS' | 'LIKE_PAGE' | 'MESSAGE_PAGE' | 'RAISE_MONEY' | 'SAVE' | 'SEND_TIP' | 'SHOP_NOW' | 'SIGN_UP' | 'VIEW_INSTAGRAM_PROFILE' | 'INSTAGRAM_MESSAGE' | 'LOYALTY_LEARN_MORE' | 'PURCHASE_GIFT_CARDS' | 'PAY_TO_ACCESS' | 'SEE_MORE' | 'TRY_IN_CAMERA' | 'WHATSAPP_LINK' | 'GET_IN_TOUCH' | 'TRY_NOW' | 'ASK_A_QUESTION' | 'START_A_CHAT' | 'CHAT_NOW' | 'ASK_US' | 'CHAT_WITH_US' | 'SHOP_ON_RETAILER' | 'BOOK_NOW' | 'CHECK_AVAILABILITY' | 'ORDER_NOW' | 'WHATSAPP_MESSAGE' | 'GET_MOBILE_APP' | 'INSTALL_MOBILE_APP' | 'USE_MOBILE_APP' | 'INSTALL_APP' | 'USE_APP' | 'PLAY_GAME' | 'TRY_DEMO' | 'WATCH_VIDEO' | 'WATCH_MORE' | 'OPEN_LINK' | 'NO_BUTTON' | 'LISTEN_MUSIC' | 'MOBILE_DOWNLOAD' | 'GET_OFFER' | 'GET_OFFER_VIEW' | 'BUY_NOW' | 'BUY_TICKETS' | 'UPDATE_APP' | 'BET_NOW' | 'ADD_TO_CART' | 'SELL_NOW' | 'GET_SHOWTIMES' | 'LISTEN_NOW' | 'GET_EVENT_TICKETS' | 'REMIND_ME' | 'SEARCH_MORE' | 'PRE_REGISTER' | 'SWIPE_UP_PRODUCT' | 'SWIPE_UP_SHOP' | 'PLAY_GAME_ON_FACEBOOK' | 'VISIT_WORLD' | 'OPEN_INSTANT_APP' | 'JOIN_GROUP' | 'GET_PROMOTIONS' | 'SEND_UPDATES' | 'INQUIRE_NOW' | 'VISIT_PROFILE' | 'CHAT_ON_WHATSAPP' | 'EXPLORE_MORE' | 'CONFIRM' | 'JOIN_CHANNEL' | 'MAKE_AN_APPOINTMENT' | 'ASK_ABOUT_SERVICES' | 'BOOK_A_CONSULTATION' | 'GET_A_QUOTE' | 'BUY_VIA_MESSAGE' | 'ASK_FOR_MORE_INFO' | 'VIEW_PRODUCT' | 'VIEW_CHANNEL' | 'WATCH_LIVE_VIDEO' | 'JOIN_LIVE_VIDEO' | 'IMAGINE' | 'WATCH_NOW' | 'STREAM_NOW' | 'BUY_ACTIVITY_TICKETS' | 'CALL' | 'MISSED_CALL' | 'CALL_NOW' | 'CALL_ME' | 'APPLY_NOW' | 'BUY' | 'GET_QUOTE' | 'SUBSCRIBE' | 'RECORD_NOW' | 'VOTE_NOW' | 'GIVE_FREE_RIDES' | 'REGISTER_NOW' | 'OPEN_MESSENGER_EXT' | 'EVENT_RSVP' | 'CIVIC_ACTION' | 'SEND_INVITES' | 'REFER_FRIENDS' | 'REQUEST_TIME' | 'SEE_MENU' | 'SEARCH' | 'TRY_IT' | 'TRY_ON' | 'LINK_CARD' | 'DIAL_CODE' | 'FIND_YOUR_GROUPS' | 'START_ORDER')>;
|
|
59027
59056
|
/**
|
|
59028
59057
|
* 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`.
|
|
59029
59058
|
*/
|