@zernio/node 0.2.961 → 0.2.963
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/README.md +3 -0
- package/dist/index.d.mts +149 -5
- package/dist/index.d.ts +149 -5
- package/dist/index.js +28 -1
- package/dist/index.mjs +28 -1
- package/package.json +1 -1
- package/src/client.ts +12 -0
- package/src/generated/sdk.gen.ts +72 -1
- package/src/generated/types.gen.ts +149 -4
|
@@ -8739,6 +8739,27 @@ export type SocialAccount = {
|
|
|
8739
8739
|
|
|
8740
8740
|
export type platform10 = 'tiktok' | 'instagram' | 'facebook' | 'youtube' | 'linkedin' | 'twitter' | 'threads' | 'pinterest' | 'reddit' | 'bluesky' | 'googlebusiness' | 'telegram' | 'snapchat' | 'discord' | 'slack' | 'whatsapp' | 'shopify' | 'wordpress' | 'linkedinads' | 'metaads' | 'pinterestads' | 'tiktokads' | 'xads' | 'googleads' | 'openaiads' | 'sms' | 'phone' | 'rcs';
|
|
8741
8741
|
|
|
8742
|
+
/**
|
|
8743
|
+
* A tracking tag's install on a connected store (Shopify web pixel).
|
|
8744
|
+
*/
|
|
8745
|
+
export type StorePixelInstall = {
|
|
8746
|
+
storeAccountId?: string;
|
|
8747
|
+
platform?: 'shopify';
|
|
8748
|
+
shopDomain?: string;
|
|
8749
|
+
/**
|
|
8750
|
+
* True when this tag is the pixel the store fires.
|
|
8751
|
+
*/
|
|
8752
|
+
installed?: boolean;
|
|
8753
|
+
/**
|
|
8754
|
+
* The Meta pixel the store fires now (may be a different tag), or null.
|
|
8755
|
+
*/
|
|
8756
|
+
installedTagId?: (string) | null;
|
|
8757
|
+
/**
|
|
8758
|
+
* Shopify web pixel id, or null when nothing is installed.
|
|
8759
|
+
*/
|
|
8760
|
+
webPixelId?: (string) | null;
|
|
8761
|
+
};
|
|
8762
|
+
|
|
8742
8763
|
/**
|
|
8743
8764
|
* Normalized, platform-agnostic ad-targeting spec. Every field is optional, an
|
|
8744
8765
|
* empty object targets the platform's default broadest audience. Field names are
|
|
@@ -39285,7 +39306,7 @@ export type GenerateKeywordHistoricalMetricsError = (unknown | {
|
|
|
39285
39306
|
export type QueryAdInsightsData = {
|
|
39286
39307
|
query: {
|
|
39287
39308
|
/**
|
|
39288
|
-
* Zernio SocialAccount id (posting or ads variant); its platform selects the Meta or
|
|
39309
|
+
* Zernio SocialAccount id (posting or ads variant); its platform selects the Meta, Google or TikTok contract.
|
|
39289
39310
|
*/
|
|
39290
39311
|
accountId: string;
|
|
39291
39312
|
/**
|
|
@@ -39301,7 +39322,7 @@ export type QueryAdInsightsData = {
|
|
|
39301
39322
|
*/
|
|
39302
39323
|
actionReportTime?: string;
|
|
39303
39324
|
/**
|
|
39304
|
-
* Google
|
|
39325
|
+
* Google: platform ad account ID (Google customer ID, digits only) when the connection has several Google Ads accounts. TikTok (required there): the advertiser id.
|
|
39305
39326
|
*/
|
|
39306
39327
|
adAccountId?: string;
|
|
39307
39328
|
/**
|
|
@@ -39317,20 +39338,28 @@ export type QueryAdInsightsData = {
|
|
|
39317
39338
|
* @deprecated
|
|
39318
39339
|
*/
|
|
39319
39340
|
customerId?: string;
|
|
39341
|
+
/**
|
|
39342
|
+
* TikTok only (required there): data_level.
|
|
39343
|
+
*/
|
|
39344
|
+
dataLevel?: 'AUCTION_ADVERTISER' | 'AUCTION_CAMPAIGN' | 'AUCTION_ADGROUP' | 'AUCTION_AD';
|
|
39320
39345
|
/**
|
|
39321
39346
|
* Meta date_preset (e.g. last_7d, last_30d, this_month). Mutually exclusive with fromDate/toDate.
|
|
39322
39347
|
*/
|
|
39323
39348
|
datePreset?: string;
|
|
39349
|
+
/**
|
|
39350
|
+
* TikTok only (required there): 1-4 comma-separated TikTok dimensions (e.g. country_code, campaign_id, stat_time_day).
|
|
39351
|
+
*/
|
|
39352
|
+
dimensions?: string;
|
|
39324
39353
|
/**
|
|
39325
39354
|
* Comma-separated Graph insights fields (e.g. spend,impressions,frequency,website_purchase_roas). Omitted = Meta's default set.
|
|
39326
39355
|
*/
|
|
39327
39356
|
fields?: string;
|
|
39328
39357
|
/**
|
|
39329
|
-
* JSON array of
|
|
39358
|
+
* JSON array of filter objects: [{"field", "operator", "value"}]. Applied server-side by Meta or TikTok (TikTok fields e.g. campaign_ids, adgroup_ids, ad_ids).
|
|
39330
39359
|
*/
|
|
39331
39360
|
filtering?: string;
|
|
39332
39361
|
/**
|
|
39333
|
-
* Start of range (YYYY-MM-DD); requires toDate.
|
|
39362
|
+
* Start of range (YYYY-MM-DD); requires toDate. Required on TikTok.
|
|
39334
39363
|
*/
|
|
39335
39364
|
fromDate?: string;
|
|
39336
39365
|
/**
|
|
@@ -39341,10 +39370,22 @@ export type QueryAdInsightsData = {
|
|
|
39341
39370
|
* Rows per page
|
|
39342
39371
|
*/
|
|
39343
39372
|
limit?: number;
|
|
39373
|
+
/**
|
|
39374
|
+
* TikTok only (required there): comma-separated TikTok metrics (e.g. reach,impressions,frequency,spend).
|
|
39375
|
+
*/
|
|
39376
|
+
metrics?: string;
|
|
39344
39377
|
/**
|
|
39345
39378
|
* Meta only (required there): insights node (act_<n>, campaign id, ad set id or ad id).
|
|
39346
39379
|
*/
|
|
39347
39380
|
objectId?: string;
|
|
39381
|
+
/**
|
|
39382
|
+
* TikTok only: page number.
|
|
39383
|
+
*/
|
|
39384
|
+
page?: number;
|
|
39385
|
+
/**
|
|
39386
|
+
* TikTok only: rows per page.
|
|
39387
|
+
*/
|
|
39388
|
+
pageSize?: number;
|
|
39348
39389
|
/**
|
|
39349
39390
|
* Google only: cursor from paging.nextPageToken of the previous page.
|
|
39350
39391
|
*/
|
|
@@ -39353,6 +39394,10 @@ export type QueryAdInsightsData = {
|
|
|
39353
39394
|
* Google only (required there): the GAQL SELECT statement to run.
|
|
39354
39395
|
*/
|
|
39355
39396
|
query?: string;
|
|
39397
|
+
/**
|
|
39398
|
+
* TikTok only: report_type.
|
|
39399
|
+
*/
|
|
39400
|
+
reportType?: 'BASIC' | 'AUDIENCE';
|
|
39356
39401
|
/**
|
|
39357
39402
|
* Days per row (1-90), monthly, or all_days.
|
|
39358
39403
|
*/
|
|
@@ -39373,6 +39418,10 @@ export type QueryAdInsightsResponse = ({
|
|
|
39373
39418
|
* Meta responses only.
|
|
39374
39419
|
*/
|
|
39375
39420
|
objectId?: string;
|
|
39421
|
+
/**
|
|
39422
|
+
* TikTok responses only: the advertiser queried.
|
|
39423
|
+
*/
|
|
39424
|
+
adAccountId?: string;
|
|
39376
39425
|
/**
|
|
39377
39426
|
* Google responses only: the customer the query ran against.
|
|
39378
39427
|
*/
|
|
@@ -39393,6 +39442,22 @@ export type QueryAdInsightsResponse = ({
|
|
|
39393
39442
|
* Google cursor for the next page; null when exhausted.
|
|
39394
39443
|
*/
|
|
39395
39444
|
nextPageToken?: (string) | null;
|
|
39445
|
+
/**
|
|
39446
|
+
* TikTok only: current page.
|
|
39447
|
+
*/
|
|
39448
|
+
page?: number;
|
|
39449
|
+
/**
|
|
39450
|
+
* TikTok only.
|
|
39451
|
+
*/
|
|
39452
|
+
pageSize?: number;
|
|
39453
|
+
/**
|
|
39454
|
+
* TikTok only.
|
|
39455
|
+
*/
|
|
39456
|
+
totalRows?: number;
|
|
39457
|
+
/**
|
|
39458
|
+
* TikTok only.
|
|
39459
|
+
*/
|
|
39460
|
+
totalPages?: number;
|
|
39396
39461
|
};
|
|
39397
39462
|
});
|
|
39398
39463
|
|
|
@@ -48519,6 +48584,86 @@ export type RemoveTrackingTagSharedAccountError = (unknown | {
|
|
|
48519
48584
|
error?: string;
|
|
48520
48585
|
} | ErrorResponse);
|
|
48521
48586
|
|
|
48587
|
+
export type InstallTrackingTagOnStoreData = {
|
|
48588
|
+
body: {
|
|
48589
|
+
/**
|
|
48590
|
+
* The connected Shopify account id (platform `shopify`).
|
|
48591
|
+
*/
|
|
48592
|
+
storeAccountId: string;
|
|
48593
|
+
};
|
|
48594
|
+
path: {
|
|
48595
|
+
accountId: string;
|
|
48596
|
+
/**
|
|
48597
|
+
* Meta pixel id.
|
|
48598
|
+
*/
|
|
48599
|
+
tagId: string;
|
|
48600
|
+
};
|
|
48601
|
+
};
|
|
48602
|
+
|
|
48603
|
+
export type InstallTrackingTagOnStoreResponse = ({
|
|
48604
|
+
platform?: 'metaads';
|
|
48605
|
+
install?: (StorePixelInstall & {
|
|
48606
|
+
/**
|
|
48607
|
+
* The pixel this install replaced on the store, if any.
|
|
48608
|
+
*/
|
|
48609
|
+
replacedTagId?: (string) | null;
|
|
48610
|
+
});
|
|
48611
|
+
});
|
|
48612
|
+
|
|
48613
|
+
export type InstallTrackingTagOnStoreError = (ErrorResponse | {
|
|
48614
|
+
error?: string;
|
|
48615
|
+
} | unknown);
|
|
48616
|
+
|
|
48617
|
+
export type GetTrackingTagStoreInstallData = {
|
|
48618
|
+
path: {
|
|
48619
|
+
accountId: string;
|
|
48620
|
+
/**
|
|
48621
|
+
* Meta pixel id.
|
|
48622
|
+
*/
|
|
48623
|
+
tagId: string;
|
|
48624
|
+
};
|
|
48625
|
+
query: {
|
|
48626
|
+
/**
|
|
48627
|
+
* The connected Shopify account id.
|
|
48628
|
+
*/
|
|
48629
|
+
storeAccountId: string;
|
|
48630
|
+
};
|
|
48631
|
+
};
|
|
48632
|
+
|
|
48633
|
+
export type GetTrackingTagStoreInstallResponse = ({
|
|
48634
|
+
platform?: 'metaads';
|
|
48635
|
+
install?: StorePixelInstall;
|
|
48636
|
+
});
|
|
48637
|
+
|
|
48638
|
+
export type GetTrackingTagStoreInstallError = (ErrorResponse | {
|
|
48639
|
+
error?: string;
|
|
48640
|
+
} | unknown);
|
|
48641
|
+
|
|
48642
|
+
export type RemoveTrackingTagFromStoreData = {
|
|
48643
|
+
path: {
|
|
48644
|
+
accountId: string;
|
|
48645
|
+
/**
|
|
48646
|
+
* Meta pixel id.
|
|
48647
|
+
*/
|
|
48648
|
+
tagId: string;
|
|
48649
|
+
};
|
|
48650
|
+
query: {
|
|
48651
|
+
/**
|
|
48652
|
+
* The connected Shopify account id.
|
|
48653
|
+
*/
|
|
48654
|
+
storeAccountId: string;
|
|
48655
|
+
};
|
|
48656
|
+
};
|
|
48657
|
+
|
|
48658
|
+
export type RemoveTrackingTagFromStoreResponse = ({
|
|
48659
|
+
platform?: 'metaads';
|
|
48660
|
+
install?: StorePixelInstall;
|
|
48661
|
+
});
|
|
48662
|
+
|
|
48663
|
+
export type RemoveTrackingTagFromStoreError = (ErrorResponse | {
|
|
48664
|
+
error?: string;
|
|
48665
|
+
} | unknown);
|
|
48666
|
+
|
|
48522
48667
|
export type GetTrackingTagStatsData = {
|
|
48523
48668
|
path: {
|
|
48524
48669
|
accountId: string;
|