PR #33 includes the following BREAKING CHANGE updates:
- We have added the following source fields to each
stg_pinterest_ads__<entity>_reportmodel:total_conversions: The sum of all website conversion events.total_conversions_quantity: The total count of items or units involved in conversions.total_conversions_value(converted fromtotal_conversions_value_in_micro_dollar) Total order value associated with conversions.
- 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.
- Created
pinterest_ads_fill_pass_through_columnsandpinterest_ads_add_pass_through_columnsmacros to ensure that the new conversion fields are backwards compatible with users who have already included them via passthrough fields. - Explicitly casts
<entity>_idfields as strings in:stg_pinterest_ads__ad_group_historystg_pinterest_ads__ad_group_reportstg_pinterest_ads__advertiser_historystg_pinterest_ads__advertiser_reportstg_pinterest_ads__campaign_historystg_pinterest_ads__campaign_reportstg_pinterest_ads__keyword_historystg_pinterest_ads__keyword_reportstg_pinterest_ads__pin_promotion_historystg_pinterest_ads__pin_promotion_report
- Updated seed data to represent an e-commerce customer scenario.
- Coalesces
spendwith 0 to ensure proper downstream aggregations.
- Updates the DECISIONLOG to clarify why there exist differences among aggregations across different grains.
PR #31 includes the following updates:
- This package now leverages the new
pinterest_ads_extract_url_parameter()macro for use in parsing out url parameters. This was added to create special logic for Databricks instances not supported bydbt_utils.get_url_parameter().- This macro will be replaced with the
fivetran_utils.extract_url_parameter()macro in the next breaking change of this package.
- This macro will be replaced with the
- Included auto-releaser GitHub Actions workflow to automate future releases.
PR #28 includes the following updates:
- Updated the following identifiers for consistency with the source name and compatibility with the union schema feature:
| current | previous |
|---|---|
| pinterest_ads_ad_group_history_identifier | pinterest_ad_group_history_identifier |
| pinterest_ads_campaign_history_identifier | pinterest_campaign_history_identifier |
| pinterest_ads_pin_promotion_report_identifier | pinterest_pin_promotion_report_identifier |
| pinterest_ads_keyword_history_identifier | pinterest_keyword_history_identifier |
| pinterest_ads_keyword_report_identifier | pinterest_keyword_report_identifier |
| pinterest_ads_ad_group_report_identifier | pinterest_ad_group_report_identifier |
| pinterest_ads_campaign_report_identifier | pinterest_campaign_report_identifier |
| pinterest_ads_advertiser_history_identifier | pinterest_advertiser_history_identifier |
| pinterest_ads_advertiser_report_identifier | pinterest_advertiser_report_identifier |
- If you are using the previous identifier, be sure to update to the current version!
- Unioning capability! This adds the ability to union source data from multiple pinterest connectors. Refer to the Union Multiple Connectors README section for more details.
- Updated tmp models to union source data using the
fivetran_utils.union_datamacro. - To distinguish which source each field comes from, added
source_relationcolumn in each staging model and applied thefivetran_utils.source_relationmacro. - Updated tests to account for the new
source_relationcolumn.
PR #25 introduces the following changes:
- Following Pinterest Ads deprecating the v4 API on June 30, 2023 in place of v5, the Pinterest Ads Fivetran connector now leverages the Pinterest v5 API. The following fields have been deprecated/introduced:
| Model | Removed | New |
|---|---|---|
| stg_pinterest_ads__advertiser_history | billing_profile_status, billing_type, merchant_id, status |
owner_username, permissions |
| stg_pinterest_ads__campaign_history | default_ad_group_budget_in_micro_currency, is_automated_campaign, is_campaign_budget_optimization, is_flexible_daily_budgets |
|
| stg_pinterest_ads__ad_group_history | pacing_delivery_type, placement_group, summary_status, advertiser_id |
|
| stg_pinterest_ads__pin_promotion_history | advertiser_id |
- Following the v5 upgrade,
ad_account_idis a net new field withinad_group_historyandpin_promotion_historysource tables synced via the connector. However, to keep these fields standard across the package, we have renamed them asadvertiser_idwithin the respective staging models. - Seed data were updated with new/removed fields following the v5 upgrade
- This was an accidental release
- Addition of the
pinterest__using_keywords(default=true) variable that allows users to disable the relevant keyword reports in the downstream Pinterest models if they are not used. (PR #23)
- Incorporated the new
fivetran_utils.drop_schemas_automationmacro into the end of each Buildkite integration test job. (PR #22) - Updated the pull request templates. (PR #22)
- Added
pin_promotion_idto unique-combination-of-columns test for modelstg_pinterest_adsto remedy test failures. (#21)
PR #19 includes the following breaking changes:
- Dispatch update for dbt-utils to dbt-core cross-db macros migration. Specifically
{{ dbt_utils.<macro> }}have been updated to{{ dbt.<macro> }}for the below macros:any_valuebool_orcast_bool_to_textconcatdate_truncdateadddatediffescape_single_quotesexcepthashintersectlast_daylengthlistaggpositionreplacerightsafe_castsplit_partstring_literaltype_biginttype_floattype_inttype_numerictype_stringtype_timestamparray_appendarray_concatarray_construct
- For
current_timestampandcurrent_timestamp_in_utcmacros, the dispatch AND the macro names have been updated to the below, respectively:dbt.current_timestamp_backcompatdbt.current_timestamp_in_utc_backcompat
- Dependencies on
fivetran/fivetran_utilshave been upgraded, previously[">=0.3.0", "<0.4.0"]now[">=0.4.0", "<0.5.0"].
- The
pin_promotion_report_pass_through_metricvariable has been renamed topinterest__pin_promotion_report_passthrough_metrics. (#18) - The declaration of passthrough variables within your root
dbt_project.ymlhas changed. To allow for more flexibility and better tracking of passthrough columns, you will now want to define passthrough metrics in the following format: (#18)
This applies to all passthrough metrics within the
dbt_pinterest_sourcepackage and not just thepinterest__pin_promotion_report_passthrough_metricsexample.
vars:
pinterest__pin_promotion_report_passthrough_metrics:
- name: "my_field_to_include" # Required: Name of the field within the source.
alias: "field_alias" # Optional: If you wish to alias the field within the staging model.PR #18 includes the following changes:
-
Addition of the following staging models which pull from the source counterparts. The inclusion of the additional
_reportsource tables is to generate a more accurate representation of the Pinterest Ads data. For example, not all Ad types are included within thepin_promotion_reporttable. Therefore, the addition of the further grain reports will allow for more flexibility and accurate Pinterest Ad reporting.stg_pinterest_ads__ad_group_reportstg_pinterest_ads__advertiser_reportstg_pinterest_ads__campaign_reportstg_pinterest_ads__keyword_reportstg_pinterest_ads__advertiser_historystg_pinterest_ads__keyword_history
-
Inclusion of additional passthrough metrics:
pinterest__ad_group_report_passthrough_metricspinterest__campaign_report_passthrough_metricspinterest__advertiser_report_passthrough_metricspinterest__keyword_report_passthrough_metrics
-
README updates for easier navigation and use of the package.
-
Addition of identifier variables for each of the source tables to allow for further flexibility in source table direction within the dbt project.
-
Included grain uniqueness tests for each staging table.
🎉 dbt v1.0.0 Compatibility 🎉
- Adjusts the
require-dbt-versionto now be within the range [">=1.0.0", "<2.0.0"]. Additionally, the package has been updated for dbt v1.0.0 compatibility. If you are using a dbt version <1.0.0, you will need to upgrade in order to leverage the latest version of the package.- For help upgrading your package, I recommend reviewing this GitHub repo's Release Notes on what changes have been implemented since your last upgrade.
- For help upgrading your dbt project to dbt v1.0.0, I recommend reviewing dbt-labs upgrading to 1.0.0 docs for more details on what changes must be made.
- Upgrades the package dependency to refer to the latest
dbt_fivetran_utils. The latestdbt_fivetran_utilspackage also has a dependency ondbt_utils[">=0.8.0", "<0.9.0"].- Please note, if you are installing a version of
dbt_utilsin yourpackages.ymlthat is not in the range above then you will encounter a package dependency error.
- Please note, if you are installing a version of
Refer to the relevant release notes on the Github repository for specific details for the previous releases. Thank you!