@getlatedev/node 0.2.1358 → 0.2.1359
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 +1 -0
- package/dist/index.d.mts +145 -9
- package/dist/index.d.ts +145 -9
- package/dist/index.js +10 -1
- package/dist/index.mjs +10 -1
- package/package.json +1 -1
- package/src/client.ts +4 -0
- package/src/generated/sdk.gen.ts +38 -4
- package/src/generated/types.gen.ts +144 -8
|
@@ -47384,15 +47384,15 @@ export type ListAdSetsError = (ErrorResponse | unknown);
|
|
|
47384
47384
|
export type CreateAdSetData = {
|
|
47385
47385
|
body: {
|
|
47386
47386
|
/**
|
|
47387
|
-
* Zernio SocialAccount id owning the Google Ads connection.
|
|
47387
|
+
* Zernio SocialAccount id owning the Google Ads or Reddit Ads connection.
|
|
47388
47388
|
*/
|
|
47389
47389
|
accountId: string;
|
|
47390
47390
|
/**
|
|
47391
|
-
*
|
|
47391
|
+
* "google" and "reddit" are implemented; every other value returns 501.
|
|
47392
47392
|
*/
|
|
47393
47393
|
platform: 'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'pinterest' | 'google' | 'twitter' | 'openai' | 'reddit';
|
|
47394
47394
|
/**
|
|
47395
|
-
*
|
|
47395
|
+
* Platform campaign ID the ad group is created under (numeric on Google).
|
|
47396
47396
|
*/
|
|
47397
47397
|
campaignId: string;
|
|
47398
47398
|
name: string;
|
|
@@ -47402,14 +47402,56 @@ export type CreateAdSetData = {
|
|
|
47402
47402
|
*/
|
|
47403
47403
|
maxCpc?: number;
|
|
47404
47404
|
/**
|
|
47405
|
-
* Platform ad account ID
|
|
47405
|
+
* Platform ad account ID: the Google customer ID (digits only, only required when the connection has more than one) or the Reddit ad account id (required).
|
|
47406
47406
|
*/
|
|
47407
47407
|
adAccountId?: string;
|
|
47408
47408
|
/**
|
|
47409
|
-
* Alias of adAccountId, kept for existing callers
|
|
47409
|
+
* Google only. Alias of adAccountId, kept for existing callers
|
|
47410
47410
|
* @deprecated
|
|
47411
47411
|
*/
|
|
47412
47412
|
customerId?: string;
|
|
47413
|
+
/**
|
|
47414
|
+
* Reddit only. Budget of the new ad group, in the ad account's currency units. Required when the campaign has no campaign budget; not applied under campaign budget optimization.
|
|
47415
|
+
*/
|
|
47416
|
+
budgetAmount?: number;
|
|
47417
|
+
/**
|
|
47418
|
+
* Reddit only. Sent together with budgetAmount.
|
|
47419
|
+
*/
|
|
47420
|
+
budgetType?: 'daily' | 'lifetime';
|
|
47421
|
+
/**
|
|
47422
|
+
* Reddit only. ISO 8601 start of the ad group. Defaults to now, or to the campaign start when it is in the future.
|
|
47423
|
+
*/
|
|
47424
|
+
startDate?: string;
|
|
47425
|
+
/**
|
|
47426
|
+
* Reddit only. ISO 8601 end of the ad group. Defaults to the campaign end.
|
|
47427
|
+
*/
|
|
47428
|
+
endDate?: string;
|
|
47429
|
+
targeting?: TargetingSpec;
|
|
47430
|
+
/**
|
|
47431
|
+
* Reddit only. The pixel and the conversion event the ad group optimizes toward.
|
|
47432
|
+
*/
|
|
47433
|
+
promotedObject?: {
|
|
47434
|
+
/**
|
|
47435
|
+
* Reddit pixel id. Defaults to the ad account's first pixel.
|
|
47436
|
+
*/
|
|
47437
|
+
pixelId?: string;
|
|
47438
|
+
/**
|
|
47439
|
+
* Conversion event (PURCHASE, LEAD, SIGN_UP, ADD_TO_CART, PAGE_VISIT). Required on a conversions campaign.
|
|
47440
|
+
*/
|
|
47441
|
+
customEventType?: string;
|
|
47442
|
+
};
|
|
47443
|
+
/**
|
|
47444
|
+
* Reddit only. VIDEO_VIEW_6S (default) or VIDEO_VIEW_15S on a video views campaign.
|
|
47445
|
+
*/
|
|
47446
|
+
optimizationGoal?: string;
|
|
47447
|
+
/**
|
|
47448
|
+
* Reddit only. Defaults to LOWEST_COST_WITHOUT_CAP. Not accepted under campaign budget optimization.
|
|
47449
|
+
*/
|
|
47450
|
+
bidStrategy?: 'LOWEST_COST_WITHOUT_CAP' | 'LOWEST_COST_WITH_BID_CAP' | 'COST_CAP';
|
|
47451
|
+
/**
|
|
47452
|
+
* Reddit only. Bid cap in currency units, sent with bidStrategy.
|
|
47453
|
+
*/
|
|
47454
|
+
bidAmount?: number;
|
|
47413
47455
|
};
|
|
47414
47456
|
headers?: {
|
|
47415
47457
|
/**
|
|
@@ -54191,10 +54233,18 @@ export type CreateStandaloneAdData = {
|
|
|
54191
54233
|
* (geo, languages, `demandGen.channels`/`audience`/`audienceId`/
|
|
54192
54234
|
* `adGroupName`) return 400. `validateOnly` is supported.
|
|
54193
54235
|
*
|
|
54236
|
+
* On Reddit Ads the `adSetId` is the AD GROUP id. Only the post
|
|
54237
|
+
* and the ad are created; the ad group keeps its budget,
|
|
54238
|
+
* schedule, targeting, bid and optimization, so `budgetAmount`,
|
|
54239
|
+
* `budgetType`, `startDate`, `endDate`, targeting fields,
|
|
54240
|
+
* `promotedObject`, `tracking.pixelId` and `optimizationGoal`
|
|
54241
|
+
* return 400. `goal` is not required. An ad group of another
|
|
54242
|
+
* ad account returns 404.
|
|
54243
|
+
*
|
|
54194
54244
|
*/
|
|
54195
54245
|
adSetId?: string;
|
|
54196
54246
|
/**
|
|
54197
|
-
* Meta, Google Ads, LinkedIn and
|
|
54247
|
+
* Meta, Google Ads, LinkedIn, TikTok and Reddit Ads. On TikTok: creates
|
|
54198
54248
|
* the ad group and the ad under this existing campaign; the
|
|
54199
54249
|
* campaign is neither created nor activated and its
|
|
54200
54250
|
* objective must fit `goal`; not with `smartPlus`.
|
|
@@ -54220,8 +54270,26 @@ export type CreateStandaloneAdData = {
|
|
|
54220
54270
|
* a new ad group, so geo and language fields return 400 there; the new
|
|
54221
54271
|
* ad group follows the campaign's targeting. On failure only the entities we
|
|
54222
54272
|
* authored are cleaned up; the pre-existing parent is left
|
|
54223
|
-
* untouched and is never (re)activated.
|
|
54224
|
-
*
|
|
54273
|
+
* untouched and is never (re)activated. On Reddit Ads:
|
|
54274
|
+
* creates a new ad group and the ad under this EXISTING
|
|
54275
|
+
* campaign; `goal` may be omitted (the campaign's objective
|
|
54276
|
+
* decides it) and any other goal returns 400 naming the one to
|
|
54277
|
+
* send. The ad group must start no earlier than a future
|
|
54278
|
+
* campaign start and end no later than the campaign end
|
|
54279
|
+
* (400 otherwise); without `endDate` it ends with the
|
|
54280
|
+
* campaign. When the campaign has
|
|
54281
|
+
* no campaign budget, send `budgetAmount`/`budgetType` for the
|
|
54282
|
+
* new ad group (400 without them); bid, conversion event and
|
|
54283
|
+
* pixel work as on a new campaign. Under campaign budget
|
|
54284
|
+
* optimization the ad group takes the campaign's bid,
|
|
54285
|
+
* goal type, optimization event and pixel, carries no budget
|
|
54286
|
+
* of its own (a budget in the request is not applied), and
|
|
54287
|
+
* bid fields or another conversion event or pixel return
|
|
54288
|
+
* 400, as does an `endDate` when the campaign has no end
|
|
54289
|
+
* date. A
|
|
54290
|
+
* campaign of another ad account returns 404, a Reddit Max
|
|
54291
|
+
* campaign 422. If the ad fails, the new ad group is
|
|
54292
|
+
* archived. Mutually exclusive with `adSetId` and `creatives[]`.
|
|
54225
54293
|
*
|
|
54226
54294
|
*/
|
|
54227
54295
|
existingCampaignId?: string;
|
|
@@ -57874,6 +57942,74 @@ export type RemoveCustomConversionGoalResponse = ({
|
|
|
57874
57942
|
|
|
57875
57943
|
export type RemoveCustomConversionGoalError = (ErrorResponse | unknown);
|
|
57876
57944
|
|
|
57945
|
+
export type ListEventsData = {
|
|
57946
|
+
query: {
|
|
57947
|
+
/**
|
|
57948
|
+
* `nextCursor` from the previous page.
|
|
57949
|
+
*/
|
|
57950
|
+
cursor?: string;
|
|
57951
|
+
/**
|
|
57952
|
+
* Only events with this name, such as `Purchase`.
|
|
57953
|
+
*/
|
|
57954
|
+
eventName?: string;
|
|
57955
|
+
/**
|
|
57956
|
+
* Only events at or after this time (ISO 8601, on the event time).
|
|
57957
|
+
*/
|
|
57958
|
+
from?: string;
|
|
57959
|
+
limit?: number;
|
|
57960
|
+
profileId: string;
|
|
57961
|
+
/**
|
|
57962
|
+
* Only events before this time (ISO 8601, on the event time).
|
|
57963
|
+
*/
|
|
57964
|
+
to?: string;
|
|
57965
|
+
};
|
|
57966
|
+
};
|
|
57967
|
+
|
|
57968
|
+
export type ListEventsResponse = ({
|
|
57969
|
+
events?: Array<{
|
|
57970
|
+
eventId?: string;
|
|
57971
|
+
eventName?: string;
|
|
57972
|
+
eventTime?: string;
|
|
57973
|
+
receivedAt?: string;
|
|
57974
|
+
actionSource?: (string) | null;
|
|
57975
|
+
value?: (number) | null;
|
|
57976
|
+
currency?: (string) | null;
|
|
57977
|
+
/**
|
|
57978
|
+
* Origin, path and attribution parameters only.
|
|
57979
|
+
*/
|
|
57980
|
+
sourceUrl?: (string) | null;
|
|
57981
|
+
utm?: {
|
|
57982
|
+
source?: (string) | null;
|
|
57983
|
+
medium?: (string) | null;
|
|
57984
|
+
campaign?: (string) | null;
|
|
57985
|
+
content?: (string) | null;
|
|
57986
|
+
};
|
|
57987
|
+
/**
|
|
57988
|
+
* Ad ID from the `zrn` parameter Zernio adds to links of ads it creates.
|
|
57989
|
+
*/
|
|
57990
|
+
zrn?: (string) | null;
|
|
57991
|
+
clickIds?: {
|
|
57992
|
+
gclid?: (string) | null;
|
|
57993
|
+
fbc?: (string) | null;
|
|
57994
|
+
};
|
|
57995
|
+
/**
|
|
57996
|
+
* Destinations the event was forwarded to.
|
|
57997
|
+
*/
|
|
57998
|
+
destinationsSent?: number;
|
|
57999
|
+
hasEmail?: boolean;
|
|
58000
|
+
hasPhone?: boolean;
|
|
58001
|
+
hasExternalId?: boolean;
|
|
58002
|
+
}>;
|
|
58003
|
+
/**
|
|
58004
|
+
* Pass as `cursor` to get the next page; `null` on the last page.
|
|
58005
|
+
*/
|
|
58006
|
+
nextCursor?: (string) | null;
|
|
58007
|
+
});
|
|
58008
|
+
|
|
58009
|
+
export type ListEventsError = (ErrorResponse | {
|
|
58010
|
+
error?: string;
|
|
58011
|
+
});
|
|
58012
|
+
|
|
57877
58013
|
export type SendEventsData = {
|
|
57878
58014
|
body: {
|
|
57879
58015
|
/**
|