@getlatedev/node 0.2.355 → 0.2.357
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 +175 -10
- package/dist/index.d.ts +175 -10
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/types.gen.ts +175 -10
package/dist/index.d.mts
CHANGED
|
@@ -961,7 +961,7 @@ type Ad = {
|
|
|
961
961
|
/**
|
|
962
962
|
* Available goals vary by platform. Meta (Facebook/Instagram) supports all 9 (incl. `lead_conversion` = website pixel lead optimization and `catalog_sales` = Advantage+ catalog ads). TikTok supports the 7 non-`lead_conversion` goals. LinkedIn supports all except app_promotion / lead_conversion. Twitter/X supports engagement, traffic, awareness, video_views, app_promotion. Pinterest and Google Ads support only engagement, traffic, awareness, video_views.
|
|
963
963
|
*/
|
|
964
|
-
goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales';
|
|
964
|
+
goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'job_applicants';
|
|
965
965
|
/**
|
|
966
966
|
* True for ads synced from platform ad managers
|
|
967
967
|
*/
|
|
@@ -1154,7 +1154,7 @@ type adType = 'boost' | 'standalone';
|
|
|
1154
1154
|
/**
|
|
1155
1155
|
* Available goals vary by platform. Meta (Facebook/Instagram) supports all 9 (incl. `lead_conversion` = website pixel lead optimization and `catalog_sales` = Advantage+ catalog ads). TikTok supports the 7 non-`lead_conversion` goals. LinkedIn supports all except app_promotion / lead_conversion. Twitter/X supports engagement, traffic, awareness, video_views, app_promotion. Pinterest and Google Ads support only engagement, traffic, awareness, video_views.
|
|
1156
1156
|
*/
|
|
1157
|
-
type goal = 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales';
|
|
1157
|
+
type goal = 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'job_applicants';
|
|
1158
1158
|
type type = 'daily' | 'lifetime';
|
|
1159
1159
|
/**
|
|
1160
1160
|
* Budget amount in the ad account's native currency (see the campaign's `currency` field for the code).
|
|
@@ -3389,6 +3389,43 @@ type LinkedInAdsPlatformData = {
|
|
|
3389
3389
|
*/
|
|
3390
3390
|
showMemberProfilePhoto?: boolean;
|
|
3391
3391
|
};
|
|
3392
|
+
/**
|
|
3393
|
+
* POST /v1/ads/create only. Dynamic Jobs Ad promoting your open roles,
|
|
3394
|
+
* personalized with the viewer's profile photo. Requires goal
|
|
3395
|
+
* job_applicants and a Company Page with active job postings.
|
|
3396
|
+
* headline and buttonLabel take exactly one of
|
|
3397
|
+
* preApproved or custom. logoUrl and organizationName default to the
|
|
3398
|
+
* Company Page's. Mutually exclusive with the other creative sources.
|
|
3399
|
+
*
|
|
3400
|
+
*/
|
|
3401
|
+
jobs?: {
|
|
3402
|
+
headline: {
|
|
3403
|
+
/**
|
|
3404
|
+
* LinkedIn preset id, not reviewed. Example MEMBER_READY_FOR_YOUR_DREAM_JOB.
|
|
3405
|
+
*/
|
|
3406
|
+
preApproved?: string;
|
|
3407
|
+
/**
|
|
3408
|
+
* Free text, reviewed by LinkedIn.
|
|
3409
|
+
*/
|
|
3410
|
+
custom?: string;
|
|
3411
|
+
};
|
|
3412
|
+
buttonLabel: {
|
|
3413
|
+
/**
|
|
3414
|
+
* LinkedIn preset id, not reviewed. One of SEE_MORE_JOBS, VIEW_MORE, CAREERS_AT_COMPANY.
|
|
3415
|
+
*/
|
|
3416
|
+
preApproved?: string;
|
|
3417
|
+
/**
|
|
3418
|
+
* Free text, reviewed by LinkedIn.
|
|
3419
|
+
*/
|
|
3420
|
+
custom?: string;
|
|
3421
|
+
};
|
|
3422
|
+
logoUrl?: string;
|
|
3423
|
+
organizationName?: string;
|
|
3424
|
+
/**
|
|
3425
|
+
* Defaults to true.
|
|
3426
|
+
*/
|
|
3427
|
+
showMemberProfilePhoto?: boolean;
|
|
3428
|
+
};
|
|
3392
3429
|
/**
|
|
3393
3430
|
* POST /v1/ads/create only. Classic right-rail Text Ad. The copy lives
|
|
3394
3431
|
* here; ad-level body and headline are not used. Mutually exclusive
|
|
@@ -3404,6 +3441,57 @@ type LinkedInAdsPlatformData = {
|
|
|
3404
3441
|
*/
|
|
3405
3442
|
imageUrl?: string;
|
|
3406
3443
|
};
|
|
3444
|
+
/**
|
|
3445
|
+
* POST /v1/ads/create only. Conversation Ad: a choose-your-path message
|
|
3446
|
+
* tree delivered to the member's LinkedIn inbox. Messages are flat
|
|
3447
|
+
* nodes wired by local ids; each button either opens a url or leads to
|
|
3448
|
+
* nextMessageId. Cycles, unknown ids and a missing firstMessageId
|
|
3449
|
+
* return a 400. LinkedIn does not deliver message ads to EU members.
|
|
3450
|
+
* Mutually exclusive with the other creative sources.
|
|
3451
|
+
*
|
|
3452
|
+
*/
|
|
3453
|
+
conversation?: {
|
|
3454
|
+
/**
|
|
3455
|
+
* InMail subject shown in the inbox.
|
|
3456
|
+
*/
|
|
3457
|
+
subject: string;
|
|
3458
|
+
/**
|
|
3459
|
+
* Person or organization URN. Defaults to the authoring Company
|
|
3460
|
+
* Page. The sender must be approved for the ad account first
|
|
3461
|
+
* (Campaign Manager > Manage message ad senders) or LinkedIn
|
|
3462
|
+
* rejects the create with SINMAIL_SENDER_NOT_APPROVED.
|
|
3463
|
+
*
|
|
3464
|
+
*/
|
|
3465
|
+
sender?: string;
|
|
3466
|
+
/**
|
|
3467
|
+
* Optional intro body (HTML allowed).
|
|
3468
|
+
*/
|
|
3469
|
+
body?: string;
|
|
3470
|
+
/**
|
|
3471
|
+
* Terms shown at the bottom of the message.
|
|
3472
|
+
*/
|
|
3473
|
+
footer?: string;
|
|
3474
|
+
/**
|
|
3475
|
+
* Conversation headline. Defaults to the first message's first line.
|
|
3476
|
+
*/
|
|
3477
|
+
headline?: string;
|
|
3478
|
+
firstMessageId: string;
|
|
3479
|
+
messages: Array<{
|
|
3480
|
+
id: string;
|
|
3481
|
+
text: string;
|
|
3482
|
+
buttons?: Array<{
|
|
3483
|
+
text: string;
|
|
3484
|
+
/**
|
|
3485
|
+
* Continues the conversation at this message. Exactly one of nextMessageId or url.
|
|
3486
|
+
*/
|
|
3487
|
+
nextMessageId?: string;
|
|
3488
|
+
/**
|
|
3489
|
+
* Opens this landing page. Exactly one of nextMessageId or url.
|
|
3490
|
+
*/
|
|
3491
|
+
url?: string;
|
|
3492
|
+
}>;
|
|
3493
|
+
}>;
|
|
3494
|
+
};
|
|
3407
3495
|
/**
|
|
3408
3496
|
* POST /v1/ads/create only. Promotes an existing LinkedIn Event; no
|
|
3409
3497
|
* headline needed. Mutually exclusive with the other creative sources.
|
|
@@ -22659,7 +22747,16 @@ type GetCampaignAnalyticsData = {
|
|
|
22659
22747
|
};
|
|
22660
22748
|
query?: {
|
|
22661
22749
|
/**
|
|
22662
|
-
* Comma-separated breakdown dimensions
|
|
22750
|
+
* Comma-separated breakdown dimensions.
|
|
22751
|
+
*
|
|
22752
|
+
* **Meta**: age, gender, country, publisher_platform, device_platform, region,
|
|
22753
|
+
* platform_position, impression_device, video_asset, image_asset, body_asset, title_asset.
|
|
22754
|
+
*
|
|
22755
|
+
* **LinkedIn** (firmographics): job_title, job_function, seniority, industry,
|
|
22756
|
+
* company, company_size, country, region. Rows carry the raw pivot `value`
|
|
22757
|
+
* plus a resolved `name`. LinkedIn serves these aggregated over the whole
|
|
22758
|
+
* range, delays the data 12-24h, and omits segments with fewer than 3 events.
|
|
22759
|
+
*
|
|
22663
22760
|
*/
|
|
22664
22761
|
breakdowns?: string;
|
|
22665
22762
|
/**
|
|
@@ -22715,7 +22812,17 @@ type GetAdAnalyticsData = {
|
|
|
22715
22812
|
};
|
|
22716
22813
|
query?: {
|
|
22717
22814
|
/**
|
|
22718
|
-
* Comma-separated breakdown dimensions.
|
|
22815
|
+
* Comma-separated breakdown dimensions.
|
|
22816
|
+
*
|
|
22817
|
+
* **Meta**: age, gender, country, publisher_platform, device_platform, region.
|
|
22818
|
+
*
|
|
22819
|
+
* **TikTok**: gender, age, country_code, platform, ac, language.
|
|
22820
|
+
*
|
|
22821
|
+
* **LinkedIn** (firmographics): job_title, job_function, seniority, industry,
|
|
22822
|
+
* company, company_size, country, region. Rows carry the raw pivot `value`
|
|
22823
|
+
* plus a resolved `name`. LinkedIn serves these aggregated over the whole
|
|
22824
|
+
* range, delays the data 12-24h, and omits segments with fewer than 3 events.
|
|
22825
|
+
*
|
|
22719
22826
|
*/
|
|
22720
22827
|
breakdowns?: string;
|
|
22721
22828
|
/**
|
|
@@ -23246,9 +23353,25 @@ type CreateStandaloneAdData = {
|
|
|
23246
23353
|
}>;
|
|
23247
23354
|
};
|
|
23248
23355
|
/**
|
|
23249
|
-
* Required on legacy
|
|
23356
|
+
* Required on legacy and multi-creative shapes; the attach shape inherits it from the ad set. Available goals vary by platform.
|
|
23357
|
+
*
|
|
23358
|
+
* **Meta**
|
|
23359
|
+
* - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL.
|
|
23360
|
+
* - `lead_conversion`: OUTCOME_LEADS optimizing website pixel leads. Same pixel and event fields, but with a leads-class event such as LEAD, SUBMIT_APPLICATION, SCHEDULE or CONTACT. Meta gates conversion events by objective, so leads-class events are rejected under `conversions`.
|
|
23361
|
+
* - `lead_generation`: OUTCOME_LEADS with instant forms. Requires `leadGenFormId`. `promotedObject.pageId` is optional and auto-filled from the connected Page.
|
|
23362
|
+
* - `app_promotion`: requires `promotedObject.applicationId` and `promotedObject.objectStoreUrl`.
|
|
23363
|
+
* - `catalog_sales`: Advantage+ catalog ads, for example vehicle inventory. Requires `promotedObject.productSetId`, `promotedObject.pixelId` and `promotedObject.customEventType`. Builds a catalog TEMPLATE creative from the copy fields, which may carry template tags like {{product.name}} or {{vehicle.make}}. No imageUrl or video is sent; Meta renders the visuals per catalog item. Discover catalogs via GET /v1/ads/catalogs and product sets via GET /v1/ads/catalogs/{catalogId}/product-sets. Single shape only, no creatives[], adSetId, dynamicCreative or placementAssets.
|
|
23364
|
+
*
|
|
23365
|
+
* **TikTok**
|
|
23366
|
+
* - `conversions`: website-conversion ad group. Requires `promotedObject.pixelId`, your TikTok Pixel ID. Accepts an optional `promotedObject.customEventType` with a TikTok optimization_event code such as ON_WEB_ORDER, INITIATE_ORDER, ON_WEB_REGISTER or FORM. To inherit pixel and event from an existing ad group, pass `adSetId` instead.
|
|
23367
|
+
*
|
|
23368
|
+
* **LinkedIn**
|
|
23369
|
+
* - `engagement`, `traffic`, `awareness` and `video_views` create standalone Direct Sponsored Content ads. `traffic` requires `linkUrl`; `video_views` requires `video`.
|
|
23370
|
+
* - `job_applicants` requires a `platformSpecificData.jobs` creative.
|
|
23371
|
+
* - For `lead_generation` or `conversions` on LinkedIn, or to promote an existing post, use POST /v1/ads/boost.
|
|
23372
|
+
*
|
|
23250
23373
|
*/
|
|
23251
|
-
goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales';
|
|
23374
|
+
goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'job_applicants';
|
|
23252
23375
|
/**
|
|
23253
23376
|
* Meta only. Explicit ad-set `optimization_goal` (e.g. `LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `REACH`, `IMPRESSIONS`, `OFFSITE_CONVERSIONS`, `THRUPLAY`, `LEAD_GENERATION`). Overrides the default derived from `goal` (e.g. `traffic` defaults to `LINK_CLICKS`). Forwarded verbatim to Meta, which validates compatibility with the campaign objective and rejects incompatible combinations.
|
|
23254
23377
|
*/
|
|
@@ -24333,9 +24456,9 @@ type ListAdAudiencesData = {
|
|
|
24333
24456
|
adAccountId: string;
|
|
24334
24457
|
platform?: 'facebook' | 'instagram' | 'googleads' | 'tiktok' | 'tiktokads' | 'pinterest' | 'linkedin' | 'linkedinads' | 'twitter' | 'xads';
|
|
24335
24458
|
/**
|
|
24336
|
-
* Filter to one audience type. `saved_targeting` returns stored TargetingSpec audiences
|
|
24459
|
+
* Filter to one audience type. `saved_targeting` returns stored TargetingSpec audiences; the other types return uploaded/derived audiences.
|
|
24337
24460
|
*/
|
|
24338
|
-
type?: 'customer_list' | 'website' | 'lookalike' | 'saved_targeting';
|
|
24461
|
+
type?: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'lookalike' | 'saved_targeting';
|
|
24339
24462
|
};
|
|
24340
24463
|
};
|
|
24341
24464
|
type ListAdAudiencesResponse = ({
|
|
@@ -24348,7 +24471,7 @@ type ListAdAudiencesResponse = ({
|
|
|
24348
24471
|
platformAudienceId?: string;
|
|
24349
24472
|
name?: string;
|
|
24350
24473
|
description?: string;
|
|
24351
|
-
type?: 'customer_list' | 'website' | 'lookalike' | 'saved_targeting';
|
|
24474
|
+
type?: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'lookalike' | 'saved_targeting';
|
|
24352
24475
|
/**
|
|
24353
24476
|
* Present (and the only meaningful payload) when `type` is `saved_targeting`. Null for uploaded/derived audience types.
|
|
24354
24477
|
*/
|
|
@@ -24370,7 +24493,49 @@ type CreateAdAudienceData = {
|
|
|
24370
24493
|
adAccountId: string;
|
|
24371
24494
|
name: string;
|
|
24372
24495
|
description?: string;
|
|
24373
|
-
type: 'customer_list' | 'website' | 'lookalike';
|
|
24496
|
+
type: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'lookalike';
|
|
24497
|
+
/**
|
|
24498
|
+
* Required for engagement audiences (LinkedIn only): what
|
|
24499
|
+
* members engaged with — a video/leadgen/single-image ad
|
|
24500
|
+
* campaign, a Company Page or an Event page.
|
|
24501
|
+
*
|
|
24502
|
+
*/
|
|
24503
|
+
sourceType?: 'VIDEO_ADS' | 'LEAD_GEN_FORMS' | 'ORGANIZATION_PAGES' | 'EVENT_PAGES' | 'SINGLE_IMAGE_ADS';
|
|
24504
|
+
/**
|
|
24505
|
+
* Required for engagement audiences. The action, validated
|
|
24506
|
+
* by LinkedIn against `sourceType`. Common values:
|
|
24507
|
+
* VIDEO_ADS FIRST_QUARTILE / MIDPOINT / THIRD_QUARTILE /
|
|
24508
|
+
* FULL_COMPLETE; LEAD_GEN_FORMS VIEW_FORM /
|
|
24509
|
+
* LEAD_FORM_SUBMIT; ORGANIZATION_PAGES VIEW / CTA_CLICK;
|
|
24510
|
+
* EVENT_PAGES RSVPED / VIDEO_VIEWED / ENGAGEMENT / CLICK.
|
|
24511
|
+
*
|
|
24512
|
+
*/
|
|
24513
|
+
trigger?: string;
|
|
24514
|
+
/**
|
|
24515
|
+
* Required for engagement audiences. Rolling window.
|
|
24516
|
+
*/
|
|
24517
|
+
lookbackDays?: 30 | 60 | 90 | 180 | 365;
|
|
24518
|
+
/**
|
|
24519
|
+
* Required for engagement audiences. Campaign URNs for the
|
|
24520
|
+
* ad source types, organization URNs for pages and events.
|
|
24521
|
+
* LinkedIn creates one rule per source, all sharing the
|
|
24522
|
+
* same trigger and lookbackDays.
|
|
24523
|
+
*
|
|
24524
|
+
*/
|
|
24525
|
+
engagementSources?: Array<(string)>;
|
|
24526
|
+
/**
|
|
24527
|
+
* Required for company_list audiences (LinkedIn only): plain-text
|
|
24528
|
+
* company rows for account targeting. Each row needs at least one
|
|
24529
|
+
* identifier. LinkedIn recommends 1,000+ companies for a usable
|
|
24530
|
+
* match rate and takes up to 48h to process the list.
|
|
24531
|
+
*
|
|
24532
|
+
*/
|
|
24533
|
+
companies?: Array<{
|
|
24534
|
+
name?: string;
|
|
24535
|
+
domain?: string;
|
|
24536
|
+
website?: string;
|
|
24537
|
+
linkedinPageUrl?: string;
|
|
24538
|
+
}>;
|
|
24374
24539
|
/**
|
|
24375
24540
|
* Required for website audiences
|
|
24376
24541
|
*/
|
package/dist/index.d.ts
CHANGED
|
@@ -961,7 +961,7 @@ type Ad = {
|
|
|
961
961
|
/**
|
|
962
962
|
* Available goals vary by platform. Meta (Facebook/Instagram) supports all 9 (incl. `lead_conversion` = website pixel lead optimization and `catalog_sales` = Advantage+ catalog ads). TikTok supports the 7 non-`lead_conversion` goals. LinkedIn supports all except app_promotion / lead_conversion. Twitter/X supports engagement, traffic, awareness, video_views, app_promotion. Pinterest and Google Ads support only engagement, traffic, awareness, video_views.
|
|
963
963
|
*/
|
|
964
|
-
goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales';
|
|
964
|
+
goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'job_applicants';
|
|
965
965
|
/**
|
|
966
966
|
* True for ads synced from platform ad managers
|
|
967
967
|
*/
|
|
@@ -1154,7 +1154,7 @@ type adType = 'boost' | 'standalone';
|
|
|
1154
1154
|
/**
|
|
1155
1155
|
* Available goals vary by platform. Meta (Facebook/Instagram) supports all 9 (incl. `lead_conversion` = website pixel lead optimization and `catalog_sales` = Advantage+ catalog ads). TikTok supports the 7 non-`lead_conversion` goals. LinkedIn supports all except app_promotion / lead_conversion. Twitter/X supports engagement, traffic, awareness, video_views, app_promotion. Pinterest and Google Ads support only engagement, traffic, awareness, video_views.
|
|
1156
1156
|
*/
|
|
1157
|
-
type goal = 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales';
|
|
1157
|
+
type goal = 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'job_applicants';
|
|
1158
1158
|
type type = 'daily' | 'lifetime';
|
|
1159
1159
|
/**
|
|
1160
1160
|
* Budget amount in the ad account's native currency (see the campaign's `currency` field for the code).
|
|
@@ -3389,6 +3389,43 @@ type LinkedInAdsPlatformData = {
|
|
|
3389
3389
|
*/
|
|
3390
3390
|
showMemberProfilePhoto?: boolean;
|
|
3391
3391
|
};
|
|
3392
|
+
/**
|
|
3393
|
+
* POST /v1/ads/create only. Dynamic Jobs Ad promoting your open roles,
|
|
3394
|
+
* personalized with the viewer's profile photo. Requires goal
|
|
3395
|
+
* job_applicants and a Company Page with active job postings.
|
|
3396
|
+
* headline and buttonLabel take exactly one of
|
|
3397
|
+
* preApproved or custom. logoUrl and organizationName default to the
|
|
3398
|
+
* Company Page's. Mutually exclusive with the other creative sources.
|
|
3399
|
+
*
|
|
3400
|
+
*/
|
|
3401
|
+
jobs?: {
|
|
3402
|
+
headline: {
|
|
3403
|
+
/**
|
|
3404
|
+
* LinkedIn preset id, not reviewed. Example MEMBER_READY_FOR_YOUR_DREAM_JOB.
|
|
3405
|
+
*/
|
|
3406
|
+
preApproved?: string;
|
|
3407
|
+
/**
|
|
3408
|
+
* Free text, reviewed by LinkedIn.
|
|
3409
|
+
*/
|
|
3410
|
+
custom?: string;
|
|
3411
|
+
};
|
|
3412
|
+
buttonLabel: {
|
|
3413
|
+
/**
|
|
3414
|
+
* LinkedIn preset id, not reviewed. One of SEE_MORE_JOBS, VIEW_MORE, CAREERS_AT_COMPANY.
|
|
3415
|
+
*/
|
|
3416
|
+
preApproved?: string;
|
|
3417
|
+
/**
|
|
3418
|
+
* Free text, reviewed by LinkedIn.
|
|
3419
|
+
*/
|
|
3420
|
+
custom?: string;
|
|
3421
|
+
};
|
|
3422
|
+
logoUrl?: string;
|
|
3423
|
+
organizationName?: string;
|
|
3424
|
+
/**
|
|
3425
|
+
* Defaults to true.
|
|
3426
|
+
*/
|
|
3427
|
+
showMemberProfilePhoto?: boolean;
|
|
3428
|
+
};
|
|
3392
3429
|
/**
|
|
3393
3430
|
* POST /v1/ads/create only. Classic right-rail Text Ad. The copy lives
|
|
3394
3431
|
* here; ad-level body and headline are not used. Mutually exclusive
|
|
@@ -3404,6 +3441,57 @@ type LinkedInAdsPlatformData = {
|
|
|
3404
3441
|
*/
|
|
3405
3442
|
imageUrl?: string;
|
|
3406
3443
|
};
|
|
3444
|
+
/**
|
|
3445
|
+
* POST /v1/ads/create only. Conversation Ad: a choose-your-path message
|
|
3446
|
+
* tree delivered to the member's LinkedIn inbox. Messages are flat
|
|
3447
|
+
* nodes wired by local ids; each button either opens a url or leads to
|
|
3448
|
+
* nextMessageId. Cycles, unknown ids and a missing firstMessageId
|
|
3449
|
+
* return a 400. LinkedIn does not deliver message ads to EU members.
|
|
3450
|
+
* Mutually exclusive with the other creative sources.
|
|
3451
|
+
*
|
|
3452
|
+
*/
|
|
3453
|
+
conversation?: {
|
|
3454
|
+
/**
|
|
3455
|
+
* InMail subject shown in the inbox.
|
|
3456
|
+
*/
|
|
3457
|
+
subject: string;
|
|
3458
|
+
/**
|
|
3459
|
+
* Person or organization URN. Defaults to the authoring Company
|
|
3460
|
+
* Page. The sender must be approved for the ad account first
|
|
3461
|
+
* (Campaign Manager > Manage message ad senders) or LinkedIn
|
|
3462
|
+
* rejects the create with SINMAIL_SENDER_NOT_APPROVED.
|
|
3463
|
+
*
|
|
3464
|
+
*/
|
|
3465
|
+
sender?: string;
|
|
3466
|
+
/**
|
|
3467
|
+
* Optional intro body (HTML allowed).
|
|
3468
|
+
*/
|
|
3469
|
+
body?: string;
|
|
3470
|
+
/**
|
|
3471
|
+
* Terms shown at the bottom of the message.
|
|
3472
|
+
*/
|
|
3473
|
+
footer?: string;
|
|
3474
|
+
/**
|
|
3475
|
+
* Conversation headline. Defaults to the first message's first line.
|
|
3476
|
+
*/
|
|
3477
|
+
headline?: string;
|
|
3478
|
+
firstMessageId: string;
|
|
3479
|
+
messages: Array<{
|
|
3480
|
+
id: string;
|
|
3481
|
+
text: string;
|
|
3482
|
+
buttons?: Array<{
|
|
3483
|
+
text: string;
|
|
3484
|
+
/**
|
|
3485
|
+
* Continues the conversation at this message. Exactly one of nextMessageId or url.
|
|
3486
|
+
*/
|
|
3487
|
+
nextMessageId?: string;
|
|
3488
|
+
/**
|
|
3489
|
+
* Opens this landing page. Exactly one of nextMessageId or url.
|
|
3490
|
+
*/
|
|
3491
|
+
url?: string;
|
|
3492
|
+
}>;
|
|
3493
|
+
}>;
|
|
3494
|
+
};
|
|
3407
3495
|
/**
|
|
3408
3496
|
* POST /v1/ads/create only. Promotes an existing LinkedIn Event; no
|
|
3409
3497
|
* headline needed. Mutually exclusive with the other creative sources.
|
|
@@ -22659,7 +22747,16 @@ type GetCampaignAnalyticsData = {
|
|
|
22659
22747
|
};
|
|
22660
22748
|
query?: {
|
|
22661
22749
|
/**
|
|
22662
|
-
* Comma-separated breakdown dimensions
|
|
22750
|
+
* Comma-separated breakdown dimensions.
|
|
22751
|
+
*
|
|
22752
|
+
* **Meta**: age, gender, country, publisher_platform, device_platform, region,
|
|
22753
|
+
* platform_position, impression_device, video_asset, image_asset, body_asset, title_asset.
|
|
22754
|
+
*
|
|
22755
|
+
* **LinkedIn** (firmographics): job_title, job_function, seniority, industry,
|
|
22756
|
+
* company, company_size, country, region. Rows carry the raw pivot `value`
|
|
22757
|
+
* plus a resolved `name`. LinkedIn serves these aggregated over the whole
|
|
22758
|
+
* range, delays the data 12-24h, and omits segments with fewer than 3 events.
|
|
22759
|
+
*
|
|
22663
22760
|
*/
|
|
22664
22761
|
breakdowns?: string;
|
|
22665
22762
|
/**
|
|
@@ -22715,7 +22812,17 @@ type GetAdAnalyticsData = {
|
|
|
22715
22812
|
};
|
|
22716
22813
|
query?: {
|
|
22717
22814
|
/**
|
|
22718
|
-
* Comma-separated breakdown dimensions.
|
|
22815
|
+
* Comma-separated breakdown dimensions.
|
|
22816
|
+
*
|
|
22817
|
+
* **Meta**: age, gender, country, publisher_platform, device_platform, region.
|
|
22818
|
+
*
|
|
22819
|
+
* **TikTok**: gender, age, country_code, platform, ac, language.
|
|
22820
|
+
*
|
|
22821
|
+
* **LinkedIn** (firmographics): job_title, job_function, seniority, industry,
|
|
22822
|
+
* company, company_size, country, region. Rows carry the raw pivot `value`
|
|
22823
|
+
* plus a resolved `name`. LinkedIn serves these aggregated over the whole
|
|
22824
|
+
* range, delays the data 12-24h, and omits segments with fewer than 3 events.
|
|
22825
|
+
*
|
|
22719
22826
|
*/
|
|
22720
22827
|
breakdowns?: string;
|
|
22721
22828
|
/**
|
|
@@ -23246,9 +23353,25 @@ type CreateStandaloneAdData = {
|
|
|
23246
23353
|
}>;
|
|
23247
23354
|
};
|
|
23248
23355
|
/**
|
|
23249
|
-
* Required on legacy
|
|
23356
|
+
* Required on legacy and multi-creative shapes; the attach shape inherits it from the ad set. Available goals vary by platform.
|
|
23357
|
+
*
|
|
23358
|
+
* **Meta**
|
|
23359
|
+
* - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL.
|
|
23360
|
+
* - `lead_conversion`: OUTCOME_LEADS optimizing website pixel leads. Same pixel and event fields, but with a leads-class event such as LEAD, SUBMIT_APPLICATION, SCHEDULE or CONTACT. Meta gates conversion events by objective, so leads-class events are rejected under `conversions`.
|
|
23361
|
+
* - `lead_generation`: OUTCOME_LEADS with instant forms. Requires `leadGenFormId`. `promotedObject.pageId` is optional and auto-filled from the connected Page.
|
|
23362
|
+
* - `app_promotion`: requires `promotedObject.applicationId` and `promotedObject.objectStoreUrl`.
|
|
23363
|
+
* - `catalog_sales`: Advantage+ catalog ads, for example vehicle inventory. Requires `promotedObject.productSetId`, `promotedObject.pixelId` and `promotedObject.customEventType`. Builds a catalog TEMPLATE creative from the copy fields, which may carry template tags like {{product.name}} or {{vehicle.make}}. No imageUrl or video is sent; Meta renders the visuals per catalog item. Discover catalogs via GET /v1/ads/catalogs and product sets via GET /v1/ads/catalogs/{catalogId}/product-sets. Single shape only, no creatives[], adSetId, dynamicCreative or placementAssets.
|
|
23364
|
+
*
|
|
23365
|
+
* **TikTok**
|
|
23366
|
+
* - `conversions`: website-conversion ad group. Requires `promotedObject.pixelId`, your TikTok Pixel ID. Accepts an optional `promotedObject.customEventType` with a TikTok optimization_event code such as ON_WEB_ORDER, INITIATE_ORDER, ON_WEB_REGISTER or FORM. To inherit pixel and event from an existing ad group, pass `adSetId` instead.
|
|
23367
|
+
*
|
|
23368
|
+
* **LinkedIn**
|
|
23369
|
+
* - `engagement`, `traffic`, `awareness` and `video_views` create standalone Direct Sponsored Content ads. `traffic` requires `linkUrl`; `video_views` requires `video`.
|
|
23370
|
+
* - `job_applicants` requires a `platformSpecificData.jobs` creative.
|
|
23371
|
+
* - For `lead_generation` or `conversions` on LinkedIn, or to promote an existing post, use POST /v1/ads/boost.
|
|
23372
|
+
*
|
|
23250
23373
|
*/
|
|
23251
|
-
goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales';
|
|
23374
|
+
goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'job_applicants';
|
|
23252
23375
|
/**
|
|
23253
23376
|
* Meta only. Explicit ad-set `optimization_goal` (e.g. `LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `REACH`, `IMPRESSIONS`, `OFFSITE_CONVERSIONS`, `THRUPLAY`, `LEAD_GENERATION`). Overrides the default derived from `goal` (e.g. `traffic` defaults to `LINK_CLICKS`). Forwarded verbatim to Meta, which validates compatibility with the campaign objective and rejects incompatible combinations.
|
|
23254
23377
|
*/
|
|
@@ -24333,9 +24456,9 @@ type ListAdAudiencesData = {
|
|
|
24333
24456
|
adAccountId: string;
|
|
24334
24457
|
platform?: 'facebook' | 'instagram' | 'googleads' | 'tiktok' | 'tiktokads' | 'pinterest' | 'linkedin' | 'linkedinads' | 'twitter' | 'xads';
|
|
24335
24458
|
/**
|
|
24336
|
-
* Filter to one audience type. `saved_targeting` returns stored TargetingSpec audiences
|
|
24459
|
+
* Filter to one audience type. `saved_targeting` returns stored TargetingSpec audiences; the other types return uploaded/derived audiences.
|
|
24337
24460
|
*/
|
|
24338
|
-
type?: 'customer_list' | 'website' | 'lookalike' | 'saved_targeting';
|
|
24461
|
+
type?: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'lookalike' | 'saved_targeting';
|
|
24339
24462
|
};
|
|
24340
24463
|
};
|
|
24341
24464
|
type ListAdAudiencesResponse = ({
|
|
@@ -24348,7 +24471,7 @@ type ListAdAudiencesResponse = ({
|
|
|
24348
24471
|
platformAudienceId?: string;
|
|
24349
24472
|
name?: string;
|
|
24350
24473
|
description?: string;
|
|
24351
|
-
type?: 'customer_list' | 'website' | 'lookalike' | 'saved_targeting';
|
|
24474
|
+
type?: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'lookalike' | 'saved_targeting';
|
|
24352
24475
|
/**
|
|
24353
24476
|
* Present (and the only meaningful payload) when `type` is `saved_targeting`. Null for uploaded/derived audience types.
|
|
24354
24477
|
*/
|
|
@@ -24370,7 +24493,49 @@ type CreateAdAudienceData = {
|
|
|
24370
24493
|
adAccountId: string;
|
|
24371
24494
|
name: string;
|
|
24372
24495
|
description?: string;
|
|
24373
|
-
type: 'customer_list' | 'website' | 'lookalike';
|
|
24496
|
+
type: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'lookalike';
|
|
24497
|
+
/**
|
|
24498
|
+
* Required for engagement audiences (LinkedIn only): what
|
|
24499
|
+
* members engaged with — a video/leadgen/single-image ad
|
|
24500
|
+
* campaign, a Company Page or an Event page.
|
|
24501
|
+
*
|
|
24502
|
+
*/
|
|
24503
|
+
sourceType?: 'VIDEO_ADS' | 'LEAD_GEN_FORMS' | 'ORGANIZATION_PAGES' | 'EVENT_PAGES' | 'SINGLE_IMAGE_ADS';
|
|
24504
|
+
/**
|
|
24505
|
+
* Required for engagement audiences. The action, validated
|
|
24506
|
+
* by LinkedIn against `sourceType`. Common values:
|
|
24507
|
+
* VIDEO_ADS FIRST_QUARTILE / MIDPOINT / THIRD_QUARTILE /
|
|
24508
|
+
* FULL_COMPLETE; LEAD_GEN_FORMS VIEW_FORM /
|
|
24509
|
+
* LEAD_FORM_SUBMIT; ORGANIZATION_PAGES VIEW / CTA_CLICK;
|
|
24510
|
+
* EVENT_PAGES RSVPED / VIDEO_VIEWED / ENGAGEMENT / CLICK.
|
|
24511
|
+
*
|
|
24512
|
+
*/
|
|
24513
|
+
trigger?: string;
|
|
24514
|
+
/**
|
|
24515
|
+
* Required for engagement audiences. Rolling window.
|
|
24516
|
+
*/
|
|
24517
|
+
lookbackDays?: 30 | 60 | 90 | 180 | 365;
|
|
24518
|
+
/**
|
|
24519
|
+
* Required for engagement audiences. Campaign URNs for the
|
|
24520
|
+
* ad source types, organization URNs for pages and events.
|
|
24521
|
+
* LinkedIn creates one rule per source, all sharing the
|
|
24522
|
+
* same trigger and lookbackDays.
|
|
24523
|
+
*
|
|
24524
|
+
*/
|
|
24525
|
+
engagementSources?: Array<(string)>;
|
|
24526
|
+
/**
|
|
24527
|
+
* Required for company_list audiences (LinkedIn only): plain-text
|
|
24528
|
+
* company rows for account targeting. Each row needs at least one
|
|
24529
|
+
* identifier. LinkedIn recommends 1,000+ companies for a usable
|
|
24530
|
+
* match rate and takes up to 48h to process the list.
|
|
24531
|
+
*
|
|
24532
|
+
*/
|
|
24533
|
+
companies?: Array<{
|
|
24534
|
+
name?: string;
|
|
24535
|
+
domain?: string;
|
|
24536
|
+
website?: string;
|
|
24537
|
+
linkedinPageUrl?: string;
|
|
24538
|
+
}>;
|
|
24374
24539
|
/**
|
|
24375
24540
|
* Required for website audiences
|
|
24376
24541
|
*/
|
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: "@getlatedev/node",
|
|
39
|
-
version: "0.2.
|
|
39
|
+
version: "0.2.357",
|
|
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: "@getlatedev/node",
|
|
8
|
-
version: "0.2.
|
|
8
|
+
version: "0.2.357",
|
|
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
|
@@ -92,7 +92,7 @@ export type Ad = {
|
|
|
92
92
|
/**
|
|
93
93
|
* Available goals vary by platform. Meta (Facebook/Instagram) supports all 9 (incl. `lead_conversion` = website pixel lead optimization and `catalog_sales` = Advantage+ catalog ads). TikTok supports the 7 non-`lead_conversion` goals. LinkedIn supports all except app_promotion / lead_conversion. Twitter/X supports engagement, traffic, awareness, video_views, app_promotion. Pinterest and Google Ads support only engagement, traffic, awareness, video_views.
|
|
94
94
|
*/
|
|
95
|
-
goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales';
|
|
95
|
+
goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'job_applicants';
|
|
96
96
|
/**
|
|
97
97
|
* True for ads synced from platform ad managers
|
|
98
98
|
*/
|
|
@@ -288,7 +288,7 @@ export type adType = 'boost' | 'standalone';
|
|
|
288
288
|
/**
|
|
289
289
|
* Available goals vary by platform. Meta (Facebook/Instagram) supports all 9 (incl. `lead_conversion` = website pixel lead optimization and `catalog_sales` = Advantage+ catalog ads). TikTok supports the 7 non-`lead_conversion` goals. LinkedIn supports all except app_promotion / lead_conversion. Twitter/X supports engagement, traffic, awareness, video_views, app_promotion. Pinterest and Google Ads support only engagement, traffic, awareness, video_views.
|
|
290
290
|
*/
|
|
291
|
-
export type goal = 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales';
|
|
291
|
+
export type goal = 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'job_applicants';
|
|
292
292
|
|
|
293
293
|
export type type = 'daily' | 'lifetime';
|
|
294
294
|
|
|
@@ -2607,6 +2607,43 @@ export type LinkedInAdsPlatformData = {
|
|
|
2607
2607
|
*/
|
|
2608
2608
|
showMemberProfilePhoto?: boolean;
|
|
2609
2609
|
};
|
|
2610
|
+
/**
|
|
2611
|
+
* POST /v1/ads/create only. Dynamic Jobs Ad promoting your open roles,
|
|
2612
|
+
* personalized with the viewer's profile photo. Requires goal
|
|
2613
|
+
* job_applicants and a Company Page with active job postings.
|
|
2614
|
+
* headline and buttonLabel take exactly one of
|
|
2615
|
+
* preApproved or custom. logoUrl and organizationName default to the
|
|
2616
|
+
* Company Page's. Mutually exclusive with the other creative sources.
|
|
2617
|
+
*
|
|
2618
|
+
*/
|
|
2619
|
+
jobs?: {
|
|
2620
|
+
headline: {
|
|
2621
|
+
/**
|
|
2622
|
+
* LinkedIn preset id, not reviewed. Example MEMBER_READY_FOR_YOUR_DREAM_JOB.
|
|
2623
|
+
*/
|
|
2624
|
+
preApproved?: string;
|
|
2625
|
+
/**
|
|
2626
|
+
* Free text, reviewed by LinkedIn.
|
|
2627
|
+
*/
|
|
2628
|
+
custom?: string;
|
|
2629
|
+
};
|
|
2630
|
+
buttonLabel: {
|
|
2631
|
+
/**
|
|
2632
|
+
* LinkedIn preset id, not reviewed. One of SEE_MORE_JOBS, VIEW_MORE, CAREERS_AT_COMPANY.
|
|
2633
|
+
*/
|
|
2634
|
+
preApproved?: string;
|
|
2635
|
+
/**
|
|
2636
|
+
* Free text, reviewed by LinkedIn.
|
|
2637
|
+
*/
|
|
2638
|
+
custom?: string;
|
|
2639
|
+
};
|
|
2640
|
+
logoUrl?: string;
|
|
2641
|
+
organizationName?: string;
|
|
2642
|
+
/**
|
|
2643
|
+
* Defaults to true.
|
|
2644
|
+
*/
|
|
2645
|
+
showMemberProfilePhoto?: boolean;
|
|
2646
|
+
};
|
|
2610
2647
|
/**
|
|
2611
2648
|
* POST /v1/ads/create only. Classic right-rail Text Ad. The copy lives
|
|
2612
2649
|
* here; ad-level body and headline are not used. Mutually exclusive
|
|
@@ -2622,6 +2659,57 @@ export type LinkedInAdsPlatformData = {
|
|
|
2622
2659
|
*/
|
|
2623
2660
|
imageUrl?: string;
|
|
2624
2661
|
};
|
|
2662
|
+
/**
|
|
2663
|
+
* POST /v1/ads/create only. Conversation Ad: a choose-your-path message
|
|
2664
|
+
* tree delivered to the member's LinkedIn inbox. Messages are flat
|
|
2665
|
+
* nodes wired by local ids; each button either opens a url or leads to
|
|
2666
|
+
* nextMessageId. Cycles, unknown ids and a missing firstMessageId
|
|
2667
|
+
* return a 400. LinkedIn does not deliver message ads to EU members.
|
|
2668
|
+
* Mutually exclusive with the other creative sources.
|
|
2669
|
+
*
|
|
2670
|
+
*/
|
|
2671
|
+
conversation?: {
|
|
2672
|
+
/**
|
|
2673
|
+
* InMail subject shown in the inbox.
|
|
2674
|
+
*/
|
|
2675
|
+
subject: string;
|
|
2676
|
+
/**
|
|
2677
|
+
* Person or organization URN. Defaults to the authoring Company
|
|
2678
|
+
* Page. The sender must be approved for the ad account first
|
|
2679
|
+
* (Campaign Manager > Manage message ad senders) or LinkedIn
|
|
2680
|
+
* rejects the create with SINMAIL_SENDER_NOT_APPROVED.
|
|
2681
|
+
*
|
|
2682
|
+
*/
|
|
2683
|
+
sender?: string;
|
|
2684
|
+
/**
|
|
2685
|
+
* Optional intro body (HTML allowed).
|
|
2686
|
+
*/
|
|
2687
|
+
body?: string;
|
|
2688
|
+
/**
|
|
2689
|
+
* Terms shown at the bottom of the message.
|
|
2690
|
+
*/
|
|
2691
|
+
footer?: string;
|
|
2692
|
+
/**
|
|
2693
|
+
* Conversation headline. Defaults to the first message's first line.
|
|
2694
|
+
*/
|
|
2695
|
+
headline?: string;
|
|
2696
|
+
firstMessageId: string;
|
|
2697
|
+
messages: Array<{
|
|
2698
|
+
id: string;
|
|
2699
|
+
text: string;
|
|
2700
|
+
buttons?: Array<{
|
|
2701
|
+
text: string;
|
|
2702
|
+
/**
|
|
2703
|
+
* Continues the conversation at this message. Exactly one of nextMessageId or url.
|
|
2704
|
+
*/
|
|
2705
|
+
nextMessageId?: string;
|
|
2706
|
+
/**
|
|
2707
|
+
* Opens this landing page. Exactly one of nextMessageId or url.
|
|
2708
|
+
*/
|
|
2709
|
+
url?: string;
|
|
2710
|
+
}>;
|
|
2711
|
+
}>;
|
|
2712
|
+
};
|
|
2625
2713
|
/**
|
|
2626
2714
|
* POST /v1/ads/create only. Promotes an existing LinkedIn Event; no
|
|
2627
2715
|
* headline needed. Mutually exclusive with the other creative sources.
|
|
@@ -23280,7 +23368,16 @@ export type GetCampaignAnalyticsData = {
|
|
|
23280
23368
|
};
|
|
23281
23369
|
query?: {
|
|
23282
23370
|
/**
|
|
23283
|
-
* Comma-separated breakdown dimensions
|
|
23371
|
+
* Comma-separated breakdown dimensions.
|
|
23372
|
+
*
|
|
23373
|
+
* **Meta**: age, gender, country, publisher_platform, device_platform, region,
|
|
23374
|
+
* platform_position, impression_device, video_asset, image_asset, body_asset, title_asset.
|
|
23375
|
+
*
|
|
23376
|
+
* **LinkedIn** (firmographics): job_title, job_function, seniority, industry,
|
|
23377
|
+
* company, company_size, country, region. Rows carry the raw pivot `value`
|
|
23378
|
+
* plus a resolved `name`. LinkedIn serves these aggregated over the whole
|
|
23379
|
+
* range, delays the data 12-24h, and omits segments with fewer than 3 events.
|
|
23380
|
+
*
|
|
23284
23381
|
*/
|
|
23285
23382
|
breakdowns?: string;
|
|
23286
23383
|
/**
|
|
@@ -23339,7 +23436,17 @@ export type GetAdAnalyticsData = {
|
|
|
23339
23436
|
};
|
|
23340
23437
|
query?: {
|
|
23341
23438
|
/**
|
|
23342
|
-
* Comma-separated breakdown dimensions.
|
|
23439
|
+
* Comma-separated breakdown dimensions.
|
|
23440
|
+
*
|
|
23441
|
+
* **Meta**: age, gender, country, publisher_platform, device_platform, region.
|
|
23442
|
+
*
|
|
23443
|
+
* **TikTok**: gender, age, country_code, platform, ac, language.
|
|
23444
|
+
*
|
|
23445
|
+
* **LinkedIn** (firmographics): job_title, job_function, seniority, industry,
|
|
23446
|
+
* company, company_size, country, region. Rows carry the raw pivot `value`
|
|
23447
|
+
* plus a resolved `name`. LinkedIn serves these aggregated over the whole
|
|
23448
|
+
* range, delays the data 12-24h, and omits segments with fewer than 3 events.
|
|
23449
|
+
*
|
|
23343
23450
|
*/
|
|
23344
23451
|
breakdowns?: string;
|
|
23345
23452
|
/**
|
|
@@ -23900,9 +24007,25 @@ export type CreateStandaloneAdData = {
|
|
|
23900
24007
|
}>;
|
|
23901
24008
|
};
|
|
23902
24009
|
/**
|
|
23903
|
-
* Required on legacy
|
|
24010
|
+
* Required on legacy and multi-creative shapes; the attach shape inherits it from the ad set. Available goals vary by platform.
|
|
24011
|
+
*
|
|
24012
|
+
* **Meta**
|
|
24013
|
+
* - `conversions`: OUTCOME_SALES. Requires `promotedObject.pixelId` and `promotedObject.customEventType` with a commerce event such as PURCHASE or START_TRIAL.
|
|
24014
|
+
* - `lead_conversion`: OUTCOME_LEADS optimizing website pixel leads. Same pixel and event fields, but with a leads-class event such as LEAD, SUBMIT_APPLICATION, SCHEDULE or CONTACT. Meta gates conversion events by objective, so leads-class events are rejected under `conversions`.
|
|
24015
|
+
* - `lead_generation`: OUTCOME_LEADS with instant forms. Requires `leadGenFormId`. `promotedObject.pageId` is optional and auto-filled from the connected Page.
|
|
24016
|
+
* - `app_promotion`: requires `promotedObject.applicationId` and `promotedObject.objectStoreUrl`.
|
|
24017
|
+
* - `catalog_sales`: Advantage+ catalog ads, for example vehicle inventory. Requires `promotedObject.productSetId`, `promotedObject.pixelId` and `promotedObject.customEventType`. Builds a catalog TEMPLATE creative from the copy fields, which may carry template tags like {{product.name}} or {{vehicle.make}}. No imageUrl or video is sent; Meta renders the visuals per catalog item. Discover catalogs via GET /v1/ads/catalogs and product sets via GET /v1/ads/catalogs/{catalogId}/product-sets. Single shape only, no creatives[], adSetId, dynamicCreative or placementAssets.
|
|
24018
|
+
*
|
|
24019
|
+
* **TikTok**
|
|
24020
|
+
* - `conversions`: website-conversion ad group. Requires `promotedObject.pixelId`, your TikTok Pixel ID. Accepts an optional `promotedObject.customEventType` with a TikTok optimization_event code such as ON_WEB_ORDER, INITIATE_ORDER, ON_WEB_REGISTER or FORM. To inherit pixel and event from an existing ad group, pass `adSetId` instead.
|
|
24021
|
+
*
|
|
24022
|
+
* **LinkedIn**
|
|
24023
|
+
* - `engagement`, `traffic`, `awareness` and `video_views` create standalone Direct Sponsored Content ads. `traffic` requires `linkUrl`; `video_views` requires `video`.
|
|
24024
|
+
* - `job_applicants` requires a `platformSpecificData.jobs` creative.
|
|
24025
|
+
* - For `lead_generation` or `conversions` on LinkedIn, or to promote an existing post, use POST /v1/ads/boost.
|
|
24026
|
+
*
|
|
23904
24027
|
*/
|
|
23905
|
-
goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales';
|
|
24028
|
+
goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'job_applicants';
|
|
23906
24029
|
/**
|
|
23907
24030
|
* Meta only. Explicit ad-set `optimization_goal` (e.g. `LANDING_PAGE_VIEWS`, `LINK_CLICKS`, `REACH`, `IMPRESSIONS`, `OFFSITE_CONVERSIONS`, `THRUPLAY`, `LEAD_GENERATION`). Overrides the default derived from `goal` (e.g. `traffic` defaults to `LINK_CLICKS`). Forwarded verbatim to Meta, which validates compatibility with the campaign objective and rejects incompatible combinations.
|
|
23908
24031
|
*/
|
|
@@ -25026,9 +25149,9 @@ export type ListAdAudiencesData = {
|
|
|
25026
25149
|
adAccountId: string;
|
|
25027
25150
|
platform?: 'facebook' | 'instagram' | 'googleads' | 'tiktok' | 'tiktokads' | 'pinterest' | 'linkedin' | 'linkedinads' | 'twitter' | 'xads';
|
|
25028
25151
|
/**
|
|
25029
|
-
* Filter to one audience type. `saved_targeting` returns stored TargetingSpec audiences
|
|
25152
|
+
* Filter to one audience type. `saved_targeting` returns stored TargetingSpec audiences; the other types return uploaded/derived audiences.
|
|
25030
25153
|
*/
|
|
25031
|
-
type?: 'customer_list' | 'website' | 'lookalike' | 'saved_targeting';
|
|
25154
|
+
type?: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'lookalike' | 'saved_targeting';
|
|
25032
25155
|
};
|
|
25033
25156
|
};
|
|
25034
25157
|
|
|
@@ -25042,7 +25165,7 @@ export type ListAdAudiencesResponse = ({
|
|
|
25042
25165
|
platformAudienceId?: string;
|
|
25043
25166
|
name?: string;
|
|
25044
25167
|
description?: string;
|
|
25045
|
-
type?: 'customer_list' | 'website' | 'lookalike' | 'saved_targeting';
|
|
25168
|
+
type?: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'lookalike' | 'saved_targeting';
|
|
25046
25169
|
/**
|
|
25047
25170
|
* Present (and the only meaningful payload) when `type` is `saved_targeting`. Null for uploaded/derived audience types.
|
|
25048
25171
|
*/
|
|
@@ -25066,7 +25189,49 @@ export type CreateAdAudienceData = {
|
|
|
25066
25189
|
adAccountId: string;
|
|
25067
25190
|
name: string;
|
|
25068
25191
|
description?: string;
|
|
25069
|
-
type: 'customer_list' | 'website' | 'lookalike';
|
|
25192
|
+
type: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'lookalike';
|
|
25193
|
+
/**
|
|
25194
|
+
* Required for engagement audiences (LinkedIn only): what
|
|
25195
|
+
* members engaged with — a video/leadgen/single-image ad
|
|
25196
|
+
* campaign, a Company Page or an Event page.
|
|
25197
|
+
*
|
|
25198
|
+
*/
|
|
25199
|
+
sourceType?: 'VIDEO_ADS' | 'LEAD_GEN_FORMS' | 'ORGANIZATION_PAGES' | 'EVENT_PAGES' | 'SINGLE_IMAGE_ADS';
|
|
25200
|
+
/**
|
|
25201
|
+
* Required for engagement audiences. The action, validated
|
|
25202
|
+
* by LinkedIn against `sourceType`. Common values:
|
|
25203
|
+
* VIDEO_ADS FIRST_QUARTILE / MIDPOINT / THIRD_QUARTILE /
|
|
25204
|
+
* FULL_COMPLETE; LEAD_GEN_FORMS VIEW_FORM /
|
|
25205
|
+
* LEAD_FORM_SUBMIT; ORGANIZATION_PAGES VIEW / CTA_CLICK;
|
|
25206
|
+
* EVENT_PAGES RSVPED / VIDEO_VIEWED / ENGAGEMENT / CLICK.
|
|
25207
|
+
*
|
|
25208
|
+
*/
|
|
25209
|
+
trigger?: string;
|
|
25210
|
+
/**
|
|
25211
|
+
* Required for engagement audiences. Rolling window.
|
|
25212
|
+
*/
|
|
25213
|
+
lookbackDays?: 30 | 60 | 90 | 180 | 365;
|
|
25214
|
+
/**
|
|
25215
|
+
* Required for engagement audiences. Campaign URNs for the
|
|
25216
|
+
* ad source types, organization URNs for pages and events.
|
|
25217
|
+
* LinkedIn creates one rule per source, all sharing the
|
|
25218
|
+
* same trigger and lookbackDays.
|
|
25219
|
+
*
|
|
25220
|
+
*/
|
|
25221
|
+
engagementSources?: Array<(string)>;
|
|
25222
|
+
/**
|
|
25223
|
+
* Required for company_list audiences (LinkedIn only): plain-text
|
|
25224
|
+
* company rows for account targeting. Each row needs at least one
|
|
25225
|
+
* identifier. LinkedIn recommends 1,000+ companies for a usable
|
|
25226
|
+
* match rate and takes up to 48h to process the list.
|
|
25227
|
+
*
|
|
25228
|
+
*/
|
|
25229
|
+
companies?: Array<{
|
|
25230
|
+
name?: string;
|
|
25231
|
+
domain?: string;
|
|
25232
|
+
website?: string;
|
|
25233
|
+
linkedinPageUrl?: string;
|
|
25234
|
+
}>;
|
|
25070
25235
|
/**
|
|
25071
25236
|
* Required for website audiences
|
|
25072
25237
|
*/
|