@getlatedev/node 0.2.400 → 0.2.402
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 +51 -10
- package/dist/index.d.ts +51 -10
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/package.json +1 -1
- package/src/generated/types.gen.ts +51 -10
package/dist/index.d.mts
CHANGED
|
@@ -23248,7 +23248,7 @@ type ListAdsResponse = ({
|
|
|
23248
23248
|
backfillPending?: boolean;
|
|
23249
23249
|
pagination?: Pagination;
|
|
23250
23250
|
} | unknown);
|
|
23251
|
-
type ListAdsError = ({
|
|
23251
|
+
type ListAdsError = (ErrorResponse | {
|
|
23252
23252
|
error?: string;
|
|
23253
23253
|
} | unknown);
|
|
23254
23254
|
type ListAdCampaignsData = {
|
|
@@ -23680,7 +23680,7 @@ type UpdateAdSetData = {
|
|
|
23680
23680
|
*/
|
|
23681
23681
|
endDate?: string;
|
|
23682
23682
|
/**
|
|
23683
|
-
* Meta ad-set promoted_object, forwarded verbatim (same shape as /v1/ads/create).
|
|
23683
|
+
* Meta ad-set promoted_object, forwarded verbatim (same shape as /v1/ads/create). Unknown keys are rejected with 400.
|
|
23684
23684
|
*/
|
|
23685
23685
|
promotedObject?: {
|
|
23686
23686
|
pixelId?: string;
|
|
@@ -23691,6 +23691,8 @@ type UpdateAdSetData = {
|
|
|
23691
23691
|
customConversionId?: string;
|
|
23692
23692
|
productCatalogId?: string;
|
|
23693
23693
|
productSetId?: string;
|
|
23694
|
+
offlineConversionDataSetId?: string;
|
|
23695
|
+
whatsappPhoneNumber?: string;
|
|
23694
23696
|
};
|
|
23695
23697
|
};
|
|
23696
23698
|
};
|
|
@@ -25356,6 +25358,10 @@ type BoostPostData = {
|
|
|
25356
25358
|
* Meta only. Required for housing, employment, credit, or political ads.
|
|
25357
25359
|
*/
|
|
25358
25360
|
specialAdCategories?: Array<('HOUSING' | 'EMPLOYMENT' | 'CREDIT' | 'FINANCIAL_PRODUCTS_SERVICES' | 'ISSUES_ELECTIONS_POLITICS' | 'ONLINE_GAMBLING_AND_GAMING')>;
|
|
25361
|
+
/**
|
|
25362
|
+
* Meta (metaads) only. 2-letter ISO country codes the special ad category applies to. Requires specialAdCategories to be set (400 otherwise).
|
|
25363
|
+
*/
|
|
25364
|
+
specialAdCategoryCountry?: Array<(string)>;
|
|
25359
25365
|
/**
|
|
25360
25366
|
* TikTok-only. Custom destination URL for the Spark Ad. Without this, TikTok
|
|
25361
25367
|
* Spark Ads have no clickable destination — required for traffic / conversion
|
|
@@ -25824,6 +25830,13 @@ type CreateStandaloneAdData = {
|
|
|
25824
25830
|
*
|
|
25825
25831
|
*/
|
|
25826
25832
|
specialAdCategories?: Array<('HOUSING' | 'EMPLOYMENT' | 'CREDIT' | 'FINANCIAL_PRODUCTS_SERVICES' | 'ISSUES_ELECTIONS_POLITICS' | 'ONLINE_GAMBLING_AND_GAMING')>;
|
|
25833
|
+
/**
|
|
25834
|
+
* Meta (metaads) only. 2-letter ISO country codes the special ad category applies to. Requires
|
|
25835
|
+
* specialAdCategories to be set (400 otherwise). Ignored when joining an existing campaign via
|
|
25836
|
+
* existingCampaignId (the existing campaign's category/country already governs it).
|
|
25837
|
+
*
|
|
25838
|
+
*/
|
|
25839
|
+
specialAdCategoryCountry?: Array<(string)>;
|
|
25827
25840
|
/**
|
|
25828
25841
|
* Required for lifetime budgets
|
|
25829
25842
|
*/
|
|
@@ -26187,6 +26200,14 @@ type CreateStandaloneAdData = {
|
|
|
26187
26200
|
* Product Set ID inside the catalog.
|
|
26188
26201
|
*/
|
|
26189
26202
|
productSetId?: string;
|
|
26203
|
+
/**
|
|
26204
|
+
* Meta only. Offline event set (dataset) to optimise toward. Post-merger these are datasets: the id is the dataset id (for pixel-backed datasets, the pixel id).
|
|
26205
|
+
*/
|
|
26206
|
+
offlineConversionDataSetId?: string;
|
|
26207
|
+
/**
|
|
26208
|
+
* Meta only. WhatsApp number on messaging-destination ad sets.
|
|
26209
|
+
*/
|
|
26210
|
+
whatsappPhoneNumber?: string;
|
|
26190
26211
|
};
|
|
26191
26212
|
};
|
|
26192
26213
|
headers?: {
|
|
@@ -26807,7 +26828,7 @@ type ListAdCatalogsResponse = ({
|
|
|
26807
26828
|
productCount?: number;
|
|
26808
26829
|
}>;
|
|
26809
26830
|
});
|
|
26810
|
-
type ListAdCatalogsError = ({
|
|
26831
|
+
type ListAdCatalogsError = (ErrorResponse | {
|
|
26811
26832
|
error?: string;
|
|
26812
26833
|
} | unknown);
|
|
26813
26834
|
type ListAdCatalogProductSetsData = {
|
|
@@ -26831,7 +26852,7 @@ type ListAdCatalogProductSetsResponse = ({
|
|
|
26831
26852
|
productCount?: number;
|
|
26832
26853
|
}>;
|
|
26833
26854
|
});
|
|
26834
|
-
type ListAdCatalogProductSetsError = ({
|
|
26855
|
+
type ListAdCatalogProductSetsError = (ErrorResponse | {
|
|
26835
26856
|
error?: string;
|
|
26836
26857
|
} | unknown);
|
|
26837
26858
|
type ListAdAudiencesData = {
|
|
@@ -26848,7 +26869,7 @@ type ListAdAudiencesData = {
|
|
|
26848
26869
|
/**
|
|
26849
26870
|
* Filter to one audience type. `saved_targeting` returns stored TargetingSpec audiences; the other types return uploaded/derived audiences.
|
|
26850
26871
|
*/
|
|
26851
|
-
type?: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
|
|
26872
|
+
type?: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
|
|
26852
26873
|
};
|
|
26853
26874
|
};
|
|
26854
26875
|
type ListAdAudiencesResponse = ({
|
|
@@ -26861,7 +26882,7 @@ type ListAdAudiencesResponse = ({
|
|
|
26861
26882
|
platformAudienceId?: string;
|
|
26862
26883
|
name?: string;
|
|
26863
26884
|
description?: string;
|
|
26864
|
-
type?: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
|
|
26885
|
+
type?: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
|
|
26865
26886
|
/**
|
|
26866
26887
|
* Present (and the only meaningful payload) when `type` is `saved_targeting`. Null for uploaded/derived audience types.
|
|
26867
26888
|
*/
|
|
@@ -26883,7 +26904,7 @@ type CreateAdAudienceData = {
|
|
|
26883
26904
|
adAccountId: string;
|
|
26884
26905
|
name: string;
|
|
26885
26906
|
description?: string;
|
|
26886
|
-
type: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'website_retargeting' | 'lookalike';
|
|
26907
|
+
type: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'website' | 'website_retargeting' | 'lookalike';
|
|
26887
26908
|
/**
|
|
26888
26909
|
* Required for website_retargeting audiences (LinkedIn only).
|
|
26889
26910
|
* Each rule is a URL pattern; a member who visits any
|
|
@@ -26948,9 +26969,29 @@ type CreateAdAudienceData = {
|
|
|
26948
26969
|
*/
|
|
26949
26970
|
pixelId?: string;
|
|
26950
26971
|
/**
|
|
26951
|
-
* Required for website audiences
|
|
26972
|
+
* Required for website (max 180) and meta_engagement (max 365) audiences.
|
|
26952
26973
|
*/
|
|
26953
26974
|
retentionDays?: number;
|
|
26975
|
+
/**
|
|
26976
|
+
* Required for meta_engagement audiences (Meta only): what people
|
|
26977
|
+
* engaged with. `page` = a Facebook Page, `instagram` = an IG
|
|
26978
|
+
* professional account, `video` = a video. The source object must be
|
|
26979
|
+
* eligible for engagement audiences or Meta rejects with subcode
|
|
26980
|
+
* 1713151 ("Invalid Event Name"), surfaced verbatim.
|
|
26981
|
+
*
|
|
26982
|
+
*/
|
|
26983
|
+
engagementSource?: 'page' | 'instagram' | 'video';
|
|
26984
|
+
/**
|
|
26985
|
+
* Required for meta_engagement: the Page / IG account / video id.
|
|
26986
|
+
*/
|
|
26987
|
+
sourceId?: string;
|
|
26988
|
+
/**
|
|
26989
|
+
* meta_engagement only. The engagement event; defaults per source
|
|
26990
|
+
* (page → page_engaged, instagram → ig_business_profile_all,
|
|
26991
|
+
* video → video_watched). Ignored when `rule` is provided.
|
|
26992
|
+
*
|
|
26993
|
+
*/
|
|
26994
|
+
event?: string;
|
|
26954
26995
|
/**
|
|
26955
26996
|
* Required for lookalike audiences
|
|
26956
26997
|
*/
|
|
@@ -26964,7 +27005,7 @@ type CreateAdAudienceData = {
|
|
|
26964
27005
|
*/
|
|
26965
27006
|
ratio?: number;
|
|
26966
27007
|
/**
|
|
26967
|
-
*
|
|
27008
|
+
* Optional raw Meta rule, forwarded verbatim: pixel event rule for website audiences, or the engagement rule for meta_engagement (overrides the built rule, e.g. for event/canvas/lead-form sources).
|
|
26968
27009
|
*/
|
|
26969
27010
|
rule?: {
|
|
26970
27011
|
[key: string]: unknown;
|
|
@@ -27097,7 +27138,7 @@ type GetConversionsQualityResponse = ({
|
|
|
27097
27138
|
eventCoveragePercentage?: number;
|
|
27098
27139
|
}>;
|
|
27099
27140
|
});
|
|
27100
|
-
type GetConversionsQualityError = ({
|
|
27141
|
+
type GetConversionsQualityError = (ErrorResponse | {
|
|
27101
27142
|
error?: string;
|
|
27102
27143
|
} | unknown);
|
|
27103
27144
|
type SendConversionsData = {
|
package/dist/index.d.ts
CHANGED
|
@@ -23248,7 +23248,7 @@ type ListAdsResponse = ({
|
|
|
23248
23248
|
backfillPending?: boolean;
|
|
23249
23249
|
pagination?: Pagination;
|
|
23250
23250
|
} | unknown);
|
|
23251
|
-
type ListAdsError = ({
|
|
23251
|
+
type ListAdsError = (ErrorResponse | {
|
|
23252
23252
|
error?: string;
|
|
23253
23253
|
} | unknown);
|
|
23254
23254
|
type ListAdCampaignsData = {
|
|
@@ -23680,7 +23680,7 @@ type UpdateAdSetData = {
|
|
|
23680
23680
|
*/
|
|
23681
23681
|
endDate?: string;
|
|
23682
23682
|
/**
|
|
23683
|
-
* Meta ad-set promoted_object, forwarded verbatim (same shape as /v1/ads/create).
|
|
23683
|
+
* Meta ad-set promoted_object, forwarded verbatim (same shape as /v1/ads/create). Unknown keys are rejected with 400.
|
|
23684
23684
|
*/
|
|
23685
23685
|
promotedObject?: {
|
|
23686
23686
|
pixelId?: string;
|
|
@@ -23691,6 +23691,8 @@ type UpdateAdSetData = {
|
|
|
23691
23691
|
customConversionId?: string;
|
|
23692
23692
|
productCatalogId?: string;
|
|
23693
23693
|
productSetId?: string;
|
|
23694
|
+
offlineConversionDataSetId?: string;
|
|
23695
|
+
whatsappPhoneNumber?: string;
|
|
23694
23696
|
};
|
|
23695
23697
|
};
|
|
23696
23698
|
};
|
|
@@ -25356,6 +25358,10 @@ type BoostPostData = {
|
|
|
25356
25358
|
* Meta only. Required for housing, employment, credit, or political ads.
|
|
25357
25359
|
*/
|
|
25358
25360
|
specialAdCategories?: Array<('HOUSING' | 'EMPLOYMENT' | 'CREDIT' | 'FINANCIAL_PRODUCTS_SERVICES' | 'ISSUES_ELECTIONS_POLITICS' | 'ONLINE_GAMBLING_AND_GAMING')>;
|
|
25361
|
+
/**
|
|
25362
|
+
* Meta (metaads) only. 2-letter ISO country codes the special ad category applies to. Requires specialAdCategories to be set (400 otherwise).
|
|
25363
|
+
*/
|
|
25364
|
+
specialAdCategoryCountry?: Array<(string)>;
|
|
25359
25365
|
/**
|
|
25360
25366
|
* TikTok-only. Custom destination URL for the Spark Ad. Without this, TikTok
|
|
25361
25367
|
* Spark Ads have no clickable destination — required for traffic / conversion
|
|
@@ -25824,6 +25830,13 @@ type CreateStandaloneAdData = {
|
|
|
25824
25830
|
*
|
|
25825
25831
|
*/
|
|
25826
25832
|
specialAdCategories?: Array<('HOUSING' | 'EMPLOYMENT' | 'CREDIT' | 'FINANCIAL_PRODUCTS_SERVICES' | 'ISSUES_ELECTIONS_POLITICS' | 'ONLINE_GAMBLING_AND_GAMING')>;
|
|
25833
|
+
/**
|
|
25834
|
+
* Meta (metaads) only. 2-letter ISO country codes the special ad category applies to. Requires
|
|
25835
|
+
* specialAdCategories to be set (400 otherwise). Ignored when joining an existing campaign via
|
|
25836
|
+
* existingCampaignId (the existing campaign's category/country already governs it).
|
|
25837
|
+
*
|
|
25838
|
+
*/
|
|
25839
|
+
specialAdCategoryCountry?: Array<(string)>;
|
|
25827
25840
|
/**
|
|
25828
25841
|
* Required for lifetime budgets
|
|
25829
25842
|
*/
|
|
@@ -26187,6 +26200,14 @@ type CreateStandaloneAdData = {
|
|
|
26187
26200
|
* Product Set ID inside the catalog.
|
|
26188
26201
|
*/
|
|
26189
26202
|
productSetId?: string;
|
|
26203
|
+
/**
|
|
26204
|
+
* Meta only. Offline event set (dataset) to optimise toward. Post-merger these are datasets: the id is the dataset id (for pixel-backed datasets, the pixel id).
|
|
26205
|
+
*/
|
|
26206
|
+
offlineConversionDataSetId?: string;
|
|
26207
|
+
/**
|
|
26208
|
+
* Meta only. WhatsApp number on messaging-destination ad sets.
|
|
26209
|
+
*/
|
|
26210
|
+
whatsappPhoneNumber?: string;
|
|
26190
26211
|
};
|
|
26191
26212
|
};
|
|
26192
26213
|
headers?: {
|
|
@@ -26807,7 +26828,7 @@ type ListAdCatalogsResponse = ({
|
|
|
26807
26828
|
productCount?: number;
|
|
26808
26829
|
}>;
|
|
26809
26830
|
});
|
|
26810
|
-
type ListAdCatalogsError = ({
|
|
26831
|
+
type ListAdCatalogsError = (ErrorResponse | {
|
|
26811
26832
|
error?: string;
|
|
26812
26833
|
} | unknown);
|
|
26813
26834
|
type ListAdCatalogProductSetsData = {
|
|
@@ -26831,7 +26852,7 @@ type ListAdCatalogProductSetsResponse = ({
|
|
|
26831
26852
|
productCount?: number;
|
|
26832
26853
|
}>;
|
|
26833
26854
|
});
|
|
26834
|
-
type ListAdCatalogProductSetsError = ({
|
|
26855
|
+
type ListAdCatalogProductSetsError = (ErrorResponse | {
|
|
26835
26856
|
error?: string;
|
|
26836
26857
|
} | unknown);
|
|
26837
26858
|
type ListAdAudiencesData = {
|
|
@@ -26848,7 +26869,7 @@ type ListAdAudiencesData = {
|
|
|
26848
26869
|
/**
|
|
26849
26870
|
* Filter to one audience type. `saved_targeting` returns stored TargetingSpec audiences; the other types return uploaded/derived audiences.
|
|
26850
26871
|
*/
|
|
26851
|
-
type?: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
|
|
26872
|
+
type?: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
|
|
26852
26873
|
};
|
|
26853
26874
|
};
|
|
26854
26875
|
type ListAdAudiencesResponse = ({
|
|
@@ -26861,7 +26882,7 @@ type ListAdAudiencesResponse = ({
|
|
|
26861
26882
|
platformAudienceId?: string;
|
|
26862
26883
|
name?: string;
|
|
26863
26884
|
description?: string;
|
|
26864
|
-
type?: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
|
|
26885
|
+
type?: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
|
|
26865
26886
|
/**
|
|
26866
26887
|
* Present (and the only meaningful payload) when `type` is `saved_targeting`. Null for uploaded/derived audience types.
|
|
26867
26888
|
*/
|
|
@@ -26883,7 +26904,7 @@ type CreateAdAudienceData = {
|
|
|
26883
26904
|
adAccountId: string;
|
|
26884
26905
|
name: string;
|
|
26885
26906
|
description?: string;
|
|
26886
|
-
type: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'website_retargeting' | 'lookalike';
|
|
26907
|
+
type: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'website' | 'website_retargeting' | 'lookalike';
|
|
26887
26908
|
/**
|
|
26888
26909
|
* Required for website_retargeting audiences (LinkedIn only).
|
|
26889
26910
|
* Each rule is a URL pattern; a member who visits any
|
|
@@ -26948,9 +26969,29 @@ type CreateAdAudienceData = {
|
|
|
26948
26969
|
*/
|
|
26949
26970
|
pixelId?: string;
|
|
26950
26971
|
/**
|
|
26951
|
-
* Required for website audiences
|
|
26972
|
+
* Required for website (max 180) and meta_engagement (max 365) audiences.
|
|
26952
26973
|
*/
|
|
26953
26974
|
retentionDays?: number;
|
|
26975
|
+
/**
|
|
26976
|
+
* Required for meta_engagement audiences (Meta only): what people
|
|
26977
|
+
* engaged with. `page` = a Facebook Page, `instagram` = an IG
|
|
26978
|
+
* professional account, `video` = a video. The source object must be
|
|
26979
|
+
* eligible for engagement audiences or Meta rejects with subcode
|
|
26980
|
+
* 1713151 ("Invalid Event Name"), surfaced verbatim.
|
|
26981
|
+
*
|
|
26982
|
+
*/
|
|
26983
|
+
engagementSource?: 'page' | 'instagram' | 'video';
|
|
26984
|
+
/**
|
|
26985
|
+
* Required for meta_engagement: the Page / IG account / video id.
|
|
26986
|
+
*/
|
|
26987
|
+
sourceId?: string;
|
|
26988
|
+
/**
|
|
26989
|
+
* meta_engagement only. The engagement event; defaults per source
|
|
26990
|
+
* (page → page_engaged, instagram → ig_business_profile_all,
|
|
26991
|
+
* video → video_watched). Ignored when `rule` is provided.
|
|
26992
|
+
*
|
|
26993
|
+
*/
|
|
26994
|
+
event?: string;
|
|
26954
26995
|
/**
|
|
26955
26996
|
* Required for lookalike audiences
|
|
26956
26997
|
*/
|
|
@@ -26964,7 +27005,7 @@ type CreateAdAudienceData = {
|
|
|
26964
27005
|
*/
|
|
26965
27006
|
ratio?: number;
|
|
26966
27007
|
/**
|
|
26967
|
-
*
|
|
27008
|
+
* Optional raw Meta rule, forwarded verbatim: pixel event rule for website audiences, or the engagement rule for meta_engagement (overrides the built rule, e.g. for event/canvas/lead-form sources).
|
|
26968
27009
|
*/
|
|
26969
27010
|
rule?: {
|
|
26970
27011
|
[key: string]: unknown;
|
|
@@ -27097,7 +27138,7 @@ type GetConversionsQualityResponse = ({
|
|
|
27097
27138
|
eventCoveragePercentage?: number;
|
|
27098
27139
|
}>;
|
|
27099
27140
|
});
|
|
27100
|
-
type GetConversionsQualityError = ({
|
|
27141
|
+
type GetConversionsQualityError = (ErrorResponse | {
|
|
27101
27142
|
error?: string;
|
|
27102
27143
|
} | unknown);
|
|
27103
27144
|
type SendConversionsData = {
|
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.402",
|
|
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.402",
|
|
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
|
@@ -23830,7 +23830,7 @@ export type ListAdsResponse = ({
|
|
|
23830
23830
|
pagination?: Pagination;
|
|
23831
23831
|
} | unknown);
|
|
23832
23832
|
|
|
23833
|
-
export type ListAdsError = ({
|
|
23833
|
+
export type ListAdsError = (ErrorResponse | {
|
|
23834
23834
|
error?: string;
|
|
23835
23835
|
} | unknown);
|
|
23836
23836
|
|
|
@@ -24293,7 +24293,7 @@ export type UpdateAdSetData = {
|
|
|
24293
24293
|
*/
|
|
24294
24294
|
endDate?: string;
|
|
24295
24295
|
/**
|
|
24296
|
-
* Meta ad-set promoted_object, forwarded verbatim (same shape as /v1/ads/create).
|
|
24296
|
+
* Meta ad-set promoted_object, forwarded verbatim (same shape as /v1/ads/create). Unknown keys are rejected with 400.
|
|
24297
24297
|
*/
|
|
24298
24298
|
promotedObject?: {
|
|
24299
24299
|
pixelId?: string;
|
|
@@ -24304,6 +24304,8 @@ export type UpdateAdSetData = {
|
|
|
24304
24304
|
customConversionId?: string;
|
|
24305
24305
|
productCatalogId?: string;
|
|
24306
24306
|
productSetId?: string;
|
|
24307
|
+
offlineConversionDataSetId?: string;
|
|
24308
|
+
whatsappPhoneNumber?: string;
|
|
24307
24309
|
};
|
|
24308
24310
|
};
|
|
24309
24311
|
};
|
|
@@ -26083,6 +26085,10 @@ export type BoostPostData = {
|
|
|
26083
26085
|
* Meta only. Required for housing, employment, credit, or political ads.
|
|
26084
26086
|
*/
|
|
26085
26087
|
specialAdCategories?: Array<('HOUSING' | 'EMPLOYMENT' | 'CREDIT' | 'FINANCIAL_PRODUCTS_SERVICES' | 'ISSUES_ELECTIONS_POLITICS' | 'ONLINE_GAMBLING_AND_GAMING')>;
|
|
26088
|
+
/**
|
|
26089
|
+
* Meta (metaads) only. 2-letter ISO country codes the special ad category applies to. Requires specialAdCategories to be set (400 otherwise).
|
|
26090
|
+
*/
|
|
26091
|
+
specialAdCategoryCountry?: Array<(string)>;
|
|
26086
26092
|
/**
|
|
26087
26093
|
* TikTok-only. Custom destination URL for the Spark Ad. Without this, TikTok
|
|
26088
26094
|
* Spark Ads have no clickable destination — required for traffic / conversion
|
|
@@ -26554,6 +26560,13 @@ export type CreateStandaloneAdData = {
|
|
|
26554
26560
|
*
|
|
26555
26561
|
*/
|
|
26556
26562
|
specialAdCategories?: Array<('HOUSING' | 'EMPLOYMENT' | 'CREDIT' | 'FINANCIAL_PRODUCTS_SERVICES' | 'ISSUES_ELECTIONS_POLITICS' | 'ONLINE_GAMBLING_AND_GAMING')>;
|
|
26563
|
+
/**
|
|
26564
|
+
* Meta (metaads) only. 2-letter ISO country codes the special ad category applies to. Requires
|
|
26565
|
+
* specialAdCategories to be set (400 otherwise). Ignored when joining an existing campaign via
|
|
26566
|
+
* existingCampaignId (the existing campaign's category/country already governs it).
|
|
26567
|
+
*
|
|
26568
|
+
*/
|
|
26569
|
+
specialAdCategoryCountry?: Array<(string)>;
|
|
26557
26570
|
/**
|
|
26558
26571
|
* Required for lifetime budgets
|
|
26559
26572
|
*/
|
|
@@ -26917,6 +26930,14 @@ export type CreateStandaloneAdData = {
|
|
|
26917
26930
|
* Product Set ID inside the catalog.
|
|
26918
26931
|
*/
|
|
26919
26932
|
productSetId?: string;
|
|
26933
|
+
/**
|
|
26934
|
+
* Meta only. Offline event set (dataset) to optimise toward. Post-merger these are datasets: the id is the dataset id (for pixel-backed datasets, the pixel id).
|
|
26935
|
+
*/
|
|
26936
|
+
offlineConversionDataSetId?: string;
|
|
26937
|
+
/**
|
|
26938
|
+
* Meta only. WhatsApp number on messaging-destination ad sets.
|
|
26939
|
+
*/
|
|
26940
|
+
whatsappPhoneNumber?: string;
|
|
26920
26941
|
};
|
|
26921
26942
|
};
|
|
26922
26943
|
headers?: {
|
|
@@ -27584,7 +27605,7 @@ export type ListAdCatalogsResponse = ({
|
|
|
27584
27605
|
}>;
|
|
27585
27606
|
});
|
|
27586
27607
|
|
|
27587
|
-
export type ListAdCatalogsError = ({
|
|
27608
|
+
export type ListAdCatalogsError = (ErrorResponse | {
|
|
27588
27609
|
error?: string;
|
|
27589
27610
|
} | unknown);
|
|
27590
27611
|
|
|
@@ -27611,7 +27632,7 @@ export type ListAdCatalogProductSetsResponse = ({
|
|
|
27611
27632
|
}>;
|
|
27612
27633
|
});
|
|
27613
27634
|
|
|
27614
|
-
export type ListAdCatalogProductSetsError = ({
|
|
27635
|
+
export type ListAdCatalogProductSetsError = (ErrorResponse | {
|
|
27615
27636
|
error?: string;
|
|
27616
27637
|
} | unknown);
|
|
27617
27638
|
|
|
@@ -27629,7 +27650,7 @@ export type ListAdAudiencesData = {
|
|
|
27629
27650
|
/**
|
|
27630
27651
|
* Filter to one audience type. `saved_targeting` returns stored TargetingSpec audiences; the other types return uploaded/derived audiences.
|
|
27631
27652
|
*/
|
|
27632
|
-
type?: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
|
|
27653
|
+
type?: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
|
|
27633
27654
|
};
|
|
27634
27655
|
};
|
|
27635
27656
|
|
|
@@ -27643,7 +27664,7 @@ export type ListAdAudiencesResponse = ({
|
|
|
27643
27664
|
platformAudienceId?: string;
|
|
27644
27665
|
name?: string;
|
|
27645
27666
|
description?: string;
|
|
27646
|
-
type?: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
|
|
27667
|
+
type?: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'website' | 'website_retargeting' | 'lookalike' | 'saved_targeting';
|
|
27647
27668
|
/**
|
|
27648
27669
|
* Present (and the only meaningful payload) when `type` is `saved_targeting`. Null for uploaded/derived audience types.
|
|
27649
27670
|
*/
|
|
@@ -27667,7 +27688,7 @@ export type CreateAdAudienceData = {
|
|
|
27667
27688
|
adAccountId: string;
|
|
27668
27689
|
name: string;
|
|
27669
27690
|
description?: string;
|
|
27670
|
-
type: 'customer_list' | 'company_list' | 'engagement' | 'website' | 'website_retargeting' | 'lookalike';
|
|
27691
|
+
type: 'customer_list' | 'company_list' | 'engagement' | 'meta_engagement' | 'website' | 'website_retargeting' | 'lookalike';
|
|
27671
27692
|
/**
|
|
27672
27693
|
* Required for website_retargeting audiences (LinkedIn only).
|
|
27673
27694
|
* Each rule is a URL pattern; a member who visits any
|
|
@@ -27732,9 +27753,29 @@ export type CreateAdAudienceData = {
|
|
|
27732
27753
|
*/
|
|
27733
27754
|
pixelId?: string;
|
|
27734
27755
|
/**
|
|
27735
|
-
* Required for website audiences
|
|
27756
|
+
* Required for website (max 180) and meta_engagement (max 365) audiences.
|
|
27736
27757
|
*/
|
|
27737
27758
|
retentionDays?: number;
|
|
27759
|
+
/**
|
|
27760
|
+
* Required for meta_engagement audiences (Meta only): what people
|
|
27761
|
+
* engaged with. `page` = a Facebook Page, `instagram` = an IG
|
|
27762
|
+
* professional account, `video` = a video. The source object must be
|
|
27763
|
+
* eligible for engagement audiences or Meta rejects with subcode
|
|
27764
|
+
* 1713151 ("Invalid Event Name"), surfaced verbatim.
|
|
27765
|
+
*
|
|
27766
|
+
*/
|
|
27767
|
+
engagementSource?: 'page' | 'instagram' | 'video';
|
|
27768
|
+
/**
|
|
27769
|
+
* Required for meta_engagement: the Page / IG account / video id.
|
|
27770
|
+
*/
|
|
27771
|
+
sourceId?: string;
|
|
27772
|
+
/**
|
|
27773
|
+
* meta_engagement only. The engagement event; defaults per source
|
|
27774
|
+
* (page → page_engaged, instagram → ig_business_profile_all,
|
|
27775
|
+
* video → video_watched). Ignored when `rule` is provided.
|
|
27776
|
+
*
|
|
27777
|
+
*/
|
|
27778
|
+
event?: string;
|
|
27738
27779
|
/**
|
|
27739
27780
|
* Required for lookalike audiences
|
|
27740
27781
|
*/
|
|
@@ -27748,7 +27789,7 @@ export type CreateAdAudienceData = {
|
|
|
27748
27789
|
*/
|
|
27749
27790
|
ratio?: number;
|
|
27750
27791
|
/**
|
|
27751
|
-
*
|
|
27792
|
+
* Optional raw Meta rule, forwarded verbatim: pixel event rule for website audiences, or the engagement rule for meta_engagement (overrides the built rule, e.g. for event/canvas/lead-form sources).
|
|
27752
27793
|
*/
|
|
27753
27794
|
rule?: {
|
|
27754
27795
|
[key: string]: unknown;
|
|
@@ -27898,7 +27939,7 @@ export type GetConversionsQualityResponse = ({
|
|
|
27898
27939
|
}>;
|
|
27899
27940
|
});
|
|
27900
27941
|
|
|
27901
|
-
export type GetConversionsQualityError = ({
|
|
27942
|
+
export type GetConversionsQualityError = (ErrorResponse | {
|
|
27902
27943
|
error?: string;
|
|
27903
27944
|
} | unknown);
|
|
27904
27945
|
|