Feature/conversions (#13)

* add under the hood updates * add conversion metrics to end models * docs and add passthrough * update passthrough * changelog and versioining * readme and docs * add decisionlog about discrepancies across different grains * changelog * realized we can remove total_items from the transforms * add validation tests * fix * new schema * update config * change schema for all * rm horizontal conversions test * add decision log entry for different grains * send to bk * Validation tests passing * tests * polishing * buildkite * seed data type * fix run steps * changelog * reword * joe feedback * source package is up on hub --------- Co-authored-by: Jamie Rodriguez <[email protected]>
fivetran · Oct 24, 2024 · 52bdeb6 · 52bdeb6
1 parent 13edded
commit 52bdeb6
Show file tree

Hide file tree

Showing 29 changed files with 983 additions and 32 deletions.
diff --git a/.buildkite/scripts/run_models.sh b/.buildkite/scripts/run_models.sh
@@ -19,4 +19,6 @@ dbt deps
 dbt seed --target "$db" --full-refresh
 dbt run --target "$db" --full-refresh
 dbt test --target "$db"
+dbt run --target "$db" --vars '{reddit_ads__conversion_event_types: []}' --full-refresh
+dbt test --target "$db"
 dbt run-operation fivetran_utils.drop_schemas_automation --target "$db"
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,33 @@
+# dbt_reddit_ads v0.3.0
+[PR #13](https://github.com/fivetran/dbt_reddit_ads/pull/13) includes the following **BREAKING CHANGE** updates:
+
+## Features: Conversion Metrics
+- Introduces the following conversion fields to the Reddit Ads `reddit_ads__<entity>_report` models:
+  - `conversions` (aliased from `click_through_conversion_attribution_window_month`): Total attributed click-through conversions for the given month-long window.
+  - `view_through_conversions` (aliased from `view_through_conversion_attribution_window_month`): Total attributed view-through conversions for the given month-long window.
+  - `total_value`: Total monetary value associated with a conversion event.
+  - `total_items`: Total number of items involved in a conversion event.
+- Introduces the `<entity>_conversions_passthrough_metrics` variables to allow additional fields from the source `_conversion_report` tables. We use the maximum attribution window when considering conversions and therefore retrieve conversions metrics from the `click_through_conversion_attribution_window_month` (conversions) and `view_through_conversion_attribution_window_month` (view_through_conversions) fields from the respective source tables. For information on how to configure these variables to bring in additional windows and fields, refer to the [README](https://github.com/fivetran/dbt_reddit_ads/tree/main?tab=readme-ov-file#passing-through-additional-metrics).
+- Introduces the `reddit_ads__conversion_event_types` variable to note which kinds of events should be considered conversions (and therefore be surfaced in conversion metrics). By default, this package considers `purchase`, `lead`, and `custom` events to be conversions. See [README](https://github.com/fivetran/dbt_reddit_ads/tree/main?tab=readme-ov-file#configure-conversion-event-types) for details on how to adjust this.
+
+## Upstream Source Package Updates
+To support the addition of conversion metrics here, [v0.3.0](https://github.com/fivetran/dbt_reddit_ads_source/releases/tag/v0.2.0) of `reddit_ads_source` included the following update:
+- Introduces 4 new staging models to bring in conversion metrics (click-through conversions, view-through conversions, total value, and total items) across different dimensions:
+  - `stg_reddit_ads__account_conversions_report`
+  - `stg_reddit_ads__ad_group_conversions_report`
+  - `stg_reddit_ads__ad_conversions_report`
+  - `stg_reddit_ads__campaign_conversions_report`
+> Note: If you would like to include conversion metrics, please ensure you have the `account_conversions_report`, `ad_group_conversions_report`, `ad_conversions_report`, and `campaign_conversions_report` source tables syncing in your Reddit Ads connector(s). Otherwise, the package will run successfully but produce `null` conversion metric values.
+
+## Under the Hood
+- Coalesces each pre-existing metrics (ie `clicks`, `impressions`, and `spend`) with `0` to avoid the complications of `null` in aggregations.
+- Adds the respective seed data for the new models in addition to updating relevant documentation.
+- Adds documentation explaining potential discrepancies across reporting grains.
+- Adds new Buildkite run step to test different configurations of the `reddit_ads__conversion_event_types` variable.
+
+## Contributors
+- [Seer Interactive](https://www.seerinteractive.com/?utm_campaign=Fivetran%20%7C%20Models&utm_source=Fivetran&utm_medium=Fivetran%20Documentation)
+
 # dbt_reddit_ads v0.2.1
 
 [PR #8](https://github.com/fivetran/dbt_reddit_ads/pull/8) includes the following updates:

diff --git a/DECISIONLOG.md b/DECISIONLOG.md
@@ -0,0 +1,4 @@
+## Why don't metrics add up across different grains (Ex. ad level vs campaign level)?
+When aggregating metrics like clicks and spend across different grains, discrepancies can arise due to differences in how data is captured, grouped, or attributed at each grain. For example, certain actions or costs might be attributed differently at the ad, campaign, or ad group level, leading to inconsistencies when rolled up. Additionally, for example, at the keyword grain, where a keyword can belong to multiple ad groups, aggregations can lead to over counting. Conversely, some ads may only be represented at the ad group level, rather than individual ad levels, leading to under counting at the ad grain.
+
+This is a reason why we have broken out the ad reporting packages into separate hierarchical end models (Ad, Ad Group, Campaign, and more). Because if we only used ad-level reports, we could be missing data.
diff --git a/README.md b/README.md
@@ -50,14 +50,17 @@ dispatch:
     search_order: ['spark_utils', 'dbt_utils']
 ```
 
-### Step 2: Install the package
-Include the following reddit_ads package version in your `packages.yml` file:
+### Step 2: Install the package (skip if also using the `ad_reporting` combo package)
+If you are not using the downstream [Ad Reporting](https://github.com/fivetran/dbt_ad_reporting) combination package, include the following reddit_ads package version in your `packages.yml` file:
 > TIP: Check [dbt Hub](https://hub.getdbt.com/) for the latest installation instructions or [read the dbt docs](https://docs.getdbt.com/docs/package-management) for more information on installing packages.
 ```yaml
 packages:
   - package: fivetran/reddit_ads
-    version: [">=0.2.0", "<0.3.0"]
+    version: [">=0.3.0", "<0.4.0"]
 ```
+
+Do NOT include the `reddit_ads_source` package in this file. The transformation package itself has a dependency on it and will install the source package as well.
+
 ### Step 3: Define database and schema variables
 By default, this package runs using your destination and the `reddit_ads` schema. If this is not where your Reddit Ads data is (for example, if your Reddit Ads schema is named `reddit_ads_fivetran`), add the following configuration to your root `dbt_project.yml` file:
 
@@ -68,6 +71,8 @@ vars:
 ```
 
 ### (Optional) Step 4: Additional configurations
+<details open><summary>Expand/Collapse details</summary>
+
 #### Union multiple connectors
 If you have multiple reddit_ads connectors in Fivetran and would like to use this package on all of them simultaneously, we have provided functionality to do so. The package will union all of the data together and pass the unioned table into the transformations. You will be able to see which source it came from in the `source_relation` column of each model. To use this functionality, you will need to set either the `reddit_ads_union_schemas` OR `reddit_ads_union_databases` variables (cannot do both) in your root `dbt_project.yml` file:
 
@@ -80,10 +85,33 @@ vars:
 
 To connect your multiple schema/database sources to the package models, follow the steps outlined in the [Union Data Defined Sources Configuration](https://github.com/fivetran/dbt_fivetran_utils/tree/releases/v0.4.latest#union_data-source) section of the Fivetran Utils documentation for the union_data macro. This will ensure a proper configuration and correct visualization of connections in the DAG.
 
+#### Configure Conversion Event Types
+By default, this package considers `purchase`, `lead`, and `custom` events from the `*_conversions_report` source tables to be conversions. This means that the package will only report values for conversion metrics (`conversions`, `total_items`, `total_value`, and `view_through_conversions`) for these 3 event types.
+
+If you would like to adjust this so that the package reports conversions related to other types of [events](https://business.reddithelp.com/s/article/supported-conversion-events), or a subset of the default ones chosen, configure the `reddit_ads__conversion_event_types` variable:
+
+```yml
+vars:
+    reddit_ads__conversion_event_types:
+      - 'lead'
+      - 'search'
+      - 'sign_up'
+      - 'purchase'
+      - 'page_visit'
+      - 'add_to_cart'
+      - 'view_content'
+      - 'custom_event_<1-20>' # individual custom events
+      - 'custom' # AGGREGATION of all individual custom events = custom_event_1 + ... + custom_event_20
+```
+
+> Note: Please ensure due diligence when selecting conversion events, as some may overlap and introduce double-counted metrics if used together. For example, the `custom` event encapsulates all individual `custom_event_<1-20>` events.
+
 #### Passing Through Additional Metrics
-By default, this package will select `clicks`, `impressions`, and `spend` from the source reporting tables to store into the staging models. If you would like to pass through additional metrics to the staging models, add the following configurations to your `dbt_project.yml` file. These variables allow the pass-through fields to be aliased (`alias`) if desired, but not required. Use the following format for declaring the respective pass-through variables:
+By default, this package will select `clicks`, `impressions`, `spend`, `conversions` (click_through_conversion_attribution_window_month), `view_through_conversions` (view_through_conversion_attribution_window_month), `total_items`, and `total_value` from the source reporting tables to store into the staging models. Note that we choose the maximum attribution window for counting conversions.
+
+If you would like to pass through additional metrics to the staging models, for example, different attribution windows for conversions such as `view_through_conversion_attribution_window_week`, add the following configurations to your `dbt_project.yml` file. These variables allow the pass-through fields to be aliased (`alias`) if desired, but not required. Use the following format for declaring the respective pass-through variables:
 
-> **NOTE** Ensure you exercised due diligence when adding metrics to these models. The metrics added by default (clicks, impressions, and cost) have been vetted by the Fivetran team maintaining this package for accuracy. There are metrics included within the source reports, for example, metric averages, which may be inaccurately represented at the grain for reports created in this package. You want to ensure whichever metrics you pass through are indeed appropriate to aggregate at the respective reporting levels provided in this package. Note that the aggregation we use for our reporting is `sum`.
+> **NOTE** Ensure you exercised due diligence when adding metrics to these models. The metrics added by default (clicks, impressions, cost, conversions, view-through conversions, total items, and total value) have been vetted by the Fivetran team maintaining this package for accuracy. There are metrics included within the source reports, for example, metric averages, which may be inaccurately represented at the grain for reports created in this package. You want to ensure whichever metrics you pass through are indeed appropriate to aggregate at the respective reporting levels provided in this package. Note that the aggregation we use for our reporting is `sum`.
 
 ```yml
 vars:
@@ -100,7 +128,7 @@ vars:
       - name: "a_second_field"
 ```
 #### Change the build schema
-By default, this package builds the Reddit Ads staging models within a schema titled (`<target_schema>` + `_reddit_ads_source`) and your Reddit Ads modeling models within a schema titled (`<target_schema>` + `_reddit_ads`) in your destination. If this is not where you would like your Reddit Ads data to be written to, add the following configuration to your root `dbt_project.yml` file:
+By default, this package builds the Reddit Ads staging models (12 views, 12 tables) within a schema titled (`<target_schema>` + `_reddit_ads_source`) and your Reddit Ads modeling models (5 tables) within a schema titled (`<target_schema>` + `_reddit_ads`) in your destination. If this is not where you would like your Reddit Ads data to be written to, add the following configuration to your root `dbt_project.yml` file:
 
 ```yml
 models:
@@ -111,7 +139,7 @@ models:
 ```
 
 #### Change the source table references
-If an individual source table has a different name than the package expects, add the table name as it appears in your destination to the respective variable:
+If an individual source table has a different name than the package expects, add the table name as it appears in your destination to the respective variable. This is not available when running the package on multiple unioned connectors.
 
 > IMPORTANT: See this project's [`dbt_project.yml`](https://github.com/fivetran/dbt_reddit_ads_source/blob/main/dbt_project.yml) variable declarations to see the expected names.
 
@@ -120,6 +148,8 @@ vars:
     reddit_ads_<default_source_table_name>_identifier: your_table_name 
 ```
 
+</details>
+
 ### (Optional) Step 5: Orchestrate your models with Fivetran Transformations for dbt Core™
 <details><summary>Expand for more details</summary>
 
@@ -134,7 +164,7 @@ This dbt package is dependent on the following dbt packages. These dependencies
 ```yml
 packages:
     - package: fivetran/reddit_ads_source
-      version: [">=0.2.0", "<0.3.0"]
+      version: [">=0.3.0", "<0.4.0"]
 
     - package: fivetran/fivetran_utils
       version: [">=0.4.0", "<0.5.0"]
@@ -145,6 +175,7 @@ packages:
     - package: dbt-labs/spark_utils
       version: [">=0.3.0", "<0.4.0"]
 ```
+
 ## How is this package maintained and can I contribute?
 ### Package Maintenance
 The Fivetran team maintaining this package _only_ maintains the latest version of the package. We highly recommend you stay consistent with the [latest version](https://hub.getdbt.com/fivetran/reddit_ads/latest/) of the package and refer to the [CHANGELOG](https://github.com/fivetran/dbt_reddit_ads/blob/main/CHANGELOG.md) and release notes for more information on changes across versions.
@@ -154,6 +185,11 @@ A small team of analytics engineers at Fivetran develops these dbt packages. How
 
 We highly encourage and welcome contributions to this package. Check out [this dbt Discourse article](https://discourse.getdbt.com/t/contributing-to-a-dbt-package/657) on the best workflow for contributing to a package.
 
+#### Contributors
+We thank [everyone](https://github.com/fivetran/dbt_reddit_ads/graphs/contributors) who has taken the time to contribute. Each PR, bug report, and feature request has made this package better and is truly appreciated.
+
+A special thank you to [Seer Interactive](https://www.seerinteractive.com/?utm_campaign=Fivetran%20%7C%20Models&utm_source=Fivetran&utm_medium=Fivetran%20Documentation), who we closely collaborated with to introduce native conversion support to our Ad packages.
+
 ## Are there any resources available?
 - If you have questions or want to reach out for help, see the [GitHub Issue](https://github.com/fivetran/dbt_reddit_ads/issues/new/choose) section to find the right avenue of support for you.
 - If you would like to provide feedback to the dbt package team at Fivetran or would like to request a new dbt package, fill out our [Feedback Form](https://www.surveymonkey.com/r/DQ7K7WW).
diff --git a/dbt_project.yml b/dbt_project.yml
@@ -1,5 +1,5 @@
 name: 'reddit_ads'
-version: '0.2.1'
+version: '0.3.0'
 config-version: 2
 require-dbt-version: [">=1.3.0", "<2.0.0"]
 vars:
@@ -10,13 +10,26 @@ vars:
     ad_group_daily_report: "{{ ref('stg_reddit_ads__ad_group_report') }}"
     ad: "{{ ref('stg_reddit_ads__ad') }}"
     ad_daily_report: "{{ ref('stg_reddit_ads__ad_report') }}"
-    campaign: "{{ ref('stg_reddit_ads__campaign') }}"
+    campaign: "{{ ref('stg_reddit_ads__campaign') }}" 
     campaign_daily_report: "{{ ref('stg_reddit_ads__campaign_report') }}"
-    post_daily_report: "{{ ref('stg_reddit_ads__post_report') }}"
+    account_conversions_report: "{{ ref('stg_reddit_ads__account_conversions_report') }}"
+    ad_group_conversions_report: "{{ ref('stg_reddit_ads__ad_group_conversions_report') }}"
+    ad_conversions_report: "{{ ref('stg_reddit_ads__ad_conversions_report') }}"
+    campaign_conversions_report: "{{ ref('stg_reddit_ads__campaign_conversions_report') }}"
+
   reddit_ads__account_passthrough_metrics: []
   reddit_ads__ad_group_passthrough_metrics: []
   reddit_ads__ad_passthrough_metrics: []
   reddit_ads__campaign_passthrough_metrics: []
+  reddit_ads__account_conversions_passthrough_metrics: []
+  reddit_ads__ad_group_conversions_passthrough_metrics: []
+  reddit_ads__ad_conversions_passthrough_metrics: []
+  reddit_ads__campaign_conversions_passthrough_metrics: []
+
+  reddit_ads__conversion_event_types:
+    - 'lead'
+    - 'purchase'
+    - 'custom'
 
 models:
   reddit_ads:

diff --git a/docs/catalog.json b/docs/catalog.json
diff --git a/docs/manifest.json b/docs/manifest.json
diff --git a/docs/run_results.json b/docs/run_results.json
diff --git a/integration_tests/ci/sample.profiles.yml b/integration_tests/ci/sample.profiles.yml
@@ -16,13 +16,13 @@ integration_tests:
       pass: "{{ env_var('CI_REDSHIFT_DBT_PASS') }}"
       dbname: "{{ env_var('CI_REDSHIFT_DBT_DBNAME') }}"
       port: 5439
-      schema: reddit_ads_integration_tests_3
+      schema: reddit_ads_integration_tests_4
       threads: 8
     bigquery:
       type: bigquery
       method: service-account-json
       project: 'dbt-package-testing'
-      schema: reddit_ads_integration_tests_3
+      schema: reddit_ads_integration_tests_4
       threads: 8
       keyfile_json: "{{ env_var('GCLOUD_SERVICE_KEY') | as_native }}"
     snowflake:
@@ -33,7 +33,7 @@ integration_tests:
       role: "{{ env_var('CI_SNOWFLAKE_DBT_ROLE') }}"
       database: "{{ env_var('CI_SNOWFLAKE_DBT_DATABASE') }}"
       warehouse: "{{ env_var('CI_SNOWFLAKE_DBT_WAREHOUSE') }}"
-      schema: reddit_ads_integration_tests_3
+      schema: reddit_ads_integration_tests_4
       threads: 8
     postgres:
       type: postgres
@@ -42,13 +42,13 @@ integration_tests:
       pass: "{{ env_var('CI_POSTGRES_DBT_PASS') }}"
       dbname: "{{ env_var('CI_POSTGRES_DBT_DBNAME') }}"
       port: 5432
-      schema: reddit_ads_integration_tests_3
+      schema: reddit_ads_integration_tests_4
       threads: 8
     databricks:
       catalog: "{{ env_var('CI_DATABRICKS_DBT_CATALOG') }}"
       host: "{{ env_var('CI_DATABRICKS_DBT_HOST') }}"
       http_path: "{{ env_var('CI_DATABRICKS_DBT_HTTP_PATH') }}"
-      schema: reddit_ads_integration_tests_3
+      schema: reddit_ads_integration_tests_4
       threads: 8
       token: "{{ env_var('CI_DATABRICKS_DBT_TOKEN') }}"
       type: databricks