This PR will address the following Issue/Feature: This is part of the add conversion metrics project
This PR will result in the following new package version: v0.6.0
We are changing the data type of one field in the source package that will change it in the transform, and customers bringing in the new conversion fields previously via passthrough columns will experience errors if they don't update.
Please provide the finalized CHANGELOG entry which details the relevant changes included in this PR:
Feature Updates: Conversion Support!
We have added the following source fields to each tiktok_ads end model:
real_time_conversion: Number of times your ad resulted in the optimization event you selected.
total_purchase_value: The total value of purchase events that occurred in your app that were recorded by your measurement partner.
total_sales_lead_value: The monetary worth or potential value assigned to a lead generated through ads.
total_conversion_value: The accumulated value of total_purchase_value and total_sales_lead_value.
In the event that you were already passing the above fields in via our passthrough columns, the package will dynamically avoid "duplicate column" errors.
The above new field additions are breaking changes for users who were not already bringing in conversion fields via passthrough columns.
Breaking Changes (in the dbt_tiktok_ads_source package)
Update conversion to be an integer rather than a numeric data type, as is the expected behavior of the field. To reflect that data type change, you will need to do a --full-refresh.
Under the Hood
Created tiktok_ads_persist_pass_through_columns macro to ensure that the new conversion fields are backwards compatible with users who have already included them via passthrough fields.
Added integrity and consistency validation tests within integration_tests folder for the transformation models (to be used by maintainers only).
Please acknowledge that you have successfully performed the following commands locally:
[x] dbt run –full-refresh && dbt test
[NA] dbt run (if incremental models are present) && dbt test
Before marking this PR as "ready for review" the following have been applied:
[NA] The appropriate issue has been linked, tagged, and properly assigned
[x] All necessary documentation and version upgrades have been applied
[x] docs were regenerated (unless this PR does not include any code or yml updates)
[x] BuildKite integration tests are passing
[x] Detailed validation steps have been provided below
Detailed Validation
Please share any and all of your validation steps:
Unfortunately the JSON issue surrounding age_groups in the ad_group model did not allow us to fully validate on dev data, so we had to use integration tests to validate nothing looks out of the ordinary.
If you had to summarize this PR in an emoji, which would it be?
PR Overview
This PR will address the following Issue/Feature: This is part of the add conversion metrics project
This PR will result in the following new package version: v0.6.0
We are changing the data type of one field in the source package that will change it in the transform, and customers bringing in the new conversion fields previously via passthrough columns will experience errors if they don't update.
Please provide the finalized CHANGELOG entry which details the relevant changes included in this PR:
Feature Updates: Conversion Support!
We have added the following source fields to each
tiktok_adsend model:real_time_conversion: Number of times your ad resulted in the optimization event you selected.total_purchase_value: The total value of purchase events that occurred in your app that were recorded by your measurement partner.total_sales_lead_value: The monetary worth or potential value assigned to a lead generated through ads.total_conversion_value: The accumulated value oftotal_purchase_valueandtotal_sales_lead_value.In the event that you were already passing the above fields in via our passthrough columns, the package will dynamically avoid "duplicate column" errors.
Breaking Changes (in the
dbt_tiktok_ads_sourcepackage)conversionto be an integer rather than a numeric data type, as is the expected behavior of the field. To reflect that data type change, you will need to do a--full-refresh.Under the Hood
tiktok_ads_persist_pass_through_columnsmacro to ensure that the new conversion fields are backwards compatible with users who have already included them via passthrough fields.integration_testsfolder for the transformation models (to be used by maintainers only).Contributors
PR Checklist
Basic Validation
Please acknowledge that you have successfully performed the following commands locally:
Before marking this PR as "ready for review" the following have been applied:
Detailed Validation
Please share any and all of your validation steps:
Unfortunately the JSON issue surrounding
age_groupsin thead_groupmodel did not allow us to fully validate on dev data, so we had to use integration tests to validate nothing looks out of the ordinary.If you had to summarize this PR in an emoji, which would it be?
🕙