Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add conversions #34

Open
wants to merge 28 commits into
base: main
Choose a base branch
from
Open

Add conversions #34

wants to merge 28 commits into from

Conversation

fivetran-reneeli
Copy link
Contributor

@fivetran-reneeli fivetran-reneeli commented Aug 30, 2024

PR Overview

This PR will address the following Issue/Feature:
Internal ticket, to add conversions data

This PR will result in the following new package version:

0.11.0

Please detail what change(s) this PR introduces and any additional information that should be known during the review of this PR:

Feature update

  • We have added the following fields to each pinterest_ads end model:
    • total_conversions
    • total_conversions_quantity
    • total_conversions_value_in_micro_dollar
  • 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.

  • Added more information about the difference in grains and their relationships in the DECISIONLOG.

Under the hood

  • Created pinterest_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).

PR Checklist

Basic Validation

Please acknowledge that you have successfully performed the following commands locally:

  • dbt compile
  • [na] dbt run –full-refresh
  • dbt run
  • dbt test
  • dbt run –vars (if applicable). -- to test backwards compatibility, see internal note

Before marking this PR as "ready for review" the following have been applied:

  • The appropriate issue has been linked and tagged
  • You are assigned to the corresponding issue and this PR
  • BuildKite integration tests are passing

Detailed Validation

Please acknowledge that the following validation checks have been performed prior to marking this PR as "ready for review":

  • You have validated these changes and assure this PR will address the respective Issue/Feature.
  • You are reasonably confident these changes will not impact any other components of this package or any dependent packages.
  • You have provided details below around the validation steps performed to gain confidence in these changes.
  1. Backwards compat: tested as noted in internal ticket:

pinterest__ad_group_report_passthrough_metrics:

  • name: "total_conversions"
  • name: "total_view_checkout"
    alias: "t_view_checkout"
  1. Prior metrics are not affected: see consistency tests
  2. Conversion values aggregate correctly across grains that rollup: see horizontal integrity test horizontal_sum_conversions
  3. Conversion values aggregate correctly from staging to final models: see vertical integrity test vertical_sum_conversions

Standard Updates

Please acknowledge that your PR contains the following standard updates:

  • Package versioning has been appropriately indexed in the following locations:
    • indexed within dbt_project.yml
    • indexed within integration_tests/dbt_project.yml
  • CHANGELOG has individual entries for each respective change in this PR
  • README updates have been applied (if applicable) no new variables, but just checking that the existing passthrough column variable still works.
  • DECISIONLOG updates have been updated (if applicable) - added section about grains
  • Appropriate yml documentation has been added (if applicable) - added field definitions for new conversion fields

dbt Docs

Please acknowledge that after the above were all completed the below were applied to your branch:

  • docs were regenerated (unless this PR does not include any code or yml updates)

If you had to summarize this PR in an emoji, which would it be?

💃

CHANGELOG.md Outdated
- `total_conversions_value_in_micro_dollar`
- In the event that you were already passing the above fields in via our [passthrough columns](https://github.com/fivetran/dbt_pinterest/blob/main/README.md#passing-through-additional-metrics), 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small request to remove emojis

Suggested change
> The above new field additions are 🚨 **breaking changes** 🚨 for users who were not already bringing in conversion fields via passthrough columns.
> The above new field additions are **breaking changes** for users who were not already bringing in conversion fields via passthrough columns.

[PR #34](https://github.com/fivetran/dbt_pinterest/pull/34) includes the following updates:

## Feature update
- We have added the following fields to each `pinterest_ads` end model:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we can add a bit more fanfare here to highlight native support for conversions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants