@zernio/node 0.2.979 → 0.2.981
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 +4 -0
- package/dist/index.d.mts +170 -3
- package/dist/index.d.ts +170 -3
- package/dist/index.js +37 -1
- package/dist/index.mjs +37 -1
- package/package.json +1 -1
- package/src/client.ts +16 -0
- package/src/generated/sdk.gen.ts +108 -1
- package/src/generated/types.gen.ts +172 -2
|
@@ -3131,6 +3131,30 @@ export type ConversionAction = {
|
|
|
3131
3131
|
* true = primary (counts toward bidding when its goal is biddable), false = secondary. Change it with PATCH /v1/ads/conversions/actions/{actionId}.
|
|
3132
3132
|
*/
|
|
3133
3133
|
primaryForGoal?: boolean;
|
|
3134
|
+
/**
|
|
3135
|
+
* Value recorded when the conversion carries none.
|
|
3136
|
+
*/
|
|
3137
|
+
defaultValue?: number;
|
|
3138
|
+
/**
|
|
3139
|
+
* ISO 4217 currency of defaultValue.
|
|
3140
|
+
*/
|
|
3141
|
+
defaultCurrency?: string;
|
|
3142
|
+
/**
|
|
3143
|
+
* true = defaultValue is used even when the conversion sends its own value.
|
|
3144
|
+
*/
|
|
3145
|
+
alwaysUseDefaultValue?: boolean;
|
|
3146
|
+
/**
|
|
3147
|
+
* Google's ConversionActionCountingType: ONE_PER_CLICK or MANY_PER_CLICK.
|
|
3148
|
+
*/
|
|
3149
|
+
countingType?: string;
|
|
3150
|
+
/**
|
|
3151
|
+
* Days after an ad click a conversion is still credited (1 to 90).
|
|
3152
|
+
*/
|
|
3153
|
+
clickThroughLookbackWindowDays?: number;
|
|
3154
|
+
/**
|
|
3155
|
+
* Days after an ad view a conversion is still credited (1 to 30).
|
|
3156
|
+
*/
|
|
3157
|
+
viewThroughLookbackWindowDays?: number;
|
|
3134
3158
|
/**
|
|
3135
3159
|
* The code a customer pastes onto their site. Present for types
|
|
3136
3160
|
* Google generates a snippet for (e.g. WEBPAGE); empty otherwise.
|
|
@@ -9698,11 +9722,11 @@ export type mediaType2 = 'video' | 'photo';
|
|
|
9698
9722
|
*/
|
|
9699
9723
|
export type TrackingTag = {
|
|
9700
9724
|
/**
|
|
9701
|
-
* Platform-native tag id, the `{tagId}` of the per-tag routes. Meta: numeric pixel id, as a string. OpenAI: the pixel resource id.
|
|
9725
|
+
* Platform-native tag id, the `{tagId}` of the per-tag routes. Meta: numeric pixel id, as a string. OpenAI: the pixel resource id. Google Ads: the 10-digit customer id (one Google tag per account).
|
|
9702
9726
|
*/
|
|
9703
9727
|
id: string;
|
|
9704
9728
|
/**
|
|
9705
|
-
* The id the on-site code carries. Equals `id` on Meta; differs on platforms with separate API and site ids (OpenAI `pixel_id`).
|
|
9729
|
+
* The id the on-site code carries. Equals `id` on Meta; differs on platforms with separate API and site ids (OpenAI `pixel_id`, Google `AW-...` conversion id, the manager's under cross-account conversion tracking).
|
|
9706
9730
|
*/
|
|
9707
9731
|
siteTagId?: string;
|
|
9708
9732
|
/**
|
|
@@ -9755,6 +9779,10 @@ export type TrackingTag = {
|
|
|
9755
9779
|
* Ad account id (`act_...`) that owns the tag, when reported.
|
|
9756
9780
|
*/
|
|
9757
9781
|
ownerAdAccountId?: string;
|
|
9782
|
+
/**
|
|
9783
|
+
* Google Ads: whether gclid auto-tagging is on for the ad account (needed to attribute conversions to clicks).
|
|
9784
|
+
*/
|
|
9785
|
+
autoTagging?: boolean;
|
|
9758
9786
|
};
|
|
9759
9787
|
|
|
9760
9788
|
export type platform11 = 'metaads' | 'openaiads' | 'tiktokads' | 'googleads' | 'xads' | 'linkedinads' | 'pinterestads';
|
|
@@ -9782,8 +9810,25 @@ export type TrackingTagDiagnostic = {
|
|
|
9782
9810
|
* Where to fix it in the platform UI (Meta: Events Manager).
|
|
9783
9811
|
*/
|
|
9784
9812
|
actionUrl?: string;
|
|
9813
|
+
/**
|
|
9814
|
+
* Record `defaultValue` even when the conversion sends its own value.
|
|
9815
|
+
*/
|
|
9816
|
+
alwaysUseDefaultValue?: boolean;
|
|
9817
|
+
/**
|
|
9818
|
+
* Primary (counts toward bidding) or secondary (observation only).
|
|
9819
|
+
*/
|
|
9820
|
+
primary?: boolean;
|
|
9821
|
+
/**
|
|
9822
|
+
* `one` = one conversion per ad interaction, `every` = each conversion.
|
|
9823
|
+
*/
|
|
9824
|
+
countingType?: 'one' | 'every';
|
|
9785
9825
|
};
|
|
9786
9826
|
|
|
9827
|
+
/**
|
|
9828
|
+
* `one` = one conversion per ad interaction, `every` = each conversion.
|
|
9829
|
+
*/
|
|
9830
|
+
export type countingType = 'one' | 'every';
|
|
9831
|
+
|
|
9787
9832
|
/**
|
|
9788
9833
|
* A conversion event tied to a tracking tag (Google conversion action, LinkedIn conversion rule, X web event tag, OpenAI event setting, TikTok pixel event, Meta custom conversion).
|
|
9789
9834
|
*/
|
|
@@ -9814,6 +9859,18 @@ export type TrackingTagEvent = {
|
|
|
9814
9859
|
* Fires only on pages whose URL contains this text (case-insensitive).
|
|
9815
9860
|
*/
|
|
9816
9861
|
urlContains?: string;
|
|
9862
|
+
/**
|
|
9863
|
+
* `defaultValue` is recorded even when the conversion sends its own value.
|
|
9864
|
+
*/
|
|
9865
|
+
alwaysUseDefaultValue?: boolean;
|
|
9866
|
+
/**
|
|
9867
|
+
* Primary conversions count toward bidding and the Conversions column; secondary ones are observation only (Google `primary_for_goal`).
|
|
9868
|
+
*/
|
|
9869
|
+
primary?: boolean;
|
|
9870
|
+
/**
|
|
9871
|
+
* `one` counts at most one conversion per ad interaction (leads), `every` counts each (purchases).
|
|
9872
|
+
*/
|
|
9873
|
+
countingType?: 'one' | 'every';
|
|
9817
9874
|
};
|
|
9818
9875
|
|
|
9819
9876
|
/**
|
|
@@ -9857,6 +9914,32 @@ export type TrackingTagEventInput = {
|
|
|
9857
9914
|
*/
|
|
9858
9915
|
export type TrackingTagInstallBlockedReason = 'insufficient_permissions' | 'scripts_stripped' | 'wordpress_com_plan' | 'no_widget_areas' | 'widgets_api_unavailable';
|
|
9859
9916
|
|
|
9917
|
+
/**
|
|
9918
|
+
* Another business a tracking tag is shared with.
|
|
9919
|
+
*/
|
|
9920
|
+
export type TrackingTagPartner = {
|
|
9921
|
+
/**
|
|
9922
|
+
* Partner business id.
|
|
9923
|
+
*/
|
|
9924
|
+
id: string;
|
|
9925
|
+
name?: string;
|
|
9926
|
+
};
|
|
9927
|
+
|
|
9928
|
+
/**
|
|
9929
|
+
* A person or system user of the owning business with access to a tracking tag.
|
|
9930
|
+
*/
|
|
9931
|
+
export type TrackingTagUser = {
|
|
9932
|
+
/**
|
|
9933
|
+
* Business-scoped user id (as listed by GET /v1/ads/businesses/users).
|
|
9934
|
+
*/
|
|
9935
|
+
id: string;
|
|
9936
|
+
name?: string;
|
|
9937
|
+
/**
|
|
9938
|
+
* Platform permission names (Meta: `AA_ANALYZE`, `ADVERTISE`, `ANALYZE`, `EDIT`, `UPLOAD`).
|
|
9939
|
+
*/
|
|
9940
|
+
tasks: Array<(string)>;
|
|
9941
|
+
};
|
|
9942
|
+
|
|
9860
9943
|
/**
|
|
9861
9944
|
* X-specific post options. The article field creates a long-form X Article and is mutually exclusive with tweet media and tweet-only options. Geo-restriction applies at the media level: media is hidden outside the specified countries while tweet text remains visible.
|
|
9862
9945
|
*
|
|
@@ -49627,6 +49710,10 @@ export type UpdateTrackingTagData = {
|
|
|
49627
49710
|
automaticMatchingFields?: Array<('em' | 'ph' | 'fn' | 'ln' | 'ge' | 'db' | 'ct' | 'st' | 'zp' | 'country' | 'external_id')>;
|
|
49628
49711
|
firstPartyCookieStatus?: 'empty' | 'first_party_cookie_disabled' | 'first_party_cookie_enabled';
|
|
49629
49712
|
dataUseSetting?: 'advertising_and_analytics' | 'analytics_only' | 'empty';
|
|
49713
|
+
/**
|
|
49714
|
+
* Google Ads: turn gclid auto-tagging on or off for the ad account.
|
|
49715
|
+
*/
|
|
49716
|
+
autoTagging?: boolean;
|
|
49630
49717
|
};
|
|
49631
49718
|
path: {
|
|
49632
49719
|
accountId: string;
|
|
@@ -49954,6 +50041,89 @@ export type DeleteTrackingTagEventError = (ErrorResponse | {
|
|
|
49954
50041
|
error?: string;
|
|
49955
50042
|
} | unknown);
|
|
49956
50043
|
|
|
50044
|
+
export type ListTrackingTagUsersData = {
|
|
50045
|
+
path: {
|
|
50046
|
+
accountId: string;
|
|
50047
|
+
/**
|
|
50048
|
+
* Tag id (`TrackingTag.id`).
|
|
50049
|
+
*/
|
|
50050
|
+
tagId: string;
|
|
50051
|
+
};
|
|
50052
|
+
};
|
|
50053
|
+
|
|
50054
|
+
export type ListTrackingTagUsersResponse = ({
|
|
50055
|
+
platform?: string;
|
|
50056
|
+
users?: Array<TrackingTagUser>;
|
|
50057
|
+
});
|
|
50058
|
+
|
|
50059
|
+
export type ListTrackingTagUsersError = (ErrorResponse | {
|
|
50060
|
+
error?: string;
|
|
50061
|
+
} | unknown);
|
|
50062
|
+
|
|
50063
|
+
export type AssignTrackingTagUserData = {
|
|
50064
|
+
body: {
|
|
50065
|
+
userId: string;
|
|
50066
|
+
tasks: Array<(string)>;
|
|
50067
|
+
};
|
|
50068
|
+
path: {
|
|
50069
|
+
accountId: string;
|
|
50070
|
+
/**
|
|
50071
|
+
* Tag id (`TrackingTag.id`).
|
|
50072
|
+
*/
|
|
50073
|
+
tagId: string;
|
|
50074
|
+
};
|
|
50075
|
+
};
|
|
50076
|
+
|
|
50077
|
+
export type AssignTrackingTagUserResponse = ({
|
|
50078
|
+
platform?: string;
|
|
50079
|
+
userId?: string;
|
|
50080
|
+
tasks?: Array<(string)>;
|
|
50081
|
+
});
|
|
50082
|
+
|
|
50083
|
+
export type AssignTrackingTagUserError = (ErrorResponse | {
|
|
50084
|
+
error?: string;
|
|
50085
|
+
} | unknown);
|
|
50086
|
+
|
|
50087
|
+
export type RemoveTrackingTagUserData = {
|
|
50088
|
+
path: {
|
|
50089
|
+
accountId: string;
|
|
50090
|
+
tagId: string;
|
|
50091
|
+
/**
|
|
50092
|
+
* User id (`TrackingTagUser.id`).
|
|
50093
|
+
*/
|
|
50094
|
+
userId: string;
|
|
50095
|
+
};
|
|
50096
|
+
};
|
|
50097
|
+
|
|
50098
|
+
export type RemoveTrackingTagUserResponse = ({
|
|
50099
|
+
platform?: string;
|
|
50100
|
+
userId?: string;
|
|
50101
|
+
removed?: boolean;
|
|
50102
|
+
});
|
|
50103
|
+
|
|
50104
|
+
export type RemoveTrackingTagUserError = (ErrorResponse | {
|
|
50105
|
+
error?: string;
|
|
50106
|
+
} | unknown);
|
|
50107
|
+
|
|
50108
|
+
export type ListTrackingTagPartnersData = {
|
|
50109
|
+
path: {
|
|
50110
|
+
accountId: string;
|
|
50111
|
+
/**
|
|
50112
|
+
* Tag id (`TrackingTag.id`).
|
|
50113
|
+
*/
|
|
50114
|
+
tagId: string;
|
|
50115
|
+
};
|
|
50116
|
+
};
|
|
50117
|
+
|
|
50118
|
+
export type ListTrackingTagPartnersResponse = ({
|
|
50119
|
+
platform?: string;
|
|
50120
|
+
partners?: Array<TrackingTagPartner>;
|
|
50121
|
+
});
|
|
50122
|
+
|
|
50123
|
+
export type ListTrackingTagPartnersError = (ErrorResponse | {
|
|
50124
|
+
error?: string;
|
|
50125
|
+
} | unknown);
|
|
50126
|
+
|
|
49957
50127
|
export type GetTrackingTagDiagnosticsData = {
|
|
49958
50128
|
path: {
|
|
49959
50129
|
accountId: string;
|