@zernio/node 0.2.974 → 0.2.976
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 +12 -12
- package/dist/index.d.ts +12 -12
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +107 -4
- package/src/generated/types.gen.ts +12 -12
package/dist/index.d.mts
CHANGED
|
@@ -11156,7 +11156,7 @@ type TrackingTag = {
|
|
|
11156
11156
|
*/
|
|
11157
11157
|
events?: Array<TrackingTagEvent>;
|
|
11158
11158
|
name: string;
|
|
11159
|
-
platform: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads';
|
|
11159
|
+
platform: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads' | 'linkedinads';
|
|
11160
11160
|
/**
|
|
11161
11161
|
* Platform-native flavor of the tag (Meta: `pixel`).
|
|
11162
11162
|
*/
|
|
@@ -11202,7 +11202,7 @@ type TrackingTag = {
|
|
|
11202
11202
|
*/
|
|
11203
11203
|
ownerAdAccountId?: string;
|
|
11204
11204
|
};
|
|
11205
|
-
type platform11 = 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads';
|
|
11205
|
+
type platform11 = 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads' | 'linkedinads';
|
|
11206
11206
|
/**
|
|
11207
11207
|
* Platform-native flavor of the tag (Meta: `pixel`).
|
|
11208
11208
|
*/
|
|
@@ -48366,7 +48366,7 @@ type ListTrackingTagsData = {
|
|
|
48366
48366
|
};
|
|
48367
48367
|
};
|
|
48368
48368
|
type ListTrackingTagsResponse = ({
|
|
48369
|
-
platform?: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads';
|
|
48369
|
+
platform?: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads' | 'linkedinads';
|
|
48370
48370
|
tags?: Array<TrackingTag>;
|
|
48371
48371
|
});
|
|
48372
48372
|
type ListTrackingTagsError = (unknown | {
|
|
@@ -48392,7 +48392,7 @@ type CreateTrackingTagData = {
|
|
|
48392
48392
|
};
|
|
48393
48393
|
};
|
|
48394
48394
|
type CreateTrackingTagResponse = ({
|
|
48395
|
-
platform?: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads';
|
|
48395
|
+
platform?: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads' | 'linkedinads';
|
|
48396
48396
|
tag?: TrackingTag;
|
|
48397
48397
|
});
|
|
48398
48398
|
type CreateTrackingTagError = (unknown | {
|
|
@@ -48414,7 +48414,7 @@ type GetTrackingTagData = {
|
|
|
48414
48414
|
};
|
|
48415
48415
|
};
|
|
48416
48416
|
type GetTrackingTagResponse = ({
|
|
48417
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
|
|
48417
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads' | 'linkedinads';
|
|
48418
48418
|
tag?: TrackingTag;
|
|
48419
48419
|
});
|
|
48420
48420
|
type GetTrackingTagError = (ErrorResponse | {
|
|
@@ -48451,7 +48451,7 @@ type UpdateTrackingTagData = {
|
|
|
48451
48451
|
};
|
|
48452
48452
|
};
|
|
48453
48453
|
type UpdateTrackingTagResponse = ({
|
|
48454
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
|
|
48454
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads' | 'linkedinads';
|
|
48455
48455
|
tag?: TrackingTag;
|
|
48456
48456
|
});
|
|
48457
48457
|
type UpdateTrackingTagError = (unknown | {
|
|
@@ -48467,7 +48467,7 @@ type ListTrackingTagSharedAccountsData = {
|
|
|
48467
48467
|
};
|
|
48468
48468
|
};
|
|
48469
48469
|
type ListTrackingTagSharedAccountsResponse = ({
|
|
48470
|
-
platform?: 'metaads';
|
|
48470
|
+
platform?: 'metaads' | 'linkedinads';
|
|
48471
48471
|
sharedAccounts?: Array<SharedAdAccount>;
|
|
48472
48472
|
});
|
|
48473
48473
|
type ListTrackingTagSharedAccountsError = (ErrorResponse | {
|
|
@@ -48489,7 +48489,7 @@ type AddTrackingTagSharedAccountData = {
|
|
|
48489
48489
|
};
|
|
48490
48490
|
};
|
|
48491
48491
|
type AddTrackingTagSharedAccountResponse = ({
|
|
48492
|
-
platform?: 'metaads';
|
|
48492
|
+
platform?: 'metaads' | 'linkedinads';
|
|
48493
48493
|
ok?: boolean;
|
|
48494
48494
|
});
|
|
48495
48495
|
type AddTrackingTagSharedAccountError = (unknown | {
|
|
@@ -48542,7 +48542,7 @@ type InstallTrackingTagOnStoreData = {
|
|
|
48542
48542
|
};
|
|
48543
48543
|
};
|
|
48544
48544
|
type InstallTrackingTagOnStoreResponse = ({
|
|
48545
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
|
|
48545
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads' | 'linkedinads';
|
|
48546
48546
|
install?: (StorePixelInstall & {
|
|
48547
48547
|
/**
|
|
48548
48548
|
* Shopify only: the pixel this install replaced on the store, if any.
|
|
@@ -48594,7 +48594,7 @@ type GetTrackingTagStoreInstallData = {
|
|
|
48594
48594
|
};
|
|
48595
48595
|
};
|
|
48596
48596
|
type GetTrackingTagStoreInstallResponse = ({
|
|
48597
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
|
|
48597
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads' | 'linkedinads';
|
|
48598
48598
|
install?: (StorePixelInstall & {
|
|
48599
48599
|
/**
|
|
48600
48600
|
* WordPress only.
|
|
@@ -48641,7 +48641,7 @@ type RemoveTrackingTagFromStoreData = {
|
|
|
48641
48641
|
};
|
|
48642
48642
|
};
|
|
48643
48643
|
type RemoveTrackingTagFromStoreResponse = ({
|
|
48644
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
|
|
48644
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads' | 'linkedinads';
|
|
48645
48645
|
install?: (StorePixelInstall & {
|
|
48646
48646
|
/**
|
|
48647
48647
|
* WordPress only: number of Zernio widgets deleted.
|
|
@@ -48763,7 +48763,7 @@ type GetTrackingTagStatsData = {
|
|
|
48763
48763
|
};
|
|
48764
48764
|
};
|
|
48765
48765
|
type GetTrackingTagStatsResponse = ({
|
|
48766
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
|
|
48766
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads' | 'linkedinads';
|
|
48767
48767
|
stats?: {
|
|
48768
48768
|
aggregation?: string;
|
|
48769
48769
|
startTime?: number;
|
package/dist/index.d.ts
CHANGED
|
@@ -11156,7 +11156,7 @@ type TrackingTag = {
|
|
|
11156
11156
|
*/
|
|
11157
11157
|
events?: Array<TrackingTagEvent>;
|
|
11158
11158
|
name: string;
|
|
11159
|
-
platform: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads';
|
|
11159
|
+
platform: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads' | 'linkedinads';
|
|
11160
11160
|
/**
|
|
11161
11161
|
* Platform-native flavor of the tag (Meta: `pixel`).
|
|
11162
11162
|
*/
|
|
@@ -11202,7 +11202,7 @@ type TrackingTag = {
|
|
|
11202
11202
|
*/
|
|
11203
11203
|
ownerAdAccountId?: string;
|
|
11204
11204
|
};
|
|
11205
|
-
type platform11 = 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads';
|
|
11205
|
+
type platform11 = 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads' | 'linkedinads';
|
|
11206
11206
|
/**
|
|
11207
11207
|
* Platform-native flavor of the tag (Meta: `pixel`).
|
|
11208
11208
|
*/
|
|
@@ -48366,7 +48366,7 @@ type ListTrackingTagsData = {
|
|
|
48366
48366
|
};
|
|
48367
48367
|
};
|
|
48368
48368
|
type ListTrackingTagsResponse = ({
|
|
48369
|
-
platform?: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads';
|
|
48369
|
+
platform?: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads' | 'linkedinads';
|
|
48370
48370
|
tags?: Array<TrackingTag>;
|
|
48371
48371
|
});
|
|
48372
48372
|
type ListTrackingTagsError = (unknown | {
|
|
@@ -48392,7 +48392,7 @@ type CreateTrackingTagData = {
|
|
|
48392
48392
|
};
|
|
48393
48393
|
};
|
|
48394
48394
|
type CreateTrackingTagResponse = ({
|
|
48395
|
-
platform?: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads';
|
|
48395
|
+
platform?: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads' | 'linkedinads';
|
|
48396
48396
|
tag?: TrackingTag;
|
|
48397
48397
|
});
|
|
48398
48398
|
type CreateTrackingTagError = (unknown | {
|
|
@@ -48414,7 +48414,7 @@ type GetTrackingTagData = {
|
|
|
48414
48414
|
};
|
|
48415
48415
|
};
|
|
48416
48416
|
type GetTrackingTagResponse = ({
|
|
48417
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
|
|
48417
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads' | 'linkedinads';
|
|
48418
48418
|
tag?: TrackingTag;
|
|
48419
48419
|
});
|
|
48420
48420
|
type GetTrackingTagError = (ErrorResponse | {
|
|
@@ -48451,7 +48451,7 @@ type UpdateTrackingTagData = {
|
|
|
48451
48451
|
};
|
|
48452
48452
|
};
|
|
48453
48453
|
type UpdateTrackingTagResponse = ({
|
|
48454
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
|
|
48454
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads' | 'linkedinads';
|
|
48455
48455
|
tag?: TrackingTag;
|
|
48456
48456
|
});
|
|
48457
48457
|
type UpdateTrackingTagError = (unknown | {
|
|
@@ -48467,7 +48467,7 @@ type ListTrackingTagSharedAccountsData = {
|
|
|
48467
48467
|
};
|
|
48468
48468
|
};
|
|
48469
48469
|
type ListTrackingTagSharedAccountsResponse = ({
|
|
48470
|
-
platform?: 'metaads';
|
|
48470
|
+
platform?: 'metaads' | 'linkedinads';
|
|
48471
48471
|
sharedAccounts?: Array<SharedAdAccount>;
|
|
48472
48472
|
});
|
|
48473
48473
|
type ListTrackingTagSharedAccountsError = (ErrorResponse | {
|
|
@@ -48489,7 +48489,7 @@ type AddTrackingTagSharedAccountData = {
|
|
|
48489
48489
|
};
|
|
48490
48490
|
};
|
|
48491
48491
|
type AddTrackingTagSharedAccountResponse = ({
|
|
48492
|
-
platform?: 'metaads';
|
|
48492
|
+
platform?: 'metaads' | 'linkedinads';
|
|
48493
48493
|
ok?: boolean;
|
|
48494
48494
|
});
|
|
48495
48495
|
type AddTrackingTagSharedAccountError = (unknown | {
|
|
@@ -48542,7 +48542,7 @@ type InstallTrackingTagOnStoreData = {
|
|
|
48542
48542
|
};
|
|
48543
48543
|
};
|
|
48544
48544
|
type InstallTrackingTagOnStoreResponse = ({
|
|
48545
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
|
|
48545
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads' | 'linkedinads';
|
|
48546
48546
|
install?: (StorePixelInstall & {
|
|
48547
48547
|
/**
|
|
48548
48548
|
* Shopify only: the pixel this install replaced on the store, if any.
|
|
@@ -48594,7 +48594,7 @@ type GetTrackingTagStoreInstallData = {
|
|
|
48594
48594
|
};
|
|
48595
48595
|
};
|
|
48596
48596
|
type GetTrackingTagStoreInstallResponse = ({
|
|
48597
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
|
|
48597
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads' | 'linkedinads';
|
|
48598
48598
|
install?: (StorePixelInstall & {
|
|
48599
48599
|
/**
|
|
48600
48600
|
* WordPress only.
|
|
@@ -48641,7 +48641,7 @@ type RemoveTrackingTagFromStoreData = {
|
|
|
48641
48641
|
};
|
|
48642
48642
|
};
|
|
48643
48643
|
type RemoveTrackingTagFromStoreResponse = ({
|
|
48644
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
|
|
48644
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads' | 'linkedinads';
|
|
48645
48645
|
install?: (StorePixelInstall & {
|
|
48646
48646
|
/**
|
|
48647
48647
|
* WordPress only: number of Zernio widgets deleted.
|
|
@@ -48763,7 +48763,7 @@ type GetTrackingTagStatsData = {
|
|
|
48763
48763
|
};
|
|
48764
48764
|
};
|
|
48765
48765
|
type GetTrackingTagStatsResponse = ({
|
|
48766
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
|
|
48766
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads' | 'linkedinads';
|
|
48767
48767
|
stats?: {
|
|
48768
48768
|
aggregation?: string;
|
|
48769
48769
|
startTime?: number;
|
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.976",
|
|
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.976",
|
|
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
|
@@ -13618,6 +13618,12 @@ export const startBusinessAgentEvalRun = <ThrowOnError extends boolean = false>(
|
|
|
13618
13618
|
* `act_...` ids from `GET /v1/ads/accounts`; `adAccountId` is ignored for
|
|
13619
13619
|
* OpenAI Ads (one API key maps to exactly one ad account).
|
|
13620
13620
|
*
|
|
13621
|
+
* LinkedIn (`linkedinads`): lists the Insight Tag of each ad account (LinkedIn allows one
|
|
13622
|
+
* per ad account; a tag shared with several accounts appears once). `adAccountId` is the
|
|
13623
|
+
* numeric ad account id or `urn:li:sponsoredAccount:{id}`; omit it to scan every active ad
|
|
13624
|
+
* account the connection can see. The tag `id` IS the partner id the site embeds, so
|
|
13625
|
+
* `siteTagId` equals `id`. LinkedIn tags have no name; it is shown as `Insight Tag {id}`.
|
|
13626
|
+
*
|
|
13621
13627
|
*/
|
|
13622
13628
|
export const listTrackingTags = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<ListTrackingTagsData, ThrowOnError>) => {
|
|
13623
13629
|
return (options?.client ?? client).get<ListTrackingTagsResponse, ListTrackingTagsError, ThrowOnError>({
|
|
@@ -13657,6 +13663,11 @@ export const listTrackingTags = <ThrowOnError extends boolean = false>(options:
|
|
|
13657
13663
|
* timeout. Meta (platform `metaads`) and OpenAI Ads (platform
|
|
13658
13664
|
* `openaiads`); other platforms return 501.
|
|
13659
13665
|
*
|
|
13666
|
+
* LinkedIn (`linkedinads`): creates the ad account's Insight Tag (`POST /rest/insightTags`).
|
|
13667
|
+
* Idempotent: an ad account holds at most one Insight Tag, so when it already has one that
|
|
13668
|
+
* tag is returned and nothing is created. `name` is ignored (LinkedIn tags have no name) and
|
|
13669
|
+
* there is no API to delete an Insight Tag.
|
|
13670
|
+
*
|
|
13660
13671
|
*/
|
|
13661
13672
|
export const createTrackingTag = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<CreateTrackingTagData, ThrowOnError>) => {
|
|
13662
13673
|
return (options?.client ?? client).post<CreateTrackingTagResponse, CreateTrackingTagError, ThrowOnError>({
|
|
@@ -13679,6 +13690,13 @@ export const createTrackingTag = <ThrowOnError extends boolean = false>(options:
|
|
|
13679
13690
|
* `pixel_id` the site and the Conversions API send; `id` is what event
|
|
13680
13691
|
* settings reference.
|
|
13681
13692
|
*
|
|
13693
|
+
* LinkedIn (`linkedinads`): `code` is LinkedIn's base code, `lastFiredTime` is the most
|
|
13694
|
+
* recent callback across the tag's domains (unix seconds, null when it never fired) and
|
|
13695
|
+
* `events` lists the ad account's conversion rules. `siteEvent` and `siteEventId` are set
|
|
13696
|
+
* only on rules a page can fire (event-specific Insight Tag rules: not Conversions API
|
|
13697
|
+
* rules, no URL match rules). `adAccountId` picks which ad account's rules to read; it
|
|
13698
|
+
* defaults to the account that created the tag.
|
|
13699
|
+
*
|
|
13682
13700
|
*/
|
|
13683
13701
|
export const getTrackingTag = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTrackingTagData, ThrowOnError>) => {
|
|
13684
13702
|
return (options?.client ?? client).get<GetTrackingTagResponse, GetTrackingTagError, ThrowOnError>({
|
|
@@ -13704,6 +13722,10 @@ export const getTrackingTag = <ThrowOnError extends boolean = false>(options: Op
|
|
|
13704
13722
|
* .../tracking-tags/{tagId}/shared-accounts`) or disable it in Events
|
|
13705
13723
|
* Manager.
|
|
13706
13724
|
*
|
|
13725
|
+
* LinkedIn (`linkedinads`): only `firstPartyCookieStatus` (`first_party_cookie_enabled` or
|
|
13726
|
+
* `first_party_cookie_disabled`), which sets the tag's first-party tracking. It applies to
|
|
13727
|
+
* every ad account using the tag. `empty` answers 400: LinkedIn has no unset state.
|
|
13728
|
+
*
|
|
13707
13729
|
*/
|
|
13708
13730
|
export const updateTrackingTag = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<UpdateTrackingTagData, ThrowOnError>) => {
|
|
13709
13731
|
return (options?.client ?? client).patch<UpdateTrackingTagResponse, UpdateTrackingTagError, ThrowOnError>({
|
|
@@ -13714,7 +13736,12 @@ export const updateTrackingTag = <ThrowOnError extends boolean = false>(options:
|
|
|
13714
13736
|
|
|
13715
13737
|
/**
|
|
13716
13738
|
* List accounts it is shared with
|
|
13717
|
-
* Meta
|
|
13739
|
+
* Meta (`metaads`) and LinkedIn (`linkedinads`); other platforms return 501.
|
|
13740
|
+
*
|
|
13741
|
+
* LinkedIn (`linkedinads`): the ad accounts this connection can see that hold access to the
|
|
13742
|
+
* Insight Tag; the role (`FULL` or `USE_ONLY`) is appended to `name`. LinkedIn exposes
|
|
13743
|
+
* permissions per ad account only, so accounts the connection cannot see are not listed.
|
|
13744
|
+
*
|
|
13718
13745
|
*/
|
|
13719
13746
|
export const listTrackingTagSharedAccounts = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<ListTrackingTagSharedAccountsData, ThrowOnError>) => {
|
|
13720
13747
|
return (options?.client ?? client).get<ListTrackingTagSharedAccountsResponse, ListTrackingTagSharedAccountsError, ThrowOnError>({
|
|
@@ -13729,7 +13756,12 @@ export const listTrackingTagSharedAccounts = <ThrowOnError extends boolean = fal
|
|
|
13729
13756
|
* account can use it. Requires that you administer both the pixel's owning
|
|
13730
13757
|
* Business Manager and the target ad account; a pixel on a personal
|
|
13731
13758
|
* (non-BM) ad account can't be shared (Meta will reject the call). Meta
|
|
13732
|
-
*
|
|
13759
|
+
* and LinkedIn; other platforms return 501.
|
|
13760
|
+
*
|
|
13761
|
+
* LinkedIn (`linkedinads`): grants `USE_ONLY` access from the ad account that created the
|
|
13762
|
+
* tag, so the target can use the tag and its conversions but cannot edit or reshare it.
|
|
13763
|
+
* `adAccountId` is the numeric LinkedIn ad account id. An ad account uses one Insight Tag at
|
|
13764
|
+
* a time, so a target that already has one answers 400.
|
|
13733
13765
|
*
|
|
13734
13766
|
*/
|
|
13735
13767
|
export const addTrackingTagSharedAccount = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<AddTrackingTagSharedAccountData, ThrowOnError>) => {
|
|
@@ -13742,8 +13774,12 @@ export const addTrackingTagSharedAccount = <ThrowOnError extends boolean = false
|
|
|
13742
13774
|
/**
|
|
13743
13775
|
* Stop sharing with an account
|
|
13744
13776
|
* `adAccountId` may be passed as a query parameter (recommended) or as a
|
|
13745
|
-
* JSON body field for clients that can send DELETE bodies. Meta
|
|
13746
|
-
*
|
|
13777
|
+
* JSON body field for clients that can send DELETE bodies. Meta and
|
|
13778
|
+
* LinkedIn; other platforms return 501.
|
|
13779
|
+
*
|
|
13780
|
+
* LinkedIn (`linkedinads`): revokes the ad account's access. Zernio answers 400 instead of
|
|
13781
|
+
* revoking the last ad account that holds the tag: LinkedIn accepts that call and the tag
|
|
13782
|
+
* is orphaned (verified live).
|
|
13747
13783
|
*
|
|
13748
13784
|
*/
|
|
13749
13785
|
export const removeTrackingTagSharedAccount = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<RemoveTrackingTagSharedAccountData, ThrowOnError>) => {
|
|
@@ -13804,6 +13840,17 @@ export const removeTrackingTagSharedAccount = <ThrowOnError extends boolean = fa
|
|
|
13804
13840
|
* `homepageCheck` says whether the pixel is visible; `not_found` can be a stale page cache,
|
|
13805
13841
|
* the widget read-back is authoritative.
|
|
13806
13842
|
*
|
|
13843
|
+
* **LinkedIn** (`linkedinads`): Shopify sends every page view to the Insight Tag, plus each
|
|
13844
|
+
* store event that has an enabled event-specific Insight Tag conversion rule of the matching
|
|
13845
|
+
* type (view_content = VIEW_CONTENT, add_to_cart = ADD_TO_CART, search = SEARCH,
|
|
13846
|
+
* initiate_checkout = START_CHECKOUT, add_payment_info = ADD_BILLING_INFO, purchase =
|
|
13847
|
+
* PURCHASE). Each conversion carries the event id; Purchase uses `shopify_order_{orderId}`,
|
|
13848
|
+
* so a Conversions API event sent to a separate CONVERSIONS_API rule with that `eventId` is
|
|
13849
|
+
* deduplicated by LinkedIn. Conversions API rules cannot be fired from a page, and no rule
|
|
13850
|
+
* is created for you. The `li_fat_id` click id is read from the landing URL and kept in a
|
|
13851
|
+
* first-party cookie for 30 days. WordPress gets LinkedIn's base code, which records page
|
|
13852
|
+
* views.
|
|
13853
|
+
*
|
|
13807
13854
|
*/
|
|
13808
13855
|
export const installTrackingTagOnStore = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<InstallTrackingTagOnStoreData, ThrowOnError>) => {
|
|
13809
13856
|
return (options?.client ?? client).post<InstallTrackingTagOnStoreResponse, InstallTrackingTagOnStoreError, ThrowOnError>({
|
|
@@ -13858,6 +13905,17 @@ export const removeTrackingTagFromStore = <ThrowOnError extends boolean = false>
|
|
|
13858
13905
|
* settings, TikTok pixel events, Meta custom conversions. Platforms where events are just
|
|
13859
13906
|
* names the site sends (Pinterest) answer 501.
|
|
13860
13907
|
*
|
|
13908
|
+
* OpenAI Ads: the account's conversion event settings whose source is this pixel.
|
|
13909
|
+
* `siteEventId` is the event name the site sends (a standard event such as
|
|
13910
|
+
* `order_created`, or the lowercase custom event name); `clickWindowDays` is the
|
|
13911
|
+
* attribution window.
|
|
13912
|
+
*
|
|
13913
|
+
* LinkedIn (`linkedinads`): the conversion rules of the ad account (`adAccountId`, default
|
|
13914
|
+
* the account that created the tag), including Conversions API and URL-match rules.
|
|
13915
|
+
* `siteEventId` (the rule id a page fires) is set only on event-specific Insight Tag rules;
|
|
13916
|
+
* `defaultValue`/`currency` come from the rule value, `clickWindowDays`/`viewWindowDays`
|
|
13917
|
+
* from its post-click and view-through windows.
|
|
13918
|
+
*
|
|
13861
13919
|
*/
|
|
13862
13920
|
export const listTrackingTagEvents = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<ListTrackingTagEventsData, ThrowOnError>) => {
|
|
13863
13921
|
return (options?.client ?? client).get<ListTrackingTagEventsResponse, ListTrackingTagEventsError, ThrowOnError>({
|
|
@@ -13874,6 +13932,28 @@ export const listTrackingTagEvents = <ThrowOnError extends boolean = false>(opti
|
|
|
13874
13932
|
* optional fields; sending one it does not store answers 400 naming the supported fields.
|
|
13875
13933
|
* NOT idempotent unless noted per platform: do not retry blindly.
|
|
13876
13934
|
*
|
|
13935
|
+
* OpenAI Ads: creates a conversion event setting on the pixel (`POST
|
|
13936
|
+
* /conversions/event_settings`, source = the pixel). Accepts `name`, `type` and
|
|
13937
|
+
* `siteEvent` only. `type` is a standard event (`order_created`, `lead_created`,
|
|
13938
|
+
* `items_added`, `contents_viewed`, `checkout_started`, `registration_completed`,
|
|
13939
|
+
* `subscription_created`, `trial_started`, `appointment_scheduled`, `page_viewed`,
|
|
13940
|
+
* `app_installed`, `app_opened`) or, for anything else, the custom event name itself
|
|
13941
|
+
* (1 to 64 letters, digits, underscores or dashes; stored lowercase). `siteEvent` maps
|
|
13942
|
+
* `search` and `add_payment_info` to the custom events `search` and `addpaymentinfo`,
|
|
13943
|
+
* the names Zernio's Shopify pixel sends. The click attribution window is 30 days, the
|
|
13944
|
+
* only value OpenAI documents. Only standard events can be a conversions campaign's
|
|
13945
|
+
* optimization goal.
|
|
13946
|
+
*
|
|
13947
|
+
* LinkedIn (`linkedinads`): creates an event-specific Insight Tag conversion rule (no URL
|
|
13948
|
+
* match rules), the kind a page or the Shopify pixel fires by id. `type` is a LinkedIn
|
|
13949
|
+
* conversion type (e.g. `PURCHASE`, `ADD_TO_CART`, `START_CHECKOUT`, `LEAD`); `siteEvent`
|
|
13950
|
+
* maps to `KEY_PAGE_VIEW`, `VIEW_CONTENT`, `ADD_TO_CART`, `SEARCH`, `START_CHECKOUT`,
|
|
13951
|
+
* `ADD_BILLING_INFO` or `PURCHASE`. `defaultValue` needs `currency` (the ad account
|
|
13952
|
+
* currency) and is a fallback: a value sent with the event wins. Click and view windows are
|
|
13953
|
+
* in days (LinkedIn validates them: the docs list 1, 7 and 30, and rules with 90 exist).
|
|
13954
|
+
* Stores name, type, siteEvent, enabled, defaultValue, currency, clickWindowDays,
|
|
13955
|
+
* viewWindowDays. Not idempotent.
|
|
13956
|
+
*
|
|
13877
13957
|
*/
|
|
13878
13958
|
export const createTrackingTagEvent = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<CreateTrackingTagEventData, ThrowOnError>) => {
|
|
13879
13959
|
return (options?.client ?? client).post<CreateTrackingTagEventResponse, CreateTrackingTagEventError, ThrowOnError>({
|
|
@@ -13885,6 +13965,15 @@ export const createTrackingTagEvent = <ThrowOnError extends boolean = false>(opt
|
|
|
13885
13965
|
/**
|
|
13886
13966
|
* Update a conversion event
|
|
13887
13967
|
* Partial update; at least one field. A field the platform does not store answers 400.
|
|
13968
|
+
*
|
|
13969
|
+
* OpenAI Ads answers 501: OpenAI documents only list and create for event settings, and
|
|
13970
|
+
* `POST`/`PATCH`/`PUT /v1/conversions/event_settings/{id}` answer 404 "Invalid URL".
|
|
13971
|
+
* Create a new event instead.
|
|
13972
|
+
*
|
|
13973
|
+
* LinkedIn (`linkedinads`): partial update of the conversion rule; same fields as create.
|
|
13974
|
+
* Pass `adAccountId` when the rule lives in another ad account than the one that created the
|
|
13975
|
+
* tag.
|
|
13976
|
+
*
|
|
13888
13977
|
*/
|
|
13889
13978
|
export const updateTrackingTagEvent = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<UpdateTrackingTagEventData, ThrowOnError>) => {
|
|
13890
13979
|
return (options?.client ?? client).patch<UpdateTrackingTagEventResponse, UpdateTrackingTagEventError, ThrowOnError>({
|
|
@@ -13898,6 +13987,14 @@ export const updateTrackingTagEvent = <ThrowOnError extends boolean = false>(opt
|
|
|
13898
13987
|
* Removes the conversion event. Platforms without a hard delete archive or disable it
|
|
13899
13988
|
* instead; `state` in the response says which (`deleted`, `archived`, `disabled`).
|
|
13900
13989
|
*
|
|
13990
|
+
* OpenAI Ads answers 501: there is no delete or archive route for event settings
|
|
13991
|
+
* (`DELETE /v1/conversions/event_settings/{id}` and `POST .../{id}/archive` answer 404
|
|
13992
|
+
* "Invalid URL"). Archive the event in OpenAI Ads Manager.
|
|
13993
|
+
*
|
|
13994
|
+
* LinkedIn (`linkedinads`): LinkedIn has no delete for conversion rules (not in the
|
|
13995
|
+
* conversion-tracking API, and `DELETE /rest/conversions/{id}` has no route), so the rule is
|
|
13996
|
+
* disabled (`enabled: false`) and `state` is `disabled`. Re-enable it with `enabled: true`.
|
|
13997
|
+
*
|
|
13901
13998
|
*/
|
|
13902
13999
|
export const deleteTrackingTagEvent = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<DeleteTrackingTagEventData, ThrowOnError>) => {
|
|
13903
14000
|
return (options?.client ?? client).delete<DeleteTrackingTagEventResponse, DeleteTrackingTagEventError, ThrowOnError>({
|
|
@@ -13921,6 +14018,12 @@ export const deleteTrackingTagEvent = <ThrowOnError extends boolean = false>(opt
|
|
|
13921
14018
|
* install fires; attributed totals come from ads analytics. Accounts not
|
|
13922
14019
|
* enabled for the stream answer 422 `feature_not_available`.
|
|
13923
14020
|
*
|
|
14021
|
+
* LinkedIn (`linkedinads`): health rows rather than counts, since LinkedIn exposes no per-
|
|
14022
|
+
* event fire counts: one row per site domain the tag has seen (`kind: domain`, `domainName`,
|
|
14023
|
+
* `lastFiredTime`, `creationTime`, `blocked`) and one per conversion rule (`kind:
|
|
14024
|
+
* conversion_rule`, `id`, `name`, `type`, `conversionMethod`, `status`, `lastFiredTime`).
|
|
14025
|
+
* Times are unix seconds; `startTime`/`endTime` are ignored.
|
|
14026
|
+
*
|
|
13924
14027
|
*/
|
|
13925
14028
|
export const getTrackingTagStats = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<GetTrackingTagStatsData, ThrowOnError>) => {
|
|
13926
14029
|
return (options?.client ?? client).get<GetTrackingTagStatsResponse, GetTrackingTagStatsError, ThrowOnError>({
|
|
@@ -9706,7 +9706,7 @@ export type TrackingTag = {
|
|
|
9706
9706
|
*/
|
|
9707
9707
|
events?: Array<TrackingTagEvent>;
|
|
9708
9708
|
name: string;
|
|
9709
|
-
platform: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads';
|
|
9709
|
+
platform: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads' | 'linkedinads';
|
|
9710
9710
|
/**
|
|
9711
9711
|
* Platform-native flavor of the tag (Meta: `pixel`).
|
|
9712
9712
|
*/
|
|
@@ -9753,7 +9753,7 @@ export type TrackingTag = {
|
|
|
9753
9753
|
ownerAdAccountId?: string;
|
|
9754
9754
|
};
|
|
9755
9755
|
|
|
9756
|
-
export type platform11 = 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads';
|
|
9756
|
+
export type platform11 = 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads' | 'linkedinads';
|
|
9757
9757
|
|
|
9758
9758
|
/**
|
|
9759
9759
|
* Platform-native flavor of the tag (Meta: `pixel`).
|
|
@@ -49512,7 +49512,7 @@ export type ListTrackingTagsData = {
|
|
|
49512
49512
|
};
|
|
49513
49513
|
|
|
49514
49514
|
export type ListTrackingTagsResponse = ({
|
|
49515
|
-
platform?: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads';
|
|
49515
|
+
platform?: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads' | 'linkedinads';
|
|
49516
49516
|
tags?: Array<TrackingTag>;
|
|
49517
49517
|
});
|
|
49518
49518
|
|
|
@@ -49541,7 +49541,7 @@ export type CreateTrackingTagData = {
|
|
|
49541
49541
|
};
|
|
49542
49542
|
|
|
49543
49543
|
export type CreateTrackingTagResponse = ({
|
|
49544
|
-
platform?: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads';
|
|
49544
|
+
platform?: 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads' | 'linkedinads';
|
|
49545
49545
|
tag?: TrackingTag;
|
|
49546
49546
|
});
|
|
49547
49547
|
|
|
@@ -49566,7 +49566,7 @@ export type GetTrackingTagData = {
|
|
|
49566
49566
|
};
|
|
49567
49567
|
|
|
49568
49568
|
export type GetTrackingTagResponse = ({
|
|
49569
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
|
|
49569
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads' | 'linkedinads';
|
|
49570
49570
|
tag?: TrackingTag;
|
|
49571
49571
|
});
|
|
49572
49572
|
|
|
@@ -49606,7 +49606,7 @@ export type UpdateTrackingTagData = {
|
|
|
49606
49606
|
};
|
|
49607
49607
|
|
|
49608
49608
|
export type UpdateTrackingTagResponse = ({
|
|
49609
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
|
|
49609
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads' | 'linkedinads';
|
|
49610
49610
|
tag?: TrackingTag;
|
|
49611
49611
|
});
|
|
49612
49612
|
|
|
@@ -49625,7 +49625,7 @@ export type ListTrackingTagSharedAccountsData = {
|
|
|
49625
49625
|
};
|
|
49626
49626
|
|
|
49627
49627
|
export type ListTrackingTagSharedAccountsResponse = ({
|
|
49628
|
-
platform?: 'metaads';
|
|
49628
|
+
platform?: 'metaads' | 'linkedinads';
|
|
49629
49629
|
sharedAccounts?: Array<SharedAdAccount>;
|
|
49630
49630
|
});
|
|
49631
49631
|
|
|
@@ -49650,7 +49650,7 @@ export type AddTrackingTagSharedAccountData = {
|
|
|
49650
49650
|
};
|
|
49651
49651
|
|
|
49652
49652
|
export type AddTrackingTagSharedAccountResponse = ({
|
|
49653
|
-
platform?: 'metaads';
|
|
49653
|
+
platform?: 'metaads' | 'linkedinads';
|
|
49654
49654
|
ok?: boolean;
|
|
49655
49655
|
});
|
|
49656
49656
|
|
|
@@ -49709,7 +49709,7 @@ export type InstallTrackingTagOnStoreData = {
|
|
|
49709
49709
|
};
|
|
49710
49710
|
|
|
49711
49711
|
export type InstallTrackingTagOnStoreResponse = ({
|
|
49712
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
|
|
49712
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads' | 'linkedinads';
|
|
49713
49713
|
install?: (StorePixelInstall & {
|
|
49714
49714
|
/**
|
|
49715
49715
|
* Shopify only: the pixel this install replaced on the store, if any.
|
|
@@ -49764,7 +49764,7 @@ export type GetTrackingTagStoreInstallData = {
|
|
|
49764
49764
|
};
|
|
49765
49765
|
|
|
49766
49766
|
export type GetTrackingTagStoreInstallResponse = ({
|
|
49767
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
|
|
49767
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads' | 'linkedinads';
|
|
49768
49768
|
install?: (StorePixelInstall & {
|
|
49769
49769
|
/**
|
|
49770
49770
|
* WordPress only.
|
|
@@ -49814,7 +49814,7 @@ export type RemoveTrackingTagFromStoreData = {
|
|
|
49814
49814
|
};
|
|
49815
49815
|
|
|
49816
49816
|
export type RemoveTrackingTagFromStoreResponse = ({
|
|
49817
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
|
|
49817
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads' | 'linkedinads';
|
|
49818
49818
|
install?: (StorePixelInstall & {
|
|
49819
49819
|
/**
|
|
49820
49820
|
* WordPress only: number of Zernio widgets deleted.
|
|
@@ -49951,7 +49951,7 @@ export type GetTrackingTagStatsData = {
|
|
|
49951
49951
|
};
|
|
49952
49952
|
|
|
49953
49953
|
export type GetTrackingTagStatsResponse = ({
|
|
49954
|
-
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads';
|
|
49954
|
+
platform?: 'metaads' | 'tiktokads' | 'googleads' | 'xads' | 'openaiads' | 'linkedinads';
|
|
49955
49955
|
stats?: {
|
|
49956
49956
|
aggregation?: string;
|
|
49957
49957
|
startTime?: number;
|