@getlatedev/node 0.2.1113 → 0.2.1114
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 +32 -23
- package/dist/index.d.ts +32 -23
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +25 -10
- package/src/generated/types.gen.ts +32 -23
package/dist/index.d.mts
CHANGED
|
@@ -44810,15 +44810,15 @@ type GetAdAccountFinanceError = (unknown | ErrorResponse);
|
|
|
44810
44810
|
type GetAdAccountLiveEntitiesData = {
|
|
44811
44811
|
query: {
|
|
44812
44812
|
/**
|
|
44813
|
-
* Zernio SocialAccount id (posting or ads variant) used to resolve the
|
|
44813
|
+
* Zernio SocialAccount id (posting or ads variant) used to resolve the platform token.
|
|
44814
44814
|
*/
|
|
44815
44815
|
accountId: string;
|
|
44816
44816
|
/**
|
|
44817
|
-
* Meta ad account id (act_<n>).
|
|
44817
|
+
* Meta ad account id (act_<n>) or TikTok advertiser id (digits).
|
|
44818
44818
|
*/
|
|
44819
44819
|
adAccountId: string;
|
|
44820
44820
|
/**
|
|
44821
|
-
* Cursor from `paging.campaigns.after` or `paging.adSets.after` of a previous response. Requires `level
|
|
44821
|
+
* Cursor from `paging.campaigns.after` or `paging.adSets.after` of a previous response. Requires `level` (and on TikTok the same `limit`).
|
|
44822
44822
|
*/
|
|
44823
44823
|
after?: string;
|
|
44824
44824
|
/**
|
|
@@ -44833,6 +44833,7 @@ type GetAdAccountLiveEntitiesData = {
|
|
|
44833
44833
|
* Comma-separated Meta `effective_status` values to keep: ACTIVE, PAUSED, IN_PROCESS,
|
|
44834
44834
|
* WITH_ISSUES, DELETED, ARCHIVED, and CAMPAIGN_PAUSED (ad sets only; the campaigns level
|
|
44835
44835
|
* ignores it). Defaults to every status except DELETED and ARCHIVED. An unknown value is a 400.
|
|
44836
|
+
* TikTok takes a single value: ACTIVE, PAUSED or DELETED (see the description).
|
|
44836
44837
|
*/
|
|
44837
44838
|
status?: string;
|
|
44838
44839
|
};
|
|
@@ -44840,13 +44841,13 @@ type GetAdAccountLiveEntitiesData = {
|
|
|
44840
44841
|
type GetAdAccountLiveEntitiesResponse = ({
|
|
44841
44842
|
accountId?: string;
|
|
44842
44843
|
adAccountId?: string;
|
|
44843
|
-
platform?: 'facebook';
|
|
44844
|
+
platform?: 'facebook' | 'tiktok';
|
|
44844
44845
|
/**
|
|
44845
44846
|
* ISO 4217 code every budget and bid amount is expressed in.
|
|
44846
44847
|
*/
|
|
44847
44848
|
currency?: string;
|
|
44848
44849
|
/**
|
|
44849
|
-
* When
|
|
44850
|
+
* When the platform was read.
|
|
44850
44851
|
*/
|
|
44851
44852
|
readAt?: string;
|
|
44852
44853
|
/**
|
|
@@ -44856,11 +44857,11 @@ type GetAdAccountLiveEntitiesResponse = ({
|
|
|
44856
44857
|
platformCampaignId?: string;
|
|
44857
44858
|
campaignName?: (string) | null;
|
|
44858
44859
|
/**
|
|
44859
|
-
* Meta `effective_status
|
|
44860
|
+
* Meta `effective_status` (ACTIVE, PAUSED, WITH_ISSUES...) or TikTok `secondary_status` (CAMPAIGN_STATUS_ENABLE...).
|
|
44860
44861
|
*/
|
|
44861
44862
|
platformCampaignStatus?: (string) | null;
|
|
44862
44863
|
/**
|
|
44863
|
-
*
|
|
44864
|
+
* The campaign's own switch: Meta `status` (ACTIVE, PAUSED, DELETED, ARCHIVED), or TikTok `operation_status` as ACTIVE (ENABLE) / PAUSED (DISABLE).
|
|
44864
44865
|
*/
|
|
44865
44866
|
configuredStatus?: (string) | null;
|
|
44866
44867
|
/**
|
|
@@ -44875,23 +44876,27 @@ type GetAdAccountLiveEntitiesResponse = ({
|
|
|
44875
44876
|
type?: 'daily' | 'lifetime';
|
|
44876
44877
|
} | null;
|
|
44877
44878
|
/**
|
|
44878
|
-
*
|
|
44879
|
+
* Daily budget in whole units of `currency` (Meta `daily_budget`; TikTok `budget` under a daily budget mode).
|
|
44879
44880
|
*/
|
|
44880
44881
|
dailyBudget?: (number) | null;
|
|
44881
44882
|
/**
|
|
44882
|
-
*
|
|
44883
|
+
* Lifetime budget in whole units of `currency` (Meta `lifetime_budget`; TikTok `budget` under BUDGET_MODE_TOTAL).
|
|
44883
44884
|
*/
|
|
44884
44885
|
lifetimeBudget?: (number) | null;
|
|
44885
44886
|
/**
|
|
44886
|
-
*
|
|
44887
|
+
* TikTok only: `budget_mode` as TikTok reports it (BUDGET_MODE_DAY, BUDGET_MODE_DYNAMIC_DAILY_BUDGET, BUDGET_MODE_TOTAL, BUDGET_MODE_INFINITE).
|
|
44888
|
+
*/
|
|
44889
|
+
budgetMode?: (string) | null;
|
|
44890
|
+
/**
|
|
44891
|
+
* Meta `budget_remaining` in whole units of `currency`. Null when the campaign has no budget of its own, and always on TikTok.
|
|
44887
44892
|
*/
|
|
44888
44893
|
budgetRemaining?: (number) | null;
|
|
44889
44894
|
/**
|
|
44890
|
-
* Campaign spending limit (Meta `spend_cap`) in whole units of `currency`. Null when none is set.
|
|
44895
|
+
* Campaign spending limit (Meta `spend_cap`) in whole units of `currency`. Null when none is set, and always on TikTok.
|
|
44891
44896
|
*/
|
|
44892
44897
|
spendCap?: (number) | null;
|
|
44893
44898
|
/**
|
|
44894
|
-
* Meta `bid_strategy`, set on campaigns with a campaign budget.
|
|
44899
|
+
* Meta `bid_strategy`, set on campaigns with a campaign budget. Null on TikTok.
|
|
44895
44900
|
*/
|
|
44896
44901
|
bidStrategy?: (string) | null;
|
|
44897
44902
|
}>;
|
|
@@ -44903,11 +44908,11 @@ type GetAdAccountLiveEntitiesResponse = ({
|
|
|
44903
44908
|
adSetName?: (string) | null;
|
|
44904
44909
|
platformCampaignId?: (string) | null;
|
|
44905
44910
|
/**
|
|
44906
|
-
* Meta `effective_status
|
|
44911
|
+
* Meta `effective_status` (ACTIVE, PAUSED, CAMPAIGN_PAUSED...) or TikTok `secondary_status` (ADGROUP_STATUS_DELIVERY_OK, ADGROUP_STATUS_AUDIT...).
|
|
44907
44912
|
*/
|
|
44908
44913
|
platformAdSetStatus?: (string) | null;
|
|
44909
44914
|
/**
|
|
44910
|
-
*
|
|
44915
|
+
* The ad set's own switch: Meta `status`, or TikTok `operation_status` as ACTIVE / PAUSED.
|
|
44911
44916
|
*/
|
|
44912
44917
|
configuredStatus?: (string) | null;
|
|
44913
44918
|
/**
|
|
@@ -44922,41 +44927,45 @@ type GetAdAccountLiveEntitiesResponse = ({
|
|
|
44922
44927
|
type?: 'daily' | 'lifetime';
|
|
44923
44928
|
} | null;
|
|
44924
44929
|
/**
|
|
44925
|
-
*
|
|
44930
|
+
* Daily budget in whole units of `currency`.
|
|
44926
44931
|
*/
|
|
44927
44932
|
dailyBudget?: (number) | null;
|
|
44928
44933
|
/**
|
|
44929
|
-
*
|
|
44934
|
+
* Lifetime budget in whole units of `currency`.
|
|
44930
44935
|
*/
|
|
44931
44936
|
lifetimeBudget?: (number) | null;
|
|
44932
44937
|
/**
|
|
44933
|
-
*
|
|
44938
|
+
* TikTok only: `budget_mode` as TikTok reports it.
|
|
44939
|
+
*/
|
|
44940
|
+
budgetMode?: (string) | null;
|
|
44941
|
+
/**
|
|
44942
|
+
* Meta `budget_remaining` in whole units of `currency`. Null when the ad set has no budget of its own, and always on TikTok.
|
|
44934
44943
|
*/
|
|
44935
44944
|
budgetRemaining?: (number) | null;
|
|
44936
44945
|
/**
|
|
44937
|
-
* Meta `bid_strategy`.
|
|
44946
|
+
* Meta `bid_strategy`. On TikTok the ad group's `bid_type` normalized to the same vocabulary (LOWEST_COST_WITHOUT_CAP, LOWEST_COST_WITH_BID_CAP, LOWEST_COST_WITH_MIN_ROAS).
|
|
44938
44947
|
*/
|
|
44939
44948
|
bidStrategy?: (string) | null;
|
|
44940
44949
|
/**
|
|
44941
|
-
*
|
|
44950
|
+
* Bid cap or cost target in whole units of `currency` (Meta `bid_amount`; TikTok `bid_price`, else `conversion_bid_price`, else `deep_cpa_bid`). Null when the strategy has none.
|
|
44942
44951
|
*/
|
|
44943
44952
|
bidAmount?: (number) | null;
|
|
44944
44953
|
/**
|
|
44945
|
-
* Meta `optimization_goal`.
|
|
44954
|
+
* Meta or TikTok `optimization_goal`.
|
|
44946
44955
|
*/
|
|
44947
44956
|
optimizationGoal?: (string) | null;
|
|
44948
44957
|
/**
|
|
44949
|
-
* Meta `billing_event`.
|
|
44958
|
+
* Meta or TikTok `billing_event`.
|
|
44950
44959
|
*/
|
|
44951
44960
|
billingEvent?: (string) | null;
|
|
44952
44961
|
/**
|
|
44953
|
-
* Meta `promoted_object` verbatim (snake_case).
|
|
44962
|
+
* Meta `promoted_object` verbatim (snake_case). On TikTok `{ pixelId, customEventType, applicationId, customConversionId }` from `pixel_id`, `optimization_event`, `app_id` and `custom_conversion_id`, only the keys TikTok has set; null when none is.
|
|
44954
44963
|
*/
|
|
44955
44964
|
promotedObject?: {
|
|
44956
44965
|
[key: string]: unknown;
|
|
44957
44966
|
} | null;
|
|
44958
44967
|
/**
|
|
44959
|
-
*
|
|
44968
|
+
* The platform's targeting verbatim (snake_case), as it reports it now: Meta `targeting`, or TikTok's ad group targeting fields (location_ids, age_groups, gender, languages, interest_category_ids, audience_ids, placements...).
|
|
44960
44969
|
*/
|
|
44961
44970
|
targeting?: {
|
|
44962
44971
|
[key: string]: unknown;
|
package/dist/index.d.ts
CHANGED
|
@@ -44810,15 +44810,15 @@ type GetAdAccountFinanceError = (unknown | ErrorResponse);
|
|
|
44810
44810
|
type GetAdAccountLiveEntitiesData = {
|
|
44811
44811
|
query: {
|
|
44812
44812
|
/**
|
|
44813
|
-
* Zernio SocialAccount id (posting or ads variant) used to resolve the
|
|
44813
|
+
* Zernio SocialAccount id (posting or ads variant) used to resolve the platform token.
|
|
44814
44814
|
*/
|
|
44815
44815
|
accountId: string;
|
|
44816
44816
|
/**
|
|
44817
|
-
* Meta ad account id (act_<n>).
|
|
44817
|
+
* Meta ad account id (act_<n>) or TikTok advertiser id (digits).
|
|
44818
44818
|
*/
|
|
44819
44819
|
adAccountId: string;
|
|
44820
44820
|
/**
|
|
44821
|
-
* Cursor from `paging.campaigns.after` or `paging.adSets.after` of a previous response. Requires `level
|
|
44821
|
+
* Cursor from `paging.campaigns.after` or `paging.adSets.after` of a previous response. Requires `level` (and on TikTok the same `limit`).
|
|
44822
44822
|
*/
|
|
44823
44823
|
after?: string;
|
|
44824
44824
|
/**
|
|
@@ -44833,6 +44833,7 @@ type GetAdAccountLiveEntitiesData = {
|
|
|
44833
44833
|
* Comma-separated Meta `effective_status` values to keep: ACTIVE, PAUSED, IN_PROCESS,
|
|
44834
44834
|
* WITH_ISSUES, DELETED, ARCHIVED, and CAMPAIGN_PAUSED (ad sets only; the campaigns level
|
|
44835
44835
|
* ignores it). Defaults to every status except DELETED and ARCHIVED. An unknown value is a 400.
|
|
44836
|
+
* TikTok takes a single value: ACTIVE, PAUSED or DELETED (see the description).
|
|
44836
44837
|
*/
|
|
44837
44838
|
status?: string;
|
|
44838
44839
|
};
|
|
@@ -44840,13 +44841,13 @@ type GetAdAccountLiveEntitiesData = {
|
|
|
44840
44841
|
type GetAdAccountLiveEntitiesResponse = ({
|
|
44841
44842
|
accountId?: string;
|
|
44842
44843
|
adAccountId?: string;
|
|
44843
|
-
platform?: 'facebook';
|
|
44844
|
+
platform?: 'facebook' | 'tiktok';
|
|
44844
44845
|
/**
|
|
44845
44846
|
* ISO 4217 code every budget and bid amount is expressed in.
|
|
44846
44847
|
*/
|
|
44847
44848
|
currency?: string;
|
|
44848
44849
|
/**
|
|
44849
|
-
* When
|
|
44850
|
+
* When the platform was read.
|
|
44850
44851
|
*/
|
|
44851
44852
|
readAt?: string;
|
|
44852
44853
|
/**
|
|
@@ -44856,11 +44857,11 @@ type GetAdAccountLiveEntitiesResponse = ({
|
|
|
44856
44857
|
platformCampaignId?: string;
|
|
44857
44858
|
campaignName?: (string) | null;
|
|
44858
44859
|
/**
|
|
44859
|
-
* Meta `effective_status
|
|
44860
|
+
* Meta `effective_status` (ACTIVE, PAUSED, WITH_ISSUES...) or TikTok `secondary_status` (CAMPAIGN_STATUS_ENABLE...).
|
|
44860
44861
|
*/
|
|
44861
44862
|
platformCampaignStatus?: (string) | null;
|
|
44862
44863
|
/**
|
|
44863
|
-
*
|
|
44864
|
+
* The campaign's own switch: Meta `status` (ACTIVE, PAUSED, DELETED, ARCHIVED), or TikTok `operation_status` as ACTIVE (ENABLE) / PAUSED (DISABLE).
|
|
44864
44865
|
*/
|
|
44865
44866
|
configuredStatus?: (string) | null;
|
|
44866
44867
|
/**
|
|
@@ -44875,23 +44876,27 @@ type GetAdAccountLiveEntitiesResponse = ({
|
|
|
44875
44876
|
type?: 'daily' | 'lifetime';
|
|
44876
44877
|
} | null;
|
|
44877
44878
|
/**
|
|
44878
|
-
*
|
|
44879
|
+
* Daily budget in whole units of `currency` (Meta `daily_budget`; TikTok `budget` under a daily budget mode).
|
|
44879
44880
|
*/
|
|
44880
44881
|
dailyBudget?: (number) | null;
|
|
44881
44882
|
/**
|
|
44882
|
-
*
|
|
44883
|
+
* Lifetime budget in whole units of `currency` (Meta `lifetime_budget`; TikTok `budget` under BUDGET_MODE_TOTAL).
|
|
44883
44884
|
*/
|
|
44884
44885
|
lifetimeBudget?: (number) | null;
|
|
44885
44886
|
/**
|
|
44886
|
-
*
|
|
44887
|
+
* TikTok only: `budget_mode` as TikTok reports it (BUDGET_MODE_DAY, BUDGET_MODE_DYNAMIC_DAILY_BUDGET, BUDGET_MODE_TOTAL, BUDGET_MODE_INFINITE).
|
|
44888
|
+
*/
|
|
44889
|
+
budgetMode?: (string) | null;
|
|
44890
|
+
/**
|
|
44891
|
+
* Meta `budget_remaining` in whole units of `currency`. Null when the campaign has no budget of its own, and always on TikTok.
|
|
44887
44892
|
*/
|
|
44888
44893
|
budgetRemaining?: (number) | null;
|
|
44889
44894
|
/**
|
|
44890
|
-
* Campaign spending limit (Meta `spend_cap`) in whole units of `currency`. Null when none is set.
|
|
44895
|
+
* Campaign spending limit (Meta `spend_cap`) in whole units of `currency`. Null when none is set, and always on TikTok.
|
|
44891
44896
|
*/
|
|
44892
44897
|
spendCap?: (number) | null;
|
|
44893
44898
|
/**
|
|
44894
|
-
* Meta `bid_strategy`, set on campaigns with a campaign budget.
|
|
44899
|
+
* Meta `bid_strategy`, set on campaigns with a campaign budget. Null on TikTok.
|
|
44895
44900
|
*/
|
|
44896
44901
|
bidStrategy?: (string) | null;
|
|
44897
44902
|
}>;
|
|
@@ -44903,11 +44908,11 @@ type GetAdAccountLiveEntitiesResponse = ({
|
|
|
44903
44908
|
adSetName?: (string) | null;
|
|
44904
44909
|
platformCampaignId?: (string) | null;
|
|
44905
44910
|
/**
|
|
44906
|
-
* Meta `effective_status
|
|
44911
|
+
* Meta `effective_status` (ACTIVE, PAUSED, CAMPAIGN_PAUSED...) or TikTok `secondary_status` (ADGROUP_STATUS_DELIVERY_OK, ADGROUP_STATUS_AUDIT...).
|
|
44907
44912
|
*/
|
|
44908
44913
|
platformAdSetStatus?: (string) | null;
|
|
44909
44914
|
/**
|
|
44910
|
-
*
|
|
44915
|
+
* The ad set's own switch: Meta `status`, or TikTok `operation_status` as ACTIVE / PAUSED.
|
|
44911
44916
|
*/
|
|
44912
44917
|
configuredStatus?: (string) | null;
|
|
44913
44918
|
/**
|
|
@@ -44922,41 +44927,45 @@ type GetAdAccountLiveEntitiesResponse = ({
|
|
|
44922
44927
|
type?: 'daily' | 'lifetime';
|
|
44923
44928
|
} | null;
|
|
44924
44929
|
/**
|
|
44925
|
-
*
|
|
44930
|
+
* Daily budget in whole units of `currency`.
|
|
44926
44931
|
*/
|
|
44927
44932
|
dailyBudget?: (number) | null;
|
|
44928
44933
|
/**
|
|
44929
|
-
*
|
|
44934
|
+
* Lifetime budget in whole units of `currency`.
|
|
44930
44935
|
*/
|
|
44931
44936
|
lifetimeBudget?: (number) | null;
|
|
44932
44937
|
/**
|
|
44933
|
-
*
|
|
44938
|
+
* TikTok only: `budget_mode` as TikTok reports it.
|
|
44939
|
+
*/
|
|
44940
|
+
budgetMode?: (string) | null;
|
|
44941
|
+
/**
|
|
44942
|
+
* Meta `budget_remaining` in whole units of `currency`. Null when the ad set has no budget of its own, and always on TikTok.
|
|
44934
44943
|
*/
|
|
44935
44944
|
budgetRemaining?: (number) | null;
|
|
44936
44945
|
/**
|
|
44937
|
-
* Meta `bid_strategy`.
|
|
44946
|
+
* Meta `bid_strategy`. On TikTok the ad group's `bid_type` normalized to the same vocabulary (LOWEST_COST_WITHOUT_CAP, LOWEST_COST_WITH_BID_CAP, LOWEST_COST_WITH_MIN_ROAS).
|
|
44938
44947
|
*/
|
|
44939
44948
|
bidStrategy?: (string) | null;
|
|
44940
44949
|
/**
|
|
44941
|
-
*
|
|
44950
|
+
* Bid cap or cost target in whole units of `currency` (Meta `bid_amount`; TikTok `bid_price`, else `conversion_bid_price`, else `deep_cpa_bid`). Null when the strategy has none.
|
|
44942
44951
|
*/
|
|
44943
44952
|
bidAmount?: (number) | null;
|
|
44944
44953
|
/**
|
|
44945
|
-
* Meta `optimization_goal`.
|
|
44954
|
+
* Meta or TikTok `optimization_goal`.
|
|
44946
44955
|
*/
|
|
44947
44956
|
optimizationGoal?: (string) | null;
|
|
44948
44957
|
/**
|
|
44949
|
-
* Meta `billing_event`.
|
|
44958
|
+
* Meta or TikTok `billing_event`.
|
|
44950
44959
|
*/
|
|
44951
44960
|
billingEvent?: (string) | null;
|
|
44952
44961
|
/**
|
|
44953
|
-
* Meta `promoted_object` verbatim (snake_case).
|
|
44962
|
+
* Meta `promoted_object` verbatim (snake_case). On TikTok `{ pixelId, customEventType, applicationId, customConversionId }` from `pixel_id`, `optimization_event`, `app_id` and `custom_conversion_id`, only the keys TikTok has set; null when none is.
|
|
44954
44963
|
*/
|
|
44955
44964
|
promotedObject?: {
|
|
44956
44965
|
[key: string]: unknown;
|
|
44957
44966
|
} | null;
|
|
44958
44967
|
/**
|
|
44959
|
-
*
|
|
44968
|
+
* The platform's targeting verbatim (snake_case), as it reports it now: Meta `targeting`, or TikTok's ad group targeting fields (location_ids, age_groups, gender, languages, interest_category_ids, audience_ids, placements...).
|
|
44960
44969
|
*/
|
|
44961
44970
|
targeting?: {
|
|
44962
44971
|
[key: string]: unknown;
|
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.1114",
|
|
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.1114",
|
|
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
|
@@ -11811,25 +11811,40 @@ export const getAdAccountFinance = <ThrowOnError extends boolean = false>(option
|
|
|
11811
11811
|
|
|
11812
11812
|
/**
|
|
11813
11813
|
* Read an ad account's campaigns and ad sets live
|
|
11814
|
-
* Reads the campaigns and ad sets of one Meta ad account **live from
|
|
11815
|
-
*
|
|
11816
|
-
*
|
|
11817
|
-
*
|
|
11818
|
-
*
|
|
11814
|
+
* Reads the campaigns and ad sets of one Meta ad account or TikTok advertiser **live from
|
|
11815
|
+
* the platform**, so it is cheap enough to run before every write: for example a
|
|
11816
|
+
* per-ad-account spend ceiling that must see the current daily / lifetime budget rather
|
|
11817
|
+
* than the synced copy. On Meta it is a single Graph call per request (the account's
|
|
11818
|
+
* `/campaigns` and `/adsets` edges, filtered by `effective_status`); on TikTok one
|
|
11819
|
+
* `campaign/get` and one `adgroup/get` page (TikTok ad groups are returned as `adSets`).
|
|
11819
11820
|
*
|
|
11820
11821
|
* **Live vs synced.** GET /v1/ads/campaigns and GET /v1/ads/ad-sets serve Zernio's synced
|
|
11821
11822
|
* store, refreshed by background sync (typically 15 to 60 minutes behind Meta), and their
|
|
11822
11823
|
* `live=true` re-reads only the on/off switches of at most 20 objects. This endpoint returns
|
|
11823
11824
|
* what Meta reports at `readAt`, for every matching campaign and ad set, and stores nothing.
|
|
11824
11825
|
*
|
|
11825
|
-
* Budgets and bid amounts are
|
|
11826
|
-
*
|
|
11827
|
-
*
|
|
11828
|
-
* otherwise each ad set carries its own.
|
|
11826
|
+
* Budgets and bid amounts are in whole units of `currency`, the same units as the synced
|
|
11827
|
+
* rows (Meta's minor units are converted; TikTok already reports whole units). A campaign
|
|
11828
|
+
* with a campaign budget (Meta Advantage+ campaign budget, TikTok campaign budget
|
|
11829
|
+
* optimization) carries `budget`; otherwise each ad set carries its own.
|
|
11829
11830
|
*
|
|
11830
11831
|
* Each level returns at most `limit` rows. When more match, `paging.<level>.after` is a
|
|
11831
11832
|
* cursor: pass it back as `after` together with `level` to read the next page of that
|
|
11832
|
-
* level only.
|
|
11833
|
+
* level only. TikTok pages by number, so a TikTok cursor must be sent with the same
|
|
11834
|
+
* `limit` that produced it (another `limit` is a 400). Other platforms answer 501 rather
|
|
11835
|
+
* than serving synced data.
|
|
11836
|
+
*
|
|
11837
|
+
* **TikTok specifics.** `status` maps to TikTok's `primary_status` filter, which takes one
|
|
11838
|
+
* value: ACTIVE = delivering (`STATUS_DELIVERY_OK`), PAUSED = switched off
|
|
11839
|
+
* (`STATUS_DISABLE`), DELETED = `STATUS_DELETE`; omitted = every status except deleted
|
|
11840
|
+
* (`STATUS_NOT_DELETE`, which includes enabled entities that are not delivering, such as
|
|
11841
|
+
* an ad group in review). Several values, or IN_PROCESS, WITH_ISSUES, CAMPAIGN_PAUSED and
|
|
11842
|
+
* ARCHIVED, are a 400. `budgetRemaining` and `spendCap` are always null (TikTok reports
|
|
11843
|
+
* neither), campaign `bidStrategy` is null (TikTok bids per ad group), ad set `bidStrategy`
|
|
11844
|
+
* is normalized to the Meta vocabulary like GET /v1/ads, `promotedObject` is
|
|
11845
|
+
* `{ pixelId, customEventType, applicationId, customConversionId }` (the keys TikTok has
|
|
11846
|
+
* set, as POST /v1/ads/create takes them), and `targeting` holds TikTok's targeting
|
|
11847
|
+
* fields verbatim.
|
|
11833
11848
|
*/
|
|
11834
11849
|
export const getAdAccountLiveEntities = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetAdAccountLiveEntitiesData, ThrowOnError>) => {
|
|
11835
11850
|
return (options?.client ?? client).get<GetAdAccountLiveEntitiesResponse, GetAdAccountLiveEntitiesError, ThrowOnError>({
|
|
@@ -45567,15 +45567,15 @@ export type GetAdAccountFinanceError = (unknown | ErrorResponse);
|
|
|
45567
45567
|
export type GetAdAccountLiveEntitiesData = {
|
|
45568
45568
|
query: {
|
|
45569
45569
|
/**
|
|
45570
|
-
* Zernio SocialAccount id (posting or ads variant) used to resolve the
|
|
45570
|
+
* Zernio SocialAccount id (posting or ads variant) used to resolve the platform token.
|
|
45571
45571
|
*/
|
|
45572
45572
|
accountId: string;
|
|
45573
45573
|
/**
|
|
45574
|
-
* Meta ad account id (act_<n>).
|
|
45574
|
+
* Meta ad account id (act_<n>) or TikTok advertiser id (digits).
|
|
45575
45575
|
*/
|
|
45576
45576
|
adAccountId: string;
|
|
45577
45577
|
/**
|
|
45578
|
-
* Cursor from `paging.campaigns.after` or `paging.adSets.after` of a previous response. Requires `level
|
|
45578
|
+
* Cursor from `paging.campaigns.after` or `paging.adSets.after` of a previous response. Requires `level` (and on TikTok the same `limit`).
|
|
45579
45579
|
*/
|
|
45580
45580
|
after?: string;
|
|
45581
45581
|
/**
|
|
@@ -45590,6 +45590,7 @@ export type GetAdAccountLiveEntitiesData = {
|
|
|
45590
45590
|
* Comma-separated Meta `effective_status` values to keep: ACTIVE, PAUSED, IN_PROCESS,
|
|
45591
45591
|
* WITH_ISSUES, DELETED, ARCHIVED, and CAMPAIGN_PAUSED (ad sets only; the campaigns level
|
|
45592
45592
|
* ignores it). Defaults to every status except DELETED and ARCHIVED. An unknown value is a 400.
|
|
45593
|
+
* TikTok takes a single value: ACTIVE, PAUSED or DELETED (see the description).
|
|
45593
45594
|
*/
|
|
45594
45595
|
status?: string;
|
|
45595
45596
|
};
|
|
@@ -45598,13 +45599,13 @@ export type GetAdAccountLiveEntitiesData = {
|
|
|
45598
45599
|
export type GetAdAccountLiveEntitiesResponse = ({
|
|
45599
45600
|
accountId?: string;
|
|
45600
45601
|
adAccountId?: string;
|
|
45601
|
-
platform?: 'facebook';
|
|
45602
|
+
platform?: 'facebook' | 'tiktok';
|
|
45602
45603
|
/**
|
|
45603
45604
|
* ISO 4217 code every budget and bid amount is expressed in.
|
|
45604
45605
|
*/
|
|
45605
45606
|
currency?: string;
|
|
45606
45607
|
/**
|
|
45607
|
-
* When
|
|
45608
|
+
* When the platform was read.
|
|
45608
45609
|
*/
|
|
45609
45610
|
readAt?: string;
|
|
45610
45611
|
/**
|
|
@@ -45614,11 +45615,11 @@ export type GetAdAccountLiveEntitiesResponse = ({
|
|
|
45614
45615
|
platformCampaignId?: string;
|
|
45615
45616
|
campaignName?: (string) | null;
|
|
45616
45617
|
/**
|
|
45617
|
-
* Meta `effective_status
|
|
45618
|
+
* Meta `effective_status` (ACTIVE, PAUSED, WITH_ISSUES...) or TikTok `secondary_status` (CAMPAIGN_STATUS_ENABLE...).
|
|
45618
45619
|
*/
|
|
45619
45620
|
platformCampaignStatus?: (string) | null;
|
|
45620
45621
|
/**
|
|
45621
|
-
*
|
|
45622
|
+
* The campaign's own switch: Meta `status` (ACTIVE, PAUSED, DELETED, ARCHIVED), or TikTok `operation_status` as ACTIVE (ENABLE) / PAUSED (DISABLE).
|
|
45622
45623
|
*/
|
|
45623
45624
|
configuredStatus?: (string) | null;
|
|
45624
45625
|
/**
|
|
@@ -45633,23 +45634,27 @@ export type GetAdAccountLiveEntitiesResponse = ({
|
|
|
45633
45634
|
type?: 'daily' | 'lifetime';
|
|
45634
45635
|
} | null;
|
|
45635
45636
|
/**
|
|
45636
|
-
*
|
|
45637
|
+
* Daily budget in whole units of `currency` (Meta `daily_budget`; TikTok `budget` under a daily budget mode).
|
|
45637
45638
|
*/
|
|
45638
45639
|
dailyBudget?: (number) | null;
|
|
45639
45640
|
/**
|
|
45640
|
-
*
|
|
45641
|
+
* Lifetime budget in whole units of `currency` (Meta `lifetime_budget`; TikTok `budget` under BUDGET_MODE_TOTAL).
|
|
45641
45642
|
*/
|
|
45642
45643
|
lifetimeBudget?: (number) | null;
|
|
45643
45644
|
/**
|
|
45644
|
-
*
|
|
45645
|
+
* TikTok only: `budget_mode` as TikTok reports it (BUDGET_MODE_DAY, BUDGET_MODE_DYNAMIC_DAILY_BUDGET, BUDGET_MODE_TOTAL, BUDGET_MODE_INFINITE).
|
|
45646
|
+
*/
|
|
45647
|
+
budgetMode?: (string) | null;
|
|
45648
|
+
/**
|
|
45649
|
+
* Meta `budget_remaining` in whole units of `currency`. Null when the campaign has no budget of its own, and always on TikTok.
|
|
45645
45650
|
*/
|
|
45646
45651
|
budgetRemaining?: (number) | null;
|
|
45647
45652
|
/**
|
|
45648
|
-
* Campaign spending limit (Meta `spend_cap`) in whole units of `currency`. Null when none is set.
|
|
45653
|
+
* Campaign spending limit (Meta `spend_cap`) in whole units of `currency`. Null when none is set, and always on TikTok.
|
|
45649
45654
|
*/
|
|
45650
45655
|
spendCap?: (number) | null;
|
|
45651
45656
|
/**
|
|
45652
|
-
* Meta `bid_strategy`, set on campaigns with a campaign budget.
|
|
45657
|
+
* Meta `bid_strategy`, set on campaigns with a campaign budget. Null on TikTok.
|
|
45653
45658
|
*/
|
|
45654
45659
|
bidStrategy?: (string) | null;
|
|
45655
45660
|
}>;
|
|
@@ -45661,11 +45666,11 @@ export type GetAdAccountLiveEntitiesResponse = ({
|
|
|
45661
45666
|
adSetName?: (string) | null;
|
|
45662
45667
|
platformCampaignId?: (string) | null;
|
|
45663
45668
|
/**
|
|
45664
|
-
* Meta `effective_status
|
|
45669
|
+
* Meta `effective_status` (ACTIVE, PAUSED, CAMPAIGN_PAUSED...) or TikTok `secondary_status` (ADGROUP_STATUS_DELIVERY_OK, ADGROUP_STATUS_AUDIT...).
|
|
45665
45670
|
*/
|
|
45666
45671
|
platformAdSetStatus?: (string) | null;
|
|
45667
45672
|
/**
|
|
45668
|
-
*
|
|
45673
|
+
* The ad set's own switch: Meta `status`, or TikTok `operation_status` as ACTIVE / PAUSED.
|
|
45669
45674
|
*/
|
|
45670
45675
|
configuredStatus?: (string) | null;
|
|
45671
45676
|
/**
|
|
@@ -45680,41 +45685,45 @@ export type GetAdAccountLiveEntitiesResponse = ({
|
|
|
45680
45685
|
type?: 'daily' | 'lifetime';
|
|
45681
45686
|
} | null;
|
|
45682
45687
|
/**
|
|
45683
|
-
*
|
|
45688
|
+
* Daily budget in whole units of `currency`.
|
|
45684
45689
|
*/
|
|
45685
45690
|
dailyBudget?: (number) | null;
|
|
45686
45691
|
/**
|
|
45687
|
-
*
|
|
45692
|
+
* Lifetime budget in whole units of `currency`.
|
|
45688
45693
|
*/
|
|
45689
45694
|
lifetimeBudget?: (number) | null;
|
|
45690
45695
|
/**
|
|
45691
|
-
*
|
|
45696
|
+
* TikTok only: `budget_mode` as TikTok reports it.
|
|
45697
|
+
*/
|
|
45698
|
+
budgetMode?: (string) | null;
|
|
45699
|
+
/**
|
|
45700
|
+
* Meta `budget_remaining` in whole units of `currency`. Null when the ad set has no budget of its own, and always on TikTok.
|
|
45692
45701
|
*/
|
|
45693
45702
|
budgetRemaining?: (number) | null;
|
|
45694
45703
|
/**
|
|
45695
|
-
* Meta `bid_strategy`.
|
|
45704
|
+
* Meta `bid_strategy`. On TikTok the ad group's `bid_type` normalized to the same vocabulary (LOWEST_COST_WITHOUT_CAP, LOWEST_COST_WITH_BID_CAP, LOWEST_COST_WITH_MIN_ROAS).
|
|
45696
45705
|
*/
|
|
45697
45706
|
bidStrategy?: (string) | null;
|
|
45698
45707
|
/**
|
|
45699
|
-
*
|
|
45708
|
+
* Bid cap or cost target in whole units of `currency` (Meta `bid_amount`; TikTok `bid_price`, else `conversion_bid_price`, else `deep_cpa_bid`). Null when the strategy has none.
|
|
45700
45709
|
*/
|
|
45701
45710
|
bidAmount?: (number) | null;
|
|
45702
45711
|
/**
|
|
45703
|
-
* Meta `optimization_goal`.
|
|
45712
|
+
* Meta or TikTok `optimization_goal`.
|
|
45704
45713
|
*/
|
|
45705
45714
|
optimizationGoal?: (string) | null;
|
|
45706
45715
|
/**
|
|
45707
|
-
* Meta `billing_event`.
|
|
45716
|
+
* Meta or TikTok `billing_event`.
|
|
45708
45717
|
*/
|
|
45709
45718
|
billingEvent?: (string) | null;
|
|
45710
45719
|
/**
|
|
45711
|
-
* Meta `promoted_object` verbatim (snake_case).
|
|
45720
|
+
* Meta `promoted_object` verbatim (snake_case). On TikTok `{ pixelId, customEventType, applicationId, customConversionId }` from `pixel_id`, `optimization_event`, `app_id` and `custom_conversion_id`, only the keys TikTok has set; null when none is.
|
|
45712
45721
|
*/
|
|
45713
45722
|
promotedObject?: {
|
|
45714
45723
|
[key: string]: unknown;
|
|
45715
45724
|
} | null;
|
|
45716
45725
|
/**
|
|
45717
|
-
*
|
|
45726
|
+
* The platform's targeting verbatim (snake_case), as it reports it now: Meta `targeting`, or TikTok's ad group targeting fields (location_ids, age_groups, gender, languages, interest_category_ids, audience_ids, placements...).
|
|
45718
45727
|
*/
|
|
45719
45728
|
targeting?: {
|
|
45720
45729
|
[key: string]: unknown;
|