@getlatedev/node 0.2.1303 → 0.2.1304
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 +10 -0
- package/dist/index.d.ts +10 -0
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +6 -4
- package/src/generated/types.gen.ts +10 -0
package/dist/index.d.mts
CHANGED
|
@@ -43812,11 +43812,17 @@ type ListAdSetsData = {
|
|
|
43812
43812
|
* Platform campaign ID
|
|
43813
43813
|
*/
|
|
43814
43814
|
campaignId?: string;
|
|
43815
|
+
limit?: number;
|
|
43815
43816
|
/**
|
|
43816
43817
|
* Read the on/off switches live from the platform instead of returning the synced values. The fresh values are stored (so later reads return them too) and the response carries `statusReadAt`, the time of the read. At most 20 platform objects are read per request. Where a read fails (credentials, platform error, no reader on that platform), the stored values come back with `statusReadAt: null`. See "Status freshness" in the operation description. On X the budget is read live in the same read: on GET /v1/ads/{adId} `budget`, `adSetBudget`, `campaignBudget` and `budgetLevel` are the line item and campaign budgets X holds now (stored like the switches); on the ad set and campaign listings `budget` is the one that line item or campaign holds now (returned, not stored); a row whose budget the other level holds keeps its synced `budget`.
|
|
43817
43818
|
*/
|
|
43818
43819
|
live?: boolean;
|
|
43820
|
+
page?: number;
|
|
43819
43821
|
platform?: 'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'pinterest' | 'google' | 'twitter' | 'openai' | 'reddit';
|
|
43822
|
+
/**
|
|
43823
|
+
* Filter by the ad set's stored `status`, the value each row returns. A live read does not change it. Rows whose `status` is null match no filter.
|
|
43824
|
+
*/
|
|
43825
|
+
status?: AdStatus;
|
|
43820
43826
|
};
|
|
43821
43827
|
};
|
|
43822
43828
|
type ListAdSetsResponse = ({
|
|
@@ -43824,6 +43830,9 @@ type ListAdSetsResponse = ({
|
|
|
43824
43830
|
platformAdSetId?: string;
|
|
43825
43831
|
platform?: string;
|
|
43826
43832
|
adSetName?: (string) | null;
|
|
43833
|
+
/**
|
|
43834
|
+
* Stored ad set status (active, paused, pending_review, rejected, completed, cancelled, error), as last synced. The `status` filter matches it.
|
|
43835
|
+
*/
|
|
43827
43836
|
status?: (string) | null;
|
|
43828
43837
|
/**
|
|
43829
43838
|
* Raw platform ad set status. On TikTok the ad group's own switch `operation_status` (ENABLE / DISABLE), independent of its campaign. On Meta and Reddit the ad set's `effective_status` (e.g. CAMPAIGN_PAUSED).
|
|
@@ -43954,6 +43963,7 @@ type ListAdSetsResponse = ({
|
|
|
43954
43963
|
*/
|
|
43955
43964
|
configReadAt?: (string) | null;
|
|
43956
43965
|
}>;
|
|
43966
|
+
pagination?: Pagination;
|
|
43957
43967
|
});
|
|
43958
43968
|
type ListAdSetsError = (ErrorResponse | unknown);
|
|
43959
43969
|
type CreateAdSetData = {
|
package/dist/index.d.ts
CHANGED
|
@@ -43812,11 +43812,17 @@ type ListAdSetsData = {
|
|
|
43812
43812
|
* Platform campaign ID
|
|
43813
43813
|
*/
|
|
43814
43814
|
campaignId?: string;
|
|
43815
|
+
limit?: number;
|
|
43815
43816
|
/**
|
|
43816
43817
|
* Read the on/off switches live from the platform instead of returning the synced values. The fresh values are stored (so later reads return them too) and the response carries `statusReadAt`, the time of the read. At most 20 platform objects are read per request. Where a read fails (credentials, platform error, no reader on that platform), the stored values come back with `statusReadAt: null`. See "Status freshness" in the operation description. On X the budget is read live in the same read: on GET /v1/ads/{adId} `budget`, `adSetBudget`, `campaignBudget` and `budgetLevel` are the line item and campaign budgets X holds now (stored like the switches); on the ad set and campaign listings `budget` is the one that line item or campaign holds now (returned, not stored); a row whose budget the other level holds keeps its synced `budget`.
|
|
43817
43818
|
*/
|
|
43818
43819
|
live?: boolean;
|
|
43820
|
+
page?: number;
|
|
43819
43821
|
platform?: 'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'pinterest' | 'google' | 'twitter' | 'openai' | 'reddit';
|
|
43822
|
+
/**
|
|
43823
|
+
* Filter by the ad set's stored `status`, the value each row returns. A live read does not change it. Rows whose `status` is null match no filter.
|
|
43824
|
+
*/
|
|
43825
|
+
status?: AdStatus;
|
|
43820
43826
|
};
|
|
43821
43827
|
};
|
|
43822
43828
|
type ListAdSetsResponse = ({
|
|
@@ -43824,6 +43830,9 @@ type ListAdSetsResponse = ({
|
|
|
43824
43830
|
platformAdSetId?: string;
|
|
43825
43831
|
platform?: string;
|
|
43826
43832
|
adSetName?: (string) | null;
|
|
43833
|
+
/**
|
|
43834
|
+
* Stored ad set status (active, paused, pending_review, rejected, completed, cancelled, error), as last synced. The `status` filter matches it.
|
|
43835
|
+
*/
|
|
43827
43836
|
status?: (string) | null;
|
|
43828
43837
|
/**
|
|
43829
43838
|
* Raw platform ad set status. On TikTok the ad group's own switch `operation_status` (ENABLE / DISABLE), independent of its campaign. On Meta and Reddit the ad set's `effective_status` (e.g. CAMPAIGN_PAUSED).
|
|
@@ -43954,6 +43963,7 @@ type ListAdSetsResponse = ({
|
|
|
43954
43963
|
*/
|
|
43955
43964
|
configReadAt?: (string) | null;
|
|
43956
43965
|
}>;
|
|
43966
|
+
pagination?: Pagination;
|
|
43957
43967
|
});
|
|
43958
43968
|
type ListAdSetsError = (ErrorResponse | unknown);
|
|
43959
43969
|
type CreateAdSetData = {
|
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.1304",
|
|
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.1304",
|
|
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
|
@@ -10690,8 +10690,10 @@ export const updateCampaignTargeting = <ThrowOnError extends boolean = false>(op
|
|
|
10690
10690
|
* directly, independent of the `ads` rollup GET /v1/ads/tree uses, so a
|
|
10691
10691
|
* newly created standalone ad group with no ad yet (POST /v1/ads/ad-sets,
|
|
10692
10692
|
* Google only) is visible here even though it is invisible in the tree
|
|
10693
|
-
* until an ad joins it via `adSetId` on POST /v1/ads/create.
|
|
10694
|
-
*
|
|
10693
|
+
* until an ad joins it via `adSetId` on POST /v1/ads/create. Rows come newest first
|
|
10694
|
+
* (by platform creation time, then id, so pages never overlap), 500 per page unless `limit`
|
|
10695
|
+
* says otherwise; `pagination.total` counts every matching ad set and `page` reaches the
|
|
10696
|
+
* rest.
|
|
10695
10697
|
*
|
|
10696
10698
|
* **This list is SYNCED, not live** (refreshed by background sync, see below). Each row also
|
|
10697
10699
|
* carries the ad set's config (`targeting`, `bidStrategy`, `bidAmount`, `optimizationGoal`,
|
|
@@ -10710,8 +10712,8 @@ export const updateCampaignTargeting = <ThrowOnError extends boolean = false>(op
|
|
|
10710
10712
|
* which reads the switches from the platform now, stores them, and returns `statusReadAt`
|
|
10711
10713
|
* (null when the read failed and the stored values were returned).
|
|
10712
10714
|
* With `live=true` (which needs a `campaignId` or `adSetId` filter) each listed ad set's own
|
|
10713
|
-
* switch (`platformAdSetStatus`) is read live, for the first 20 rows; later rows keep their
|
|
10714
|
-
* synced value with `statusReadAt: null`. Live reads cover TikTok, Meta, Google, OpenAI and Reddit.
|
|
10715
|
+
* switch (`platformAdSetStatus`) is read live, for the first 20 rows of the page; later rows keep their
|
|
10716
|
+
* synced value with `statusReadAt: null`. To read more ad sets live, page with `limit=20`. Live reads cover TikTok, Meta, Google, OpenAI and Reddit.
|
|
10715
10717
|
* The rolled-up `status` is not re-derived by a live read. On TikTok the same live read also
|
|
10716
10718
|
* returns the ad group's applied `optimizationGoal` and `billingEvent`, as TikTok's adgroup/get
|
|
10717
10719
|
* reports them, so you can verify the goal TikTok applied rather than the one you requested.
|
|
@@ -44336,11 +44336,17 @@ export type ListAdSetsData = {
|
|
|
44336
44336
|
* Platform campaign ID
|
|
44337
44337
|
*/
|
|
44338
44338
|
campaignId?: string;
|
|
44339
|
+
limit?: number;
|
|
44339
44340
|
/**
|
|
44340
44341
|
* Read the on/off switches live from the platform instead of returning the synced values. The fresh values are stored (so later reads return them too) and the response carries `statusReadAt`, the time of the read. At most 20 platform objects are read per request. Where a read fails (credentials, platform error, no reader on that platform), the stored values come back with `statusReadAt: null`. See "Status freshness" in the operation description. On X the budget is read live in the same read: on GET /v1/ads/{adId} `budget`, `adSetBudget`, `campaignBudget` and `budgetLevel` are the line item and campaign budgets X holds now (stored like the switches); on the ad set and campaign listings `budget` is the one that line item or campaign holds now (returned, not stored); a row whose budget the other level holds keeps its synced `budget`.
|
|
44341
44342
|
*/
|
|
44342
44343
|
live?: boolean;
|
|
44344
|
+
page?: number;
|
|
44343
44345
|
platform?: 'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'pinterest' | 'google' | 'twitter' | 'openai' | 'reddit';
|
|
44346
|
+
/**
|
|
44347
|
+
* Filter by the ad set's stored `status`, the value each row returns. A live read does not change it. Rows whose `status` is null match no filter.
|
|
44348
|
+
*/
|
|
44349
|
+
status?: AdStatus;
|
|
44344
44350
|
};
|
|
44345
44351
|
};
|
|
44346
44352
|
|
|
@@ -44349,6 +44355,9 @@ export type ListAdSetsResponse = ({
|
|
|
44349
44355
|
platformAdSetId?: string;
|
|
44350
44356
|
platform?: string;
|
|
44351
44357
|
adSetName?: (string) | null;
|
|
44358
|
+
/**
|
|
44359
|
+
* Stored ad set status (active, paused, pending_review, rejected, completed, cancelled, error), as last synced. The `status` filter matches it.
|
|
44360
|
+
*/
|
|
44352
44361
|
status?: (string) | null;
|
|
44353
44362
|
/**
|
|
44354
44363
|
* Raw platform ad set status. On TikTok the ad group's own switch `operation_status` (ENABLE / DISABLE), independent of its campaign. On Meta and Reddit the ad set's `effective_status` (e.g. CAMPAIGN_PAUSED).
|
|
@@ -44479,6 +44488,7 @@ export type ListAdSetsResponse = ({
|
|
|
44479
44488
|
*/
|
|
44480
44489
|
configReadAt?: (string) | null;
|
|
44481
44490
|
}>;
|
|
44491
|
+
pagination?: Pagination;
|
|
44482
44492
|
});
|
|
44483
44493
|
|
|
44484
44494
|
export type ListAdSetsError = (ErrorResponse | unknown);
|