feat(): add ad_reporting passthrough metrics variable

CHANGELOG.md

@@ -1,3 +1,12 @@
+# dbt_ad_reporting v1.2.2
+
+## Feature Enhancement
+- Added `ad_reporting__passthrough_metrics` variable to easily add common metrics across all platforms into the `ad_reporting` models.
+
+## Contributors
+- [@aleix-cd](https://github.com/aleix-cd)
+
+
 # dbt_ad_reporting v1.2.1
 
 ## Updates

dbt_project.yml

@@ -1,5 +1,5 @@
 name: 'ad_reporting'
-version: '1.2.1'
+version: '1.2.2'
 
 config-version: 2
 
@@ -11,4 +11,7 @@ models:
     +schema: ad_reporting 
     intermediate:
       +materialized: ephemeral
-      +schema: int_ad_reporting 
+      +schema: int_ad_reporting
+
+vars:
+  ad_reporting__passthrough_metrics: []

integration_tests/dbt_project.yml

@@ -1,5 +1,5 @@
 name: 'ad_reporting_integration_tests'
-version: '1.2.1'
+version: '1.2.2'
 profile: 'integration_tests'
 config-version: 2
 

macros/get_query.sql

@@ -17,6 +17,13 @@
 
 {#- Add the consistent_fields and account_fields to all reports regardless of type -#}
 {%- if report_type -%}
+    {%- if var('ad_reporting__passthrough_metrics') -%}
+        {%- set ns = namespace(consistent_fields=consistent_fields) -%}
+        {%- for field in var('ad_reporting__passthrough_metrics') -%}
+            {%- set ns.consistent_fields = ns.consistent_fields + [field] -%}
+        {% endfor %}
+        {%- set consistent_fields = ns.consistent_fields -%}
+    {%- endif -%}
     {%- for consistent_field in consistent_fields -%}
         {%- do final_fields_superset.update({consistent_field: consistent_field}) -%}
     {%- endfor -%}
@@ -78,7 +85,7 @@ select
     cast( '{{ platform }}' as {{ dbt.type_string() }}) as platform,
 
     {% for field in final_fields_superset.keys()|sort() -%}
-    {% if field in ['clicks', 'impressions'] -%}
+    {% if field in consistent_fields and field != 'spend' -%}
     cast({{ final_fields_superset[field] }} as {{ dbt.type_int() }}) as {{ field }}
 
     {% elif field == 'spend' -%}

models/ad_reporting__account_report.sql

@@ -17,6 +17,13 @@ aggregated as (
         sum(clicks) as clicks,
         sum(impressions) as impressions,
         sum(spend) as spend
+
+        {%- if var('ad_reporting__passthrough_metrics') -%}
+            {% for metric in var('ad_reporting__passthrough_metrics') %}
+                , sum({{ metric }}) as {{ metric }}
+            {% endfor %}
+        {%- endif -%}
+
     from base
     {{ dbt_utils.group_by(4) }}
 )

models/ad_reporting__ad_group_report.sql

@@ -21,6 +21,13 @@ aggregated as (
         sum(clicks) as clicks,
         sum(impressions) as impressions,
         sum(spend) as spend
+
+        {%- if var('ad_reporting__passthrough_metrics') -%}
+            {% for metric in var('ad_reporting__passthrough_metrics') %}
+                , sum({{ metric }}) as {{ metric }}
+            {% endfor %}
+        {%- endif -%}
+
     from base
     {{ dbt_utils.group_by(8) }}
 )

models/ad_reporting__ad_report.sql

@@ -23,6 +23,13 @@ aggregated as (
         sum(clicks) as clicks,
         sum(impressions) as impressions,
         sum(spend) as spend
+
+        {%- if var('ad_reporting__passthrough_metrics') -%}
+            {% for metric in var('ad_reporting__passthrough_metrics') %}
+                , sum({{ metric }}) as {{ metric }}
+            {% endfor %}
+        {%- endif -%}
+
     from base
     {{ dbt_utils.group_by(10) }}
 )

models/ad_reporting__campaign_report.sql

@@ -19,6 +19,13 @@ aggregated as (
         sum(clicks) as clicks,
         sum(impressions) as impressions,
         sum(spend) as spend
+
+        {%- if var('ad_reporting__passthrough_metrics') -%}
+            {% for metric in var('ad_reporting__passthrough_metrics') %}
+                , sum({{ metric }}) as {{ metric }}
+            {% endfor %}
+        {%- endif -%}
+
     from base
     {{ dbt_utils.group_by(6) }}
 )

models/ad_reporting__keyword_report.sql

@@ -30,6 +30,13 @@ aggregated as (
         sum(clicks) as clicks,
         sum(impressions) as impressions,
         sum(spend) as spend
+
+        {%- if var('ad_reporting__passthrough_metrics') -%}
+            {% for metric in var('ad_reporting__passthrough_metrics') %}
+                , sum({{ metric }}) as {{ metric }}
+            {% endfor %}
+        {%- endif -%}
+
     from base
     {{ dbt_utils.group_by(11) }}
 )

models/ad_reporting__search_report.sql

@@ -31,6 +31,13 @@ aggregated as (
         sum(clicks) as clicks,
         sum(impressions) as impressions,
         sum(spend) as spend
+
+        {%- if var('ad_reporting__passthrough_metrics') -%}
+            {% for metric in var('ad_reporting__passthrough_metrics') %}
+                , sum({{ metric }}) as {{ metric }}
+            {% endfor %}
+        {%- endif -%}
+
     from base
     {{ dbt_utils.group_by(12) }}
 )

models/ad_reporting__url_report.sql

@@ -29,6 +29,13 @@ aggregated as (
         sum(clicks) as clicks,
         sum(impressions) as impressions,
         sum(spend) as spend
+
+        {%- if var('ad_reporting__passthrough_metrics') -%}
+            {% for metric in var('ad_reporting__passthrough_metrics') %}
+                , sum({{ metric }}) as {{ metric }}
+            {% endfor %}
+        {%- endif -%}
+
     from base
     {{ dbt_utils.group_by(16) }}
 )