@zernio/node 0.2.149 → 0.2.151
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 +4 -0
- package/dist/index.d.ts +4 -0
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +35 -43
- package/src/generated/types.gen.ts +4 -0
package/dist/index.d.mts
CHANGED
|
@@ -14066,6 +14066,10 @@ type GetAdTreeData = {
|
|
|
14066
14066
|
* Profile ID
|
|
14067
14067
|
*/
|
|
14068
14068
|
profileId?: string;
|
|
14069
|
+
/**
|
|
14070
|
+
* Campaign-level sort order. `newest` (default) and `oldest` order by the campaign's newest-ad createdAt. `spend_desc` / `spend_asc` are accepted for forward compatibility but currently fall back to an adSetCount-based ordering (spend ranking via Tinybird is pending).
|
|
14071
|
+
*/
|
|
14072
|
+
sort?: 'newest' | 'oldest' | 'spend_desc' | 'spend_asc';
|
|
14069
14073
|
/**
|
|
14070
14074
|
* `all` (default) returns both Zernio-created ads and those discovered from the platform's ad manager — matches the web UI's default view. Pass `zernio` to restrict to isExternal=false only. Status is NOT filtered by default — use the `status` param for that.
|
|
14071
14075
|
*/
|
package/dist/index.d.ts
CHANGED
|
@@ -14066,6 +14066,10 @@ type GetAdTreeData = {
|
|
|
14066
14066
|
* Profile ID
|
|
14067
14067
|
*/
|
|
14068
14068
|
profileId?: string;
|
|
14069
|
+
/**
|
|
14070
|
+
* Campaign-level sort order. `newest` (default) and `oldest` order by the campaign's newest-ad createdAt. `spend_desc` / `spend_asc` are accepted for forward compatibility but currently fall back to an adSetCount-based ordering (spend ranking via Tinybird is pending).
|
|
14071
|
+
*/
|
|
14072
|
+
sort?: 'newest' | 'oldest' | 'spend_desc' | 'spend_asc';
|
|
14069
14073
|
/**
|
|
14070
14074
|
* `all` (default) returns both Zernio-created ads and those discovered from the platform's ad manager — matches the web UI's default view. Pass `zernio` to restrict to isExternal=false only. Status is NOT filtered by default — use the `status` param for that.
|
|
14071
14075
|
*/
|
package/package.json
CHANGED
package/src/generated/sdk.gen.ts
CHANGED
|
@@ -3757,51 +3757,43 @@ export const addUsersToAdAudience = <ThrowOnError extends boolean = false>(optio
|
|
|
3757
3757
|
|
|
3758
3758
|
/**
|
|
3759
3759
|
* Send conversion events to an ad platform
|
|
3760
|
-
* Relay one or more conversion events to the target ad platform's native
|
|
3761
|
-
*
|
|
3762
|
-
*
|
|
3763
|
-
*
|
|
3764
|
-
*
|
|
3765
|
-
*
|
|
3766
|
-
*
|
|
3767
|
-
* -
|
|
3768
|
-
*
|
|
3769
|
-
*
|
|
3770
|
-
*
|
|
3771
|
-
*
|
|
3772
|
-
*
|
|
3773
|
-
*
|
|
3774
|
-
*
|
|
3775
|
-
*
|
|
3776
|
-
*
|
|
3777
|
-
* server-side per each
|
|
3778
|
-
* Gmail-specific dot/plus-suffix stripping
|
|
3779
|
-
* LinkedIn `externalIds` are passed through as plaintext per LinkedIn's
|
|
3780
|
-
*
|
|
3781
|
-
*
|
|
3782
|
-
*
|
|
3783
|
-
*
|
|
3784
|
-
*
|
|
3785
|
-
*
|
|
3786
|
-
*
|
|
3787
|
-
*
|
|
3788
|
-
*
|
|
3789
|
-
*
|
|
3790
|
-
*
|
|
3791
|
-
*
|
|
3792
|
-
* Dedup: pass a stable `eventId` on every event. Meta and LinkedIn use
|
|
3793
|
-
* it to dedupe against browser-side pixel/Insight Tag events; Google
|
|
3794
|
-
* maps it to transactionId.
|
|
3760
|
+
* Relay one or more conversion events to the target ad platform's native Conversions API.
|
|
3761
|
+
* Platform is inferred from the provided `accountId`. Requires the Ads add-on.
|
|
3762
|
+
*
|
|
3763
|
+
* Supported platforms:
|
|
3764
|
+
*
|
|
3765
|
+
* - Meta (`metaads`) via Graph API
|
|
3766
|
+
* - Google Ads (`googleads`) via Data Manager API `ingestEvents`
|
|
3767
|
+
* - LinkedIn (`linkedinads`) via `/rest/conversionEvents`
|
|
3768
|
+
*
|
|
3769
|
+
* `destinationId` semantics differ per platform:
|
|
3770
|
+
*
|
|
3771
|
+
* - Meta: pixel (dataset) ID, e.g. `123456789012345`
|
|
3772
|
+
* - Google: conversion action resource name, e.g. `customers/1234567890/conversionActions/987654321`
|
|
3773
|
+
* - LinkedIn: conversion rule ID or URN, e.g. `104012` or `urn:lla:llaPartnerConversion:104012`
|
|
3774
|
+
*
|
|
3775
|
+
* Callers can list valid destinations via `GET /v1/accounts/{accountId}/conversion-destinations`.
|
|
3776
|
+
*
|
|
3777
|
+
* All PII (email, phone, names, external IDs) is hashed with SHA-256 server-side per each
|
|
3778
|
+
* platform's normalization spec, including Google's Gmail-specific dot/plus-suffix stripping.
|
|
3779
|
+
* Send plaintext. LinkedIn `externalIds` are passed through as plaintext per LinkedIn's spec;
|
|
3780
|
+
* only emails and phones are hashed.
|
|
3781
|
+
*
|
|
3782
|
+
* For LinkedIn, the connected account must have been authorized after the Conversions API
|
|
3783
|
+
* rollout (i.e. the OAuth grant must include `rw_conversions`). Older accounts must reconnect.
|
|
3784
|
+
*
|
|
3785
|
+
* Batching is handled automatically. Meta caps at 1000 events per request and rejects the
|
|
3786
|
+
* entire batch if any event is malformed. Google caps at 2000. LinkedIn caps at 5000 and is
|
|
3787
|
+
* also all-or-nothing per chunk.
|
|
3788
|
+
*
|
|
3789
|
+
* Dedup: pass a stable `eventId` on every event. Meta and LinkedIn use it to dedupe against
|
|
3790
|
+
* browser-side pixel/Insight Tag events; Google maps it to `transactionId`.
|
|
3795
3791
|
*
|
|
3796
3792
|
* Per-platform `eventName` semantics:
|
|
3797
|
-
*
|
|
3798
|
-
* built-in events; custom strings are accepted.
|
|
3799
|
-
* - Google: ignored
|
|
3800
|
-
*
|
|
3801
|
-
* documentation, but the platform will not branch on it.
|
|
3802
|
-
* - LinkedIn: ignored — the conversion rule's `type` (LEAD, PURCHASE,
|
|
3803
|
-
* etc.) is locked to the destination at rule-creation time. Send the
|
|
3804
|
-
* standard name for documentation; LinkedIn does not branch on it.
|
|
3793
|
+
*
|
|
3794
|
+
* - Meta: free-form. Standard names (Purchase, Lead, ...) match Meta's built-in events; custom strings are accepted.
|
|
3795
|
+
* - Google: ignored. The conversion action's category determines the event type. Send the standard name closest to your action for documentation, but the platform will not branch on it.
|
|
3796
|
+
* - LinkedIn: ignored. The conversion rule's `type` (LEAD, PURCHASE, etc.) is locked to the destination at rule-creation time. Send the standard name for documentation; LinkedIn does not branch on it.
|
|
3805
3797
|
*
|
|
3806
3798
|
*/
|
|
3807
3799
|
export const sendConversions = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<SendConversionsData, ThrowOnError>) => {
|
|
@@ -14388,6 +14388,10 @@ export type GetAdTreeData = {
|
|
|
14388
14388
|
* Profile ID
|
|
14389
14389
|
*/
|
|
14390
14390
|
profileId?: string;
|
|
14391
|
+
/**
|
|
14392
|
+
* Campaign-level sort order. `newest` (default) and `oldest` order by the campaign's newest-ad createdAt. `spend_desc` / `spend_asc` are accepted for forward compatibility but currently fall back to an adSetCount-based ordering (spend ranking via Tinybird is pending).
|
|
14393
|
+
*/
|
|
14394
|
+
sort?: 'newest' | 'oldest' | 'spend_desc' | 'spend_asc';
|
|
14391
14395
|
/**
|
|
14392
14396
|
* `all` (default) returns both Zernio-created ads and those discovered from the platform's ad manager — matches the web UI's default view. Pass `zernio` to restrict to isExternal=false only. Status is NOT filtered by default — use the `status` param for that.
|
|
14393
14397
|
*/
|