@getlatedev/node 0.2.934 → 0.2.935

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
@@ -2676,7 +2676,7 @@ type matchType2 = 'broad' | 'phrase' | 'exact';
2676
2676
  * For `goal: app_promotion`, it is also sent on the campaign only when
2677
2677
  * `isSkadnetworkAttribution: true`. Plain Android app installs keep the
2678
2678
  * existing campaign payload, with the promoted object only on the ad set.
2679
- * POST /v1/ads/campaigns forwards this object only for that explicit SKAN flag.
2679
+ * POST /v1/ads/campaigns forwards this object on Meta only for that explicit SKAN flag.
2680
2680
  * Required for goals whose ad-set optimization_goal points at a specific
2681
2681
  * event/page/app (without it Meta rejects the ad-set create with
2682
2682
  * `error_subcode: 1815430` "Please select a promoted object for your ad set"):
@@ -2696,8 +2696,13 @@ type matchType2 = 'broad' | 'phrase' | 'exact';
2696
2696
  * the App ID of an app registered on the TikTok Ads account (Assets → Events →
2697
2697
  * App Events). Install optimization needs the app's MMP tracking configured.
2698
2698
  *
2699
+ * **OpenAI (ChatGPT) Ads**: `goal: conversions` only, on POST /v1/ads/create and
2700
+ * POST /v1/ads/campaigns. `customEventType` picks the conversion event the campaign
2701
+ * optimizes for (sent as the campaign's `conversion_event_setting_ids`); every other
2702
+ * `promotedObject` field is rejected with a 400. See `customEventType` below.
2703
+ *
2699
2704
  * The remaining `promotedObject.*` fields are Meta-only. Platforms other than
2700
- * Meta and TikTok ignore `promotedObject` entirely.
2705
+ * Meta, TikTok and OpenAI ignore `promotedObject` entirely.
2701
2706
  *
2702
2707
  */
2703
2708
  type AdPromotedObject = {
@@ -2733,6 +2738,17 @@ type AdPromotedObject = {
2733
2738
  * deprecated. On rejection the error lists the event types your pixel
2734
2739
  * actually tracks. Optional for `goal: conversions`.
2735
2740
  *
2741
+ * **OpenAI (ChatGPT) Ads:** a conversion event from
2742
+ * `GET /v1/accounts/{accountId}/conversion-destinations` (`conversionEvents[]`),
2743
+ * given as its `id` (exact), its `eventType` (e.g. `order_created`) or its `name`
2744
+ * (e.g. `Purchase`), both case-insensitive. It must be `optimizable` (active and
2745
+ * not custom). An unknown, archived or custom event returns a 400 listing the
2746
+ * account's optimizable events; a type or name shared by several optimizable
2747
+ * events returns a 400 asking for the id. `validateOnly: true` runs the same
2748
+ * check and names the resolved event in its `message`. Optional: when omitted,
2749
+ * the campaign optimizes for the first optimizable event in OpenAI's own list
2750
+ * order, which is the most recently created one.
2751
+ *
2736
2752
  */
2737
2753
  customEventType?: string;
2738
2754
  /**
@@ -40366,7 +40382,7 @@ type CreateStandaloneAdData = {
40366
40382
  * - For `conversions` on LinkedIn, or to promote an existing post, use POST /v1/ads/boost.
40367
40383
  *
40368
40384
  * **OpenAI Ads**
40369
- * - Only `traffic`, `awareness`, and `conversions` are supported (other goals return 400). Maps to OpenAI's `bidding_type` (clicks, impressions, conversions respectively). `conversions` requires an active conversion event setting on the account; create a tracking tag with `defaultEventType` via the tracking-tags API (`POST /v1/accounts/{accountId}/tracking-tags`), or configure a conversion event in OpenAI Ads Manager, or the request returns 422.
40385
+ * - Only `traffic`, `awareness`, and `conversions` are supported (other goals return 400). Maps to OpenAI's `bidding_type` (clicks, impressions, conversions respectively). `conversions` requires an active conversion event setting on the account; create a tracking tag with `defaultEventType` via the tracking-tags API (`POST /v1/accounts/{accountId}/tracking-tags`), or configure a conversion event in OpenAI Ads Manager, or the request returns 400. Pick the event with `promotedObject.customEventType` (see AdPromotedObject); without it the most recently created optimizable event is used.
40370
40386
  *
40371
40387
  */
40372
40388
  goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'page_likes' | 'job_applicants';
@@ -43542,9 +43558,12 @@ type ListConversionDestinationsResponse = ({
43542
43558
  adAccountId?: string;
43543
43559
  /**
43544
43560
  * OpenAI Ads only: the conversion event settings wired
43545
- * to this pixel. A `goal: conversions` create on
43546
- * POST /v1/ads/create optimizes for the first
43547
- * `optimizable` one; when none is, it returns 400.
43561
+ * to this pixel. Pass one's `id`, `eventType` or `name`
43562
+ * as `promotedObject.customEventType` on a
43563
+ * `goal: conversions` create (POST /v1/ads/create or
43564
+ * POST /v1/ads/campaigns) to optimize for it. Without
43565
+ * it, the account's most recently created `optimizable`
43566
+ * event is used; when none is, the create returns 400.
43548
43567
  *
43549
43568
  */
43550
43569
  conversionEvents?: Array<{
package/dist/index.d.ts CHANGED
@@ -2676,7 +2676,7 @@ type matchType2 = 'broad' | 'phrase' | 'exact';
2676
2676
  * For `goal: app_promotion`, it is also sent on the campaign only when
2677
2677
  * `isSkadnetworkAttribution: true`. Plain Android app installs keep the
2678
2678
  * existing campaign payload, with the promoted object only on the ad set.
2679
- * POST /v1/ads/campaigns forwards this object only for that explicit SKAN flag.
2679
+ * POST /v1/ads/campaigns forwards this object on Meta only for that explicit SKAN flag.
2680
2680
  * Required for goals whose ad-set optimization_goal points at a specific
2681
2681
  * event/page/app (without it Meta rejects the ad-set create with
2682
2682
  * `error_subcode: 1815430` "Please select a promoted object for your ad set"):
@@ -2696,8 +2696,13 @@ type matchType2 = 'broad' | 'phrase' | 'exact';
2696
2696
  * the App ID of an app registered on the TikTok Ads account (Assets → Events →
2697
2697
  * App Events). Install optimization needs the app's MMP tracking configured.
2698
2698
  *
2699
+ * **OpenAI (ChatGPT) Ads**: `goal: conversions` only, on POST /v1/ads/create and
2700
+ * POST /v1/ads/campaigns. `customEventType` picks the conversion event the campaign
2701
+ * optimizes for (sent as the campaign's `conversion_event_setting_ids`); every other
2702
+ * `promotedObject` field is rejected with a 400. See `customEventType` below.
2703
+ *
2699
2704
  * The remaining `promotedObject.*` fields are Meta-only. Platforms other than
2700
- * Meta and TikTok ignore `promotedObject` entirely.
2705
+ * Meta, TikTok and OpenAI ignore `promotedObject` entirely.
2701
2706
  *
2702
2707
  */
2703
2708
  type AdPromotedObject = {
@@ -2733,6 +2738,17 @@ type AdPromotedObject = {
2733
2738
  * deprecated. On rejection the error lists the event types your pixel
2734
2739
  * actually tracks. Optional for `goal: conversions`.
2735
2740
  *
2741
+ * **OpenAI (ChatGPT) Ads:** a conversion event from
2742
+ * `GET /v1/accounts/{accountId}/conversion-destinations` (`conversionEvents[]`),
2743
+ * given as its `id` (exact), its `eventType` (e.g. `order_created`) or its `name`
2744
+ * (e.g. `Purchase`), both case-insensitive. It must be `optimizable` (active and
2745
+ * not custom). An unknown, archived or custom event returns a 400 listing the
2746
+ * account's optimizable events; a type or name shared by several optimizable
2747
+ * events returns a 400 asking for the id. `validateOnly: true` runs the same
2748
+ * check and names the resolved event in its `message`. Optional: when omitted,
2749
+ * the campaign optimizes for the first optimizable event in OpenAI's own list
2750
+ * order, which is the most recently created one.
2751
+ *
2736
2752
  */
2737
2753
  customEventType?: string;
2738
2754
  /**
@@ -40366,7 +40382,7 @@ type CreateStandaloneAdData = {
40366
40382
  * - For `conversions` on LinkedIn, or to promote an existing post, use POST /v1/ads/boost.
40367
40383
  *
40368
40384
  * **OpenAI Ads**
40369
- * - Only `traffic`, `awareness`, and `conversions` are supported (other goals return 400). Maps to OpenAI's `bidding_type` (clicks, impressions, conversions respectively). `conversions` requires an active conversion event setting on the account; create a tracking tag with `defaultEventType` via the tracking-tags API (`POST /v1/accounts/{accountId}/tracking-tags`), or configure a conversion event in OpenAI Ads Manager, or the request returns 422.
40385
+ * - Only `traffic`, `awareness`, and `conversions` are supported (other goals return 400). Maps to OpenAI's `bidding_type` (clicks, impressions, conversions respectively). `conversions` requires an active conversion event setting on the account; create a tracking tag with `defaultEventType` via the tracking-tags API (`POST /v1/accounts/{accountId}/tracking-tags`), or configure a conversion event in OpenAI Ads Manager, or the request returns 400. Pick the event with `promotedObject.customEventType` (see AdPromotedObject); without it the most recently created optimizable event is used.
40370
40386
  *
40371
40387
  */
40372
40388
  goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'page_likes' | 'job_applicants';
@@ -43542,9 +43558,12 @@ type ListConversionDestinationsResponse = ({
43542
43558
  adAccountId?: string;
43543
43559
  /**
43544
43560
  * OpenAI Ads only: the conversion event settings wired
43545
- * to this pixel. A `goal: conversions` create on
43546
- * POST /v1/ads/create optimizes for the first
43547
- * `optimizable` one; when none is, it returns 400.
43561
+ * to this pixel. Pass one's `id`, `eventType` or `name`
43562
+ * as `promotedObject.customEventType` on a
43563
+ * `goal: conversions` create (POST /v1/ads/create or
43564
+ * POST /v1/ads/campaigns) to optimize for it. Without
43565
+ * it, the account's most recently created `optimizable`
43566
+ * event is used; when none is, the create returns 400.
43548
43567
  *
43549
43568
  */
43550
43569
  conversionEvents?: Array<{
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.934",
39
+ version: "0.2.935",
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.934",
8
+ version: "0.2.935",
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.934",
3
+ "version": "0.2.935",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -1017,7 +1017,7 @@ export type matchType2 = 'broad' | 'phrase' | 'exact';
1017
1017
  * For `goal: app_promotion`, it is also sent on the campaign only when
1018
1018
  * `isSkadnetworkAttribution: true`. Plain Android app installs keep the
1019
1019
  * existing campaign payload, with the promoted object only on the ad set.
1020
- * POST /v1/ads/campaigns forwards this object only for that explicit SKAN flag.
1020
+ * POST /v1/ads/campaigns forwards this object on Meta only for that explicit SKAN flag.
1021
1021
  * Required for goals whose ad-set optimization_goal points at a specific
1022
1022
  * event/page/app (without it Meta rejects the ad-set create with
1023
1023
  * `error_subcode: 1815430` "Please select a promoted object for your ad set"):
@@ -1037,8 +1037,13 @@ export type matchType2 = 'broad' | 'phrase' | 'exact';
1037
1037
  * the App ID of an app registered on the TikTok Ads account (Assets → Events →
1038
1038
  * App Events). Install optimization needs the app's MMP tracking configured.
1039
1039
  *
1040
+ * **OpenAI (ChatGPT) Ads**: `goal: conversions` only, on POST /v1/ads/create and
1041
+ * POST /v1/ads/campaigns. `customEventType` picks the conversion event the campaign
1042
+ * optimizes for (sent as the campaign's `conversion_event_setting_ids`); every other
1043
+ * `promotedObject` field is rejected with a 400. See `customEventType` below.
1044
+ *
1040
1045
  * The remaining `promotedObject.*` fields are Meta-only. Platforms other than
1041
- * Meta and TikTok ignore `promotedObject` entirely.
1046
+ * Meta, TikTok and OpenAI ignore `promotedObject` entirely.
1042
1047
  *
1043
1048
  */
1044
1049
  export type AdPromotedObject = {
@@ -1074,6 +1079,17 @@ export type AdPromotedObject = {
1074
1079
  * deprecated. On rejection the error lists the event types your pixel
1075
1080
  * actually tracks. Optional for `goal: conversions`.
1076
1081
  *
1082
+ * **OpenAI (ChatGPT) Ads:** a conversion event from
1083
+ * `GET /v1/accounts/{accountId}/conversion-destinations` (`conversionEvents[]`),
1084
+ * given as its `id` (exact), its `eventType` (e.g. `order_created`) or its `name`
1085
+ * (e.g. `Purchase`), both case-insensitive. It must be `optimizable` (active and
1086
+ * not custom). An unknown, archived or custom event returns a 400 listing the
1087
+ * account's optimizable events; a type or name shared by several optimizable
1088
+ * events returns a 400 asking for the id. `validateOnly: true` runs the same
1089
+ * check and names the resolved event in its `message`. Optional: when omitted,
1090
+ * the campaign optimizes for the first optimizable event in OpenAI's own list
1091
+ * order, which is the most recently created one.
1092
+ *
1077
1093
  */
1078
1094
  customEventType?: string;
1079
1095
  /**
@@ -41024,7 +41040,7 @@ export type CreateStandaloneAdData = {
41024
41040
  * - For `conversions` on LinkedIn, or to promote an existing post, use POST /v1/ads/boost.
41025
41041
  *
41026
41042
  * **OpenAI Ads**
41027
- * - Only `traffic`, `awareness`, and `conversions` are supported (other goals return 400). Maps to OpenAI's `bidding_type` (clicks, impressions, conversions respectively). `conversions` requires an active conversion event setting on the account; create a tracking tag with `defaultEventType` via the tracking-tags API (`POST /v1/accounts/{accountId}/tracking-tags`), or configure a conversion event in OpenAI Ads Manager, or the request returns 422.
41043
+ * - Only `traffic`, `awareness`, and `conversions` are supported (other goals return 400). Maps to OpenAI's `bidding_type` (clicks, impressions, conversions respectively). `conversions` requires an active conversion event setting on the account; create a tracking tag with `defaultEventType` via the tracking-tags API (`POST /v1/accounts/{accountId}/tracking-tags`), or configure a conversion event in OpenAI Ads Manager, or the request returns 400. Pick the event with `promotedObject.customEventType` (see AdPromotedObject); without it the most recently created optimizable event is used.
41028
41044
  *
41029
41045
  */
41030
41046
  goal?: 'engagement' | 'traffic' | 'awareness' | 'video_views' | 'lead_generation' | 'lead_conversion' | 'conversions' | 'app_promotion' | 'catalog_sales' | 'page_likes' | 'job_applicants';
@@ -44354,9 +44370,12 @@ export type ListConversionDestinationsResponse = ({
44354
44370
  adAccountId?: string;
44355
44371
  /**
44356
44372
  * OpenAI Ads only: the conversion event settings wired
44357
- * to this pixel. A `goal: conversions` create on
44358
- * POST /v1/ads/create optimizes for the first
44359
- * `optimizable` one; when none is, it returns 400.
44373
+ * to this pixel. Pass one's `id`, `eventType` or `name`
44374
+ * as `promotedObject.customEventType` on a
44375
+ * `goal: conversions` create (POST /v1/ads/create or
44376
+ * POST /v1/ads/campaigns) to optimize for it. Without
44377
+ * it, the account's most recently created `optimizable`
44378
+ * event is used; when none is, the create returns 400.
44360
44379
  *
44361
44380
  */
44362
44381
  conversionEvents?: Array<{