@getlatedev/node 0.2.1444 → 0.2.1446
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 +48 -5
- package/dist/index.d.ts +48 -5
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/types.gen.ts +48 -5
package/dist/index.d.mts
CHANGED
|
@@ -4363,9 +4363,16 @@ type AdTreeAdSet = {
|
|
|
4363
4363
|
platformAdSetId?: string;
|
|
4364
4364
|
adSetName?: string;
|
|
4365
4365
|
/**
|
|
4366
|
-
* Derived from child ad statuses
|
|
4366
|
+
* Derived from child ad statuses. Reads `paused` when the synced ad set or its campaign is switched off on the platform, even while the ads still report their own switch as on.
|
|
4367
4367
|
*/
|
|
4368
4368
|
status?: (AdStatus);
|
|
4369
|
+
/**
|
|
4370
|
+
* The ad set's start and end as last synced from the platform, as UTC instants. Null when the ad set was never synced or has no schedule (on Pinterest under a CBO campaign, the end date sits on the campaign).
|
|
4371
|
+
*/
|
|
4372
|
+
schedule?: {
|
|
4373
|
+
startDate?: string;
|
|
4374
|
+
endDate?: string;
|
|
4375
|
+
} | null;
|
|
4369
4376
|
/**
|
|
4370
4377
|
* Earliest `platformCreatedAt` (platform ad creation time; falls back to `createdAt`, Zernio's sync time, for ads synced before that field existed) across this ad set's ads. Not the ad set's own creation time on the platform, but a proxy usable for sorting.
|
|
4371
4378
|
*/
|
|
@@ -4533,9 +4540,16 @@ type AdTreeCampaign = {
|
|
|
4533
4540
|
*/
|
|
4534
4541
|
createdTime?: (string) | null;
|
|
4535
4542
|
/**
|
|
4536
|
-
* Delivery status derived from child ad statuses. Distinct from `reviewStatus`, which reflects the platform-side review state.
|
|
4543
|
+
* Delivery status derived from child ad statuses. Reads `paused` when the campaign is switched off on the platform (`platformCampaignStatus`), even while its ads still report their own switch as on. Distinct from `reviewStatus`, which reflects the platform-side review state.
|
|
4537
4544
|
*/
|
|
4538
4545
|
status?: (AdStatus);
|
|
4546
|
+
/**
|
|
4547
|
+
* The campaign's start and end as last synced from the platform, as UTC instants. Null when the campaign was never synced or has no schedule. Where the platform schedules the ad set instead (Meta, TikTok), read `AdTreeAdSet.schedule`.
|
|
4548
|
+
*/
|
|
4549
|
+
schedule?: {
|
|
4550
|
+
startDate?: string;
|
|
4551
|
+
endDate?: string;
|
|
4552
|
+
} | null;
|
|
4539
4553
|
/**
|
|
4540
4554
|
* Platform-side review state of the campaign. Independent of the
|
|
4541
4555
|
* children-derived delivery `status`: a campaign can have ads
|
|
@@ -13823,7 +13837,7 @@ type condition2 = 'new' | 'refurbished' | 'used';
|
|
|
13823
13837
|
type visibility2 = 'published' | 'staging';
|
|
13824
13838
|
type gender2 = 'female' | 'male' | 'unisex';
|
|
13825
13839
|
/**
|
|
13826
|
-
* Meta Advantage+ creative enhancements. Map snake_case feature names to OPT_IN or OPT_OUT; Meta validates supported keys and unspecified features default to OPT_OUT. auto_promotion_tag is an Advantage+ enhancement, not the Ads Manager Promotion setting. The deprecated standard_enhancements bundle is
|
|
13840
|
+
* Meta Advantage+ creative enhancements. Map snake_case feature names to OPT_IN or OPT_OUT; Meta validates supported keys and unspecified features default to OPT_OUT. auto_promotion_tag is an Advantage+ enhancement, not the Ads Manager Promotion setting. The deprecated standard_enhancements bundle (subcode 3858504) is a 400 before any Meta call.
|
|
13827
13841
|
*/
|
|
13828
13842
|
type MetaCreativeFeatures = {
|
|
13829
13843
|
[key: string]: ('OPT_IN' | 'OPT_OUT');
|
|
@@ -52629,7 +52643,11 @@ type UpdateAdData = {
|
|
|
52629
52643
|
* **Meta**: patch-style.
|
|
52630
52644
|
*
|
|
52631
52645
|
* - Pass any subset: omitted fields are preserved from the live creative, including media (`image_hash`/`video_id` reused, no re-upload) and `url_tags`. Sending the full set (`headline`, `body`, `callToAction`, `linkUrl`, `imageUrl`) rebuilds the creative from scratch.
|
|
52632
|
-
* - Partial patching reads the live `object_story_spec`, which Meta strips on SHARE / page-post / dark
|
|
52646
|
+
* - Partial patching reads the live `object_story_spec`, which Meta strips on SHARE / page-post / dark post creatives; those return 422 asking for the full set. A `videoUrl`/`videoId` on an image creative is a type change and also needs the full set.
|
|
52647
|
+
* - Creatives with an `asset_feed_spec` (several text options, placement or language rules) take text, link, tracking and enhancement edits in place. The new creative is built from the live asset feed with the edited text, and every video, image, label and rule is kept.
|
|
52648
|
+
* - On those, `body`, `headline` and `description` replace the one option of that kind. When the feed has several, send `bodies`, `headlines` or `descriptions` with one text per option, in order. `linkUrl` replaces the feed's only destination link.
|
|
52649
|
+
* - Image, video and call-to-action changes on asset_feed creatives apply to the story spec (Multiple Text Options creatives). They return 422 when the feed itself holds the images, videos or call-to-action options.
|
|
52650
|
+
* - The live creative's deprecated `standard_enhancements` setting (Meta subcode 3858504) is never sent back; every other enhancement setting is kept.
|
|
52633
52651
|
* - `existingCreativeId` repoints the ad at a creative from GET /v1/ads/creatives and ignores every other field.
|
|
52634
52652
|
* - Meta creatives are immutable: any change creates a new creative and repoints the ad. The old creative stays on the ad account for historical reporting.
|
|
52635
52653
|
* - `creativeFeatures` is Meta-only. Omitted settings are preserved from the live creative, including on full rebuilds; a supplied creativeFeatures map overrides individual existing keys.
|
|
@@ -52681,11 +52699,26 @@ type UpdateAdData = {
|
|
|
52681
52699
|
* Google Display only. Uploaded as a new square (1:1) marketing image asset that replaces the current one.
|
|
52682
52700
|
*/
|
|
52683
52701
|
squareImageUrl?: string;
|
|
52702
|
+
/**
|
|
52703
|
+
* Primary text. On a Meta asset_feed creative it replaces the feed's only body option (422 when it has several: send `bodies`).
|
|
52704
|
+
*/
|
|
52684
52705
|
body?: string;
|
|
52706
|
+
/**
|
|
52707
|
+
* Meta only. The primary text options of an asset_feed creative, one text per option in the order GET /v1/ads/{adId} returns them. Each replaces the option in its position and keeps its rule. A different count returns 422, as does a single-text creative (send `body`). Not with `body`.
|
|
52708
|
+
*/
|
|
52709
|
+
bodies?: Array<(string)>;
|
|
52710
|
+
/**
|
|
52711
|
+
* Meta only. Same as `bodies`, for the headline options (Meta `asset_feed_spec.titles`). Cannot be sent with `headline`. Not the top-level Google `headlines`.
|
|
52712
|
+
*/
|
|
52713
|
+
headlines?: Array<(string)>;
|
|
52685
52714
|
/**
|
|
52686
52715
|
* Link description slot (Meta `link_data.description` / `video_data.link_description`, LinkedIn creative description).
|
|
52687
52716
|
*/
|
|
52688
52717
|
description?: string;
|
|
52718
|
+
/**
|
|
52719
|
+
* Meta only. Same as `bodies`, for the description options. Cannot be sent with `description`. Not the top-level Google `descriptions`.
|
|
52720
|
+
*/
|
|
52721
|
+
descriptions?: Array<(string)>;
|
|
52689
52722
|
callToAction?: string;
|
|
52690
52723
|
linkUrl?: string;
|
|
52691
52724
|
imageUrl?: string;
|
|
@@ -57274,10 +57307,12 @@ type BoostPostData = {
|
|
|
57274
57307
|
/**
|
|
57275
57308
|
* Ad-set end time (ISO 8601). Required for lifetime budgets. Same field as on POST /v1/ads/create.
|
|
57276
57309
|
*
|
|
57277
|
-
* Maps to the ad set's `end_time` (on X, the line item's `end_time`; X campaigns carry no flight dates).
|
|
57310
|
+
* Maps to the ad set's `end_time` (on X, the line item's `end_time`; X campaigns carry no flight dates). On Pinterest it also goes on the campaign when the ad account needs Campaign Budget Optimization, daily budget included.
|
|
57278
57311
|
*
|
|
57279
57312
|
* On Meta, TikTok, X, Pinterest and Reddit, a value without an offset (`YYYY-MM-DD`, `YYYY-MM-DD HH:MM:SS` or `YYYY-MM-DDTHH:MM:SS`) is read in the ad account timezone, and a date-only end runs to 23:59:59 local.
|
|
57280
57313
|
*
|
|
57314
|
+
* Anything that is not an ISO 8601 date or date-time is a 400 on `endDate`.
|
|
57315
|
+
*
|
|
57281
57316
|
*/
|
|
57282
57317
|
endDate?: string;
|
|
57283
57318
|
/**
|
|
@@ -58794,6 +58829,10 @@ type CreateStandaloneAdData = {
|
|
|
58794
58829
|
* When the ad ends. If omitted: on a lifetime budget, the ad ends 7 days after it starts (reported in `appliedDefaults.endDate`); a daily budget runs until paused.
|
|
58795
58830
|
*
|
|
58796
58831
|
* Read like `startDate`: account timezone on Meta, TikTok, X, Pinterest, OpenAI and Reddit; whole account-local days on Google; UTC on LinkedIn. A date-only end runs to 23:59:59 local.
|
|
58832
|
+
*
|
|
58833
|
+
* On a Pinterest ad account that needs Campaign Budget Optimization, the end also goes on the campaign, daily budget included.
|
|
58834
|
+
*
|
|
58835
|
+
* 400 when it is not an ISO 8601 date or date-time, or when the ad joins a parent that keeps its own dates: `adSetId` on Meta, TikTok, Google, LinkedIn and Reddit, and `existingCampaignId` on Google.
|
|
58797
58836
|
*/
|
|
58798
58837
|
endDate?: string;
|
|
58799
58838
|
/**
|
|
@@ -61117,6 +61156,10 @@ type ListAdAudiencesResponse = ({
|
|
|
61117
61156
|
spec?: (TargetingSpec | null);
|
|
61118
61157
|
platform?: string;
|
|
61119
61158
|
size?: number;
|
|
61159
|
+
/**
|
|
61160
|
+
* Who the audience contains, in one line (e.g. '1% lookalike of Customers in US' or 'All website visitors, last 30 days'). Meta only.
|
|
61161
|
+
*/
|
|
61162
|
+
summary?: string;
|
|
61120
61163
|
status?: string;
|
|
61121
61164
|
}>;
|
|
61122
61165
|
});
|
package/dist/index.d.ts
CHANGED
|
@@ -4363,9 +4363,16 @@ type AdTreeAdSet = {
|
|
|
4363
4363
|
platformAdSetId?: string;
|
|
4364
4364
|
adSetName?: string;
|
|
4365
4365
|
/**
|
|
4366
|
-
* Derived from child ad statuses
|
|
4366
|
+
* Derived from child ad statuses. Reads `paused` when the synced ad set or its campaign is switched off on the platform, even while the ads still report their own switch as on.
|
|
4367
4367
|
*/
|
|
4368
4368
|
status?: (AdStatus);
|
|
4369
|
+
/**
|
|
4370
|
+
* The ad set's start and end as last synced from the platform, as UTC instants. Null when the ad set was never synced or has no schedule (on Pinterest under a CBO campaign, the end date sits on the campaign).
|
|
4371
|
+
*/
|
|
4372
|
+
schedule?: {
|
|
4373
|
+
startDate?: string;
|
|
4374
|
+
endDate?: string;
|
|
4375
|
+
} | null;
|
|
4369
4376
|
/**
|
|
4370
4377
|
* Earliest `platformCreatedAt` (platform ad creation time; falls back to `createdAt`, Zernio's sync time, for ads synced before that field existed) across this ad set's ads. Not the ad set's own creation time on the platform, but a proxy usable for sorting.
|
|
4371
4378
|
*/
|
|
@@ -4533,9 +4540,16 @@ type AdTreeCampaign = {
|
|
|
4533
4540
|
*/
|
|
4534
4541
|
createdTime?: (string) | null;
|
|
4535
4542
|
/**
|
|
4536
|
-
* Delivery status derived from child ad statuses. Distinct from `reviewStatus`, which reflects the platform-side review state.
|
|
4543
|
+
* Delivery status derived from child ad statuses. Reads `paused` when the campaign is switched off on the platform (`platformCampaignStatus`), even while its ads still report their own switch as on. Distinct from `reviewStatus`, which reflects the platform-side review state.
|
|
4537
4544
|
*/
|
|
4538
4545
|
status?: (AdStatus);
|
|
4546
|
+
/**
|
|
4547
|
+
* The campaign's start and end as last synced from the platform, as UTC instants. Null when the campaign was never synced or has no schedule. Where the platform schedules the ad set instead (Meta, TikTok), read `AdTreeAdSet.schedule`.
|
|
4548
|
+
*/
|
|
4549
|
+
schedule?: {
|
|
4550
|
+
startDate?: string;
|
|
4551
|
+
endDate?: string;
|
|
4552
|
+
} | null;
|
|
4539
4553
|
/**
|
|
4540
4554
|
* Platform-side review state of the campaign. Independent of the
|
|
4541
4555
|
* children-derived delivery `status`: a campaign can have ads
|
|
@@ -13823,7 +13837,7 @@ type condition2 = 'new' | 'refurbished' | 'used';
|
|
|
13823
13837
|
type visibility2 = 'published' | 'staging';
|
|
13824
13838
|
type gender2 = 'female' | 'male' | 'unisex';
|
|
13825
13839
|
/**
|
|
13826
|
-
* Meta Advantage+ creative enhancements. Map snake_case feature names to OPT_IN or OPT_OUT; Meta validates supported keys and unspecified features default to OPT_OUT. auto_promotion_tag is an Advantage+ enhancement, not the Ads Manager Promotion setting. The deprecated standard_enhancements bundle is
|
|
13840
|
+
* Meta Advantage+ creative enhancements. Map snake_case feature names to OPT_IN or OPT_OUT; Meta validates supported keys and unspecified features default to OPT_OUT. auto_promotion_tag is an Advantage+ enhancement, not the Ads Manager Promotion setting. The deprecated standard_enhancements bundle (subcode 3858504) is a 400 before any Meta call.
|
|
13827
13841
|
*/
|
|
13828
13842
|
type MetaCreativeFeatures = {
|
|
13829
13843
|
[key: string]: ('OPT_IN' | 'OPT_OUT');
|
|
@@ -52629,7 +52643,11 @@ type UpdateAdData = {
|
|
|
52629
52643
|
* **Meta**: patch-style.
|
|
52630
52644
|
*
|
|
52631
52645
|
* - Pass any subset: omitted fields are preserved from the live creative, including media (`image_hash`/`video_id` reused, no re-upload) and `url_tags`. Sending the full set (`headline`, `body`, `callToAction`, `linkUrl`, `imageUrl`) rebuilds the creative from scratch.
|
|
52632
|
-
* - Partial patching reads the live `object_story_spec`, which Meta strips on SHARE / page-post / dark
|
|
52646
|
+
* - Partial patching reads the live `object_story_spec`, which Meta strips on SHARE / page-post / dark post creatives; those return 422 asking for the full set. A `videoUrl`/`videoId` on an image creative is a type change and also needs the full set.
|
|
52647
|
+
* - Creatives with an `asset_feed_spec` (several text options, placement or language rules) take text, link, tracking and enhancement edits in place. The new creative is built from the live asset feed with the edited text, and every video, image, label and rule is kept.
|
|
52648
|
+
* - On those, `body`, `headline` and `description` replace the one option of that kind. When the feed has several, send `bodies`, `headlines` or `descriptions` with one text per option, in order. `linkUrl` replaces the feed's only destination link.
|
|
52649
|
+
* - Image, video and call-to-action changes on asset_feed creatives apply to the story spec (Multiple Text Options creatives). They return 422 when the feed itself holds the images, videos or call-to-action options.
|
|
52650
|
+
* - The live creative's deprecated `standard_enhancements` setting (Meta subcode 3858504) is never sent back; every other enhancement setting is kept.
|
|
52633
52651
|
* - `existingCreativeId` repoints the ad at a creative from GET /v1/ads/creatives and ignores every other field.
|
|
52634
52652
|
* - Meta creatives are immutable: any change creates a new creative and repoints the ad. The old creative stays on the ad account for historical reporting.
|
|
52635
52653
|
* - `creativeFeatures` is Meta-only. Omitted settings are preserved from the live creative, including on full rebuilds; a supplied creativeFeatures map overrides individual existing keys.
|
|
@@ -52681,11 +52699,26 @@ type UpdateAdData = {
|
|
|
52681
52699
|
* Google Display only. Uploaded as a new square (1:1) marketing image asset that replaces the current one.
|
|
52682
52700
|
*/
|
|
52683
52701
|
squareImageUrl?: string;
|
|
52702
|
+
/**
|
|
52703
|
+
* Primary text. On a Meta asset_feed creative it replaces the feed's only body option (422 when it has several: send `bodies`).
|
|
52704
|
+
*/
|
|
52684
52705
|
body?: string;
|
|
52706
|
+
/**
|
|
52707
|
+
* Meta only. The primary text options of an asset_feed creative, one text per option in the order GET /v1/ads/{adId} returns them. Each replaces the option in its position and keeps its rule. A different count returns 422, as does a single-text creative (send `body`). Not with `body`.
|
|
52708
|
+
*/
|
|
52709
|
+
bodies?: Array<(string)>;
|
|
52710
|
+
/**
|
|
52711
|
+
* Meta only. Same as `bodies`, for the headline options (Meta `asset_feed_spec.titles`). Cannot be sent with `headline`. Not the top-level Google `headlines`.
|
|
52712
|
+
*/
|
|
52713
|
+
headlines?: Array<(string)>;
|
|
52685
52714
|
/**
|
|
52686
52715
|
* Link description slot (Meta `link_data.description` / `video_data.link_description`, LinkedIn creative description).
|
|
52687
52716
|
*/
|
|
52688
52717
|
description?: string;
|
|
52718
|
+
/**
|
|
52719
|
+
* Meta only. Same as `bodies`, for the description options. Cannot be sent with `description`. Not the top-level Google `descriptions`.
|
|
52720
|
+
*/
|
|
52721
|
+
descriptions?: Array<(string)>;
|
|
52689
52722
|
callToAction?: string;
|
|
52690
52723
|
linkUrl?: string;
|
|
52691
52724
|
imageUrl?: string;
|
|
@@ -57274,10 +57307,12 @@ type BoostPostData = {
|
|
|
57274
57307
|
/**
|
|
57275
57308
|
* Ad-set end time (ISO 8601). Required for lifetime budgets. Same field as on POST /v1/ads/create.
|
|
57276
57309
|
*
|
|
57277
|
-
* Maps to the ad set's `end_time` (on X, the line item's `end_time`; X campaigns carry no flight dates).
|
|
57310
|
+
* Maps to the ad set's `end_time` (on X, the line item's `end_time`; X campaigns carry no flight dates). On Pinterest it also goes on the campaign when the ad account needs Campaign Budget Optimization, daily budget included.
|
|
57278
57311
|
*
|
|
57279
57312
|
* On Meta, TikTok, X, Pinterest and Reddit, a value without an offset (`YYYY-MM-DD`, `YYYY-MM-DD HH:MM:SS` or `YYYY-MM-DDTHH:MM:SS`) is read in the ad account timezone, and a date-only end runs to 23:59:59 local.
|
|
57280
57313
|
*
|
|
57314
|
+
* Anything that is not an ISO 8601 date or date-time is a 400 on `endDate`.
|
|
57315
|
+
*
|
|
57281
57316
|
*/
|
|
57282
57317
|
endDate?: string;
|
|
57283
57318
|
/**
|
|
@@ -58794,6 +58829,10 @@ type CreateStandaloneAdData = {
|
|
|
58794
58829
|
* When the ad ends. If omitted: on a lifetime budget, the ad ends 7 days after it starts (reported in `appliedDefaults.endDate`); a daily budget runs until paused.
|
|
58795
58830
|
*
|
|
58796
58831
|
* Read like `startDate`: account timezone on Meta, TikTok, X, Pinterest, OpenAI and Reddit; whole account-local days on Google; UTC on LinkedIn. A date-only end runs to 23:59:59 local.
|
|
58832
|
+
*
|
|
58833
|
+
* On a Pinterest ad account that needs Campaign Budget Optimization, the end also goes on the campaign, daily budget included.
|
|
58834
|
+
*
|
|
58835
|
+
* 400 when it is not an ISO 8601 date or date-time, or when the ad joins a parent that keeps its own dates: `adSetId` on Meta, TikTok, Google, LinkedIn and Reddit, and `existingCampaignId` on Google.
|
|
58797
58836
|
*/
|
|
58798
58837
|
endDate?: string;
|
|
58799
58838
|
/**
|
|
@@ -61117,6 +61156,10 @@ type ListAdAudiencesResponse = ({
|
|
|
61117
61156
|
spec?: (TargetingSpec | null);
|
|
61118
61157
|
platform?: string;
|
|
61119
61158
|
size?: number;
|
|
61159
|
+
/**
|
|
61160
|
+
* Who the audience contains, in one line (e.g. '1% lookalike of Customers in US' or 'All website visitors, last 30 days'). Meta only.
|
|
61161
|
+
*/
|
|
61162
|
+
summary?: string;
|
|
61120
61163
|
status?: string;
|
|
61121
61164
|
}>;
|
|
61122
61165
|
});
|
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.1446",
|
|
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.1446",
|
|
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
|
@@ -2174,9 +2174,16 @@ export type AdTreeAdSet = {
|
|
|
2174
2174
|
platformAdSetId?: string;
|
|
2175
2175
|
adSetName?: string;
|
|
2176
2176
|
/**
|
|
2177
|
-
* Derived from child ad statuses
|
|
2177
|
+
* Derived from child ad statuses. Reads `paused` when the synced ad set or its campaign is switched off on the platform, even while the ads still report their own switch as on.
|
|
2178
2178
|
*/
|
|
2179
2179
|
status?: (AdStatus);
|
|
2180
|
+
/**
|
|
2181
|
+
* The ad set's start and end as last synced from the platform, as UTC instants. Null when the ad set was never synced or has no schedule (on Pinterest under a CBO campaign, the end date sits on the campaign).
|
|
2182
|
+
*/
|
|
2183
|
+
schedule?: {
|
|
2184
|
+
startDate?: string;
|
|
2185
|
+
endDate?: string;
|
|
2186
|
+
} | null;
|
|
2180
2187
|
/**
|
|
2181
2188
|
* Earliest `platformCreatedAt` (platform ad creation time; falls back to `createdAt`, Zernio's sync time, for ads synced before that field existed) across this ad set's ads. Not the ad set's own creation time on the platform, but a proxy usable for sorting.
|
|
2182
2189
|
*/
|
|
@@ -2346,9 +2353,16 @@ export type AdTreeCampaign = {
|
|
|
2346
2353
|
*/
|
|
2347
2354
|
createdTime?: (string) | null;
|
|
2348
2355
|
/**
|
|
2349
|
-
* Delivery status derived from child ad statuses. Distinct from `reviewStatus`, which reflects the platform-side review state.
|
|
2356
|
+
* Delivery status derived from child ad statuses. Reads `paused` when the campaign is switched off on the platform (`platformCampaignStatus`), even while its ads still report their own switch as on. Distinct from `reviewStatus`, which reflects the platform-side review state.
|
|
2350
2357
|
*/
|
|
2351
2358
|
status?: (AdStatus);
|
|
2359
|
+
/**
|
|
2360
|
+
* The campaign's start and end as last synced from the platform, as UTC instants. Null when the campaign was never synced or has no schedule. Where the platform schedules the ad set instead (Meta, TikTok), read `AdTreeAdSet.schedule`.
|
|
2361
|
+
*/
|
|
2362
|
+
schedule?: {
|
|
2363
|
+
startDate?: string;
|
|
2364
|
+
endDate?: string;
|
|
2365
|
+
} | null;
|
|
2352
2366
|
/**
|
|
2353
2367
|
* Platform-side review state of the campaign. Independent of the
|
|
2354
2368
|
* children-derived delivery `status`: a campaign can have ads
|
|
@@ -12058,7 +12072,7 @@ export type visibility2 = 'published' | 'staging';
|
|
|
12058
12072
|
export type gender2 = 'female' | 'male' | 'unisex';
|
|
12059
12073
|
|
|
12060
12074
|
/**
|
|
12061
|
-
* Meta Advantage+ creative enhancements. Map snake_case feature names to OPT_IN or OPT_OUT; Meta validates supported keys and unspecified features default to OPT_OUT. auto_promotion_tag is an Advantage+ enhancement, not the Ads Manager Promotion setting. The deprecated standard_enhancements bundle is
|
|
12075
|
+
* Meta Advantage+ creative enhancements. Map snake_case feature names to OPT_IN or OPT_OUT; Meta validates supported keys and unspecified features default to OPT_OUT. auto_promotion_tag is an Advantage+ enhancement, not the Ads Manager Promotion setting. The deprecated standard_enhancements bundle (subcode 3858504) is a 400 before any Meta call.
|
|
12062
12076
|
*/
|
|
12063
12077
|
export type MetaCreativeFeatures = {
|
|
12064
12078
|
[key: string]: ('OPT_IN' | 'OPT_OUT');
|
|
@@ -53471,7 +53485,11 @@ export type UpdateAdData = {
|
|
|
53471
53485
|
* **Meta**: patch-style.
|
|
53472
53486
|
*
|
|
53473
53487
|
* - Pass any subset: omitted fields are preserved from the live creative, including media (`image_hash`/`video_id` reused, no re-upload) and `url_tags`. Sending the full set (`headline`, `body`, `callToAction`, `linkUrl`, `imageUrl`) rebuilds the creative from scratch.
|
|
53474
|
-
* - Partial patching reads the live `object_story_spec`, which Meta strips on SHARE / page-post / dark
|
|
53488
|
+
* - Partial patching reads the live `object_story_spec`, which Meta strips on SHARE / page-post / dark post creatives; those return 422 asking for the full set. A `videoUrl`/`videoId` on an image creative is a type change and also needs the full set.
|
|
53489
|
+
* - Creatives with an `asset_feed_spec` (several text options, placement or language rules) take text, link, tracking and enhancement edits in place. The new creative is built from the live asset feed with the edited text, and every video, image, label and rule is kept.
|
|
53490
|
+
* - On those, `body`, `headline` and `description` replace the one option of that kind. When the feed has several, send `bodies`, `headlines` or `descriptions` with one text per option, in order. `linkUrl` replaces the feed's only destination link.
|
|
53491
|
+
* - Image, video and call-to-action changes on asset_feed creatives apply to the story spec (Multiple Text Options creatives). They return 422 when the feed itself holds the images, videos or call-to-action options.
|
|
53492
|
+
* - The live creative's deprecated `standard_enhancements` setting (Meta subcode 3858504) is never sent back; every other enhancement setting is kept.
|
|
53475
53493
|
* - `existingCreativeId` repoints the ad at a creative from GET /v1/ads/creatives and ignores every other field.
|
|
53476
53494
|
* - Meta creatives are immutable: any change creates a new creative and repoints the ad. The old creative stays on the ad account for historical reporting.
|
|
53477
53495
|
* - `creativeFeatures` is Meta-only. Omitted settings are preserved from the live creative, including on full rebuilds; a supplied creativeFeatures map overrides individual existing keys.
|
|
@@ -53523,11 +53541,26 @@ export type UpdateAdData = {
|
|
|
53523
53541
|
* Google Display only. Uploaded as a new square (1:1) marketing image asset that replaces the current one.
|
|
53524
53542
|
*/
|
|
53525
53543
|
squareImageUrl?: string;
|
|
53544
|
+
/**
|
|
53545
|
+
* Primary text. On a Meta asset_feed creative it replaces the feed's only body option (422 when it has several: send `bodies`).
|
|
53546
|
+
*/
|
|
53526
53547
|
body?: string;
|
|
53548
|
+
/**
|
|
53549
|
+
* Meta only. The primary text options of an asset_feed creative, one text per option in the order GET /v1/ads/{adId} returns them. Each replaces the option in its position and keeps its rule. A different count returns 422, as does a single-text creative (send `body`). Not with `body`.
|
|
53550
|
+
*/
|
|
53551
|
+
bodies?: Array<(string)>;
|
|
53552
|
+
/**
|
|
53553
|
+
* Meta only. Same as `bodies`, for the headline options (Meta `asset_feed_spec.titles`). Cannot be sent with `headline`. Not the top-level Google `headlines`.
|
|
53554
|
+
*/
|
|
53555
|
+
headlines?: Array<(string)>;
|
|
53527
53556
|
/**
|
|
53528
53557
|
* Link description slot (Meta `link_data.description` / `video_data.link_description`, LinkedIn creative description).
|
|
53529
53558
|
*/
|
|
53530
53559
|
description?: string;
|
|
53560
|
+
/**
|
|
53561
|
+
* Meta only. Same as `bodies`, for the description options. Cannot be sent with `description`. Not the top-level Google `descriptions`.
|
|
53562
|
+
*/
|
|
53563
|
+
descriptions?: Array<(string)>;
|
|
53531
53564
|
callToAction?: string;
|
|
53532
53565
|
linkUrl?: string;
|
|
53533
53566
|
imageUrl?: string;
|
|
@@ -58443,10 +58476,12 @@ export type BoostPostData = {
|
|
|
58443
58476
|
/**
|
|
58444
58477
|
* Ad-set end time (ISO 8601). Required for lifetime budgets. Same field as on POST /v1/ads/create.
|
|
58445
58478
|
*
|
|
58446
|
-
* Maps to the ad set's `end_time` (on X, the line item's `end_time`; X campaigns carry no flight dates).
|
|
58479
|
+
* Maps to the ad set's `end_time` (on X, the line item's `end_time`; X campaigns carry no flight dates). On Pinterest it also goes on the campaign when the ad account needs Campaign Budget Optimization, daily budget included.
|
|
58447
58480
|
*
|
|
58448
58481
|
* On Meta, TikTok, X, Pinterest and Reddit, a value without an offset (`YYYY-MM-DD`, `YYYY-MM-DD HH:MM:SS` or `YYYY-MM-DDTHH:MM:SS`) is read in the ad account timezone, and a date-only end runs to 23:59:59 local.
|
|
58449
58482
|
*
|
|
58483
|
+
* Anything that is not an ISO 8601 date or date-time is a 400 on `endDate`.
|
|
58484
|
+
*
|
|
58450
58485
|
*/
|
|
58451
58486
|
endDate?: string;
|
|
58452
58487
|
/**
|
|
@@ -59987,6 +60022,10 @@ export type CreateStandaloneAdData = {
|
|
|
59987
60022
|
* When the ad ends. If omitted: on a lifetime budget, the ad ends 7 days after it starts (reported in `appliedDefaults.endDate`); a daily budget runs until paused.
|
|
59988
60023
|
*
|
|
59989
60024
|
* Read like `startDate`: account timezone on Meta, TikTok, X, Pinterest, OpenAI and Reddit; whole account-local days on Google; UTC on LinkedIn. A date-only end runs to 23:59:59 local.
|
|
60025
|
+
*
|
|
60026
|
+
* On a Pinterest ad account that needs Campaign Budget Optimization, the end also goes on the campaign, daily budget included.
|
|
60027
|
+
*
|
|
60028
|
+
* 400 when it is not an ISO 8601 date or date-time, or when the ad joins a parent that keeps its own dates: `adSetId` on Meta, TikTok, Google, LinkedIn and Reddit, and `existingCampaignId` on Google.
|
|
59990
60029
|
*/
|
|
59991
60030
|
endDate?: string;
|
|
59992
60031
|
/**
|
|
@@ -62440,6 +62479,10 @@ export type ListAdAudiencesResponse = ({
|
|
|
62440
62479
|
spec?: (TargetingSpec | null);
|
|
62441
62480
|
platform?: string;
|
|
62442
62481
|
size?: number;
|
|
62482
|
+
/**
|
|
62483
|
+
* Who the audience contains, in one line (e.g. '1% lookalike of Customers in US' or 'All website visitors, last 30 days'). Meta only.
|
|
62484
|
+
*/
|
|
62485
|
+
summary?: string;
|
|
62443
62486
|
status?: string;
|
|
62444
62487
|
}>;
|
|
62445
62488
|
});
|