@getlatedev/node 0.2.1117 → 0.2.1118

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
@@ -40777,14 +40777,32 @@ type ListAdSetsResponse = ({
40777
40777
  endDate?: string;
40778
40778
  } | null;
40779
40779
  /**
40780
- * The audience this ad set delivers to, as the platform reports it at the last sync.
40781
- * LinkedIn and Meta; null for every other platform and for ad sets not yet re-synced.
40782
- *
40783
- * On Meta it is the ad set's `targeting` verbatim (snake_case: geo_locations,
40784
- * age_min, custom_audiences, flexible_spec, ...), so it can be read, edited and sent
40785
- * back as is. On LinkedIn `include` and `exclude` (below) are the campaign's
40786
- * `targetingCriteria` verbatim, without reconstructing them from our normalized
40787
- * targeting spec.
40780
+ * The audience this ad set delivers to, as the platform reports it at the last sync,
40781
+ * in the platform's own shape. Every platform; null only for an ad set not re-synced
40782
+ * yet, or when the platform's targeting read failed on every sync so far (a failed read
40783
+ * keeps the last stored value).
40784
+ *
40785
+ * - Meta: the ad set's `targeting` verbatim (snake_case: geo_locations, age_min,
40786
+ * custom_audiences, flexible_spec, ...), so it can be read, edited and sent back as is.
40787
+ * - LinkedIn: `include` and `exclude` (below) are the campaign's `targetingCriteria`
40788
+ * verbatim, without reconstructing them from our normalized targeting spec.
40789
+ * - TikTok: the ad group's targeting fields from adgroup/get, verbatim (placement_type,
40790
+ * placements, location_ids, age_groups, gender, languages, interest_category_ids,
40791
+ * actions, audience_ids, excluded_audience_ids, operating_systems, ...). Only fields
40792
+ * TikTok returned are present.
40793
+ * - Google: `campaignCriteria` (LOCATION, LANGUAGE, PROXIMITY, DEVICE, AGE_RANGE, GENDER,
40794
+ * USER_LIST, INCOME_RANGE, PARENTAL_STATUS) and `adGroupCriteria` (AGE_RANGE, GENDER,
40795
+ * USER_LIST, USER_INTEREST, INCOME_RANGE, PARENTAL_STATUS), each a Google criterion
40796
+ * verbatim (camelCase: resourceName, type, negative, bidModifier and the payload its type sets, for
40797
+ * example `location.geoTargetConstant`). Most Google targeting lives on the campaign,
40798
+ * so every ad group of a campaign carries the same `campaignCriteria`. Keywords are
40799
+ * not included (they have their own endpoints). Synced on Google's slower keyword cycle.
40800
+ * - Pinterest: the ad group's `targeting_spec` verbatim (GEO, AGE_BUCKET, GENDER,
40801
+ * INTEREST, AUDIENCE_INCLUDE, LOCALE, ...).
40802
+ * - X: `targeting_criteria`, the line item's criteria as X lists them (targeting_type,
40803
+ * targeting_value, operator_type, name), the same shape X's batch create takes.
40804
+ * - OpenAI: the campaign's `targeting` (OpenAI targets at the campaign), plus the ad
40805
+ * group's `context_hints` when it has any.
40788
40806
  *
40789
40807
  */
40790
40808
  targeting?: {
@@ -40817,19 +40835,19 @@ type ListAdSetsResponse = ({
40817
40835
  */
40818
40836
  statusReadAt?: (string) | null;
40819
40837
  /**
40820
- * The ad set's optimization goal as last synced, in the platform's own enum (Meta `optimization_goal`, for example OFFSITE_CONVERSIONS or LINK_CLICKS). On TikTok with `live=true`, rows read live carry the ad group's `optimization_goal` exactly as TikTok's adgroup/get returns it now (for example ENGAGED_VIEW, ENGAGED_VIEW_FIFTEEN, CLICK, CONVERT).
40838
+ * The ad set's optimization goal as last synced, in the platform's own enum (Meta `optimization_goal`, for example OFFSITE_CONVERSIONS or LINK_CLICKS; TikTok `optimization_goal`; Pinterest the conversion event of `optimization_goal_metadata`, for example CHECKOUT; X the line item `goal`; OpenAI the campaign `bidding_type`). Always null on Google, which has no per-ad-group optimization goal. On TikTok with `live=true`, rows read live carry the ad group's `optimization_goal` exactly as TikTok's adgroup/get returns it now (for example ENGAGED_VIEW, ENGAGED_VIEW_FIFTEEN, CLICK, CONVERT).
40821
40839
  */
40822
40840
  optimizationGoal?: (string) | null;
40823
40841
  /**
40824
- * The ad set's billing event as last synced, where the platform reports one. On TikTok with `live=true`, rows read live carry the ad group's `billing_event` exactly as TikTok's adgroup/get returns it now (for example CPV, CPC, OCPM).
40842
+ * The ad set's billing event as last synced, in the platform's own enum (Meta `billing_event`, TikTok `billing_event`, Pinterest `billable_event`, X `pay_by`, OpenAI `bidding_config.billing_event_type`). Always null on Google, which reports none per ad group. On TikTok with `live=true`, rows read live carry the ad group's `billing_event` exactly as TikTok's adgroup/get returns it now (for example CPV, CPC, OCPM).
40825
40843
  */
40826
40844
  billingEvent?: (string) | null;
40827
40845
  /**
40828
- * The bid strategy as last synced, in the platform's own enum (Meta `bid_strategy`, for example LOWEST_COST_WITHOUT_CAP, COST_CAP). On Meta under a campaign budget this is the campaign's strategy.
40846
+ * The bid strategy as last synced, in Meta's vocabulary (LOWEST_COST_WITHOUT_CAP, LOWEST_COST_WITH_BID_CAP, COST_CAP, LOWEST_COST_WITH_MIN_ROAS) on every platform that has an equivalent. On Meta under a campaign budget this is the campaign's strategy. TikTok maps bid_type / deep_bid_type, Pinterest AUTOMATIC_BID / MAX_BID / TARGET_AVG, X AUTO / MAX / TARGET, OpenAI Maximize Results / a max bid. Google bids at the campaign, so an ad group carries its campaign's strategy; one without a Meta equivalent (MANUAL_CPC, TARGET_IMPRESSION_SHARE, or a portfolio strategy's type such as TARGET_CPA) keeps Google's own name. Null on LinkedIn.
40829
40847
  */
40830
40848
  bidStrategy?: (string) | null;
40831
40849
  /**
40832
- * Bid cap or cost target in whole units of `currency`, as last synced. Null when the strategy has none.
40850
+ * Bid cap or cost target in whole units of `currency`, as last synced. Null when the strategy has none (automatic bidding, ROAS targets, a Google portfolio strategy). On Google a campaign target CPA, a Maximize clicks ceiling, the ad group's own target CPA override, or its CPC bid under MANUAL_CPC.
40833
40851
  */
40834
40852
  bidAmount?: (number) | null;
40835
40853
  /**
package/dist/index.d.ts CHANGED
@@ -40777,14 +40777,32 @@ type ListAdSetsResponse = ({
40777
40777
  endDate?: string;
40778
40778
  } | null;
40779
40779
  /**
40780
- * The audience this ad set delivers to, as the platform reports it at the last sync.
40781
- * LinkedIn and Meta; null for every other platform and for ad sets not yet re-synced.
40782
- *
40783
- * On Meta it is the ad set's `targeting` verbatim (snake_case: geo_locations,
40784
- * age_min, custom_audiences, flexible_spec, ...), so it can be read, edited and sent
40785
- * back as is. On LinkedIn `include` and `exclude` (below) are the campaign's
40786
- * `targetingCriteria` verbatim, without reconstructing them from our normalized
40787
- * targeting spec.
40780
+ * The audience this ad set delivers to, as the platform reports it at the last sync,
40781
+ * in the platform's own shape. Every platform; null only for an ad set not re-synced
40782
+ * yet, or when the platform's targeting read failed on every sync so far (a failed read
40783
+ * keeps the last stored value).
40784
+ *
40785
+ * - Meta: the ad set's `targeting` verbatim (snake_case: geo_locations, age_min,
40786
+ * custom_audiences, flexible_spec, ...), so it can be read, edited and sent back as is.
40787
+ * - LinkedIn: `include` and `exclude` (below) are the campaign's `targetingCriteria`
40788
+ * verbatim, without reconstructing them from our normalized targeting spec.
40789
+ * - TikTok: the ad group's targeting fields from adgroup/get, verbatim (placement_type,
40790
+ * placements, location_ids, age_groups, gender, languages, interest_category_ids,
40791
+ * actions, audience_ids, excluded_audience_ids, operating_systems, ...). Only fields
40792
+ * TikTok returned are present.
40793
+ * - Google: `campaignCriteria` (LOCATION, LANGUAGE, PROXIMITY, DEVICE, AGE_RANGE, GENDER,
40794
+ * USER_LIST, INCOME_RANGE, PARENTAL_STATUS) and `adGroupCriteria` (AGE_RANGE, GENDER,
40795
+ * USER_LIST, USER_INTEREST, INCOME_RANGE, PARENTAL_STATUS), each a Google criterion
40796
+ * verbatim (camelCase: resourceName, type, negative, bidModifier and the payload its type sets, for
40797
+ * example `location.geoTargetConstant`). Most Google targeting lives on the campaign,
40798
+ * so every ad group of a campaign carries the same `campaignCriteria`. Keywords are
40799
+ * not included (they have their own endpoints). Synced on Google's slower keyword cycle.
40800
+ * - Pinterest: the ad group's `targeting_spec` verbatim (GEO, AGE_BUCKET, GENDER,
40801
+ * INTEREST, AUDIENCE_INCLUDE, LOCALE, ...).
40802
+ * - X: `targeting_criteria`, the line item's criteria as X lists them (targeting_type,
40803
+ * targeting_value, operator_type, name), the same shape X's batch create takes.
40804
+ * - OpenAI: the campaign's `targeting` (OpenAI targets at the campaign), plus the ad
40805
+ * group's `context_hints` when it has any.
40788
40806
  *
40789
40807
  */
40790
40808
  targeting?: {
@@ -40817,19 +40835,19 @@ type ListAdSetsResponse = ({
40817
40835
  */
40818
40836
  statusReadAt?: (string) | null;
40819
40837
  /**
40820
- * The ad set's optimization goal as last synced, in the platform's own enum (Meta `optimization_goal`, for example OFFSITE_CONVERSIONS or LINK_CLICKS). On TikTok with `live=true`, rows read live carry the ad group's `optimization_goal` exactly as TikTok's adgroup/get returns it now (for example ENGAGED_VIEW, ENGAGED_VIEW_FIFTEEN, CLICK, CONVERT).
40838
+ * The ad set's optimization goal as last synced, in the platform's own enum (Meta `optimization_goal`, for example OFFSITE_CONVERSIONS or LINK_CLICKS; TikTok `optimization_goal`; Pinterest the conversion event of `optimization_goal_metadata`, for example CHECKOUT; X the line item `goal`; OpenAI the campaign `bidding_type`). Always null on Google, which has no per-ad-group optimization goal. On TikTok with `live=true`, rows read live carry the ad group's `optimization_goal` exactly as TikTok's adgroup/get returns it now (for example ENGAGED_VIEW, ENGAGED_VIEW_FIFTEEN, CLICK, CONVERT).
40821
40839
  */
40822
40840
  optimizationGoal?: (string) | null;
40823
40841
  /**
40824
- * The ad set's billing event as last synced, where the platform reports one. On TikTok with `live=true`, rows read live carry the ad group's `billing_event` exactly as TikTok's adgroup/get returns it now (for example CPV, CPC, OCPM).
40842
+ * The ad set's billing event as last synced, in the platform's own enum (Meta `billing_event`, TikTok `billing_event`, Pinterest `billable_event`, X `pay_by`, OpenAI `bidding_config.billing_event_type`). Always null on Google, which reports none per ad group. On TikTok with `live=true`, rows read live carry the ad group's `billing_event` exactly as TikTok's adgroup/get returns it now (for example CPV, CPC, OCPM).
40825
40843
  */
40826
40844
  billingEvent?: (string) | null;
40827
40845
  /**
40828
- * The bid strategy as last synced, in the platform's own enum (Meta `bid_strategy`, for example LOWEST_COST_WITHOUT_CAP, COST_CAP). On Meta under a campaign budget this is the campaign's strategy.
40846
+ * The bid strategy as last synced, in Meta's vocabulary (LOWEST_COST_WITHOUT_CAP, LOWEST_COST_WITH_BID_CAP, COST_CAP, LOWEST_COST_WITH_MIN_ROAS) on every platform that has an equivalent. On Meta under a campaign budget this is the campaign's strategy. TikTok maps bid_type / deep_bid_type, Pinterest AUTOMATIC_BID / MAX_BID / TARGET_AVG, X AUTO / MAX / TARGET, OpenAI Maximize Results / a max bid. Google bids at the campaign, so an ad group carries its campaign's strategy; one without a Meta equivalent (MANUAL_CPC, TARGET_IMPRESSION_SHARE, or a portfolio strategy's type such as TARGET_CPA) keeps Google's own name. Null on LinkedIn.
40829
40847
  */
40830
40848
  bidStrategy?: (string) | null;
40831
40849
  /**
40832
- * Bid cap or cost target in whole units of `currency`, as last synced. Null when the strategy has none.
40850
+ * Bid cap or cost target in whole units of `currency`, as last synced. Null when the strategy has none (automatic bidding, ROAS targets, a Google portfolio strategy). On Google a campaign target CPA, a Maximize clicks ceiling, the ad group's own target CPA override, or its CPC bid under MANUAL_CPC.
40833
40851
  */
40834
40852
  bidAmount?: (number) | null;
40835
40853
  /**
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.1117",
39
+ version: "0.2.1118",
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.1117",
8
+ version: "0.2.1118",
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.1117",
3
+ "version": "0.2.1118",
4
4
  "description": "The official Node.js library for the Zernio API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -41233,14 +41233,32 @@ export type ListAdSetsResponse = ({
41233
41233
  endDate?: string;
41234
41234
  } | null;
41235
41235
  /**
41236
- * The audience this ad set delivers to, as the platform reports it at the last sync.
41237
- * LinkedIn and Meta; null for every other platform and for ad sets not yet re-synced.
41238
- *
41239
- * On Meta it is the ad set's `targeting` verbatim (snake_case: geo_locations,
41240
- * age_min, custom_audiences, flexible_spec, ...), so it can be read, edited and sent
41241
- * back as is. On LinkedIn `include` and `exclude` (below) are the campaign's
41242
- * `targetingCriteria` verbatim, without reconstructing them from our normalized
41243
- * targeting spec.
41236
+ * The audience this ad set delivers to, as the platform reports it at the last sync,
41237
+ * in the platform's own shape. Every platform; null only for an ad set not re-synced
41238
+ * yet, or when the platform's targeting read failed on every sync so far (a failed read
41239
+ * keeps the last stored value).
41240
+ *
41241
+ * - Meta: the ad set's `targeting` verbatim (snake_case: geo_locations, age_min,
41242
+ * custom_audiences, flexible_spec, ...), so it can be read, edited and sent back as is.
41243
+ * - LinkedIn: `include` and `exclude` (below) are the campaign's `targetingCriteria`
41244
+ * verbatim, without reconstructing them from our normalized targeting spec.
41245
+ * - TikTok: the ad group's targeting fields from adgroup/get, verbatim (placement_type,
41246
+ * placements, location_ids, age_groups, gender, languages, interest_category_ids,
41247
+ * actions, audience_ids, excluded_audience_ids, operating_systems, ...). Only fields
41248
+ * TikTok returned are present.
41249
+ * - Google: `campaignCriteria` (LOCATION, LANGUAGE, PROXIMITY, DEVICE, AGE_RANGE, GENDER,
41250
+ * USER_LIST, INCOME_RANGE, PARENTAL_STATUS) and `adGroupCriteria` (AGE_RANGE, GENDER,
41251
+ * USER_LIST, USER_INTEREST, INCOME_RANGE, PARENTAL_STATUS), each a Google criterion
41252
+ * verbatim (camelCase: resourceName, type, negative, bidModifier and the payload its type sets, for
41253
+ * example `location.geoTargetConstant`). Most Google targeting lives on the campaign,
41254
+ * so every ad group of a campaign carries the same `campaignCriteria`. Keywords are
41255
+ * not included (they have their own endpoints). Synced on Google's slower keyword cycle.
41256
+ * - Pinterest: the ad group's `targeting_spec` verbatim (GEO, AGE_BUCKET, GENDER,
41257
+ * INTEREST, AUDIENCE_INCLUDE, LOCALE, ...).
41258
+ * - X: `targeting_criteria`, the line item's criteria as X lists them (targeting_type,
41259
+ * targeting_value, operator_type, name), the same shape X's batch create takes.
41260
+ * - OpenAI: the campaign's `targeting` (OpenAI targets at the campaign), plus the ad
41261
+ * group's `context_hints` when it has any.
41244
41262
  *
41245
41263
  */
41246
41264
  targeting?: {
@@ -41273,19 +41291,19 @@ export type ListAdSetsResponse = ({
41273
41291
  */
41274
41292
  statusReadAt?: (string) | null;
41275
41293
  /**
41276
- * The ad set's optimization goal as last synced, in the platform's own enum (Meta `optimization_goal`, for example OFFSITE_CONVERSIONS or LINK_CLICKS). On TikTok with `live=true`, rows read live carry the ad group's `optimization_goal` exactly as TikTok's adgroup/get returns it now (for example ENGAGED_VIEW, ENGAGED_VIEW_FIFTEEN, CLICK, CONVERT).
41294
+ * The ad set's optimization goal as last synced, in the platform's own enum (Meta `optimization_goal`, for example OFFSITE_CONVERSIONS or LINK_CLICKS; TikTok `optimization_goal`; Pinterest the conversion event of `optimization_goal_metadata`, for example CHECKOUT; X the line item `goal`; OpenAI the campaign `bidding_type`). Always null on Google, which has no per-ad-group optimization goal. On TikTok with `live=true`, rows read live carry the ad group's `optimization_goal` exactly as TikTok's adgroup/get returns it now (for example ENGAGED_VIEW, ENGAGED_VIEW_FIFTEEN, CLICK, CONVERT).
41277
41295
  */
41278
41296
  optimizationGoal?: (string) | null;
41279
41297
  /**
41280
- * The ad set's billing event as last synced, where the platform reports one. On TikTok with `live=true`, rows read live carry the ad group's `billing_event` exactly as TikTok's adgroup/get returns it now (for example CPV, CPC, OCPM).
41298
+ * The ad set's billing event as last synced, in the platform's own enum (Meta `billing_event`, TikTok `billing_event`, Pinterest `billable_event`, X `pay_by`, OpenAI `bidding_config.billing_event_type`). Always null on Google, which reports none per ad group. On TikTok with `live=true`, rows read live carry the ad group's `billing_event` exactly as TikTok's adgroup/get returns it now (for example CPV, CPC, OCPM).
41281
41299
  */
41282
41300
  billingEvent?: (string) | null;
41283
41301
  /**
41284
- * The bid strategy as last synced, in the platform's own enum (Meta `bid_strategy`, for example LOWEST_COST_WITHOUT_CAP, COST_CAP). On Meta under a campaign budget this is the campaign's strategy.
41302
+ * The bid strategy as last synced, in Meta's vocabulary (LOWEST_COST_WITHOUT_CAP, LOWEST_COST_WITH_BID_CAP, COST_CAP, LOWEST_COST_WITH_MIN_ROAS) on every platform that has an equivalent. On Meta under a campaign budget this is the campaign's strategy. TikTok maps bid_type / deep_bid_type, Pinterest AUTOMATIC_BID / MAX_BID / TARGET_AVG, X AUTO / MAX / TARGET, OpenAI Maximize Results / a max bid. Google bids at the campaign, so an ad group carries its campaign's strategy; one without a Meta equivalent (MANUAL_CPC, TARGET_IMPRESSION_SHARE, or a portfolio strategy's type such as TARGET_CPA) keeps Google's own name. Null on LinkedIn.
41285
41303
  */
41286
41304
  bidStrategy?: (string) | null;
41287
41305
  /**
41288
- * Bid cap or cost target in whole units of `currency`, as last synced. Null when the strategy has none.
41306
+ * Bid cap or cost target in whole units of `currency`, as last synced. Null when the strategy has none (automatic bidding, ROAS targets, a Google portfolio strategy). On Google a campaign target CPA, a Maximize clicks ceiling, the ad group's own target CPA override, or its CPC bid under MANUAL_CPC.
41289
41307
  */
41290
41308
  bidAmount?: (number) | null;
41291
41309
  /**