diff --git a/CHANGELOG.md b/CHANGELOG.md index c5cb45f..ef4d166 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,5 @@ # dbt_ad_reporting v1.4.0 + ## 🎉 Feature Enhancement 🎉 - Added `ad_reporting___passthrough_metrics` variables to easily add common metrics across all platforms into the `ad_reporting` models! This allows metrics other than the standard `clicks`, `impressions`, and `cost` to be included in the final ad reporting models. See below for a full list of new variables and example metrics to passthrough. ([PR #85](https://github.com/fivetran/dbt_ad_reporting/pull/84)) - It is important to call out that this is only possible if the relevant upstream Ad platform variables have the same metric to be unioned in the roll up model. Please see the [README](https://github.com/fivetran/dbt_ad_reporting#optional-step-6-additional-configurations) section for details around how to configure the passthrough metrics. @@ -23,6 +24,8 @@ vars: - name: conversions - name: local_spend_amount ``` +- 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 #89](https://github.com/fivetran/dbt_ad_reporting/pull/89)) + ## Under the Hood: - Incorporated the new `fivetran_utils.drop_schemas_automation` macro into the end of each Buildkite integration test job. ([PR #86](https://github.com/fivetran/dbt_ad_reporting/pull/86)) diff --git a/README.md b/README.md index 428c4e3..d4285e8 100644 --- a/README.md +++ b/README.md @@ -145,7 +145,9 @@ vars: ### Enable/Disable Specific Reports within Platforms For **Apple Search Ads**, if you are not utilizing the search functionality, you may choose to update the respective variable below. -For **Twitter Ads**, if you are tracking keyword performance, you may choose to update the corresponding variable below. +For **Twitter Ads**, if you are not tracking keyword performance, you may choose to update the corresponding variable below. + +For **Pinterest Ads**, if you are not tracking keyword performance, you may choose to update the corresponding variable below. Add the following variables to your dbt_project.yml file @@ -153,6 +155,7 @@ Add the following variables to your dbt_project.yml file vars: apple_search_ads__using_search_terms: False # by default this is assumed to be True twitter_ads__using_keywords: False # by default this is assumed to be True + pinterest__using_keywords: False # by default this is assumed to be True ``` ## (Recommended) Step 5: Change the Build Schema diff --git a/docs/index.html b/docs/index.html index 0807e63..c247eb4 100644 --- a/docs/index.html +++ b/docs/index.html @@ -99,4 +99,4 @@ */ e.exports=function(e){return null!=e&&(n(e)||function(e){return"function"==typeof e.readFloatLE&&"function"==typeof e.slice&&n(e.slice(0,0))}(e)||!!e._isBuffer)}},function(e,t,n){n(9).module("dbt").factory("locationService",["$state",function(e){var t={};return t.parseState=function(e){return function(e){return{selected:{include:e.g_i||"",exclude:e.g_e||""},show_graph:!!e.g_v}}(e)},t.setState=function(t){var n=function(e){var t={g_v:1};return t.g_i=e.include,t.g_e=e.exclude,t}(t),r=e.current.name;e.go(r,n)},t.clearState=function(){var t=e.current.name;e.go(t,{g_i:null,g_e:null,g_v:null})},t}])},function(e,t,n){"use strict";const r=n(9),i=n(202);r.module("dbt").controller("OverviewCtrl",["$scope","$state","project",function(e,t,n){e.overview_md="(loading)",n.ready((function(n){let r=t.params.project_name?t.params.project_name:null;var o=n.docs["doc.dbt.__overview__"],a=i.filter(n.docs,{name:"__overview__"});if(i.each(a,(function(e){"dbt"!=e.package_name&&(o=e)})),null!==r){o=n.docs[`doc.${r}.__${r}__`]||o;let e=i.filter(n.docs,{name:`__${r}__`});i.each(e,e=>{e.package_name!==r&&(o=e)})}e.overview_md=o.block_contents}))}])},function(e,t,n){"use strict";n(9).module("dbt").controller("SourceListCtrl",["$scope","$state","project",function(e,t,n){e.source=t.params.source,e.model={},e.extra_table_fields=[],e.has_more_info=function(e){return(e.description||"").length},e.toggle_source_expanded=function(t){e.has_more_info(t)&&(t.expanded=!t.expanded)},n.ready((function(t){var n=_.filter(t.nodes,(function(t){return t.source_name==e.source}));if(0!=n.length){n.sort((e,t)=>e.name.localeCompare(t.name));var r=n[0];e.model={name:e.source,source_description:r.source_description,sources:n};var i=_.uniq(_.map(n,"metadata.owner")),o=_.uniq(_.map(n,"database")),a=_.uniq(_.map(n,"schema"));e.extra_table_fields=[{name:"Loader",value:r.loader},{name:1==i.length?"Owner":"Owners",value:i.join(", ")},{name:1==o.length?"Database":"Databases",value:o.join(", ")},{name:1==a.length?"Schema":"Schemas",value:a.join(", ")},{name:"Tables",value:n.length}]}}))}])},function(e,t,n){const r=n(9),i={main:n(480),overview:n(481),graph:n(482),source:n(205),source_list:n(483),model:n(484),source:n(205),snapshot:n(485),seed:n(486),test:n(487),analysis:n(488),macro:n(489),exposure:n(490),metric:n(491),operation:n(492)};r.module("dbt").config(["$stateProvider","$urlRouterProvider",function(e,t){var n="g_v&g_i&g_e&g_p&g_n";t.otherwise("/overview"),e.state("dbt",{url:"/",abstract:!0,controller:"MainController",templateUrl:i.main}).state("dbt.overview",{url:"overview?"+n,controller:"OverviewCtrl",templateUrl:i.overview}).state("dbt.project_overview",{url:"overview/:project_name?"+n,controller:"OverviewCtrl",templateUrl:i.overview,params:{project_name:{type:"string"}}}).state("dbt.graph",{url:"graph",controller:"GraphCtrl",templateUrl:i.graph}).state("dbt.model",{url:"model/:unique_id?section&"+n,controller:"ModelCtrl",templateUrl:i.model,params:{unique_id:{type:"string"}}}).state("dbt.seed",{url:"seed/:unique_id?section&"+n,controller:"SeedCtrl",templateUrl:i.seed,params:{unique_id:{type:"string"}}}).state("dbt.snapshot",{url:"snapshot/:unique_id?section&"+n,controller:"SnapshotCtrl",templateUrl:i.snapshot,params:{unique_id:{type:"string"}}}).state("dbt.test",{url:"test/:unique_id?section&"+n,controller:"TestCtrl",templateUrl:i.test,params:{unique_id:{type:"string"}}}).state("dbt.analysis",{url:"analysis/:unique_id?section&"+n,controller:"AnalysisCtrl",templateUrl:i.analysis,params:{unique_id:{type:"string"}}}).state("dbt.source",{url:"source/:unique_id?section&"+n,controller:"SourceCtrl",templateUrl:i.source,params:{unique_id:{type:"string"}}}).state("dbt.source_list",{url:"source_list/:source?section&"+n,controller:"SourceListCtrl",templateUrl:i.source_list,params:{source:{type:"string"}}}).state("dbt.macro",{url:"macro/:unique_id?section",controller:"MacroCtrl",templateUrl:i.macro,params:{unique_id:{type:"string"}}}).state("dbt.exposure",{url:"exposure/:unique_id?section&"+n,controller:"ExposureCtrl",templateUrl:i.exposure,params:{unique_id:{type:"string"}}}).state("dbt.metric",{url:"metric/:unique_id?section&"+n,controller:"MetricCtrl",templateUrl:i.metric,params:{unique_id:{type:"string"}}}).state("dbt.operation",{url:"operation/:unique_id?section&"+n,controller:"OperationCtrl",templateUrl:i.operation,params:{unique_id:{type:"string"}}})}])},function(e,t){var n="/main/main.html";window.angular.module("ng").run(["$templateCache",function(e){e.put(n,'\n\n
\n \n\n
\n
\n
\n
\n
\n
\n \n
\n
\n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n \n
\n
\n
\n \n
\n
\n
\n
\n
\n \n
\n
\n
\n
\n')}]),e.exports=n},function(e,t){var n="/overview/overview.html";window.angular.module("ng").run(["$templateCache",function(e){e.put(n,'
\n \n
\n
\n

\n
\n
\n
\n\n')}]),e.exports=n},function(e,t){var n="/graph/graph.html";window.angular.module("ng").run(["$templateCache",function(e){e.put(n,'
\n
\n
\n
\n
\n
\n
\n')}]),e.exports=n},function(e,t){var n="/sources/source_list.html";window.angular.module("ng").run(["$templateCache",function(e){e.put(n,'\n\n
\n
\n
\n
\n

\n {{ source }}\n source\n

\n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n \n
\n\n
\n
\n
\n
Description
\n
\n
\n
\n
This {{ model.resource_type }} is not currently documented
\n
\n
\n
\n
\n\n\n
\n
\n
\n
Source Tables
\n
\n
\n
\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
SourceTableDescriptionLinkMore?
\n
\n {{ source.source_name }}\n
\n 		\n {{ source.name }}

\n 		\n {{ source.description }}\n \n View docs\n \n \n \n \n \n \n \n \n \n
\n
\n
\n
Description
\n \n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n
\n')}]),e.exports=n},function(e,t){var n="/docs/model.html";window.angular.module("ng").run(["$templateCache",function(e){e.put(n,'\n\n
\n
\n
\n
\n

\n \n \n This model is hidden\n \n

\n

\n {{ model.name }}\n {{ model.config.materialized }}\n

\n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n \n
\n\n
\n
\n
\n
Description
\n
\n
\n
\n
This {{ model.resource_type }} is not currently documented
\n
\n
\n
\n
\n\n
\n
\n
\n
Columns
\n \n
\n
\n\n
\n
\n
\n
Referenced By
\n \n
\n
\n\n
\n
\n
\n
Depends On
\n \n
\n
\n\n
\n
\n
\n \n
\n
\n
\n
\n
\n')}]),e.exports=n},function(e,t){var n="/docs/snapshot.html";window.angular.module("ng").run(["$templateCache",function(e){e.put(n,'\n\n
\n
\n
\n
\n

\n \n \n This {{ model.resource_type }} is hidden\n \n

\n

\n {{ model.name }}\n {{ model.config.materialized }}\n

\n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n \n
\n\n
\n
\n
\n
Description
\n
\n
\n
\n
This {{ model.resource_type }} is not currently documented
\n
\n
\n
\n
\n\n
\n
\n
\n
Columns
\n \n
\n
\n\n
\n
\n
\n
Referenced By
\n \n
\n
\n\n
\n
\n
\n
Depends On
\n \n
\n
\n\n
\n
\n
\n \n
\n
\n
\n
\n
\n')}]),e.exports=n},function(e,t){var n="/docs/seed.html";window.angular.module("ng").run(["$templateCache",function(e){e.put(n,'\n\n
\n
\n
\n
\n

\n \n \n This {{ model.resource_type }} is hidden\n \n

\n

\n {{ model.name }}\n {{ model.config.materialized }}\n

\n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n \n
\n\n
\n
\n
\n
Description
\n
\n
\n
\n
This {{ model.resource_type }} is not currently documented
\n
\n
\n
\n
\n
\n
\n
\n
Columns
\n \n
\n
\n\n
\n
\n
\n
Referenced By
\n \n
\n
\n\n
\n
\n
\n
Depends On
\n \n
\n
\n\n
\n
\n
\n \n
\n
\n
\n
\n
\n')}]),e.exports=n},function(e,t){var n="/docs/test.html";window.angular.module("ng").run(["$templateCache",function(e){e.put(n,'\n\n
\n
\n
\n
\n

\n {{ model.name }}\n test\n

\n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
Description
\n
\n
\n
\n
This {{ model.resource_type }} is not currently documented
\n
\n
\n
\n
\n\n
\n
\n
\n
Depends On
\n \n
\n
\n\n
\n
\n
\n \n
\n
\n
\n
\n
\n')}]),e.exports=n},function(e,t){var n="/docs/analysis.html";window.angular.module("ng").run(["$templateCache",function(e){e.put(n,'\n\n
\n
\n
\n
\n

\n \n \n This {{ model.resource_type }} is hidden\n \n

\n

\n {{ model.name }}\n Analysis\n

\n
\n
\n
\n \n
\n
\n
\n
\n\n
\n
\n
\n
Description
\n
\n
\n
\n
This {{ model.resource_type }} is not currently documented
\n
\n
\n
\n
\n\n
\n
\n
\n
Depends On
\n \n
\n
\n\n
\n
\n
\n \n
\n
\n
\n
\n
\n')}]),e.exports=n},function(e,t){var n="/docs/macro.html";window.angular.module("ng").run(["$templateCache",function(e){e.put(n,'\n\n
\n
\n
\n
\n

\n {{ macro.package_name }}.{{ macro.name }}\n adapter macro\n macro\n

\n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
Description
\n
\n
\n
\n
This {{ macro.resource_type }} is not currently documented
\n
\n
\n
\n
\n\n
\n
\n
\n
Arguments
\n \n
\n
\n\n
\n
\n
\n
Referenced By
\n \n
\n
\n\n
\n
\n
\n
Depends On
\n \n
\n
\n\n
\n
\n
\n \n
\n
\n
\n
\n
\n')}]),e.exports=n},function(e,t){var n="/docs/exposure.html";window.angular.module("ng").run(["$templateCache",function(e){e.put(n,'\n\n
\n
\n
\n
\n\n

\n {{ exposure.label }}\n exposure\n\n
\n View this exposure\n
\n\n
\n

\n\n
\n
\n
\n \n
\n
\n
\n
\n\n
\n
\n \n
\n\n
\n
\n
\n
Description
\n
\n
\n
\n
This {{ exposure.resource_type }} is not currently documented
\n
\n
\n
\n
\n\n
\n
\n
\n
Depends On
\n \n
\n
\n\n
\n
\n
\n')}]),e.exports=n},function(e,t){var n="/docs/metric.html";window.angular.module("ng").run(["$templateCache",function(e){e.put(n,'\n\n
\n
\n
\n
\n\n

\n {{ metric.label }}\n metric\n\n
\n

\n\n
\n
\n
\n \n
\n
\n
\n
\n\n
\n
\n \n
\n\n
\n
\n
\n
Description
\n
\n
\n
\n
This {{ metric.resource_type }} is not currently documented
\n
\n
\n
\n
\n\n
\n
\n
\n
Depends On
\n \n
\n
\n\n\n
\n
\n
\n \n
\n
\n
\n
\n
\n')}]),e.exports=n},function(e,t){var n="/docs/operation.html";window.angular.module("ng").run(["$templateCache",function(e){e.put(n,'\n\n
\n
\n
\n
\n

\n {{ model.name }}\n operation\n

\n
\n
\n
\n \n
\n
\n
\n
\n
\n
\n
\n
Description
\n
\n
\n
\n
This {{ model.resource_type }} is not currently documented
\n
\n
\n
\n
\n\n
\n
\n
\n
Depends On
\n \n
\n
\n\n
\n
\n
\n \n
\n
\n
\n
\n
\n')}]),e.exports=n}]); //# sourceMappingURL=main.js.map - + \ No newline at end of file diff --git a/models/ad_reporting__keyword_report.sql b/models/ad_reporting__keyword_report.sql index ef0436a..f837d72 100644 --- a/models/ad_reporting__keyword_report.sql +++ b/models/ad_reporting__keyword_report.sql @@ -1,8 +1,6 @@ -{% if var('twitter_ads__using_keywords', True) %} - {% set include_list = ['amazon_ads', 'apple_search_ads', 'google_ads', 'microsoft_ads', 'pinterest_ads', 'twitter_ads'] %} -{% else %} - {% set include_list = ['amazon_ads', 'apple_search_ads', 'google_ads', 'microsoft_ads', 'pinterest_ads'] %} -{% endif %} +{% set include_list = ['amazon_ads', 'apple_search_ads', 'google_ads', 'microsoft_ads'] %} +{% do include_list.append('pinterest_ads') if var('pinterest__using_keywords', true) %} +{% do include_list.append('twitter_ads') if var('twitter_ads__using_keywords', true) %} {% set enabled_packages = get_enabled_packages(include=include_list)%} {{ config(enabled=is_enabled(enabled_packages)) }} diff --git a/models/intermediate/int_ad_reporting__keyword_report.sql b/models/intermediate/int_ad_reporting__keyword_report.sql index a399a3d..e9704e9 100644 --- a/models/intermediate/int_ad_reporting__keyword_report.sql +++ b/models/intermediate/int_ad_reporting__keyword_report.sql @@ -1,8 +1,6 @@ -{% if var('twitter_ads__using_keywords', True) %} - {% set include_list = ['amazon_ads', 'apple_search_ads', 'google_ads', 'microsoft_ads', 'pinterest_ads', 'twitter_ads'] %} -{% else %} - {% set include_list = ['amazon_ads', 'apple_search_ads', 'google_ads', 'microsoft_ads', 'pinterest_ads'] %} -{% endif %} +{% set include_list = ['amazon_ads', 'apple_search_ads', 'google_ads', 'microsoft_ads'] %} +{% do include_list.append('pinterest_ads') if var('pinterest__using_keywords', true) %} +{% do include_list.append('twitter_ads') if var('twitter_ads__using_keywords', true) %} {% set enabled_packages = get_enabled_packages(include=include_list)%} {{ config(enabled=is_enabled(enabled_packages)) }} @@ -54,7 +52,7 @@ microsoft_ads as ( ), {% endif %} -{% if 'pinterest_ads' in enabled_packages %} +{% if 'pinterest_ads' in enabled_packages and var('pinterest__using_keywords', True) %} pinterest_ads as ( {{ get_query( diff --git a/packages.yml b/packages.yml index 006c469..29297e6 100644 --- a/packages.yml +++ b/packages.yml @@ -11,8 +11,12 @@ packages: - package: fivetran/google_ads version: [">=0.9.0", "<0.10.0"] - - package: fivetran/pinterest - version: [">=0.7.0", "<0.8.0"] + # - package: fivetran/pinterest + # version: [">=0.7.0", "<0.8.0"] + + - git: https://github.com/fivetran/dbt_pinterest.git + revision: feature/keywords-variable-addition + warn-unpinned: false - package: fivetran/linkedin version: [">=0.7.0", "<0.8.0"]