@zernio/node 0.2.1067 → 0.2.1069
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 -0
- package/dist/index.d.ts +24 -0
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +7 -0
- package/src/generated/types.gen.ts +24 -0
package/dist/index.d.mts
CHANGED
|
@@ -2473,6 +2473,16 @@ type AdCampaign = {
|
|
|
2473
2473
|
* Only on GET /v1/ads/campaigns with `live=true`. When `platformCampaignStatus` was read from the platform; null when this campaign could not be read live.
|
|
2474
2474
|
*/
|
|
2475
2475
|
statusReadAt?: (string) | null;
|
|
2476
|
+
/**
|
|
2477
|
+
* TikTok only, only on GET /v1/ads/campaigns with `live=true` and only on campaigns read live. TikTok's campaign/get record verbatim: operation_status, objective_type, budget_mode (BUDGET_MODE_INFINITE means no campaign budget, so budget lives on the ad groups), budget, and budget_optimize_on when TikTok returns it. Plus advertiser_currency and advertiser_timezone from TikTok's advertiser/info.
|
|
2478
|
+
*/
|
|
2479
|
+
nativeSettings?: {
|
|
2480
|
+
[key: string]: unknown;
|
|
2481
|
+
};
|
|
2482
|
+
/**
|
|
2483
|
+
* Only on GET /v1/ads/campaigns with `live=true`. When `nativeSettings` was read from the platform. Null whenever native settings were not read now.
|
|
2484
|
+
*/
|
|
2485
|
+
configReadAt?: (string) | null;
|
|
2476
2486
|
/**
|
|
2477
2487
|
* Platform-reported campaign issues (Meta `issues_info[]`).
|
|
2478
2488
|
*/
|
|
@@ -39469,6 +39479,16 @@ type ListAdSetsResponse = ({
|
|
|
39469
39479
|
* TikTok only, only with `live=true` and only on rows read live. The ad group's `billing_event` exactly as TikTok's adgroup/get returns it now (for example CPV, CPC, OCPM).
|
|
39470
39480
|
*/
|
|
39471
39481
|
billingEvent?: (string) | null;
|
|
39482
|
+
/**
|
|
39483
|
+
* TikTok only, only with `live=true` and only on rows read live. TikTok's adgroup/get record verbatim (snake_case, TikTok's own names and enums): operation_status, optimization_goal, optimization_event, billing_event, bid_type, bid_price, budget, budget_mode, pacing, schedule_type, schedule_start_time, schedule_end_time, dayparting, placement_type, placements, location_ids, age_groups, gender, languages, interest_category_ids, interest_keyword_ids, actions, audience_ids, excluded_audience_ids, operating_systems, frequency, frequency_schedule, smart_audience_enabled, smart_interest_behavior_enabled. schedule_start_time and schedule_end_time are UTC wall clocks (YYYY-MM-DD HH:MM:SS). location_ids holds TikTok's native location ids (GeoNames ids for countries); GET /v1/ads/targeting/search?dimension=geo returns them as `platformId` on country results. Plus advertiser_currency and advertiser_timezone from TikTok's advertiser/info. A field TikTok does not return is absent.
|
|
39484
|
+
*/
|
|
39485
|
+
nativeSettings?: {
|
|
39486
|
+
[key: string]: unknown;
|
|
39487
|
+
};
|
|
39488
|
+
/**
|
|
39489
|
+
* Only with `live=true`. When `nativeSettings` was read from the platform. Null on every row whose native settings were not read now (row past the cap, failed read, or a platform without a native read).
|
|
39490
|
+
*/
|
|
39491
|
+
configReadAt?: (string) | null;
|
|
39472
39492
|
}>;
|
|
39473
39493
|
});
|
|
39474
39494
|
type ListAdSetsError = (ErrorResponse | unknown);
|
|
@@ -46193,6 +46213,10 @@ type SearchAdTargetingResponse = ({
|
|
|
46193
46213
|
* ISO-3166 alpha-2 of the country a sub-country geo result (city, region, zip, metro) belongs to, when the platform reports it (Meta does). Useful to know whether a location falls under the EU DSA disclosure rules before creating the ad.
|
|
46194
46214
|
*/
|
|
46195
46215
|
countryCode?: string;
|
|
46216
|
+
/**
|
|
46217
|
+
* Only on `country` results: the platform's own id for the country, which `id` replaced with the ISO code (TikTok's native location_id, a GeoNames id such as 2635167 for GB; Meta's country key; Google's geo target constant id; X's targeting value; LinkedIn's geo URN). Use it to match a country against what the platform reports back, e.g. `location_ids` in a TikTok `nativeSettings` read.
|
|
46218
|
+
*/
|
|
46219
|
+
platformId?: string;
|
|
46196
46220
|
}>;
|
|
46197
46221
|
});
|
|
46198
46222
|
type SearchAdTargetingError = (unknown | ErrorResponse);
|
package/dist/index.d.ts
CHANGED
|
@@ -2473,6 +2473,16 @@ type AdCampaign = {
|
|
|
2473
2473
|
* Only on GET /v1/ads/campaigns with `live=true`. When `platformCampaignStatus` was read from the platform; null when this campaign could not be read live.
|
|
2474
2474
|
*/
|
|
2475
2475
|
statusReadAt?: (string) | null;
|
|
2476
|
+
/**
|
|
2477
|
+
* TikTok only, only on GET /v1/ads/campaigns with `live=true` and only on campaigns read live. TikTok's campaign/get record verbatim: operation_status, objective_type, budget_mode (BUDGET_MODE_INFINITE means no campaign budget, so budget lives on the ad groups), budget, and budget_optimize_on when TikTok returns it. Plus advertiser_currency and advertiser_timezone from TikTok's advertiser/info.
|
|
2478
|
+
*/
|
|
2479
|
+
nativeSettings?: {
|
|
2480
|
+
[key: string]: unknown;
|
|
2481
|
+
};
|
|
2482
|
+
/**
|
|
2483
|
+
* Only on GET /v1/ads/campaigns with `live=true`. When `nativeSettings` was read from the platform. Null whenever native settings were not read now.
|
|
2484
|
+
*/
|
|
2485
|
+
configReadAt?: (string) | null;
|
|
2476
2486
|
/**
|
|
2477
2487
|
* Platform-reported campaign issues (Meta `issues_info[]`).
|
|
2478
2488
|
*/
|
|
@@ -39469,6 +39479,16 @@ type ListAdSetsResponse = ({
|
|
|
39469
39479
|
* TikTok only, only with `live=true` and only on rows read live. The ad group's `billing_event` exactly as TikTok's adgroup/get returns it now (for example CPV, CPC, OCPM).
|
|
39470
39480
|
*/
|
|
39471
39481
|
billingEvent?: (string) | null;
|
|
39482
|
+
/**
|
|
39483
|
+
* TikTok only, only with `live=true` and only on rows read live. TikTok's adgroup/get record verbatim (snake_case, TikTok's own names and enums): operation_status, optimization_goal, optimization_event, billing_event, bid_type, bid_price, budget, budget_mode, pacing, schedule_type, schedule_start_time, schedule_end_time, dayparting, placement_type, placements, location_ids, age_groups, gender, languages, interest_category_ids, interest_keyword_ids, actions, audience_ids, excluded_audience_ids, operating_systems, frequency, frequency_schedule, smart_audience_enabled, smart_interest_behavior_enabled. schedule_start_time and schedule_end_time are UTC wall clocks (YYYY-MM-DD HH:MM:SS). location_ids holds TikTok's native location ids (GeoNames ids for countries); GET /v1/ads/targeting/search?dimension=geo returns them as `platformId` on country results. Plus advertiser_currency and advertiser_timezone from TikTok's advertiser/info. A field TikTok does not return is absent.
|
|
39484
|
+
*/
|
|
39485
|
+
nativeSettings?: {
|
|
39486
|
+
[key: string]: unknown;
|
|
39487
|
+
};
|
|
39488
|
+
/**
|
|
39489
|
+
* Only with `live=true`. When `nativeSettings` was read from the platform. Null on every row whose native settings were not read now (row past the cap, failed read, or a platform without a native read).
|
|
39490
|
+
*/
|
|
39491
|
+
configReadAt?: (string) | null;
|
|
39472
39492
|
}>;
|
|
39473
39493
|
});
|
|
39474
39494
|
type ListAdSetsError = (ErrorResponse | unknown);
|
|
@@ -46193,6 +46213,10 @@ type SearchAdTargetingResponse = ({
|
|
|
46193
46213
|
* ISO-3166 alpha-2 of the country a sub-country geo result (city, region, zip, metro) belongs to, when the platform reports it (Meta does). Useful to know whether a location falls under the EU DSA disclosure rules before creating the ad.
|
|
46194
46214
|
*/
|
|
46195
46215
|
countryCode?: string;
|
|
46216
|
+
/**
|
|
46217
|
+
* Only on `country` results: the platform's own id for the country, which `id` replaced with the ISO code (TikTok's native location_id, a GeoNames id such as 2635167 for GB; Meta's country key; Google's geo target constant id; X's targeting value; LinkedIn's geo URN). Use it to match a country against what the platform reports back, e.g. `location_ids` in a TikTok `nativeSettings` read.
|
|
46218
|
+
*/
|
|
46219
|
+
platformId?: string;
|
|
46196
46220
|
}>;
|
|
46197
46221
|
});
|
|
46198
46222
|
type SearchAdTargetingError = (unknown | ErrorResponse);
|
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.1069",
|
|
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.1069",
|
|
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
|
@@ -9778,6 +9778,13 @@ export const updateCampaignTargeting = <ThrowOnError extends boolean = false>(op
|
|
|
9778
9778
|
* The rolled-up `status` is not re-derived by a live read. On TikTok the same live read also
|
|
9779
9779
|
* returns the ad group's applied `optimizationGoal` and `billingEvent`, as TikTok's adgroup/get
|
|
9780
9780
|
* reports them, so you can verify the goal TikTok applied rather than the one you requested.
|
|
9781
|
+
* It also returns `nativeSettings`: TikTok's own adgroup/get record for the ad group, verbatim and
|
|
9782
|
+
* read in that same call (budget, budget_mode, schedule, placements, locations, ages, gender,
|
|
9783
|
+
* languages, interests, actions, audiences and exclusions), plus the advertiser's currency and
|
|
9784
|
+
* timezone. TikTok's `schedule_start_time` / `schedule_end_time` are UTC wall clocks
|
|
9785
|
+
* ("YYYY-MM-DD HH:MM:SS", no offset); Ads Manager displays them in `advertiser_timezone`. `configReadAt` says when it was read; it
|
|
9786
|
+
* is null on every row whose native settings were not read now, so never treat a null as a match.
|
|
9787
|
+
* These are read, not retained create payloads, and are not stored.
|
|
9781
9788
|
*/
|
|
9782
9789
|
export const listAdSets = <ThrowOnError extends boolean = false>(options?: OptionsLegacyParser<ListAdSetsData, ThrowOnError>) => {
|
|
9783
9790
|
return (options?.client ?? client).get<ListAdSetsResponse, ListAdSetsError, ThrowOnError>({
|
|
@@ -516,6 +516,16 @@ export type AdCampaign = {
|
|
|
516
516
|
* Only on GET /v1/ads/campaigns with `live=true`. When `platformCampaignStatus` was read from the platform; null when this campaign could not be read live.
|
|
517
517
|
*/
|
|
518
518
|
statusReadAt?: (string) | null;
|
|
519
|
+
/**
|
|
520
|
+
* TikTok only, only on GET /v1/ads/campaigns with `live=true` and only on campaigns read live. TikTok's campaign/get record verbatim: operation_status, objective_type, budget_mode (BUDGET_MODE_INFINITE means no campaign budget, so budget lives on the ad groups), budget, and budget_optimize_on when TikTok returns it. Plus advertiser_currency and advertiser_timezone from TikTok's advertiser/info.
|
|
521
|
+
*/
|
|
522
|
+
nativeSettings?: {
|
|
523
|
+
[key: string]: unknown;
|
|
524
|
+
};
|
|
525
|
+
/**
|
|
526
|
+
* Only on GET /v1/ads/campaigns with `live=true`. When `nativeSettings` was read from the platform. Null whenever native settings were not read now.
|
|
527
|
+
*/
|
|
528
|
+
configReadAt?: (string) | null;
|
|
519
529
|
/**
|
|
520
530
|
* Platform-reported campaign issues (Meta `issues_info[]`).
|
|
521
531
|
*/
|
|
@@ -39860,6 +39870,16 @@ export type ListAdSetsResponse = ({
|
|
|
39860
39870
|
* TikTok only, only with `live=true` and only on rows read live. The ad group's `billing_event` exactly as TikTok's adgroup/get returns it now (for example CPV, CPC, OCPM).
|
|
39861
39871
|
*/
|
|
39862
39872
|
billingEvent?: (string) | null;
|
|
39873
|
+
/**
|
|
39874
|
+
* TikTok only, only with `live=true` and only on rows read live. TikTok's adgroup/get record verbatim (snake_case, TikTok's own names and enums): operation_status, optimization_goal, optimization_event, billing_event, bid_type, bid_price, budget, budget_mode, pacing, schedule_type, schedule_start_time, schedule_end_time, dayparting, placement_type, placements, location_ids, age_groups, gender, languages, interest_category_ids, interest_keyword_ids, actions, audience_ids, excluded_audience_ids, operating_systems, frequency, frequency_schedule, smart_audience_enabled, smart_interest_behavior_enabled. schedule_start_time and schedule_end_time are UTC wall clocks (YYYY-MM-DD HH:MM:SS). location_ids holds TikTok's native location ids (GeoNames ids for countries); GET /v1/ads/targeting/search?dimension=geo returns them as `platformId` on country results. Plus advertiser_currency and advertiser_timezone from TikTok's advertiser/info. A field TikTok does not return is absent.
|
|
39875
|
+
*/
|
|
39876
|
+
nativeSettings?: {
|
|
39877
|
+
[key: string]: unknown;
|
|
39878
|
+
};
|
|
39879
|
+
/**
|
|
39880
|
+
* Only with `live=true`. When `nativeSettings` was read from the platform. Null on every row whose native settings were not read now (row past the cap, failed read, or a platform without a native read).
|
|
39881
|
+
*/
|
|
39882
|
+
configReadAt?: (string) | null;
|
|
39863
39883
|
}>;
|
|
39864
39884
|
});
|
|
39865
39885
|
|
|
@@ -46974,6 +46994,10 @@ export type SearchAdTargetingResponse = ({
|
|
|
46974
46994
|
* ISO-3166 alpha-2 of the country a sub-country geo result (city, region, zip, metro) belongs to, when the platform reports it (Meta does). Useful to know whether a location falls under the EU DSA disclosure rules before creating the ad.
|
|
46975
46995
|
*/
|
|
46976
46996
|
countryCode?: string;
|
|
46997
|
+
/**
|
|
46998
|
+
* Only on `country` results: the platform's own id for the country, which `id` replaced with the ISO code (TikTok's native location_id, a GeoNames id such as 2635167 for GB; Meta's country key; Google's geo target constant id; X's targeting value; LinkedIn's geo URN). Use it to match a country against what the platform reports back, e.g. `location_ids` in a TikTok `nativeSettings` read.
|
|
46999
|
+
*/
|
|
47000
|
+
platformId?: string;
|
|
46977
47001
|
}>;
|
|
46978
47002
|
});
|
|
46979
47003
|
|