@getlatedev/node 0.2.1413 → 0.2.1415

package/src/generated/types.gen.ts

@@ -1754,10 +1754,13 @@ export type status3 = 'done' | 'skipped' | 'failed';
 export type AdRuleCondition = {
     /**
      * `ctr` is a percentage. `spend`, `cpc`, `cpm` and `cpa` are in the ad account currency. `reach` and `frequency` use the platform's de-duplicated reach, so they are accepted on Meta and TikTok only.
+     *
+     * `result:<key>` reads one of your own results (see [Campaign results](/guides/campaign-results)), on campaign rules only: the values you sent for the window, or a formula over them and the platform's numbers. A campaign with no value for it never matches.
+     *
      */
-    metric: 'spend' | 'impressions' | 'clicks' | 'conversions' | 'ctr' | 'cpc' | 'cpm' | 'cpa' | 'roas' | 'reach' | 'frequency';
+    metric: ('spend' | 'impressions' | 'clicks' | 'conversions' | 'ctr' | 'cpc' | 'cpm' | 'cpa' | 'roas' | 'reach' | 'frequency' | unknown);
     /**
-     * Days in the ad account's own timezone. `last_7d` includes today.
+     * Days in the ad account's own timezone. `last_7d` is the 7 full days before today; only `today` reads the day in progress.
      */
     window: 'today' | 'yesterday' | 'last_3d' | 'last_7d' | 'last_14d' | 'last_30d';
     op: '>' | '>=' | '<' | '<=';
@@ -1765,12 +1768,7 @@ export type AdRuleCondition = {
 };
 
 /**
- * `ctr` is a percentage. `spend`, `cpc`, `cpm` and `cpa` are in the ad account currency. `reach` and `frequency` use the platform's de-duplicated reach, so they are accepted on Meta and TikTok only.
- */
-export type metric = 'spend' | 'impressions' | 'clicks' | 'conversions' | 'ctr' | 'cpc' | 'cpm' | 'cpa' | 'roas' | 'reach' | 'frequency';
-
-/**
- * Days in the ad account's own timezone. `last_7d` includes today.
+ * Days in the ad account's own timezone. `last_7d` is the 7 full days before today; only `today` reads the day in progress.
  */
 export type window = 'today' | 'yesterday' | 'last_3d' | 'last_7d' | 'last_14d' | 'last_30d';
 
@@ -2295,6 +2293,12 @@ export type learningStatus = 'LEARNING' | 'SUCCESS' | 'FAIL';
  * Campaign with nested ad sets and rolled-up metrics
  */
 export type AdTreeCampaign = {
+    /**
+     * Only with `results=true`. The values you sent for this campaign over the range, plus each formula they allow, by metric key. A metric with no value is absent.
+     */
+    results?: {
+        [key: string]: (number);
+    };
     platformCampaignId?: string;
     platform?: 'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'pinterest' | 'google' | 'twitter' | 'openai' | 'reddit';
     campaignName?: string;
@@ -2445,6 +2449,10 @@ export type AdTreeResponse = {
         fromDate?: string;
         toDate?: string;
     };
+    /**
+     * Only with `results=true`. Your metrics and formulas, to label each campaign's `results`.
+     */
+    resultMetrics?: Array<CampaignResultMetric>;
     /**
      * Meta only. Present and true while historical data is being backfilled.
      */
@@ -4423,6 +4431,10 @@ export type CampaignReport = {
          * Latest view counts.
          */
         total: number;
+        /**
+         * Views from ads, on YouTube and X posts.
+         */
+        paid: number;
     };
     /**
      * The campaign engagement types summed over the same submissions.
@@ -4458,11 +4470,25 @@ export type CampaignReport = {
 export type CampaignResultMetric = {
     key: string;
     label: string;
-    kind: 'count' | 'money';
+    /**
+     * How the value reads: `percent` values are already multiplied by 100.
+     */
+    kind: 'count' | 'money' | 'percent' | 'ratio';
     currency: (string) | null;
+    /**
+     * Null for a number you send. For a computed metric, the formula over `spend`, `impressions`, `clicks`, `conversions`, `purchase_value` and the metrics you send, e.g. `spend / revenue * 100`.
+     */
+    formula: (string) | null;
+    /**
+     * One of the formulas every team has (`cac_percent`, `cost_per_sale`, `cost_per_qualified_lead`, `lead_to_sale`). Setting the same key replaces it for your team.
+     */
+    builtIn: boolean;
 };
 
-export type kind4 = 'count' | 'money';
+/**
+ * How the value reads: `percent` values are already multiplied by 100.
+ */
+export type kind4 = 'count' | 'money' | 'percent' | 'ratio';
 
 export type CampaignSettlement = {
     /**
@@ -4538,6 +4564,14 @@ export type CampaignSubmission = {
      * The campaign engagement types summed at the latest read (all four on a views campaign), frozen at the tracking window end like `viewsEligible`. An `engagements` campaign earns on this count.
      */
     engagementsLatest: (number) | null;
+    /**
+     * Views from ads the creator ran: YouTube views from the advertising traffic source, X impressions beyond the organic ones. Null on other platforms and before the first read. On an organic-only campaign `viewsEligible` is the latest views minus these.
+     */
+    viewsPaid: (number) | null;
+    /**
+     * When `viewsPaid` was last read. YouTube refreshes every 6 hours and reports ad views up to 2 days late; X about once a day while the post is under 30 days old.
+     */
+    paidViewsReadAt: (string) | null;
     lastAccruedViews: number;
     accruedCents: number;
     approvedCents: number;
@@ -4627,12 +4661,12 @@ export type CampaignSubmissionDetail = CampaignSubmission & {
 };
 
 export type CampaignSubmissionFlag = {
-    code: 'duplicate_media' | 'duplicate_post' | 'view_spike' | 'linked_accounts' | 'cross_operator' | 'unreachable' | 'post_deleted' | 'account_restricted' | 'low_authenticity' | 'x_read_cap';
+    code: 'duplicate_media' | 'duplicate_post' | 'view_spike' | 'linked_accounts' | 'cross_operator' | 'unreachable' | 'post_deleted' | 'account_restricted' | 'low_authenticity' | 'x_read_cap' | 'paid_views' | 'organic_unverified';
     detail: string;
     raisedAt: string;
 };
 
-export type code = 'duplicate_media' | 'duplicate_post' | 'view_spike' | 'linked_accounts' | 'cross_operator' | 'unreachable' | 'post_deleted' | 'account_restricted' | 'low_authenticity' | 'x_read_cap';
+export type code = 'duplicate_media' | 'duplicate_post' | 'view_spike' | 'linked_accounts' | 'cross_operator' | 'unreachable' | 'post_deleted' | 'account_restricted' | 'low_authenticity' | 'x_read_cap' | 'paid_views' | 'organic_unverified';
 
 /**
  * Actions taken on the matched comment itself (comment trigger only; ignored on the
@@ -6505,6 +6539,10 @@ export type CreatorCampaignEconomicsCpm = {
      * With `metric: engagements`, the engagements that count. Missing means all four, and sending it on a views campaign answers 400. YouTube reports likes and comments only, Facebook and Threads have no saves, and Pinterest reports saves only.
      */
     engagementTypes?: Array<('likes' | 'comments' | 'shares' | 'saves')>;
+    /**
+     * Count only organic views: views from ads the creator ran do not earn. Every campaign platform must be YouTube or X, which report ad views per post, or the request answers 400. A post earns nothing until its ad views were first read.
+     */
+    organicViewsOnly?: boolean;
     ratePer1kCents: number;
     /**
      * The count a post must reach before it earns, in the campaign metric (views or engagements).
@@ -6517,7 +6555,7 @@ export type CreatorCampaignEconomicsCpm = {
 /**
  * What the rate pays on. `engagements` counts the `engagementTypes` as each platform reports them, and `minViewsToEarn` then applies to engagements. Fixed once the campaign leaves draft.
  */
-export type metric2 = 'views' | 'engagements';
+export type metric = 'views' | 'engagements';
 
 export type CreatorCampaignEconomicsPerPost = {
     type: 'per_post';
@@ -6530,6 +6568,10 @@ export type CreatorCampaignEconomicsPool = {
     type: 'pool';
     budgetCents: number;
     minViewsToQualify: number;
+    /**
+     * Count only organic views: views from ads the creator ran do not earn. Every campaign platform must be YouTube or X, which report ad views per post, or the request answers 400. A post earns nothing until its ad views were first read.
+     */
+    organicViewsOnly?: boolean;
 };
 
 /**
@@ -6583,6 +6625,10 @@ export type CreatorPortalEconomics = {
      * The engagements that count. Missing means all four.
      */
     engagementTypes?: Array<('likes' | 'comments' | 'shares' | 'saves')>;
+    /**
+     * Only organic views count; views from ads do not.
+     */
+    organicViewsOnly?: boolean;
     ratePer1kCents: number;
     minViewsToEarn: number;
     maxPayoutPerClipCents?: number;
@@ -6594,6 +6640,10 @@ export type CreatorPortalEconomics = {
     type: 'pool';
     poolCents: number;
     minViewsToQualify: number;
+    /**
+     * Only organic views count; views from ads do not.
+     */
+    organicViewsOnly?: boolean;
 };
 
 export type type10 = 'cpm';
@@ -6707,6 +6757,10 @@ export type CreatorPortalSubmission = {
      * The campaign engagement types summed at the latest read. Null until the post is read.
      */
     engagements: (number) | null;
+    /**
+     * Views that came from ads the creator ran, on YouTube and X. Null where the platform does not report them or before the first read.
+     */
+    viewsFromAds: (number) | null;
     earnedCents: number;
     rejectReason: (string) | null;
     /**
@@ -10641,7 +10695,7 @@ export type InstagramDemographicsResponse = {
     note?: string;
 };
 
-export type metric3 = 'follower_demographics' | 'engaged_audience_demographics';
+export type metric2 = 'follower_demographics' | 'engaged_audience_demographics';
 
 /**
  * The timeframe used for demographic data
@@ -18093,6 +18147,10 @@ export type WebhookPayloadCampaignSubmission = {
          * The campaign engagement types summed at the latest read. An engagements campaign earns on this count.
          */
         engagementsLatest: (number) | null;
+        /**
+         * Views from ads, on YouTube and X. Null elsewhere or before the first read.
+         */
+        viewsPaid: (number) | null;
         flags: Array<{
             code: string;
             detail: string;
@@ -50778,6 +50836,30 @@ export type GetCampaignResultsUploadError = (ErrorResponse | {
     error?: string;
 });
 
+export type GetCampaignResultsTotalsData = {
+    query: {
+        /**
+         * Comma-separated platform ad account ids, at most 100. Omit for every ad account your key can see.
+         */
+        adAccountIds?: string;
+        fromDate: string;
+        /**
+         * Inclusive. At most 400 days after `fromDate`.
+         */
+        toDate: string;
+    };
+};
+
+export type GetCampaignResultsTotalsResponse = ({
+    fromDate: string;
+    toDate: string;
+    totals: {
+        [key: string]: (number);
+    };
+});
+
+export type GetCampaignResultsTotalsError = (ErrorResponse);
+
 export type ListCampaignResultMetricsResponse = ({
     metrics: Array<CampaignResultMetric>;
 });
@@ -50787,11 +50869,15 @@ export type ListCampaignResultMetricsError = (ErrorResponse);
 export type SetCampaignResultMetricData = {
     body: {
         label: string;
-        kind: 'count' | 'money';
+        kind: 'count' | 'money' | 'percent' | 'ratio';
         /**
          * ISO 4217, money metrics only.
          */
         currency?: (string) | null;
+        /**
+         * Makes it a computed metric. Null or absent for a number you send.
+         */
+        formula?: (string) | null;
     };
     path: {
         key: string;
@@ -52804,6 +52890,10 @@ export type GetAdTreeData = {
          * Profile ID
          */
         profileId?: string;
+        /**
+         * Set to `true` to add your own results (see [Campaign results](/guides/campaign-results)): every campaign gains `results`, the values you sent for the range plus each formula they allow, and the response gains `resultMetrics` to label them.
+         */
+        results?: boolean;
         /**
          * Case-insensitive substring match on campaign, ad set and ad names (`_`, `%` and spaces match literally), or an exact platform campaign, ad set or ad id.
          *
@@ -68412,7 +68502,7 @@ export type ListCampaignSubmissionsData = {
         campaignId: string;
     };
     query?: {
-        flag?: 'duplicate_media' | 'duplicate_post' | 'view_spike' | 'linked_accounts' | 'cross_operator' | 'unreachable' | 'post_deleted' | 'account_restricted' | 'low_authenticity' | 'x_read_cap';
+        flag?: 'duplicate_media' | 'duplicate_post' | 'view_spike' | 'linked_accounts' | 'cross_operator' | 'unreachable' | 'post_deleted' | 'account_restricted' | 'low_authenticity' | 'x_read_cap' | 'paid_views' | 'organic_unverified';
         limit?: number;
         maxScore?: number;
         minScore?: number;