@getlatedev/node 0.2.1451 → 0.2.1452

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 CHANGED
@@ -2547,6 +2547,10 @@ type Ad = {
2547
2547
  *
2548
2548
  */
2549
2549
  roasAverageFloor?: (number) | null;
2550
+ /**
2551
+ * Special ad categories declared when Zernio created this ad (`specialAdCategories` on POST /v1/ads/create or /v1/ads/boost), e.g. ["HOUSING"]. Empty or absent when none was declared or the ad was created outside Zernio.
2552
+ */
2553
+ specialAdCategories?: Array<(string)>;
2550
2554
  /**
2551
2555
  * Meta promoted object containing conversion event details. Structure varies by objective. Only present for Meta ads.
2552
2556
  */
@@ -3144,6 +3148,10 @@ type AdCampaign = {
3144
3148
  pixel_id?: string;
3145
3149
  page_id?: string;
3146
3150
  } | null;
3151
+ /**
3152
+ * Special ad categories declared when Zernio created the campaign, read from the ad that created it (its earliest ad), e.g. ["HOUSING"]. Absent when none was declared or the campaign was created outside Zernio.
3153
+ */
3154
+ specialAdCategories?: Array<(string)>;
3147
3155
  earliestAd?: string;
3148
3156
  latestAd?: string;
3149
3157
  };
@@ -4716,6 +4724,10 @@ type AdTreeCampaign = {
4716
4724
  pixel_id?: string;
4717
4725
  page_id?: string;
4718
4726
  } | null;
4727
+ /**
4728
+ * Special ad categories declared when Zernio created the campaign, read from the ad that created it (its earliest ad), e.g. ["HOUSING"]. Absent when none was declared or the campaign was created outside Zernio.
4729
+ */
4730
+ specialAdCategories?: Array<(string)>;
4719
4731
  adSets?: Array<AdTreeAdSet>;
4720
4732
  /**
4721
4733
  * Per-day metric series for this campaign. Present only when `GET /v1/ads/tree` is called with `timeIncrement=1` (any `dailyLevel`). This is the per-campaign daily trend. Summing its additive fields reproduces the campaign `metrics` total, except `reach`: on Meta the range total is de-duplicated, so daily reach does not sum to it.
@@ -57624,7 +57636,14 @@ type BoostPostData = {
57624
57636
  }>;
57625
57637
  };
57626
57638
  /**
57627
- * Meta only. Required for housing, employment, credit, or political ads.
57639
+ * Special ad category of the campaign the boost creates. Required for housing, employment, credit, or political ads.
57640
+ *
57641
+ * - Meta: every value.
57642
+ * - TikTok: HOUSING, EMPLOYMENT and CREDIT, sent as the campaign's `special_industries` (TikTok requires one for these ads aimed at the US or Canada). Other values return 400.
57643
+ * - TikTok targeting: a 400 names the field for ZIP codes (`targeting.locations.zips`), gender, ages under 18 (`targeting.ageMin`), interest keywords (`keyword:` ids in `targeting.interests`) and hashtag behaviors.
57644
+ * - TikTok also refuses Smart Targeting (`smartTargeting`) and lookalike audiences (`targeting.audienceInclude` / `targeting.audienceExclude`). Without an age, the ad group targets 18+.
57645
+ * - TikTok sets the category when the campaign is created, so it is a 400 with `smartPlus` or `existingCampaignId`.
57646
+ *
57628
57647
  */
57629
57648
  specialAdCategories?: Array<('HOUSING' | 'EMPLOYMENT' | 'CREDIT' | 'FINANCIAL_PRODUCTS_SERVICES' | 'ISSUES_ELECTIONS_POLITICS' | 'ONLINE_GAMBLING_AND_GAMING')>;
57630
57649
  /**
@@ -58916,9 +58935,21 @@ type CreateStandaloneAdData = {
58916
58935
  [key: string]: unknown;
58917
58936
  };
58918
58937
  /**
58919
- * Meta only. Declares the ad's special category, required for housing, employment, credit, or
58920
- * political/social-issue ads (Meta enforces restricted targeting for these). Note: setting a special
58921
- * category disables income/zip targeting on Meta.
58938
+ * Declares the ad's special category, required for housing, employment, credit, or
58939
+ * political/social-issue ads.
58940
+ *
58941
+ * - Meta: every value. Setting a housing, employment or credit category disables income/zip
58942
+ * targeting on Meta.
58943
+ * - TikTok: HOUSING, EMPLOYMENT and CREDIT, sent as the new campaign's `special_industries`
58944
+ * (TikTok requires one for these ads aimed at the US or Canada). Other values return 400.
58945
+ * - TikTok targeting: the create (and `validateOnly`) returns 400 naming the field for ZIP codes
58946
+ * (`targeting.zips`), gender, ages under 18 (`targeting.ageMin`), interest keywords (`keyword:`
58947
+ * ids in `targeting.interests`) and hashtag behaviors.
58948
+ * - TikTok also refuses Smart Targeting (`smartTargeting`) and lookalike audiences
58949
+ * (`targeting.audienceInclude` / `targeting.audienceExclude`). Without an age, the ad group
58950
+ * targets 18+.
58951
+ * - TikTok sets the category when the campaign is created, so it is a 400 with `smartPlus`,
58952
+ * `existingCampaignId` or `adSetId`.
58922
58953
  *
58923
58954
  */
58924
58955
  specialAdCategories?: Array<('HOUSING' | 'EMPLOYMENT' | 'CREDIT' | 'FINANCIAL_PRODUCTS_SERVICES' | 'ISSUES_ELECTIONS_POLITICS' | 'ONLINE_GAMBLING_AND_GAMING')>;
package/dist/index.d.ts CHANGED
@@ -2547,6 +2547,10 @@ type Ad = {
2547
2547
  *
2548
2548
  */
2549
2549
  roasAverageFloor?: (number) | null;
2550
+ /**
2551
+ * Special ad categories declared when Zernio created this ad (`specialAdCategories` on POST /v1/ads/create or /v1/ads/boost), e.g. ["HOUSING"]. Empty or absent when none was declared or the ad was created outside Zernio.
2552
+ */
2553
+ specialAdCategories?: Array<(string)>;
2550
2554
  /**
2551
2555
  * Meta promoted object containing conversion event details. Structure varies by objective. Only present for Meta ads.
2552
2556
  */
@@ -3144,6 +3148,10 @@ type AdCampaign = {
3144
3148
  pixel_id?: string;
3145
3149
  page_id?: string;
3146
3150
  } | null;
3151
+ /**
3152
+ * Special ad categories declared when Zernio created the campaign, read from the ad that created it (its earliest ad), e.g. ["HOUSING"]. Absent when none was declared or the campaign was created outside Zernio.
3153
+ */
3154
+ specialAdCategories?: Array<(string)>;
3147
3155
  earliestAd?: string;
3148
3156
  latestAd?: string;
3149
3157
  };
@@ -4716,6 +4724,10 @@ type AdTreeCampaign = {
4716
4724
  pixel_id?: string;
4717
4725
  page_id?: string;
4718
4726
  } | null;
4727
+ /**
4728
+ * Special ad categories declared when Zernio created the campaign, read from the ad that created it (its earliest ad), e.g. ["HOUSING"]. Absent when none was declared or the campaign was created outside Zernio.
4729
+ */
4730
+ specialAdCategories?: Array<(string)>;
4719
4731
  adSets?: Array<AdTreeAdSet>;
4720
4732
  /**
4721
4733
  * Per-day metric series for this campaign. Present only when `GET /v1/ads/tree` is called with `timeIncrement=1` (any `dailyLevel`). This is the per-campaign daily trend. Summing its additive fields reproduces the campaign `metrics` total, except `reach`: on Meta the range total is de-duplicated, so daily reach does not sum to it.
@@ -57624,7 +57636,14 @@ type BoostPostData = {
57624
57636
  }>;
57625
57637
  };
57626
57638
  /**
57627
- * Meta only. Required for housing, employment, credit, or political ads.
57639
+ * Special ad category of the campaign the boost creates. Required for housing, employment, credit, or political ads.
57640
+ *
57641
+ * - Meta: every value.
57642
+ * - TikTok: HOUSING, EMPLOYMENT and CREDIT, sent as the campaign's `special_industries` (TikTok requires one for these ads aimed at the US or Canada). Other values return 400.
57643
+ * - TikTok targeting: a 400 names the field for ZIP codes (`targeting.locations.zips`), gender, ages under 18 (`targeting.ageMin`), interest keywords (`keyword:` ids in `targeting.interests`) and hashtag behaviors.
57644
+ * - TikTok also refuses Smart Targeting (`smartTargeting`) and lookalike audiences (`targeting.audienceInclude` / `targeting.audienceExclude`). Without an age, the ad group targets 18+.
57645
+ * - TikTok sets the category when the campaign is created, so it is a 400 with `smartPlus` or `existingCampaignId`.
57646
+ *
57628
57647
  */
57629
57648
  specialAdCategories?: Array<('HOUSING' | 'EMPLOYMENT' | 'CREDIT' | 'FINANCIAL_PRODUCTS_SERVICES' | 'ISSUES_ELECTIONS_POLITICS' | 'ONLINE_GAMBLING_AND_GAMING')>;
57630
57649
  /**
@@ -58916,9 +58935,21 @@ type CreateStandaloneAdData = {
58916
58935
  [key: string]: unknown;
58917
58936
  };
58918
58937
  /**
58919
- * Meta only. Declares the ad's special category, required for housing, employment, credit, or
58920
- * political/social-issue ads (Meta enforces restricted targeting for these). Note: setting a special
58921
- * category disables income/zip targeting on Meta.
58938
+ * Declares the ad's special category, required for housing, employment, credit, or
58939
+ * political/social-issue ads.
58940
+ *
58941
+ * - Meta: every value. Setting a housing, employment or credit category disables income/zip
58942
+ * targeting on Meta.
58943
+ * - TikTok: HOUSING, EMPLOYMENT and CREDIT, sent as the new campaign's `special_industries`
58944
+ * (TikTok requires one for these ads aimed at the US or Canada). Other values return 400.
58945
+ * - TikTok targeting: the create (and `validateOnly`) returns 400 naming the field for ZIP codes
58946
+ * (`targeting.zips`), gender, ages under 18 (`targeting.ageMin`), interest keywords (`keyword:`
58947
+ * ids in `targeting.interests`) and hashtag behaviors.
58948
+ * - TikTok also refuses Smart Targeting (`smartTargeting`) and lookalike audiences
58949
+ * (`targeting.audienceInclude` / `targeting.audienceExclude`). Without an age, the ad group
58950
+ * targets 18+.
58951
+ * - TikTok sets the category when the campaign is created, so it is a 400 with `smartPlus`,
58952
+ * `existingCampaignId` or `adSetId`.
58922
58953
  *
58923
58954
  */
58924
58955
  specialAdCategories?: Array<('HOUSING' | 'EMPLOYMENT' | 'CREDIT' | 'FINANCIAL_PRODUCTS_SERVICES' | 'ISSUES_ELECTIONS_POLITICS' | 'ONLINE_GAMBLING_AND_GAMING')>;
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.1451",
39
+ version: "0.2.1452",
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.1451",
8
+ version: "0.2.1452",
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
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@getlatedev/node",
3
- "version": "0.2.1451",
3
+ "version": "0.2.1452",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -287,6 +287,10 @@ export type Ad = {
287
287
  *
288
288
  */
289
289
  roasAverageFloor?: (number) | null;
290
+ /**
291
+ * Special ad categories declared when Zernio created this ad (`specialAdCategories` on POST /v1/ads/create or /v1/ads/boost), e.g. ["HOUSING"]. Empty or absent when none was declared or the ad was created outside Zernio.
292
+ */
293
+ specialAdCategories?: Array<(string)>;
290
294
  /**
291
295
  * Meta promoted object containing conversion event details. Structure varies by objective. Only present for Meta ads.
292
296
  */
@@ -896,6 +900,10 @@ export type AdCampaign = {
896
900
  pixel_id?: string;
897
901
  page_id?: string;
898
902
  } | null;
903
+ /**
904
+ * Special ad categories declared when Zernio created the campaign, read from the ad that created it (its earliest ad), e.g. ["HOUSING"]. Absent when none was declared or the campaign was created outside Zernio.
905
+ */
906
+ specialAdCategories?: Array<(string)>;
899
907
  earliestAd?: string;
900
908
  latestAd?: string;
901
909
  };
@@ -2527,6 +2535,10 @@ export type AdTreeCampaign = {
2527
2535
  pixel_id?: string;
2528
2536
  page_id?: string;
2529
2537
  } | null;
2538
+ /**
2539
+ * Special ad categories declared when Zernio created the campaign, read from the ad that created it (its earliest ad), e.g. ["HOUSING"]. Absent when none was declared or the campaign was created outside Zernio.
2540
+ */
2541
+ specialAdCategories?: Array<(string)>;
2530
2542
  adSets?: Array<AdTreeAdSet>;
2531
2543
  /**
2532
2544
  * Per-day metric series for this campaign. Present only when `GET /v1/ads/tree` is called with `timeIncrement=1` (any `dailyLevel`). This is the per-campaign daily trend. Summing its additive fields reproduces the campaign `metrics` total, except `reach`: on Meta the range total is de-duplicated, so daily reach does not sum to it.
@@ -58796,7 +58808,14 @@ export type BoostPostData = {
58796
58808
  }>;
58797
58809
  };
58798
58810
  /**
58799
- * Meta only. Required for housing, employment, credit, or political ads.
58811
+ * Special ad category of the campaign the boost creates. Required for housing, employment, credit, or political ads.
58812
+ *
58813
+ * - Meta: every value.
58814
+ * - TikTok: HOUSING, EMPLOYMENT and CREDIT, sent as the campaign's `special_industries` (TikTok requires one for these ads aimed at the US or Canada). Other values return 400.
58815
+ * - TikTok targeting: a 400 names the field for ZIP codes (`targeting.locations.zips`), gender, ages under 18 (`targeting.ageMin`), interest keywords (`keyword:` ids in `targeting.interests`) and hashtag behaviors.
58816
+ * - TikTok also refuses Smart Targeting (`smartTargeting`) and lookalike audiences (`targeting.audienceInclude` / `targeting.audienceExclude`). Without an age, the ad group targets 18+.
58817
+ * - TikTok sets the category when the campaign is created, so it is a 400 with `smartPlus` or `existingCampaignId`.
58818
+ *
58800
58819
  */
58801
58820
  specialAdCategories?: Array<('HOUSING' | 'EMPLOYMENT' | 'CREDIT' | 'FINANCIAL_PRODUCTS_SERVICES' | 'ISSUES_ELECTIONS_POLITICS' | 'ONLINE_GAMBLING_AND_GAMING')>;
58802
58821
  /**
@@ -60112,9 +60131,21 @@ export type CreateStandaloneAdData = {
60112
60131
  [key: string]: unknown;
60113
60132
  };
60114
60133
  /**
60115
- * Meta only. Declares the ad's special category, required for housing, employment, credit, or
60116
- * political/social-issue ads (Meta enforces restricted targeting for these). Note: setting a special
60117
- * category disables income/zip targeting on Meta.
60134
+ * Declares the ad's special category, required for housing, employment, credit, or
60135
+ * political/social-issue ads.
60136
+ *
60137
+ * - Meta: every value. Setting a housing, employment or credit category disables income/zip
60138
+ * targeting on Meta.
60139
+ * - TikTok: HOUSING, EMPLOYMENT and CREDIT, sent as the new campaign's `special_industries`
60140
+ * (TikTok requires one for these ads aimed at the US or Canada). Other values return 400.
60141
+ * - TikTok targeting: the create (and `validateOnly`) returns 400 naming the field for ZIP codes
60142
+ * (`targeting.zips`), gender, ages under 18 (`targeting.ageMin`), interest keywords (`keyword:`
60143
+ * ids in `targeting.interests`) and hashtag behaviors.
60144
+ * - TikTok also refuses Smart Targeting (`smartTargeting`) and lookalike audiences
60145
+ * (`targeting.audienceInclude` / `targeting.audienceExclude`). Without an age, the ad group
60146
+ * targets 18+.
60147
+ * - TikTok sets the category when the campaign is created, so it is a 400 with `smartPlus`,
60148
+ * `existingCampaignId` or `adSetId`.
60118
60149
  *
60119
60150
  */
60120
60151
  specialAdCategories?: Array<('HOUSING' | 'EMPLOYMENT' | 'CREDIT' | 'FINANCIAL_PRODUCTS_SERVICES' | 'ISSUES_ELECTIONS_POLITICS' | 'ONLINE_GAMBLING_AND_GAMING')>;