@getlatedev/node 0.2.1077 → 0.2.1078
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 +74 -9
- package/dist/index.d.ts +74 -9
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/sdk.gen.ts +24 -3
- package/src/generated/types.gen.ts +74 -9
package/dist/index.d.mts
CHANGED
|
@@ -47130,7 +47130,7 @@ type ListAdAudiencesResponse = ({
|
|
|
47130
47130
|
platformAudienceId?: string;
|
|
47131
47131
|
name?: string;
|
|
47132
47132
|
description?: string;
|
|
47133
|
-
type?: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
|
|
47133
|
+
type?: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'tiktok_engagement' | 'pinterest_engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
|
|
47134
47134
|
/**
|
|
47135
47135
|
* Present (and the only meaningful payload) when `type` is `saved_targeting`. Null for uploaded/derived audience types.
|
|
47136
47136
|
*/
|
|
@@ -47150,7 +47150,7 @@ type CreateAdAudienceData = {
|
|
|
47150
47150
|
adAccountId: string;
|
|
47151
47151
|
name: string;
|
|
47152
47152
|
description?: string;
|
|
47153
|
-
type: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'website' | 'website_retargeting' | 'lookalike';
|
|
47153
|
+
type: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'tiktok_engagement' | 'pinterest_engagement' | 'website' | 'website_retargeting' | 'lookalike';
|
|
47154
47154
|
/**
|
|
47155
47155
|
* Required for website_retargeting audiences (LinkedIn only).
|
|
47156
47156
|
* Each rule is a URL pattern; a member who visits any
|
|
@@ -47213,11 +47213,11 @@ type CreateAdAudienceData = {
|
|
|
47213
47213
|
linkedinPageUrl?: string;
|
|
47214
47214
|
}>;
|
|
47215
47215
|
/**
|
|
47216
|
-
* Required
|
|
47216
|
+
* website: the Meta pixel, TikTok pixel or Pinterest tag id. Required on those three, rejected on Google.
|
|
47217
47217
|
*/
|
|
47218
47218
|
pixelId?: string;
|
|
47219
47219
|
/**
|
|
47220
|
-
* Required for website (max 180
|
|
47220
|
+
* Required for website (Meta max 180, TikTok 7/14/30/60/90/180, Pinterest and Google max 540), meta_engagement (max 365) and tiktok_engagement (7/14/30/60/90/180; organic and live video and most business-account events only 7/14/30).
|
|
47221
47221
|
*/
|
|
47222
47222
|
retentionDays?: number;
|
|
47223
47223
|
/**
|
|
@@ -47232,10 +47232,26 @@ type CreateAdAudienceData = {
|
|
|
47232
47232
|
*/
|
|
47233
47233
|
sourceId?: string;
|
|
47234
47234
|
/**
|
|
47235
|
-
* meta_engagement
|
|
47235
|
+
* meta_engagement: the engagement event; defaults per source
|
|
47236
47236
|
* (page → page_engaged, instagram → ig_business_profile_all,
|
|
47237
47237
|
* video → video_watched). Ignored when `rule` is provided.
|
|
47238
47238
|
*
|
|
47239
|
+
* website on TikTok: the pixel event (default `PAGE BROWSE`). website
|
|
47240
|
+
* on Pinterest: the tag event (`pagevisit`, `signup`, `checkout`, `viewcategory`, `search`, `addtocart`, `watchvideo`, `lead`, `custom` or a partner-defined event).
|
|
47241
|
+
*
|
|
47242
|
+
* tiktok_engagement (required): the TikTok engagement event, validated
|
|
47243
|
+
* per `source` (TikTok's filter values, spaces included):
|
|
47244
|
+
* - ads: `CLICK`, `IMPRESSION`, `PLAY 2S`, `PLAY 6S`, `PLAY 25`, `PLAY 50`, `PLAY 75`,
|
|
47245
|
+
* `PLAY OVER`, and the `ENGAGEMENT APP PROFILE` / `ENGAGEMENT TIKTOK INSTANT` /
|
|
47246
|
+
* `ENGAGEMENT COLLECTION ADS` `CLICK` and `IMPRESSION` events.
|
|
47247
|
+
* - organic_video: `ORGANIC VIDEO PLAY 2S`, `ORGANIC VIDEO PLAY 6S`,
|
|
47248
|
+
* `ORGANIC VIDEO PLAY OVER`, `ORGANIC VIDEO ENGAGEMENT`.
|
|
47249
|
+
* - live_video: `LIVE VIDEO VIEW`, `LIVE VIDEO ENGAGEMENT`.
|
|
47250
|
+
* - business_account: `BUSINESS ACCOUNT PROFILE FOLLOW`, `BUSINESS ACCOUNT PROFILE VISIT`,
|
|
47251
|
+
* `BUSINESS ACCOUNT ENGAGEMENT`, `BUSINESS ACCOUNT PLAY 2S`, `BUSINESS ACCOUNT PLAY 6S`,
|
|
47252
|
+
* `BUSINESS ACCOUNT PLAY OVER` and the rest of TikTok's business-account events.
|
|
47253
|
+
* An unknown value is a 400 that lists the valid ones.
|
|
47254
|
+
*
|
|
47239
47255
|
*/
|
|
47240
47256
|
event?: string;
|
|
47241
47257
|
/**
|
|
@@ -47247,17 +47263,66 @@ type CreateAdAudienceData = {
|
|
|
47247
47263
|
*/
|
|
47248
47264
|
country?: string;
|
|
47249
47265
|
/**
|
|
47250
|
-
*
|
|
47266
|
+
* lookalike on Meta (0.01-0.20) and Pinterest (0.01-0.10, whole percents). Rejected on TikTok and Google.
|
|
47251
47267
|
*/
|
|
47252
47268
|
ratio?: number;
|
|
47253
47269
|
/**
|
|
47254
|
-
*
|
|
47255
|
-
|
|
47270
|
+
* lookalike on TikTok and Google: audience breadth. Rejected on Meta and Pinterest.
|
|
47271
|
+
*/
|
|
47272
|
+
size?: 'narrow' | 'balanced' | 'broad';
|
|
47273
|
+
/**
|
|
47274
|
+
* Required for tiktok_engagement: what people engaged with.
|
|
47275
|
+
*/
|
|
47276
|
+
source?: 'ads' | 'organic_video' | 'live_video' | 'business_account';
|
|
47277
|
+
/**
|
|
47278
|
+
* tiktok_engagement: ad group / campaign ids for `ads`, video ids for `organic_video` and `live_video` (max 10). Required except for `business_account`.
|
|
47279
|
+
*/
|
|
47280
|
+
sourceIds?: Array<(string)>;
|
|
47281
|
+
/**
|
|
47282
|
+
* tiktok_engagement: the TikTok identity that owns the videos or business account. Required for organic_video, live_video and business_account.
|
|
47283
|
+
*/
|
|
47284
|
+
identityId?: string;
|
|
47285
|
+
/**
|
|
47286
|
+
* tiktok_engagement: type of `identityId`.
|
|
47287
|
+
*/
|
|
47288
|
+
identityType?: 'TT_USER' | 'BC_AUTH_TT';
|
|
47289
|
+
/**
|
|
47290
|
+
* tiktok_engagement: required when identityType is BC_AUTH_TT.
|
|
47291
|
+
*/
|
|
47292
|
+
identityAuthorizedBcId?: string;
|
|
47293
|
+
/**
|
|
47294
|
+
* pinterest_engagement: Pinterest's `engager_type`, passed through when set.
|
|
47295
|
+
*/
|
|
47296
|
+
engagerType?: 1 | 2;
|
|
47297
|
+
/**
|
|
47298
|
+
* pinterest_engagement: limit to one engagement action.
|
|
47299
|
+
*/
|
|
47300
|
+
engagementType?: 'click' | 'save' | 'closeup' | 'comment' | 'like';
|
|
47301
|
+
/**
|
|
47302
|
+
* pinterest_engagement: people who engaged with Pins from these domains. The domain must be claimed on the Pinterest account or Pinterest rejects it.
|
|
47303
|
+
*/
|
|
47304
|
+
engagementDomains?: Array<(string)>;
|
|
47305
|
+
/**
|
|
47306
|
+
* pinterest_engagement: people who engaged with these campaigns' ads.
|
|
47307
|
+
*/
|
|
47308
|
+
campaignIds?: Array<(string)>;
|
|
47309
|
+
/**
|
|
47310
|
+
* pinterest_engagement: people who engaged with these ads.
|
|
47311
|
+
*/
|
|
47312
|
+
adIds?: Array<(string)>;
|
|
47313
|
+
/**
|
|
47314
|
+
* pinterest_engagement: people who engaged with these Pins. At least one of engagementDomains, campaignIds, adIds or pinIds is required.
|
|
47315
|
+
*/
|
|
47316
|
+
pinIds?: Array<(string)>;
|
|
47317
|
+
/**
|
|
47318
|
+
* website on Meta, TikTok and Google. Narrows the audience from all visitors
|
|
47319
|
+
* to visitors of URLs containing this substring. Ignored when `rule` is
|
|
47320
|
+
* supplied. A 400 on Pinterest, which only matches exact URLs.
|
|
47256
47321
|
*
|
|
47257
47322
|
*/
|
|
47258
47323
|
urlContains?: string;
|
|
47259
47324
|
/**
|
|
47260
|
-
* Optional raw Meta rule, replacing the one we build. Omit it for all
|
|
47325
|
+
* Meta only (a 400 elsewhere). Optional raw Meta rule, replacing the one we build. Omit it for all
|
|
47261
47326
|
* visitors of `pixelId`, or use `urlContains` for the common page-match
|
|
47262
47327
|
* case.
|
|
47263
47328
|
*
|
package/dist/index.d.ts
CHANGED
|
@@ -47130,7 +47130,7 @@ type ListAdAudiencesResponse = ({
|
|
|
47130
47130
|
platformAudienceId?: string;
|
|
47131
47131
|
name?: string;
|
|
47132
47132
|
description?: string;
|
|
47133
|
-
type?: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
|
|
47133
|
+
type?: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'tiktok_engagement' | 'pinterest_engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
|
|
47134
47134
|
/**
|
|
47135
47135
|
* Present (and the only meaningful payload) when `type` is `saved_targeting`. Null for uploaded/derived audience types.
|
|
47136
47136
|
*/
|
|
@@ -47150,7 +47150,7 @@ type CreateAdAudienceData = {
|
|
|
47150
47150
|
adAccountId: string;
|
|
47151
47151
|
name: string;
|
|
47152
47152
|
description?: string;
|
|
47153
|
-
type: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'website' | 'website_retargeting' | 'lookalike';
|
|
47153
|
+
type: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'tiktok_engagement' | 'pinterest_engagement' | 'website' | 'website_retargeting' | 'lookalike';
|
|
47154
47154
|
/**
|
|
47155
47155
|
* Required for website_retargeting audiences (LinkedIn only).
|
|
47156
47156
|
* Each rule is a URL pattern; a member who visits any
|
|
@@ -47213,11 +47213,11 @@ type CreateAdAudienceData = {
|
|
|
47213
47213
|
linkedinPageUrl?: string;
|
|
47214
47214
|
}>;
|
|
47215
47215
|
/**
|
|
47216
|
-
* Required
|
|
47216
|
+
* website: the Meta pixel, TikTok pixel or Pinterest tag id. Required on those three, rejected on Google.
|
|
47217
47217
|
*/
|
|
47218
47218
|
pixelId?: string;
|
|
47219
47219
|
/**
|
|
47220
|
-
* Required for website (max 180
|
|
47220
|
+
* Required for website (Meta max 180, TikTok 7/14/30/60/90/180, Pinterest and Google max 540), meta_engagement (max 365) and tiktok_engagement (7/14/30/60/90/180; organic and live video and most business-account events only 7/14/30).
|
|
47221
47221
|
*/
|
|
47222
47222
|
retentionDays?: number;
|
|
47223
47223
|
/**
|
|
@@ -47232,10 +47232,26 @@ type CreateAdAudienceData = {
|
|
|
47232
47232
|
*/
|
|
47233
47233
|
sourceId?: string;
|
|
47234
47234
|
/**
|
|
47235
|
-
* meta_engagement
|
|
47235
|
+
* meta_engagement: the engagement event; defaults per source
|
|
47236
47236
|
* (page → page_engaged, instagram → ig_business_profile_all,
|
|
47237
47237
|
* video → video_watched). Ignored when `rule` is provided.
|
|
47238
47238
|
*
|
|
47239
|
+
* website on TikTok: the pixel event (default `PAGE BROWSE`). website
|
|
47240
|
+
* on Pinterest: the tag event (`pagevisit`, `signup`, `checkout`, `viewcategory`, `search`, `addtocart`, `watchvideo`, `lead`, `custom` or a partner-defined event).
|
|
47241
|
+
*
|
|
47242
|
+
* tiktok_engagement (required): the TikTok engagement event, validated
|
|
47243
|
+
* per `source` (TikTok's filter values, spaces included):
|
|
47244
|
+
* - ads: `CLICK`, `IMPRESSION`, `PLAY 2S`, `PLAY 6S`, `PLAY 25`, `PLAY 50`, `PLAY 75`,
|
|
47245
|
+
* `PLAY OVER`, and the `ENGAGEMENT APP PROFILE` / `ENGAGEMENT TIKTOK INSTANT` /
|
|
47246
|
+
* `ENGAGEMENT COLLECTION ADS` `CLICK` and `IMPRESSION` events.
|
|
47247
|
+
* - organic_video: `ORGANIC VIDEO PLAY 2S`, `ORGANIC VIDEO PLAY 6S`,
|
|
47248
|
+
* `ORGANIC VIDEO PLAY OVER`, `ORGANIC VIDEO ENGAGEMENT`.
|
|
47249
|
+
* - live_video: `LIVE VIDEO VIEW`, `LIVE VIDEO ENGAGEMENT`.
|
|
47250
|
+
* - business_account: `BUSINESS ACCOUNT PROFILE FOLLOW`, `BUSINESS ACCOUNT PROFILE VISIT`,
|
|
47251
|
+
* `BUSINESS ACCOUNT ENGAGEMENT`, `BUSINESS ACCOUNT PLAY 2S`, `BUSINESS ACCOUNT PLAY 6S`,
|
|
47252
|
+
* `BUSINESS ACCOUNT PLAY OVER` and the rest of TikTok's business-account events.
|
|
47253
|
+
* An unknown value is a 400 that lists the valid ones.
|
|
47254
|
+
*
|
|
47239
47255
|
*/
|
|
47240
47256
|
event?: string;
|
|
47241
47257
|
/**
|
|
@@ -47247,17 +47263,66 @@ type CreateAdAudienceData = {
|
|
|
47247
47263
|
*/
|
|
47248
47264
|
country?: string;
|
|
47249
47265
|
/**
|
|
47250
|
-
*
|
|
47266
|
+
* lookalike on Meta (0.01-0.20) and Pinterest (0.01-0.10, whole percents). Rejected on TikTok and Google.
|
|
47251
47267
|
*/
|
|
47252
47268
|
ratio?: number;
|
|
47253
47269
|
/**
|
|
47254
|
-
*
|
|
47255
|
-
|
|
47270
|
+
* lookalike on TikTok and Google: audience breadth. Rejected on Meta and Pinterest.
|
|
47271
|
+
*/
|
|
47272
|
+
size?: 'narrow' | 'balanced' | 'broad';
|
|
47273
|
+
/**
|
|
47274
|
+
* Required for tiktok_engagement: what people engaged with.
|
|
47275
|
+
*/
|
|
47276
|
+
source?: 'ads' | 'organic_video' | 'live_video' | 'business_account';
|
|
47277
|
+
/**
|
|
47278
|
+
* tiktok_engagement: ad group / campaign ids for `ads`, video ids for `organic_video` and `live_video` (max 10). Required except for `business_account`.
|
|
47279
|
+
*/
|
|
47280
|
+
sourceIds?: Array<(string)>;
|
|
47281
|
+
/**
|
|
47282
|
+
* tiktok_engagement: the TikTok identity that owns the videos or business account. Required for organic_video, live_video and business_account.
|
|
47283
|
+
*/
|
|
47284
|
+
identityId?: string;
|
|
47285
|
+
/**
|
|
47286
|
+
* tiktok_engagement: type of `identityId`.
|
|
47287
|
+
*/
|
|
47288
|
+
identityType?: 'TT_USER' | 'BC_AUTH_TT';
|
|
47289
|
+
/**
|
|
47290
|
+
* tiktok_engagement: required when identityType is BC_AUTH_TT.
|
|
47291
|
+
*/
|
|
47292
|
+
identityAuthorizedBcId?: string;
|
|
47293
|
+
/**
|
|
47294
|
+
* pinterest_engagement: Pinterest's `engager_type`, passed through when set.
|
|
47295
|
+
*/
|
|
47296
|
+
engagerType?: 1 | 2;
|
|
47297
|
+
/**
|
|
47298
|
+
* pinterest_engagement: limit to one engagement action.
|
|
47299
|
+
*/
|
|
47300
|
+
engagementType?: 'click' | 'save' | 'closeup' | 'comment' | 'like';
|
|
47301
|
+
/**
|
|
47302
|
+
* pinterest_engagement: people who engaged with Pins from these domains. The domain must be claimed on the Pinterest account or Pinterest rejects it.
|
|
47303
|
+
*/
|
|
47304
|
+
engagementDomains?: Array<(string)>;
|
|
47305
|
+
/**
|
|
47306
|
+
* pinterest_engagement: people who engaged with these campaigns' ads.
|
|
47307
|
+
*/
|
|
47308
|
+
campaignIds?: Array<(string)>;
|
|
47309
|
+
/**
|
|
47310
|
+
* pinterest_engagement: people who engaged with these ads.
|
|
47311
|
+
*/
|
|
47312
|
+
adIds?: Array<(string)>;
|
|
47313
|
+
/**
|
|
47314
|
+
* pinterest_engagement: people who engaged with these Pins. At least one of engagementDomains, campaignIds, adIds or pinIds is required.
|
|
47315
|
+
*/
|
|
47316
|
+
pinIds?: Array<(string)>;
|
|
47317
|
+
/**
|
|
47318
|
+
* website on Meta, TikTok and Google. Narrows the audience from all visitors
|
|
47319
|
+
* to visitors of URLs containing this substring. Ignored when `rule` is
|
|
47320
|
+
* supplied. A 400 on Pinterest, which only matches exact URLs.
|
|
47256
47321
|
*
|
|
47257
47322
|
*/
|
|
47258
47323
|
urlContains?: string;
|
|
47259
47324
|
/**
|
|
47260
|
-
* Optional raw Meta rule, replacing the one we build. Omit it for all
|
|
47325
|
+
* Meta only (a 400 elsewhere). Optional raw Meta rule, replacing the one we build. Omit it for all
|
|
47261
47326
|
* visitors of `pixelId`, or use `urlContains` for the common page-match
|
|
47262
47327
|
* case.
|
|
47263
47328
|
*
|
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.1078",
|
|
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.1078",
|
|
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
|
@@ -12482,8 +12482,28 @@ export const listAdAudiences = <ThrowOnError extends boolean = false>(options: O
|
|
|
12482
12482
|
|
|
12483
12483
|
/**
|
|
12484
12484
|
* Create custom audience
|
|
12485
|
-
* Create a custom audience. `customer_list` is supported on Meta, Google, X, LinkedIn, TikTok, and Pinterest
|
|
12486
|
-
* `website` and `lookalike` are Meta
|
|
12485
|
+
* Create a custom audience. `customer_list` is supported on Meta, Google, X, LinkedIn, TikTok, and Pinterest.
|
|
12486
|
+
* `website` (pixel/tag visitors) and `lookalike` are supported on Meta, TikTok, Pinterest and Google.
|
|
12487
|
+
* `meta_engagement` is Meta-only, `tiktok_engagement` TikTok-only, `pinterest_engagement` Pinterest-only;
|
|
12488
|
+
* `company_list`, `engagement` and `website_retargeting` are LinkedIn-only. A type sent to a platform
|
|
12489
|
+
* that does not support it is a 422 `FEATURE_NOT_AVAILABLE`.
|
|
12490
|
+
*
|
|
12491
|
+
* Per-platform rules for `website`:
|
|
12492
|
+
*
|
|
12493
|
+
* - Meta: `pixelId` required, `retentionDays` 1-180, optional `urlContains` or raw `rule`. `event` is not accepted.
|
|
12494
|
+
* - TikTok: `pixelId` required, `retentionDays` one of 7, 14, 30, 60, 90, 180. `event` is a TikTok pixel event
|
|
12495
|
+
* (default `PAGE BROWSE`; also `CLICK BUTTON`, `PIXEL SUBMIT FORM`, `CONTACT`, `DOWNLOAD`,
|
|
12496
|
+
* `PIXEL ADD PAYMENT INFO`, `COMPLETE PAYMENT`, `INITIATE CHECKOUT`, `COMPLETE REGISTRATION`,
|
|
12497
|
+
* `PRODUCT DETAIL PAGE BROWSE`, `PIXEL SEARCH`, `PIXEL ADD TO CART`, `PLACE AN ORDER`,
|
|
12498
|
+
* `PIXEL ADD TO WISHLIST`, `PIXEL SUBSCRIBE`), optional `urlContains`.
|
|
12499
|
+
* - Pinterest: `pixelId` is the Pinterest tag id, `retentionDays` 1-540, optional `event` (e.g. `checkout`, `addtocart`).
|
|
12500
|
+
* Pinterest matches URLs exactly, so `urlContains` is a 400 there.
|
|
12501
|
+
* - Google: no `pixelId` (the account's Google tag is used), `retentionDays` 1-540, `urlContains`
|
|
12502
|
+
* defaults to `/` (all visitors). Built as a rule-based user list with prepopulation requested.
|
|
12503
|
+
*
|
|
12504
|
+
* Per-platform rules for `lookalike`: Meta takes `ratio` (0.01-0.20); Pinterest takes `ratio` in whole
|
|
12505
|
+
* percents (0.01-0.10) and `country` US, CA or GB; TikTok and Google take `size` (narrow, balanced, broad)
|
|
12506
|
+
* instead of `ratio`. TikTok needs a seed with at least 1,000 matched people.
|
|
12487
12507
|
* `saved_targeting` stores a reusable TargetingSpec (no member upload, no adAccountId) that you reference later via
|
|
12488
12508
|
* `savedTargetingId` on `POST /v1/ads/create`.
|
|
12489
12509
|
*
|
|
@@ -12494,7 +12514,8 @@ export const listAdAudiences = <ThrowOnError extends boolean = false>(options: O
|
|
|
12494
12514
|
* - `company_list` is filled AT CREATION from the `companies` array below, which is required. To change the list
|
|
12495
12515
|
* afterwards send the new full list to `POST /v1/ads/audiences/{audienceId}/companies` (a replace, not a merge).
|
|
12496
12516
|
* The `/users` endpoint rejects these audiences with a 422.
|
|
12497
|
-
* - `website`, `website_retargeting`, `engagement`, `meta_engagement`
|
|
12517
|
+
* - `website`, `website_retargeting`, `engagement`, `meta_engagement`, `tiktok_engagement`, `pinterest_engagement`
|
|
12518
|
+
* and `lookalike` fill themselves from the pixel,
|
|
12498
12519
|
* engagement source or seed audience you point them at. They take no member upload at all.
|
|
12499
12520
|
*
|
|
12500
12521
|
* Create is not idempotent, never auto-retry.
|
|
@@ -47983,7 +47983,7 @@ export type ListAdAudiencesResponse = ({
|
|
|
47983
47983
|
platformAudienceId?: string;
|
|
47984
47984
|
name?: string;
|
|
47985
47985
|
description?: string;
|
|
47986
|
-
type?: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
|
|
47986
|
+
type?: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'tiktok_engagement' | 'pinterest_engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
|
|
47987
47987
|
/**
|
|
47988
47988
|
* Present (and the only meaningful payload) when `type` is `saved_targeting`. Null for uploaded/derived audience types.
|
|
47989
47989
|
*/
|
|
@@ -48005,7 +48005,7 @@ export type CreateAdAudienceData = {
|
|
|
48005
48005
|
adAccountId: string;
|
|
48006
48006
|
name: string;
|
|
48007
48007
|
description?: string;
|
|
48008
|
-
type: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'website' | 'website_retargeting' | 'lookalike';
|
|
48008
|
+
type: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'tiktok_engagement' | 'pinterest_engagement' | 'website' | 'website_retargeting' | 'lookalike';
|
|
48009
48009
|
/**
|
|
48010
48010
|
* Required for website_retargeting audiences (LinkedIn only).
|
|
48011
48011
|
* Each rule is a URL pattern; a member who visits any
|
|
@@ -48068,11 +48068,11 @@ export type CreateAdAudienceData = {
|
|
|
48068
48068
|
linkedinPageUrl?: string;
|
|
48069
48069
|
}>;
|
|
48070
48070
|
/**
|
|
48071
|
-
* Required
|
|
48071
|
+
* website: the Meta pixel, TikTok pixel or Pinterest tag id. Required on those three, rejected on Google.
|
|
48072
48072
|
*/
|
|
48073
48073
|
pixelId?: string;
|
|
48074
48074
|
/**
|
|
48075
|
-
* Required for website (max 180
|
|
48075
|
+
* Required for website (Meta max 180, TikTok 7/14/30/60/90/180, Pinterest and Google max 540), meta_engagement (max 365) and tiktok_engagement (7/14/30/60/90/180; organic and live video and most business-account events only 7/14/30).
|
|
48076
48076
|
*/
|
|
48077
48077
|
retentionDays?: number;
|
|
48078
48078
|
/**
|
|
@@ -48087,10 +48087,26 @@ export type CreateAdAudienceData = {
|
|
|
48087
48087
|
*/
|
|
48088
48088
|
sourceId?: string;
|
|
48089
48089
|
/**
|
|
48090
|
-
* meta_engagement
|
|
48090
|
+
* meta_engagement: the engagement event; defaults per source
|
|
48091
48091
|
* (page → page_engaged, instagram → ig_business_profile_all,
|
|
48092
48092
|
* video → video_watched). Ignored when `rule` is provided.
|
|
48093
48093
|
*
|
|
48094
|
+
* website on TikTok: the pixel event (default `PAGE BROWSE`). website
|
|
48095
|
+
* on Pinterest: the tag event (`pagevisit`, `signup`, `checkout`, `viewcategory`, `search`, `addtocart`, `watchvideo`, `lead`, `custom` or a partner-defined event).
|
|
48096
|
+
*
|
|
48097
|
+
* tiktok_engagement (required): the TikTok engagement event, validated
|
|
48098
|
+
* per `source` (TikTok's filter values, spaces included):
|
|
48099
|
+
* - ads: `CLICK`, `IMPRESSION`, `PLAY 2S`, `PLAY 6S`, `PLAY 25`, `PLAY 50`, `PLAY 75`,
|
|
48100
|
+
* `PLAY OVER`, and the `ENGAGEMENT APP PROFILE` / `ENGAGEMENT TIKTOK INSTANT` /
|
|
48101
|
+
* `ENGAGEMENT COLLECTION ADS` `CLICK` and `IMPRESSION` events.
|
|
48102
|
+
* - organic_video: `ORGANIC VIDEO PLAY 2S`, `ORGANIC VIDEO PLAY 6S`,
|
|
48103
|
+
* `ORGANIC VIDEO PLAY OVER`, `ORGANIC VIDEO ENGAGEMENT`.
|
|
48104
|
+
* - live_video: `LIVE VIDEO VIEW`, `LIVE VIDEO ENGAGEMENT`.
|
|
48105
|
+
* - business_account: `BUSINESS ACCOUNT PROFILE FOLLOW`, `BUSINESS ACCOUNT PROFILE VISIT`,
|
|
48106
|
+
* `BUSINESS ACCOUNT ENGAGEMENT`, `BUSINESS ACCOUNT PLAY 2S`, `BUSINESS ACCOUNT PLAY 6S`,
|
|
48107
|
+
* `BUSINESS ACCOUNT PLAY OVER` and the rest of TikTok's business-account events.
|
|
48108
|
+
* An unknown value is a 400 that lists the valid ones.
|
|
48109
|
+
*
|
|
48094
48110
|
*/
|
|
48095
48111
|
event?: string;
|
|
48096
48112
|
/**
|
|
@@ -48102,17 +48118,66 @@ export type CreateAdAudienceData = {
|
|
|
48102
48118
|
*/
|
|
48103
48119
|
country?: string;
|
|
48104
48120
|
/**
|
|
48105
|
-
*
|
|
48121
|
+
* lookalike on Meta (0.01-0.20) and Pinterest (0.01-0.10, whole percents). Rejected on TikTok and Google.
|
|
48106
48122
|
*/
|
|
48107
48123
|
ratio?: number;
|
|
48108
48124
|
/**
|
|
48109
|
-
*
|
|
48110
|
-
|
|
48125
|
+
* lookalike on TikTok and Google: audience breadth. Rejected on Meta and Pinterest.
|
|
48126
|
+
*/
|
|
48127
|
+
size?: 'narrow' | 'balanced' | 'broad';
|
|
48128
|
+
/**
|
|
48129
|
+
* Required for tiktok_engagement: what people engaged with.
|
|
48130
|
+
*/
|
|
48131
|
+
source?: 'ads' | 'organic_video' | 'live_video' | 'business_account';
|
|
48132
|
+
/**
|
|
48133
|
+
* tiktok_engagement: ad group / campaign ids for `ads`, video ids for `organic_video` and `live_video` (max 10). Required except for `business_account`.
|
|
48134
|
+
*/
|
|
48135
|
+
sourceIds?: Array<(string)>;
|
|
48136
|
+
/**
|
|
48137
|
+
* tiktok_engagement: the TikTok identity that owns the videos or business account. Required for organic_video, live_video and business_account.
|
|
48138
|
+
*/
|
|
48139
|
+
identityId?: string;
|
|
48140
|
+
/**
|
|
48141
|
+
* tiktok_engagement: type of `identityId`.
|
|
48142
|
+
*/
|
|
48143
|
+
identityType?: 'TT_USER' | 'BC_AUTH_TT';
|
|
48144
|
+
/**
|
|
48145
|
+
* tiktok_engagement: required when identityType is BC_AUTH_TT.
|
|
48146
|
+
*/
|
|
48147
|
+
identityAuthorizedBcId?: string;
|
|
48148
|
+
/**
|
|
48149
|
+
* pinterest_engagement: Pinterest's `engager_type`, passed through when set.
|
|
48150
|
+
*/
|
|
48151
|
+
engagerType?: 1 | 2;
|
|
48152
|
+
/**
|
|
48153
|
+
* pinterest_engagement: limit to one engagement action.
|
|
48154
|
+
*/
|
|
48155
|
+
engagementType?: 'click' | 'save' | 'closeup' | 'comment' | 'like';
|
|
48156
|
+
/**
|
|
48157
|
+
* pinterest_engagement: people who engaged with Pins from these domains. The domain must be claimed on the Pinterest account or Pinterest rejects it.
|
|
48158
|
+
*/
|
|
48159
|
+
engagementDomains?: Array<(string)>;
|
|
48160
|
+
/**
|
|
48161
|
+
* pinterest_engagement: people who engaged with these campaigns' ads.
|
|
48162
|
+
*/
|
|
48163
|
+
campaignIds?: Array<(string)>;
|
|
48164
|
+
/**
|
|
48165
|
+
* pinterest_engagement: people who engaged with these ads.
|
|
48166
|
+
*/
|
|
48167
|
+
adIds?: Array<(string)>;
|
|
48168
|
+
/**
|
|
48169
|
+
* pinterest_engagement: people who engaged with these Pins. At least one of engagementDomains, campaignIds, adIds or pinIds is required.
|
|
48170
|
+
*/
|
|
48171
|
+
pinIds?: Array<(string)>;
|
|
48172
|
+
/**
|
|
48173
|
+
* website on Meta, TikTok and Google. Narrows the audience from all visitors
|
|
48174
|
+
* to visitors of URLs containing this substring. Ignored when `rule` is
|
|
48175
|
+
* supplied. A 400 on Pinterest, which only matches exact URLs.
|
|
48111
48176
|
*
|
|
48112
48177
|
*/
|
|
48113
48178
|
urlContains?: string;
|
|
48114
48179
|
/**
|
|
48115
|
-
* Optional raw Meta rule, replacing the one we build. Omit it for all
|
|
48180
|
+
* Meta only (a 400 elsewhere). Optional raw Meta rule, replacing the one we build. Omit it for all
|
|
48116
48181
|
* visitors of `pixelId`, or use `urlContains` for the common page-match
|
|
48117
48182
|
* case.
|
|
48118
48183
|
*
|