@zernio/node 0.2.986 → 0.2.988
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 +24 -23
- package/dist/index.d.ts +24 -23
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +23 -11
- package/src/generated/types.gen.ts +24 -23
package/dist/index.d.mts
CHANGED
|
@@ -38725,11 +38725,11 @@ type UpdateAdSetData = {
|
|
|
38725
38725
|
*/
|
|
38726
38726
|
billingEvent?: string;
|
|
38727
38727
|
/**
|
|
38728
|
-
* Ad set start_time (ISO 8601).
|
|
38728
|
+
* Ad set start_time (ISO 8601). 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.
|
|
38729
38729
|
*/
|
|
38730
38730
|
startDate?: string;
|
|
38731
38731
|
/**
|
|
38732
|
-
* Ad set end_time (ISO 8601).
|
|
38732
|
+
* Ad set end_time (ISO 8601). 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.
|
|
38733
38733
|
*/
|
|
38734
38734
|
endDate?: string;
|
|
38735
38735
|
/**
|
|
@@ -38785,7 +38785,7 @@ type UpdateAdSetResponse = ({
|
|
|
38785
38785
|
budget?: AdBudget;
|
|
38786
38786
|
budgetLevel?: 'adset';
|
|
38787
38787
|
/**
|
|
38788
|
-
* The status written to the ad set
|
|
38788
|
+
* The status written to the ad set switch
|
|
38789
38789
|
*/
|
|
38790
38790
|
status?: 'active' | 'paused';
|
|
38791
38791
|
/**
|
|
@@ -38800,10 +38800,6 @@ type UpdateAdSetResponse = ({
|
|
|
38800
38800
|
* Why each group of ads was skipped
|
|
38801
38801
|
*/
|
|
38802
38802
|
statusSkippedReasons?: Array<(string)>;
|
|
38803
|
-
/**
|
|
38804
|
-
* Present only where the platform has no ad-set switch and no child ad was actionable; `status` is then absent because nothing was written
|
|
38805
|
-
*/
|
|
38806
|
-
statusMessage?: string;
|
|
38807
38803
|
bidStrategy?: BidStrategy;
|
|
38808
38804
|
bidAmount?: (number) | null;
|
|
38809
38805
|
roasAverageFloor?: (number) | null;
|
|
@@ -38846,7 +38842,7 @@ type UpdateAdSetStatusData = {
|
|
|
38846
38842
|
};
|
|
38847
38843
|
type UpdateAdSetStatusResponse = ({
|
|
38848
38844
|
/**
|
|
38849
|
-
* The status written to the ad set
|
|
38845
|
+
* The status written to the ad set switch
|
|
38850
38846
|
*/
|
|
38851
38847
|
status?: 'active' | 'paused';
|
|
38852
38848
|
/**
|
|
@@ -38858,13 +38854,9 @@ type UpdateAdSetStatusResponse = ({
|
|
|
38858
38854
|
*/
|
|
38859
38855
|
skipped?: number;
|
|
38860
38856
|
/**
|
|
38861
|
-
* Why each group of ads was skipped
|
|
38857
|
+
* Why each group of ads was skipped (for example "2 ads already switched off", read from each ad's own switch)
|
|
38862
38858
|
*/
|
|
38863
38859
|
skippedReasons?: Array<(string)>;
|
|
38864
|
-
/**
|
|
38865
|
-
* Present only where the platform has no ad-set switch and no child ad was actionable
|
|
38866
|
-
*/
|
|
38867
|
-
message?: string;
|
|
38868
38860
|
});
|
|
38869
38861
|
type UpdateAdSetStatusError = (unknown | {
|
|
38870
38862
|
error?: string;
|
|
@@ -39247,15 +39239,23 @@ type UpdateAdStatusData = {
|
|
|
39247
39239
|
};
|
|
39248
39240
|
type UpdateAdStatusResponse = ({
|
|
39249
39241
|
/**
|
|
39250
|
-
* 1 when the
|
|
39242
|
+
* 1 when the switch was written, 0 when skipped
|
|
39251
39243
|
*/
|
|
39252
39244
|
updated?: number;
|
|
39253
39245
|
/**
|
|
39254
|
-
* 1 when skipped (terminal status or already in target state), else 0
|
|
39246
|
+
* 1 when skipped (terminal status, or the ad's own switch already in the target state), else 0
|
|
39255
39247
|
*/
|
|
39256
39248
|
skipped?: number;
|
|
39257
39249
|
/**
|
|
39258
|
-
*
|
|
39250
|
+
* The ad's delivery status after the call, as the platform reports it when it can be read back (e.g. `paused` for an ad switched on under a paused campaign)
|
|
39251
|
+
*/
|
|
39252
|
+
status?: string;
|
|
39253
|
+
/**
|
|
39254
|
+
* The ad's own on/off switch (`ACTIVE` / `PAUSED`), re-read from the platform after the write. Null where the platform exposes no per-ad switch (X) or the read-back failed and the platform does not store one.
|
|
39255
|
+
*/
|
|
39256
|
+
configuredStatus?: (string) | null;
|
|
39257
|
+
/**
|
|
39258
|
+
* Human-readable summary (present only when skipped), e.g. "No change: the ad's own switch is already off"
|
|
39259
39259
|
*/
|
|
39260
39260
|
message?: string;
|
|
39261
39261
|
});
|
|
@@ -42967,11 +42967,11 @@ type BoostPostData = {
|
|
|
42967
42967
|
*/
|
|
42968
42968
|
currency?: string;
|
|
42969
42969
|
/**
|
|
42970
|
-
* Ad-set start time (ISO 8601, e.g. "2026-06-10T09:00:00Z"), mapped to the ad set's `start_time`. When omitted the ad starts delivering immediately. Same field as on POST /v1/ads/create.
|
|
42970
|
+
* Ad-set start time (ISO 8601, e.g. "2026-06-10T09:00:00Z"), mapped to the ad set's `start_time`. When omitted the ad starts delivering immediately. On Meta and TikTok 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. Same field as on POST /v1/ads/create.
|
|
42971
42971
|
*/
|
|
42972
42972
|
startDate?: string;
|
|
42973
42973
|
/**
|
|
42974
|
-
* Ad-set end time (ISO 8601), mapped to the ad set's `end_time`. Required for lifetime budgets. Same field as on POST /v1/ads/create.
|
|
42974
|
+
* Ad-set end time (ISO 8601), mapped to the ad set's `end_time`. Required for lifetime budgets. On Meta and TikTok 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. Same field as on POST /v1/ads/create.
|
|
42975
42975
|
*/
|
|
42976
42976
|
endDate?: string;
|
|
42977
42977
|
/**
|
|
@@ -44110,17 +44110,18 @@ type CreateStandaloneAdData = {
|
|
|
44110
44110
|
[key: string]: (number);
|
|
44111
44111
|
};
|
|
44112
44112
|
/**
|
|
44113
|
-
* Required for lifetime budgets. On TikTok a value without an offset (`YYYY-MM-DD HH:MM:SS` or `YYYY-MM-
|
|
44113
|
+
* Required for lifetime budgets. On Meta and TikTok 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.
|
|
44114
44114
|
*/
|
|
44115
44115
|
endDate?: string;
|
|
44116
44116
|
/**
|
|
44117
44117
|
* Ad-set start time (ISO 8601, e.g. "2026-06-10T09:00:00Z"), mapped to the ad set's
|
|
44118
44118
|
* start (Meta `start_time`, TikTok ad group `schedule_start_time`, LinkedIn / Pinterest / X
|
|
44119
44119
|
* / Google campaign start). When omitted the ad starts delivering immediately. For lifetime
|
|
44120
|
-
* budgets Meta also requires `endDate`. On TikTok a value without an offset
|
|
44121
|
-
* (`YYYY-MM-DD HH:MM:SS` or `YYYY-MM-
|
|
44122
|
-
*
|
|
44123
|
-
* as
|
|
44120
|
+
* budgets Meta also requires `endDate`. On Meta and TikTok a value without an offset
|
|
44121
|
+
* (`YYYY-MM-DD`, `YYYY-MM-DD HH:MM:SS` or `YYYY-MM-DDTHH:MM:SS`) is read in the ad account
|
|
44122
|
+
* timezone (Meta itself would read it as UTC). The created ad's `schedule` echoes the start
|
|
44123
|
+
* and end the platform stored, as UTC instants; when attaching to an existing ad set
|
|
44124
|
+
* (`adSetId`) it is that ad set's start and end. Same field as on `POST /v1/ads/boost`.
|
|
44124
44125
|
*
|
|
44125
44126
|
*/
|
|
44126
44127
|
startDate?: string;
|
package/dist/index.d.ts
CHANGED
|
@@ -38725,11 +38725,11 @@ type UpdateAdSetData = {
|
|
|
38725
38725
|
*/
|
|
38726
38726
|
billingEvent?: string;
|
|
38727
38727
|
/**
|
|
38728
|
-
* Ad set start_time (ISO 8601).
|
|
38728
|
+
* Ad set start_time (ISO 8601). 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.
|
|
38729
38729
|
*/
|
|
38730
38730
|
startDate?: string;
|
|
38731
38731
|
/**
|
|
38732
|
-
* Ad set end_time (ISO 8601).
|
|
38732
|
+
* Ad set end_time (ISO 8601). 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.
|
|
38733
38733
|
*/
|
|
38734
38734
|
endDate?: string;
|
|
38735
38735
|
/**
|
|
@@ -38785,7 +38785,7 @@ type UpdateAdSetResponse = ({
|
|
|
38785
38785
|
budget?: AdBudget;
|
|
38786
38786
|
budgetLevel?: 'adset';
|
|
38787
38787
|
/**
|
|
38788
|
-
* The status written to the ad set
|
|
38788
|
+
* The status written to the ad set switch
|
|
38789
38789
|
*/
|
|
38790
38790
|
status?: 'active' | 'paused';
|
|
38791
38791
|
/**
|
|
@@ -38800,10 +38800,6 @@ type UpdateAdSetResponse = ({
|
|
|
38800
38800
|
* Why each group of ads was skipped
|
|
38801
38801
|
*/
|
|
38802
38802
|
statusSkippedReasons?: Array<(string)>;
|
|
38803
|
-
/**
|
|
38804
|
-
* Present only where the platform has no ad-set switch and no child ad was actionable; `status` is then absent because nothing was written
|
|
38805
|
-
*/
|
|
38806
|
-
statusMessage?: string;
|
|
38807
38803
|
bidStrategy?: BidStrategy;
|
|
38808
38804
|
bidAmount?: (number) | null;
|
|
38809
38805
|
roasAverageFloor?: (number) | null;
|
|
@@ -38846,7 +38842,7 @@ type UpdateAdSetStatusData = {
|
|
|
38846
38842
|
};
|
|
38847
38843
|
type UpdateAdSetStatusResponse = ({
|
|
38848
38844
|
/**
|
|
38849
|
-
* The status written to the ad set
|
|
38845
|
+
* The status written to the ad set switch
|
|
38850
38846
|
*/
|
|
38851
38847
|
status?: 'active' | 'paused';
|
|
38852
38848
|
/**
|
|
@@ -38858,13 +38854,9 @@ type UpdateAdSetStatusResponse = ({
|
|
|
38858
38854
|
*/
|
|
38859
38855
|
skipped?: number;
|
|
38860
38856
|
/**
|
|
38861
|
-
* Why each group of ads was skipped
|
|
38857
|
+
* Why each group of ads was skipped (for example "2 ads already switched off", read from each ad's own switch)
|
|
38862
38858
|
*/
|
|
38863
38859
|
skippedReasons?: Array<(string)>;
|
|
38864
|
-
/**
|
|
38865
|
-
* Present only where the platform has no ad-set switch and no child ad was actionable
|
|
38866
|
-
*/
|
|
38867
|
-
message?: string;
|
|
38868
38860
|
});
|
|
38869
38861
|
type UpdateAdSetStatusError = (unknown | {
|
|
38870
38862
|
error?: string;
|
|
@@ -39247,15 +39239,23 @@ type UpdateAdStatusData = {
|
|
|
39247
39239
|
};
|
|
39248
39240
|
type UpdateAdStatusResponse = ({
|
|
39249
39241
|
/**
|
|
39250
|
-
* 1 when the
|
|
39242
|
+
* 1 when the switch was written, 0 when skipped
|
|
39251
39243
|
*/
|
|
39252
39244
|
updated?: number;
|
|
39253
39245
|
/**
|
|
39254
|
-
* 1 when skipped (terminal status or already in target state), else 0
|
|
39246
|
+
* 1 when skipped (terminal status, or the ad's own switch already in the target state), else 0
|
|
39255
39247
|
*/
|
|
39256
39248
|
skipped?: number;
|
|
39257
39249
|
/**
|
|
39258
|
-
*
|
|
39250
|
+
* The ad's delivery status after the call, as the platform reports it when it can be read back (e.g. `paused` for an ad switched on under a paused campaign)
|
|
39251
|
+
*/
|
|
39252
|
+
status?: string;
|
|
39253
|
+
/**
|
|
39254
|
+
* The ad's own on/off switch (`ACTIVE` / `PAUSED`), re-read from the platform after the write. Null where the platform exposes no per-ad switch (X) or the read-back failed and the platform does not store one.
|
|
39255
|
+
*/
|
|
39256
|
+
configuredStatus?: (string) | null;
|
|
39257
|
+
/**
|
|
39258
|
+
* Human-readable summary (present only when skipped), e.g. "No change: the ad's own switch is already off"
|
|
39259
39259
|
*/
|
|
39260
39260
|
message?: string;
|
|
39261
39261
|
});
|
|
@@ -42967,11 +42967,11 @@ type BoostPostData = {
|
|
|
42967
42967
|
*/
|
|
42968
42968
|
currency?: string;
|
|
42969
42969
|
/**
|
|
42970
|
-
* Ad-set start time (ISO 8601, e.g. "2026-06-10T09:00:00Z"), mapped to the ad set's `start_time`. When omitted the ad starts delivering immediately. Same field as on POST /v1/ads/create.
|
|
42970
|
+
* Ad-set start time (ISO 8601, e.g. "2026-06-10T09:00:00Z"), mapped to the ad set's `start_time`. When omitted the ad starts delivering immediately. On Meta and TikTok 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. Same field as on POST /v1/ads/create.
|
|
42971
42971
|
*/
|
|
42972
42972
|
startDate?: string;
|
|
42973
42973
|
/**
|
|
42974
|
-
* Ad-set end time (ISO 8601), mapped to the ad set's `end_time`. Required for lifetime budgets. Same field as on POST /v1/ads/create.
|
|
42974
|
+
* Ad-set end time (ISO 8601), mapped to the ad set's `end_time`. Required for lifetime budgets. On Meta and TikTok 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. Same field as on POST /v1/ads/create.
|
|
42975
42975
|
*/
|
|
42976
42976
|
endDate?: string;
|
|
42977
42977
|
/**
|
|
@@ -44110,17 +44110,18 @@ type CreateStandaloneAdData = {
|
|
|
44110
44110
|
[key: string]: (number);
|
|
44111
44111
|
};
|
|
44112
44112
|
/**
|
|
44113
|
-
* Required for lifetime budgets. On TikTok a value without an offset (`YYYY-MM-DD HH:MM:SS` or `YYYY-MM-
|
|
44113
|
+
* Required for lifetime budgets. On Meta and TikTok 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.
|
|
44114
44114
|
*/
|
|
44115
44115
|
endDate?: string;
|
|
44116
44116
|
/**
|
|
44117
44117
|
* Ad-set start time (ISO 8601, e.g. "2026-06-10T09:00:00Z"), mapped to the ad set's
|
|
44118
44118
|
* start (Meta `start_time`, TikTok ad group `schedule_start_time`, LinkedIn / Pinterest / X
|
|
44119
44119
|
* / Google campaign start). When omitted the ad starts delivering immediately. For lifetime
|
|
44120
|
-
* budgets Meta also requires `endDate`. On TikTok a value without an offset
|
|
44121
|
-
* (`YYYY-MM-DD HH:MM:SS` or `YYYY-MM-
|
|
44122
|
-
*
|
|
44123
|
-
* as
|
|
44120
|
+
* budgets Meta also requires `endDate`. On Meta and TikTok a value without an offset
|
|
44121
|
+
* (`YYYY-MM-DD`, `YYYY-MM-DD HH:MM:SS` or `YYYY-MM-DDTHH:MM:SS`) is read in the ad account
|
|
44122
|
+
* timezone (Meta itself would read it as UTC). The created ad's `schedule` echoes the start
|
|
44123
|
+
* and end the platform stored, as UTC instants; when attaching to an existing ad set
|
|
44124
|
+
* (`adSetId`) it is that ad set's start and end. Same field as on `POST /v1/ads/boost`.
|
|
44124
44125
|
*
|
|
44125
44126
|
*/
|
|
44126
44127
|
startDate?: string;
|
package/dist/index.js
CHANGED
|
@@ -36,7 +36,7 @@ module.exports = __toCommonJS(index_exports);
|
|
|
36
36
|
// package.json
|
|
37
37
|
var package_default = {
|
|
38
38
|
name: "@zernio/node",
|
|
39
|
-
version: "0.2.
|
|
39
|
+
version: "0.2.988",
|
|
40
40
|
description: "The official Node.js library for the Zernio API",
|
|
41
41
|
main: "dist/index.js",
|
|
42
42
|
module: "dist/index.mjs",
|
package/dist/index.mjs
CHANGED
|
@@ -5,7 +5,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
|
|
|
5
5
|
// package.json
|
|
6
6
|
var package_default = {
|
|
7
7
|
name: "@zernio/node",
|
|
8
|
-
version: "0.2.
|
|
8
|
+
version: "0.2.988",
|
|
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
package/src/generated/sdk.gen.ts
CHANGED
|
@@ -9786,13 +9786,13 @@ export const deleteAdSet = <ThrowOnError extends boolean = false>(options: Optio
|
|
|
9786
9786
|
* status toggle and prefer a symmetric URL to
|
|
9787
9787
|
* /v1/ads/campaigns/{campaignId}/status.
|
|
9788
9788
|
*
|
|
9789
|
-
*
|
|
9790
|
-
*
|
|
9791
|
-
*
|
|
9792
|
-
*
|
|
9793
|
-
*
|
|
9794
|
-
*
|
|
9795
|
-
*
|
|
9789
|
+
* Writes the ad set's own on/off switch on every platform (Meta
|
|
9790
|
+
* `configured_status`, TikTok ad group `operation_status`, Google ad group
|
|
9791
|
+
* status, LinkedIn campaign, Pinterest ad group, X line item, OpenAI ad
|
|
9792
|
+
* group), whatever delivery status its ads report: an ad still in review
|
|
9793
|
+
* or paused by its campaign does not block it. The echoed `status` is the
|
|
9794
|
+
* confirmation that it landed. On TikTok, Pinterest and OpenAI the ads
|
|
9795
|
+
* whose own switch is not yet in the target state are flipped with it.
|
|
9796
9796
|
*
|
|
9797
9797
|
* `updated` / `skipped` describe only the ads whose own stored status
|
|
9798
9798
|
* CHANGED alongside the switch, so `updated: 0` is a normal successful
|
|
@@ -10007,16 +10007,28 @@ export const deleteAd = <ThrowOnError extends boolean = false>(options: OptionsL
|
|
|
10007
10007
|
|
|
10008
10008
|
/**
|
|
10009
10009
|
* Pause or resume a single ad
|
|
10010
|
-
* Ad-scoped pause/resume:
|
|
10011
|
-
*
|
|
10012
|
-
*
|
|
10010
|
+
* Ad-scoped pause/resume: flips ONLY this ad's own switch (Meta
|
|
10011
|
+
* `configured_status`, TikTok `operation_status`, Google ad group ad
|
|
10012
|
+
* status, LinkedIn creative, Pinterest ad), never its parent ad set or
|
|
10013
|
+
* campaign, so sibling ads keep running. X is the exception: its smallest
|
|
10014
|
+
* switch is the line item. Thin wrapper over the `status` field of
|
|
10015
|
+
* PUT /v1/ads/{adId}, for callers that want a URL symmetric to
|
|
10013
10016
|
* /v1/ads/campaigns/{campaignId}/status and /v1/ads/ad-sets/{adSetId}/status.
|
|
10014
10017
|
*
|
|
10018
|
+
* The ad's own switch is independent of its delivery status. An ad paused
|
|
10019
|
+
* only because its campaign or ad set is off (`status: paused`,
|
|
10020
|
+
* `configuredStatus: ACTIVE`) can still be switched off here, and
|
|
10021
|
+
* switching an ad on under a paused campaign leaves it `paused` until the
|
|
10022
|
+
* campaign is resumed. After the write the switch is read back from the
|
|
10023
|
+
* platform and returned as `configuredStatus`, together with the
|
|
10024
|
+
* resulting delivery `status`.
|
|
10025
|
+
*
|
|
10015
10026
|
* `{adId}` accepts the same identifier dialects as GET/PUT /v1/ads/{adId}
|
|
10016
10027
|
* (Zernio hex `_id`, Meta numeric `platformAdId`, or the creative's
|
|
10017
10028
|
* effective story/media IDs). `platform` is inferred from the ad, so it's
|
|
10018
10029
|
* not required in the body. Ads in terminal statuses (rejected, completed,
|
|
10019
|
-
* cancelled) and
|
|
10030
|
+
* cancelled) are skipped, and so is a request whose target already matches
|
|
10031
|
+
* the ad's own switch. The rolled-up `status` never decides a skip.
|
|
10020
10032
|
*
|
|
10021
10033
|
*/
|
|
10022
10034
|
export const updateAdStatus = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<UpdateAdStatusData, ThrowOnError>) => {
|
|
@@ -39139,11 +39139,11 @@ export type UpdateAdSetData = {
|
|
|
39139
39139
|
*/
|
|
39140
39140
|
billingEvent?: string;
|
|
39141
39141
|
/**
|
|
39142
|
-
* Ad set start_time (ISO 8601).
|
|
39142
|
+
* Ad set start_time (ISO 8601). 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.
|
|
39143
39143
|
*/
|
|
39144
39144
|
startDate?: string;
|
|
39145
39145
|
/**
|
|
39146
|
-
* Ad set end_time (ISO 8601).
|
|
39146
|
+
* Ad set end_time (ISO 8601). 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.
|
|
39147
39147
|
*/
|
|
39148
39148
|
endDate?: string;
|
|
39149
39149
|
/**
|
|
@@ -39200,7 +39200,7 @@ export type UpdateAdSetResponse = ({
|
|
|
39200
39200
|
budget?: AdBudget;
|
|
39201
39201
|
budgetLevel?: 'adset';
|
|
39202
39202
|
/**
|
|
39203
|
-
* The status written to the ad set
|
|
39203
|
+
* The status written to the ad set switch
|
|
39204
39204
|
*/
|
|
39205
39205
|
status?: 'active' | 'paused';
|
|
39206
39206
|
/**
|
|
@@ -39215,10 +39215,6 @@ export type UpdateAdSetResponse = ({
|
|
|
39215
39215
|
* Why each group of ads was skipped
|
|
39216
39216
|
*/
|
|
39217
39217
|
statusSkippedReasons?: Array<(string)>;
|
|
39218
|
-
/**
|
|
39219
|
-
* Present only where the platform has no ad-set switch and no child ad was actionable; `status` is then absent because nothing was written
|
|
39220
|
-
*/
|
|
39221
|
-
statusMessage?: string;
|
|
39222
39218
|
bidStrategy?: BidStrategy;
|
|
39223
39219
|
bidAmount?: (number) | null;
|
|
39224
39220
|
roasAverageFloor?: (number) | null;
|
|
@@ -39267,7 +39263,7 @@ export type UpdateAdSetStatusData = {
|
|
|
39267
39263
|
|
|
39268
39264
|
export type UpdateAdSetStatusResponse = ({
|
|
39269
39265
|
/**
|
|
39270
|
-
* The status written to the ad set
|
|
39266
|
+
* The status written to the ad set switch
|
|
39271
39267
|
*/
|
|
39272
39268
|
status?: 'active' | 'paused';
|
|
39273
39269
|
/**
|
|
@@ -39279,13 +39275,9 @@ export type UpdateAdSetStatusResponse = ({
|
|
|
39279
39275
|
*/
|
|
39280
39276
|
skipped?: number;
|
|
39281
39277
|
/**
|
|
39282
|
-
* Why each group of ads was skipped
|
|
39278
|
+
* Why each group of ads was skipped (for example "2 ads already switched off", read from each ad's own switch)
|
|
39283
39279
|
*/
|
|
39284
39280
|
skippedReasons?: Array<(string)>;
|
|
39285
|
-
/**
|
|
39286
|
-
* Present only where the platform has no ad-set switch and no child ad was actionable
|
|
39287
|
-
*/
|
|
39288
|
-
message?: string;
|
|
39289
39281
|
});
|
|
39290
39282
|
|
|
39291
39283
|
export type UpdateAdSetStatusError = (unknown | {
|
|
@@ -39686,15 +39678,23 @@ export type UpdateAdStatusData = {
|
|
|
39686
39678
|
|
|
39687
39679
|
export type UpdateAdStatusResponse = ({
|
|
39688
39680
|
/**
|
|
39689
|
-
* 1 when the
|
|
39681
|
+
* 1 when the switch was written, 0 when skipped
|
|
39690
39682
|
*/
|
|
39691
39683
|
updated?: number;
|
|
39692
39684
|
/**
|
|
39693
|
-
* 1 when skipped (terminal status or already in target state), else 0
|
|
39685
|
+
* 1 when skipped (terminal status, or the ad's own switch already in the target state), else 0
|
|
39694
39686
|
*/
|
|
39695
39687
|
skipped?: number;
|
|
39696
39688
|
/**
|
|
39697
|
-
*
|
|
39689
|
+
* The ad's delivery status after the call, as the platform reports it when it can be read back (e.g. `paused` for an ad switched on under a paused campaign)
|
|
39690
|
+
*/
|
|
39691
|
+
status?: string;
|
|
39692
|
+
/**
|
|
39693
|
+
* The ad's own on/off switch (`ACTIVE` / `PAUSED`), re-read from the platform after the write. Null where the platform exposes no per-ad switch (X) or the read-back failed and the platform does not store one.
|
|
39694
|
+
*/
|
|
39695
|
+
configuredStatus?: (string) | null;
|
|
39696
|
+
/**
|
|
39697
|
+
* Human-readable summary (present only when skipped), e.g. "No change: the ad's own switch is already off"
|
|
39698
39698
|
*/
|
|
39699
39699
|
message?: string;
|
|
39700
39700
|
});
|
|
@@ -43684,11 +43684,11 @@ export type BoostPostData = {
|
|
|
43684
43684
|
*/
|
|
43685
43685
|
currency?: string;
|
|
43686
43686
|
/**
|
|
43687
|
-
* Ad-set start time (ISO 8601, e.g. "2026-06-10T09:00:00Z"), mapped to the ad set's `start_time`. When omitted the ad starts delivering immediately. Same field as on POST /v1/ads/create.
|
|
43687
|
+
* Ad-set start time (ISO 8601, e.g. "2026-06-10T09:00:00Z"), mapped to the ad set's `start_time`. When omitted the ad starts delivering immediately. On Meta and TikTok 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. Same field as on POST /v1/ads/create.
|
|
43688
43688
|
*/
|
|
43689
43689
|
startDate?: string;
|
|
43690
43690
|
/**
|
|
43691
|
-
* Ad-set end time (ISO 8601), mapped to the ad set's `end_time`. Required for lifetime budgets. Same field as on POST /v1/ads/create.
|
|
43691
|
+
* Ad-set end time (ISO 8601), mapped to the ad set's `end_time`. Required for lifetime budgets. On Meta and TikTok 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. Same field as on POST /v1/ads/create.
|
|
43692
43692
|
*/
|
|
43693
43693
|
endDate?: string;
|
|
43694
43694
|
/**
|
|
@@ -44851,17 +44851,18 @@ export type CreateStandaloneAdData = {
|
|
|
44851
44851
|
[key: string]: (number);
|
|
44852
44852
|
};
|
|
44853
44853
|
/**
|
|
44854
|
-
* Required for lifetime budgets. On TikTok a value without an offset (`YYYY-MM-DD HH:MM:SS` or `YYYY-MM-
|
|
44854
|
+
* Required for lifetime budgets. On Meta and TikTok 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.
|
|
44855
44855
|
*/
|
|
44856
44856
|
endDate?: string;
|
|
44857
44857
|
/**
|
|
44858
44858
|
* Ad-set start time (ISO 8601, e.g. "2026-06-10T09:00:00Z"), mapped to the ad set's
|
|
44859
44859
|
* start (Meta `start_time`, TikTok ad group `schedule_start_time`, LinkedIn / Pinterest / X
|
|
44860
44860
|
* / Google campaign start). When omitted the ad starts delivering immediately. For lifetime
|
|
44861
|
-
* budgets Meta also requires `endDate`. On TikTok a value without an offset
|
|
44862
|
-
* (`YYYY-MM-DD HH:MM:SS` or `YYYY-MM-
|
|
44863
|
-
*
|
|
44864
|
-
* as
|
|
44861
|
+
* budgets Meta also requires `endDate`. On Meta and TikTok a value without an offset
|
|
44862
|
+
* (`YYYY-MM-DD`, `YYYY-MM-DD HH:MM:SS` or `YYYY-MM-DDTHH:MM:SS`) is read in the ad account
|
|
44863
|
+
* timezone (Meta itself would read it as UTC). The created ad's `schedule` echoes the start
|
|
44864
|
+
* and end the platform stored, as UTC instants; when attaching to an existing ad set
|
|
44865
|
+
* (`adSetId`) it is that ad set's start and end. Same field as on `POST /v1/ads/boost`.
|
|
44865
44866
|
*
|
|
44866
44867
|
*/
|
|
44867
44868
|
startDate?: string;
|