Feature: Adding conversions (#28)

* regen docs

* Add conversions

* Add conversions

* ready?

* gitignore

* revert typo

* postgres

* more postgres work

* remove ds_store

* columns

* remove commented out code

* docs

---------

Co-authored-by: Jamie Rodriguez <[email protected]>

.gitignore

@@ -4,4 +4,6 @@ dbt_modules/
 logs/
 env/
 dbt_packages/
-package-lock.yml
+package-lock.yml
+.DS_Store
+integration_tests/.DS_Store

CHANGELOG.md

@@ -1,3 +1,26 @@
+# dbt_snapchat_ads v0.7.0
+[PR #28](https://github.com/fivetran/dbt_snapchat_ads/pull/28) includes the following **BREAKING CHANGE** updates:
+
+## Feature Updates: Conversion Support
+We have added more robust support for conversions in our data models by doing the following:
+
+- Added a `conversion_purchases_value` field to each `_report` end model, representing the value of conversions that occurred on each day for each account,  ad, ad squad, campaign and url in your Ad Account's currency.
+- Introduced the `snapchat_ads_conversion_fields` variable to configure which conversion fields (reflecting the total number of conversions) to include in each end model.
+  - By default, `snapchat_ads_conversion_fields` will include the most commonly used conversion field, `conversion_purchases`. See [README](https://github.com/fivetran/dbt_snapchat_ads/tree/main?tab=readme-ov-file#configuring-conversion-fields) for details on how to configure this variable to include other conversion events.
+  - The individual conversion fields specified by `snapchat_ads_conversion_fields` are summed together into a `total_conversions` field in each end model as well.
+> **IMPORTANT**: The above new field additions are **breaking changes** for users who were not already bringing in conversion fields via passthrough columns.
+
+## Documentation Update 
+- Documented how to use the new `snapchat_ads__conversion_fields` variable [here](https://github.com/fivetran/dbt_snapchat_ads/tree/main?tab=readme-ov-file#configuring-conversion-fields).
+- Documented new default conversion fields in yml.
+
+## Under the Hood
+- Added a new [version](https://github.com/fivetran/dbt_snapchat_ads/blob/main/macros/snapchat_ads_persist_pass_through_columns.sql) of the `persist_pass_through_columns()` [macro](https://github.com/fivetran/dbt_fivetran_utils/blob/v0.4.10/macros/persist_pass_through_columns.sql) in which we can include `coalesces` and properly check between conversion field values and the existing passthrough column.
+- Added data validation tests to verify this release.
+
+## Contributors
+- [Seer Interactive](https://www.seerinteractive.com/?utm_campaign=Fivetran%20%7C%20Models&utm_source=Fivetran&utm_medium=Fivetran%20Documentation)
+
 # dbt_snapchat_ads v0.6.2
 ## Bug Fixes
 - Adjust the severity of the `ad_account_id` test in `snapchat_ads__account_report` to `warn`. This is required since Snapchat can hard-delete records from the history tables, but not from the reporting tables. This ensures that accurate statistics are being reported and production pipelines aren't failing. ([PR #20](https://github.com/fivetran/dbt_snapchat_ads/pull/20))

DECISIONLOG.md

@@ -5,7 +5,7 @@ An ad can be associated with multiple ad squads and therefore multiple campaigns
 ## UTM Filtering
 This package contains a `snapchat_ads__url_report` which provides daily metrics for your utm compatible ads. It is important to note that not all Ads leverage utm parameters. Therefore, this package takes an opinionated approach to filter out any records that do not contain utm parameters or leverage a url within the ad.
 
-If you would like to leverage a report that contains all ads and their daily metrics, I would suggest you leverage the snpapchat_ads__ad_report which does not apply any filtering.
+If you would like to leverage a report that contains all ads and their daily metrics, I would suggest you leverage the `snapchat_ads__ad_report` which does not apply any filtering.
 
 ## Ad Account Report Metrics Associated with Deleted Entities
 Similar to some other Ad Platforms, Snapchat Ads will hard-delete entities (i.e. ads, ad squads, campaigns, accounts) from their `*_history` tables but retain associated records in their respective `*_hourly_report` tables. This typically does not pose an issue for our `not_null` tests on our end models, as most entities have their own `<entity>_hourly_report` source tables that come with the appropriate entity-level ID. However, `snapchat_ads__account_report` draws from the `ad_hourly_report` table, rolls it up to the account level, and joins in the `ad_account_id` using history tables. Thus, if any ad report record is associated with a deleted ad, campaign, ad squad, or account, the `ad_account_id` will be `null`.

README.md

@@ -47,14 +47,15 @@ dispatch:
     search_order: ['spark_utils', 'dbt_utils']
 ```
 
-### Step 2: Install the package
-Include the following snapchat_ads_source package version in your `packages.yml` file:
+### Step 2: Install the package  (skip if also using the `ad_reporting` combination package)
+If you are not using the [Ad Reporting](https://github.com/fivetran/dbt_ad_reporting) combination package, include the following Snapchat 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.
 ```yml
 packages:
   - package: fivetran/snapchat_ads
-    version: [">=0.6.0", "<0.7.0"] # we recommend using ranges to capture non-breaking changes automatically
+    version: [">=0.7.0", "<0.8.0"] # we recommend using ranges to capture non-breaking changes automatically
 ```
+
 Do NOT include the `snapchat_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: Configure your variables
@@ -69,6 +70,8 @@ vars:
 ```
 
 ### (Optional) Step 4: Additional configurations
+<details open><summary>Expand/Collapse details</summary>
+
 #### Union multiple connectors
 If you have multiple snapchat_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 `snapchat_ads_union_schemas` OR `snapchat_ads_union_databases` variables (cannot do both) in your root `dbt_project.yml` file:
 
@@ -82,24 +85,45 @@ 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.
 
 #### Passing Through Additional Metrics
-By default, this package will select `clicks`, `impressions`, and `cost` 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 below configurations to your `dbt_project.yml` file. These variables allow for the pass-through fields to be aliased (`alias`) if desired, but not required. Use the below format for declaring the respective pass-through variables:
-
-> IMPORTANT: Make sure to exercise due diligence when adding metrics to these models. The metrics added by default (taps, impressions, and spend) have been vetted by the Fivetran team, maintaining this package for accuracy. There are metrics included within the source reports, such as metric averages, which may be inaccurately represented at the grain for reports created in this package. You must ensure that whichever metrics you pass through are appropriate to aggregate at the respective reporting levels in this package.
+By default, this package will select `swipes`, `impressions`, `spend`, `conversion_purchases_value`, and `total_conversions` (as well as fields set via `snapchat_ads__conversion_fields` in the next section) 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 below configurations to your `dbt_project.yml` file. These variables allow for the pass-through fields to be aliased (`alias`) if desired, but not required. Use the below format for declaring the respective pass-through variables:
 
 ```yml
 vars:
     snapchat_ads__ad_hourly_passthrough_metrics: 
       - name: "new_custom_field"
-        alias: "custom_field"
+        alias: "custom_field_alias"
+        transform_sql: "coalesce(custom_field_alias, 0)" # reference the `alias` here if you are using one
+      - name: "unique_int_field"
+        alias: "field_id"
+      - name: "another_one"
+        transform_sql: "coalesce(another_one, 0)" # reference the `name` here if you're not using an alias
     snapchat_ads__ad_squad_hourly_passthrough_metrics:
       - name: "this_field"
     snapchat_ads__campaign_hourly_report_passthrough_metrics:
       - name: "unique_string_field"
         alias: "field_id"
 ```
 
+>**Note**: Make sure to exercise due diligence when adding metrics to these models. The metrics added by default (swipes, impressions, spend, and conversions) have been vetted by the Fivetran team, maintaining this package for accuracy. There are metrics included within the source reports, such as metric averages, which may be inaccurately represented at the grain for reports created in this package. You must ensure that whichever metrics you pass through are appropriate to aggregate at the respective reporting levels in this package.
+
+**Important**: You do NOT need to add conversions in this way. See the following section for an alternative implementation.
+
+#### Configuring Conversion Fields
+Separate from the above passthrough metrics, the package will also include conversion metrics based on the `snapchat_ads__conversion_fields` variable, in addition to the `conversion_purchases_value` field.
+
+By default, the data models consider `conversion_purchases` to be conversions. These should cover most use cases, but, say, if you would like to consider adding payment info, adding to wishlist, adding to the cart, etc. to also be conversions, you would apply the following configuration with the **original** source names of the conversion fields (not aliases you provided in the section above):
+
+```yml
+# dbt_project.yml
+vars:
+    snapchat_ads__conversion_fields: ['conversion_purchases', 'conversion_add_billing', 'conversion_save', 'conversion_add_cart']
+```
+
+> We introduced support for conversion fields in our `*_report` data models in the [v0.7.0 release](https://github.com/fivetran/dbt_snapchat_ads_source/releases/tag/v0.7.0) of the package, but customers might have been bringing in these conversion fields earlier using the passthrough fields variables. The data models will avoid "duplicate column" errors automatically if this is the case.
+
 #### 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_snapchat_ads_source/blob/main/dbt_project.yml) variable declarations to see the expected names.
 
 ```yml
@@ -108,7 +132,7 @@ vars:
 ```
 
 #### Change the build schema
-By default, this package builds the Snapchat Ads staging models within a schema titled (`<target_schema>` + `_stg_snapchat_ads`) and your Snapchat Ads modeling models within a schema titled (`<target_schema>` + `_snapchat_ads`) in your destination. If this is not where you would like your Snapchat Ads data to be written to, add the following configuration to your root `dbt_project.yml` file:
+By default, this package builds the Snapchat Ads staging models (9 views, 9 tables) within a schema titled (`<target_schema>` + `_stg_snapchat_ads`) and your Snapchat Ads modeling models (5 tables) within a schema titled (`<target_schema>` + `_snapchat_ads`) in your destination. If this is not where you would like your Snapchat Ads data to be written to, add the following configuration to your root `dbt_project.yml` file:
 
 ```yml
 models:
@@ -118,6 +142,8 @@ models:
       +schema: my_new_schema_name # leave blank for just the target_schema
 ```
 
+</details>
+
 ### (Optional) Step 5: Orchestrate your models with Fivetran Transformations for dbt Core™
 <details><summary>Expand for more details</summary>
 <br>
@@ -133,7 +159,7 @@ This dbt package is dependent on the following dbt packages. These dependencies
 ```yml
 packages:
     - package: fivetran/snapchat_ads_source
-      version: [">=0.6.0", "<0.7.0"]
+      version: [">=0.7.0", "<0.8.0"]
 
     - package: fivetran/fivetran_utils
       version: [">=0.4.0", "<0.5.0"]
@@ -156,6 +182,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_snapchat_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_snapchat_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).

dbt_project.yml

@@ -16,6 +16,7 @@ vars:
   snapchat_ads__ad_hourly_passthrough_metrics: []
   snapchat_ads__ad_squad_hourly_passthrough_metrics: []
   snapchat_ads__campaign_hourly_report_passthrough_metrics: []
+  snapchat_ads__conversion_fields: ['conversion_purchases']
 models:
   snapchat_ads:
     +schema: snapchat_ads