feat(ma): adding reported roas (#42313)

Co-authored-by: Javier Bahamondes <[email protected]>

Author: jabahamondes

frontend/src/queries/schema.json

@@ -17995,7 +17995,8 @@
                 "CPC",
                 "CTR",
                 "Reported Conversion",
-                "Reported Conversion Value"
+                "Reported Conversion Value",
+                "Reported ROAS"
             ],
             "type": "string"
         },

frontend/src/queries/schema/schema-general.ts

@@ -4402,6 +4402,7 @@ export enum MarketingAnalyticsBaseColumns {
     CTR = 'CTR',
     ReportedConversion = 'Reported Conversion',
     ReportedConversionValue = 'Reported Conversion Value',
+    ReportedROAS = 'Reported ROAS',
 }
 
 export enum MarketingAnalyticsHelperForColumnNames {

posthog/schema.py

@@ -2009,6 +2009,7 @@ class MarketingAnalyticsBaseColumns(StrEnum):
     CTR = "CTR"
     REPORTED_CONVERSION = "Reported Conversion"
     REPORTED_CONVERSION_VALUE = "Reported Conversion Value"
+    REPORTED_ROAS = "Reported ROAS"
 
 
 class MarketingAnalyticsColumnsSchemaNames(StrEnum):

products/marketing_analytics/backend/hogql_queries/__snapshots__/test_adapters.ambr

@@ -10,7 +10,7 @@
 # name: TestMarketingAnalyticsAdapters.test_bing_ads_native_query_generation
   '''
 
-  SELECT toString(bing_campaigns.name) AS match_key, toString(bing_campaigns.name) AS campaign, toString(bing_campaigns.id) AS id, toString('bing') AS source, toFloat(SUM(toFloatOrZero(bing_campaign_performance_report.impressions))) AS impressions, toFloat(SUM(toFloatOrZero(bing_campaign_performance_report.clicks))) AS clicks, SUM(toFloatOrZero(bing_campaign_performance_report.spend)) AS cost, toFloat(SUM(toFloatOrZero(bing_campaign_performance_report.conversions))) AS reported_conversion, toFloat(SUM(toFloatOrZero(bing_campaign_performance_report.revenue))) AS reported_conversion_value 
+  SELECT toString(bing_campaigns.name) AS match_key, toString(bing_campaigns.name) AS campaign, toString(bing_campaigns.id) AS id, toString('bing') AS source, toFloat(SUM(ifNull(toFloat(bing_campaign_performance_report.impressions), 0))) AS impressions, toFloat(SUM(ifNull(toFloat(bing_campaign_performance_report.clicks), 0))) AS clicks, SUM(ifNull(toFloat(bing_campaign_performance_report.spend), 0)) AS cost, toFloat(SUM(ifNull(toFloat(bing_campaign_performance_report.conversions), 0))) AS reported_conversion, toFloat(SUM(ifNull(toFloat(bing_campaign_performance_report.revenue), 0))) AS reported_conversion_value 
   FROM bing_campaigns LEFT JOIN bing_campaign_performance_report ON equals(toString(bing_campaigns.id), toString(bing_campaign_performance_report.campaign_id)) 
   WHERE and(greaterOrEquals(toDateTime(bing_campaign_performance_report.time_period), toDateTime('2024-01-01 00:00:00')), lessOrEquals(toDateTime(bing_campaign_performance_report.time_period), toDateTime('2024-12-31 23:59:59'))) 
   GROUP BY toString(bing_campaigns.name), toString(bing_campaigns.id)
@@ -43,7 +43,7 @@
 # name: TestMarketingAnalyticsAdapters.test_google_ads_query_generation
   '''
 
-  SELECT toString(google_campaign.campaign_name) AS match_key, toString(google_campaign.campaign_name) AS campaign, toString(google_campaign.campaign_id) AS id, toString('google') AS source, toFloat(SUM(google_stats.metrics_impressions)) AS impressions, toFloat(SUM(google_stats.metrics_clicks)) AS clicks, toFloat(convertCurrency('USD', 'USD', SUM(toFloat(divide(google_stats.metrics_cost_micros, 1000000))))) AS cost, toFloat(SUM(google_stats.metrics_conversions)) AS reported_conversion, toFloat(SUM(google_stats.metrics_conversions_value)) AS reported_conversion_value 
+  SELECT toString(google_campaign.campaign_name) AS match_key, toString(google_campaign.campaign_name) AS campaign, toString(google_campaign.campaign_id) AS id, toString('google') AS source, toFloat(SUM(ifNull(toFloat(google_stats.metrics_impressions), 0))) AS impressions, toFloat(SUM(ifNull(toFloat(google_stats.metrics_clicks), 0))) AS clicks, toFloat(convertCurrency('USD', 'USD', SUM(toFloat(divide(google_stats.metrics_cost_micros, 1000000))))) AS cost, toFloat(SUM(ifNull(toFloat(google_stats.metrics_conversions), 0))) AS reported_conversion, toFloat(SUM(ifNull(toFloat(google_stats.metrics_conversions_value), 0))) AS reported_conversion_value 
   FROM google_campaign LEFT JOIN google_stats ON equals(google_campaign.campaign_id, google_stats.campaign_id) 
   WHERE and(greaterOrEquals(toDateTime(google_stats.segments_date), toDateTime('2024-01-01 00:00:00')), lessOrEquals(toDateTime(google_stats.segments_date), toDateTime('2024-12-31 23:59:59'))) 
   GROUP BY toString(google_campaign.campaign_name), toString(google_campaign.campaign_id)
@@ -52,7 +52,7 @@
 # name: TestMarketingAnalyticsAdapters.test_linkedin_ads_query_generation
   '''
 
-  SELECT toString(linkedin_campaigns.name) AS match_key, toString(linkedin_campaigns.name) AS campaign, toString(linkedin_campaigns.id) AS id, toString('linkedin') AS source, toFloat(SUM(linkedin_stats.impressions)) AS impressions, toFloat(SUM(linkedin_stats.clicks)) AS clicks, toFloat(SUM(toFloat(linkedin_stats.cost_in_usd))) AS cost, toFloat(SUM(linkedin_stats.external_website_conversions)) AS reported_conversion, 0 AS reported_conversion_value 
+  SELECT toString(linkedin_campaigns.name) AS match_key, toString(linkedin_campaigns.name) AS campaign, toString(linkedin_campaigns.id) AS id, toString('linkedin') AS source, toFloat(SUM(ifNull(toFloat(linkedin_stats.impressions), 0))) AS impressions, toFloat(SUM(ifNull(toFloat(linkedin_stats.clicks), 0))) AS clicks, toFloat(SUM(ifNull(toFloat(linkedin_stats.cost_in_usd), 0))) AS cost, toFloat(SUM(ifNull(toFloat(linkedin_stats.external_website_conversions), 0))) AS reported_conversion, 0 AS reported_conversion_value 
   FROM linkedin_campaigns LEFT JOIN linkedin_stats ON equals(linkedin_campaigns.id, linkedin_stats.campaign_id) 
   WHERE and(greaterOrEquals(toDateTime(linkedin_stats.date_start), toDateTime('2024-01-01 00:00:00')), lessOrEquals(toDateTime(linkedin_stats.date_start), toDateTime('2024-12-31 23:59:59'))) 
   GROUP BY toString(linkedin_campaigns.name), toString(linkedin_campaigns.id)
@@ -61,7 +61,7 @@
 # name: TestMarketingAnalyticsAdapters.test_match_key_uses_campaign_id_when_configured
   '''
 
-  SELECT toString(metaads_campaigns.id) AS match_key, toString(metaads_campaigns.name) AS campaign, toString(metaads_campaigns.id) AS id, toString('meta') AS source, toFloat(SUM(toFloat(metaads_campaign_stats.impressions))) AS impressions, toFloat(SUM(toFloat(metaads_campaign_stats.clicks))) AS clicks, SUM(toFloat(metaads_campaign_stats.spend)) AS cost, 0 AS reported_conversion, 0 AS reported_conversion_value 
+  SELECT toString(metaads_campaigns.id) AS match_key, toString(metaads_campaigns.name) AS campaign, toString(metaads_campaigns.id) AS id, toString('meta') AS source, toFloat(SUM(ifNull(toFloat(metaads_campaign_stats.impressions), 0))) AS impressions, toFloat(SUM(ifNull(toFloat(metaads_campaign_stats.clicks), 0))) AS clicks, SUM(ifNull(toFloat(metaads_campaign_stats.spend), 0)) AS cost, 0 AS reported_conversion, 0 AS reported_conversion_value 
   FROM metaads_campaigns LEFT JOIN metaads_campaign_stats ON equals(metaads_campaigns.id, metaads_campaign_stats.campaign_id) 
   WHERE and(greaterOrEquals(toDateTime(metaads_campaign_stats.date_stop), toDateTime('2024-01-01 00:00:00')), lessOrEquals(toDateTime(metaads_campaign_stats.date_stop), toDateTime('2024-12-31 23:59:59'))) 
   GROUP BY toString(metaads_campaigns.name), toString(metaads_campaigns.id)
@@ -70,7 +70,7 @@
 # name: TestMarketingAnalyticsAdapters.test_match_key_uses_campaign_name_by_default
   '''
 
-  SELECT toString(metaads_campaigns.name) AS match_key, toString(metaads_campaigns.name) AS campaign, toString(metaads_campaigns.id) AS id, toString('meta') AS source, toFloat(SUM(toFloat(metaads_campaign_stats.impressions))) AS impressions, toFloat(SUM(toFloat(metaads_campaign_stats.clicks))) AS clicks, SUM(toFloat(metaads_campaign_stats.spend)) AS cost, 0 AS reported_conversion, 0 AS reported_conversion_value 
+  SELECT toString(metaads_campaigns.name) AS match_key, toString(metaads_campaigns.name) AS campaign, toString(metaads_campaigns.id) AS id, toString('meta') AS source, toFloat(SUM(ifNull(toFloat(metaads_campaign_stats.impressions), 0))) AS impressions, toFloat(SUM(ifNull(toFloat(metaads_campaign_stats.clicks), 0))) AS clicks, SUM(ifNull(toFloat(metaads_campaign_stats.spend), 0)) AS cost, 0 AS reported_conversion, 0 AS reported_conversion_value 
   FROM metaads_campaigns LEFT JOIN metaads_campaign_stats ON equals(metaads_campaigns.id, metaads_campaign_stats.campaign_id) 
   WHERE and(greaterOrEquals(toDateTime(metaads_campaign_stats.date_stop), toDateTime('2024-01-01 00:00:00')), lessOrEquals(toDateTime(metaads_campaign_stats.date_stop), toDateTime('2024-12-31 23:59:59'))) 
   GROUP BY toString(metaads_campaigns.name), toString(metaads_campaigns.id)
@@ -79,7 +79,7 @@
 # name: TestMarketingAnalyticsAdapters.test_meta_ads_query_generation
   '''
 
-  SELECT toString(meta_campaigns.name) AS match_key, toString(meta_campaigns.name) AS campaign, toString(meta_campaigns.id) AS id, toString('meta') AS source, toFloat(SUM(toFloat(meta_campaign_stats.impressions))) AS impressions, toFloat(SUM(toFloat(meta_campaign_stats.clicks))) AS clicks, SUM(toFloat(meta_campaign_stats.spend)) AS cost, 0 AS reported_conversion, 0 AS reported_conversion_value 
+  SELECT toString(meta_campaigns.name) AS match_key, toString(meta_campaigns.name) AS campaign, toString(meta_campaigns.id) AS id, toString('meta') AS source, toFloat(SUM(ifNull(toFloat(meta_campaign_stats.impressions), 0))) AS impressions, toFloat(SUM(ifNull(toFloat(meta_campaign_stats.clicks), 0))) AS clicks, SUM(ifNull(toFloat(meta_campaign_stats.spend), 0)) AS cost, 0 AS reported_conversion, 0 AS reported_conversion_value 
   FROM meta_campaigns LEFT JOIN meta_campaign_stats ON equals(meta_campaigns.id, meta_campaign_stats.campaign_id) 
   WHERE and(greaterOrEquals(toDateTime(meta_campaign_stats.date_stop), toDateTime('2024-01-01 00:00:00')), lessOrEquals(toDateTime(meta_campaign_stats.date_stop), toDateTime('2024-12-31 23:59:59'))) 
   GROUP BY toString(meta_campaigns.name), toString(meta_campaigns.id)
@@ -88,7 +88,7 @@
 # name: TestMarketingAnalyticsAdapters.test_reddit_ads_query_generation
   '''
 
-  SELECT toString(reddit_campaign.name) AS match_key, toString(reddit_campaign.name) AS campaign, toString(reddit_campaign.id) AS id, toString('reddit') AS source, toFloat(SUM(reddit_stats.impressions)) AS impressions, toFloat(SUM(reddit_stats.clicks)) AS clicks, SUM(toFloat(divide(reddit_stats.spend, 1000000))) AS cost, toFloat(SUM(reddit_stats.key_conversion_total_count)) AS reported_conversion, toFloat(plus(SUM(reddit_stats.conversion_purchase_total_value), SUM(reddit_stats.conversion_signup_total_value))) AS reported_conversion_value 
+  SELECT toString(reddit_campaign.name) AS match_key, toString(reddit_campaign.name) AS campaign, toString(reddit_campaign.id) AS id, toString('reddit') AS source, toFloat(SUM(ifNull(toFloat(reddit_stats.impressions), 0))) AS impressions, toFloat(SUM(ifNull(toFloat(reddit_stats.clicks), 0))) AS clicks, SUM(toFloat(divide(reddit_stats.spend, 1000000))) AS cost, toFloat(SUM(ifNull(toFloat(reddit_stats.key_conversion_total_count), 0))) AS reported_conversion, toFloat(plus(SUM(ifNull(toFloat(reddit_stats.conversion_purchase_total_value), 0)), SUM(ifNull(toFloat(reddit_stats.conversion_signup_total_value), 0)))) AS reported_conversion_value 
   FROM reddit_campaign LEFT JOIN reddit_stats ON equals(reddit_campaign.id, reddit_stats.campaign_id) 
   WHERE and(greaterOrEquals(toDateTime(reddit_stats.date), toDateTime('2024-01-01 00:00:00')), lessOrEquals(toDateTime(reddit_stats.date), toDateTime('2024-12-31 23:59:59'))) 
   GROUP BY toString(reddit_campaign.name), toString(reddit_campaign.id)
@@ -97,7 +97,7 @@
 # name: TestMarketingAnalyticsAdapters.test_tiktok_ads_native_query_generation
   '''
 
-  SELECT toString(tiktok_campaigns.campaign_name) AS match_key, toString(tiktok_campaigns.campaign_name) AS campaign, toString(tiktok_campaigns.campaign_id) AS id, toString('tiktok') AS source, toFloat(SUM(toFloatOrZero(tiktok_campaign_report.impressions))) AS impressions, toFloat(SUM(toFloatOrZero(tiktok_campaign_report.clicks))) AS clicks, SUM(toFloatOrZero(tiktok_campaign_report.spend)) AS cost, toFloat(SUM(toFloatOrZero(tiktok_campaign_report.conversion))) AS reported_conversion, 0 AS reported_conversion_value 
+  SELECT toString(tiktok_campaigns.campaign_name) AS match_key, toString(tiktok_campaigns.campaign_name) AS campaign, toString(tiktok_campaigns.campaign_id) AS id, toString('tiktok') AS source, toFloat(SUM(ifNull(toFloat(tiktok_campaign_report.impressions), 0))) AS impressions, toFloat(SUM(ifNull(toFloat(tiktok_campaign_report.clicks), 0))) AS clicks, SUM(ifNull(toFloat(tiktok_campaign_report.spend), 0)) AS cost, toFloat(SUM(ifNull(toFloat(tiktok_campaign_report.conversion), 0))) AS reported_conversion, 0 AS reported_conversion_value 
   FROM tiktok_campaigns LEFT JOIN tiktok_campaign_report ON equals(tiktok_campaigns.campaign_id, tiktok_campaign_report.campaign_id) 
   WHERE and(greaterOrEquals(toDateTime(tiktok_campaign_report.stat_time_day), toDateTime('2024-01-01 00:00:00')), lessOrEquals(toDateTime(tiktok_campaign_report.stat_time_day), toDateTime('2024-12-31 23:59:59'))) 
   GROUP BY toString(tiktok_campaigns.campaign_name), toString(tiktok_campaigns.campaign_id)