@zernio/node 0.2.1511 → 0.2.1513

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
@@ -8618,6 +8618,19 @@ type ConversionEvent = {
8618
8618
  * URL where the conversion originated (used by Meta).
8619
8619
  */
8620
8620
  sourceUrl?: string;
8621
+ /**
8622
+ * The ad campaign behind the event, when you know it. Read only by `POST /v1/events`, which ties the event to the campaign named by `campaign.id`, then by the `utm_campaign` of `sourceUrl`, then by `campaign.name`. See its Storage notes for how the event then counts.
8623
+ */
8624
+ campaign?: {
8625
+ /**
8626
+ * Platform campaign ID.
8627
+ */
8628
+ id?: string;
8629
+ /**
8630
+ * Campaign name as it appears on the ad platform (case-insensitive).
8631
+ */
8632
+ name?: string;
8633
+ };
8621
8634
  /**
8622
8635
  * Where the conversion happened. Used by Meta. Google also requires an event source internally; omitting this field sends OTHER to Google. Send an explicit value for accurate origin reporting. `business_messaging` (Meta) marks an event from a WhatsApp, Messenger or Instagram Direct conversation and needs `messaging`.
8623
8636
  */
@@ -24457,6 +24470,14 @@ type YouTubePlatformData = {
24457
24470
  * Optional YouTube playlist ID to add the video to after upload (e.g. 'PLxxxxxxxxxxxxx'). Use GET /v1/accounts/{id}/youtube-playlists to list available playlists. Works for both immediate and scheduled uploads. Quota cost: 50 YouTube API units per call.
24458
24471
  */
24459
24472
  playlistId?: string;
24473
+ /**
24474
+ * Language of the title and description (BCP-47, e.g. ko).
24475
+ */
24476
+ defaultLanguage?: string;
24477
+ /**
24478
+ * Spoken language of the video (BCP-47, e.g. ko). When a video has no audio language, YouTube may set en-US once its metadata is updated.
24479
+ */
24480
+ defaultAudioLanguage?: string;
24460
24481
  };
24461
24482
  type YouTubeScopeMissingResponse = {
24462
24483
  success?: boolean;
@@ -29155,6 +29176,14 @@ type UpdatePostMetadataData = {
29155
29176
  * YouTube playlist ID to add the video to (e.g. 'PLxxxxxxxxxxxxx'). Use GET /v1/accounts/{id}/youtube-playlists to list available playlists. Only playlists owned by the channel are supported.
29156
29177
  */
29157
29178
  playlistId?: string;
29179
+ /**
29180
+ * Language of the title and description (BCP-47, e.g. ko).
29181
+ */
29182
+ defaultLanguage?: string;
29183
+ /**
29184
+ * Spoken language of the video (BCP-47, e.g. ko). When a video has no audio language, YouTube may set en-US once its metadata is updated.
29185
+ */
29186
+ defaultAudioLanguage?: string;
29158
29187
  };
29159
29188
  path: {
29160
29189
  /**
package/dist/index.d.ts CHANGED
@@ -8618,6 +8618,19 @@ type ConversionEvent = {
8618
8618
  * URL where the conversion originated (used by Meta).
8619
8619
  */
8620
8620
  sourceUrl?: string;
8621
+ /**
8622
+ * The ad campaign behind the event, when you know it. Read only by `POST /v1/events`, which ties the event to the campaign named by `campaign.id`, then by the `utm_campaign` of `sourceUrl`, then by `campaign.name`. See its Storage notes for how the event then counts.
8623
+ */
8624
+ campaign?: {
8625
+ /**
8626
+ * Platform campaign ID.
8627
+ */
8628
+ id?: string;
8629
+ /**
8630
+ * Campaign name as it appears on the ad platform (case-insensitive).
8631
+ */
8632
+ name?: string;
8633
+ };
8621
8634
  /**
8622
8635
  * Where the conversion happened. Used by Meta. Google also requires an event source internally; omitting this field sends OTHER to Google. Send an explicit value for accurate origin reporting. `business_messaging` (Meta) marks an event from a WhatsApp, Messenger or Instagram Direct conversation and needs `messaging`.
8623
8636
  */
@@ -24457,6 +24470,14 @@ type YouTubePlatformData = {
24457
24470
  * Optional YouTube playlist ID to add the video to after upload (e.g. 'PLxxxxxxxxxxxxx'). Use GET /v1/accounts/{id}/youtube-playlists to list available playlists. Works for both immediate and scheduled uploads. Quota cost: 50 YouTube API units per call.
24458
24471
  */
24459
24472
  playlistId?: string;
24473
+ /**
24474
+ * Language of the title and description (BCP-47, e.g. ko).
24475
+ */
24476
+ defaultLanguage?: string;
24477
+ /**
24478
+ * Spoken language of the video (BCP-47, e.g. ko). When a video has no audio language, YouTube may set en-US once its metadata is updated.
24479
+ */
24480
+ defaultAudioLanguage?: string;
24460
24481
  };
24461
24482
  type YouTubeScopeMissingResponse = {
24462
24483
  success?: boolean;
@@ -29155,6 +29176,14 @@ type UpdatePostMetadataData = {
29155
29176
  * YouTube playlist ID to add the video to (e.g. 'PLxxxxxxxxxxxxx'). Use GET /v1/accounts/{id}/youtube-playlists to list available playlists. Only playlists owned by the channel are supported.
29156
29177
  */
29157
29178
  playlistId?: string;
29179
+ /**
29180
+ * Language of the title and description (BCP-47, e.g. ko).
29181
+ */
29182
+ defaultLanguage?: string;
29183
+ /**
29184
+ * Spoken language of the video (BCP-47, e.g. ko). When a video has no audio language, YouTube may set en-US once its metadata is updated.
29185
+ */
29186
+ defaultAudioLanguage?: string;
29158
29187
  };
29159
29188
  path: {
29160
29189
  /**
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: "@zernio/node",
39
- version: "0.2.1511",
39
+ version: "0.2.1513",
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: "@zernio/node",
8
- version: "0.2.1511",
8
+ version: "0.2.1513",
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": "@zernio/node",
3
- "version": "0.2.1511",
3
+ "version": "0.2.1513",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -12670,7 +12670,7 @@ export const uploadCampaignResults = <ThrowOnError extends boolean = false>(opti
12670
12670
 
12671
12671
  /**
12672
12672
  * List your results per campaign
12673
- * Your results summed per campaign over a date range, one entry per campaign with every metric it has, for the ad accounts your key can see. Each day counts its newest value only.
12673
+ * Your results summed per campaign over a date range, one entry per campaign with every metric it has, for the ad accounts your key can see. Each day counts its newest uploaded value only, plus the events sent to `POST /v1/events` that are tied to the campaign (`sales`, `revenue`, `leads`, `qualified_leads`).
12674
12674
  *
12675
12675
  * Paginated by campaign: pass `nextCursor` back as `cursor` until it is null.
12676
12676
  *
@@ -12700,7 +12700,7 @@ export const getCampaignResultsUpload = <ThrowOnError extends boolean = false>(o
12700
12700
 
12701
12701
  /**
12702
12702
  * Get your results totals
12703
- * Each metric you send summed over a date range across every campaign of the ad accounts your key can see, or of the ones you name. Each day counts its newest value only.
12703
+ * Each metric you send summed over a date range across every campaign of the ad accounts your key can see, or of the ones you name. Each day counts its newest uploaded value only, plus the events sent to `POST /v1/events` that are tied to a campaign.
12704
12704
  *
12705
12705
  * Formulas are not computed here, since they also read the platform's numbers: apply one to these totals and the account's spend for the same range, or read it per campaign from `GET /v1/ads/tree?results=true`.
12706
12706
  *
@@ -18370,6 +18370,8 @@ export const listEvents = <ThrowOnError extends boolean = false>(options: Option
18370
18370
  * - Email, phone and `externalId` are stored only as SHA-256 hashes.
18371
18371
  * - `sourceUrl` keeps only its origin, path and attribution parameters (`utm_*`, `gclid`, `fbclid`, `ttclid`, `li_fat_id`, `epik`, `rdt_cid`, `gbraid`, `wbraid`).
18372
18372
  * - Events sent with `testCode` are forwarded but not stored.
18373
+ * - Sending an event again with the same `eventId` replaces the stored one.
18374
+ * - A stored `Purchase`, `Lead` or `QualifiedLead` tied to one of your campaigns (see `campaign` on each event) counts in `GET /v1/ads/campaign-results` and in ad rules as `sales` and `revenue`, `leads` or `qualified_leads`.
18373
18375
  *
18374
18376
  */
18375
18377
  export const sendEvents = <ThrowOnError extends boolean = false>(options: OptionsLegacyParser<SendEventsData, ThrowOnError>) => {
@@ -6605,6 +6605,19 @@ export type ConversionEvent = {
6605
6605
  * URL where the conversion originated (used by Meta).
6606
6606
  */
6607
6607
  sourceUrl?: string;
6608
+ /**
6609
+ * The ad campaign behind the event, when you know it. Read only by `POST /v1/events`, which ties the event to the campaign named by `campaign.id`, then by the `utm_campaign` of `sourceUrl`, then by `campaign.name`. See its Storage notes for how the event then counts.
6610
+ */
6611
+ campaign?: {
6612
+ /**
6613
+ * Platform campaign ID.
6614
+ */
6615
+ id?: string;
6616
+ /**
6617
+ * Campaign name as it appears on the ad platform (case-insensitive).
6618
+ */
6619
+ name?: string;
6620
+ };
6608
6621
  /**
6609
6622
  * Where the conversion happened. Used by Meta. Google also requires an event source internally; omitting this field sends OTHER to Google. Send an explicit value for accurate origin reporting. `business_messaging` (Meta) marks an event from a WhatsApp, Messenger or Instagram Direct conversation and needs `messaging`.
6610
6623
  */
@@ -23142,6 +23155,14 @@ export type YouTubePlatformData = {
23142
23155
  * Optional YouTube playlist ID to add the video to after upload (e.g. 'PLxxxxxxxxxxxxx'). Use GET /v1/accounts/{id}/youtube-playlists to list available playlists. Works for both immediate and scheduled uploads. Quota cost: 50 YouTube API units per call.
23143
23156
  */
23144
23157
  playlistId?: string;
23158
+ /**
23159
+ * Language of the title and description (BCP-47, e.g. ko).
23160
+ */
23161
+ defaultLanguage?: string;
23162
+ /**
23163
+ * Spoken language of the video (BCP-47, e.g. ko). When a video has no audio language, YouTube may set en-US once its metadata is updated.
23164
+ */
23165
+ defaultAudioLanguage?: string;
23145
23166
  };
23146
23167
 
23147
23168
  export type YouTubeScopeMissingResponse = {
@@ -28149,6 +28170,14 @@ export type UpdatePostMetadataData = {
28149
28170
  * YouTube playlist ID to add the video to (e.g. 'PLxxxxxxxxxxxxx'). Use GET /v1/accounts/{id}/youtube-playlists to list available playlists. Only playlists owned by the channel are supported.
28150
28171
  */
28151
28172
  playlistId?: string;
28173
+ /**
28174
+ * Language of the title and description (BCP-47, e.g. ko).
28175
+ */
28176
+ defaultLanguage?: string;
28177
+ /**
28178
+ * Spoken language of the video (BCP-47, e.g. ko). When a video has no audio language, YouTube may set en-US once its metadata is updated.
28179
+ */
28180
+ defaultAudioLanguage?: string;
28152
28181
  };
28153
28182
  path: {
28154
28183
  /**