This package models TikTok Ads data from Fivetran’s connector. It uses data in the format described by this ERD.
The main focus of the package is to transform the core ad object tables into analytics-ready models, including an ‘ad adapter’ model that can be easily unioned in to other ad platform packages to get a single view. This is especially easy using our Ad Reporting package.
Modelslink
This package contains transformation models, designed to work simultaneously with our Tiktok Ads source package and our multi-platform Ad Reporting package. A dependency on the source package is declared in this package’s packages.yml
file, so it will automatically download when you run dbt deps
. The primary outputs of this package are described below.
model | description |
---|---|
tiktok_ads__ad_adapter | Each record represents the daily ad performance, including information about the UTM parameters. |
tiktok_ads__ad_group_report | Each record represents the daily ad performance for each ad group. This also includes additional data on the demographics you want to target. |
tiktok_ads__campaign_report | Each record represents the daily ad performance for each campaign. |
Installation Instructionslink
Check dbt Hub for the latest installation instructions, or read the dbt docs for more information on installing packages.
Include in your packages.yml
packages:
- package: fivetran/tiktok_ads
version: [">=0.1.0", "<0.2.0"]
Configurationlink
By default, this package will look for your TikTok Ads data in the tiktok_ads
schema of your target database. If this is not where your TikTok Ads data is, please add the following configuration to your
dbt_project.yml
file:
...
config-version: 2
vars:
tiktok_ads_schema: your_database_name
tiktok_ads_database: your_schema_name
For additional configurations for the source models, visit the Tiktok Ads source package.
Changing the Build Schemalink
By default, this package will build the TikTok Ads staging models within a schema titled (<target_schema>
+ _stg_tiktok_ads
) and the final TikTok Ads models within a schema titled (<target_schema>
+ _tiktok_ads
) in your target database. If this is not where you would like your modeled TikTok data to be written to, add the following configuration to your dbt_project.yml
file:
...
models:
tiktok_ads:
+schema: my_new_schema_name # leave blank for just the target_schema
tiktok_ads_source:
+schema: my_new_schema_name # leave blank for just the target_schema
Contributionslink
Don’t see a model or specific metric you would have liked to be included? Notice any bugs when installing and running the package? If so, we highly encourage and welcome contributions to this package!
Please create issues or open PRs against master
. See this Discourse post for information on how to contribute to a package.
Database Supportlink
This package has been tested on BigQuery, Snowflake, Redshift, Postgres, and Databricks.
Databricks Dispatch Configurationlink
dbt v0.20.0
introduced a new project-level dispatch configuration that enables an “override” setting for all dispatched macros. If you are using a Databricks destination with this package, you will need to add the following (or a variation of the following) dispatch configuration within your dbt_project.yml
. This is required in order for the package to accurately search for macros within the dbt-labs/spark_utils
and then the dbt-labs/dbt_utils
packages, respectively.
dispatch:
- macro_namespace: dbt_utils
search_order: ['spark_utils', 'dbt_utils']
Resources:link
- Provide feedback on our existing dbt packages or what you’d like to see next
- Have questions, feedback, or need help? Book a time during our office hours using Calendly or email us at solutions@fivetran.com
- Find all of Fivetran’s pre-built dbt packages in our dbt hub
- Learn how to orchestrate your models with Fivetran Transformations for dbt Core™
- Learn more about Fivetran overall in our docs
- Check out Fivetran’s blog
- Learn more about dbt in the dbt docs
- Check out Discourse for commonly asked questions and answers
- Join the chat on Slack for live discussions and support
- Find dbt events near you
- Check out the dbt blog for the latest news on dbt’s development and best practices