The following table provides a detailed list of all tables materialized within this package by default.
TIP: See more details about these tables in the package's dbt docs site.
Table | Description |
---|---|
tiktok_ads__ad_group_report | Each record represents the daily performance for each ad group. This also includes additional data on the demographics you are targeting. |
tiktok_ads__campaign_report | Each record represents the daily performance for each campaign. |
tiktok_ads__advertiser_report | Each record represents the daily performance for each account. |
tiktok_ads__ad_report | Each record represents the daily performance for each ad. This also includes additional data on the demographics you are targeting. |
tiktok_ads__url_report | Each record in this table represents the daily performance of URLs at the ad level. This also includes additional data on the demographics you are targeting. |
To use this dbt package, you must have the following:
If you are using a Databricks destination with this package you will need to add the below (or a variation of the below) 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
then the dbt-labs/dbt_utils
packages respectively.
dispatch:
- macro_namespace: dbt_utils
search_order: ['spark_utils', 'dbt_utils']
Include the following tiktok_ads package version in your packages.yml
file:
TIP: Check dbt Hub for the latest installation instructions or read the dbt docs for more information on installing packages.
packages: - package: fivetran/tiktok_ads version: [">=0.5.0", "<0.6.0"]
Do **NOT** include the `tiktok_ads_source` package in this file. The transformation package itself has a dependency on it and will install the source package as well.
### Step 3: Define database and schema variables
By default, this package will look for your TikTok Ads data in the `tiktok_ads` schema of your [target database](https://docs.getdbt.com/docs/running-a-dbt-project/using-the-command-line-interface/configure-your-profile). If this is not where your TikTok Ads data is, you would add the following configuration to your root `dbt_project.yml` file with your custom database and schema names:
```yml
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.
If you have multiple tiktok_ads connectors in Fivetran and would like to use this package on all of them simultaneously, we have provided functionality to do so. The package will union all of the data together and pass the unioned table into the transformations. You will be able to see which source it came from in the source_relation
column of each model. To use this functionality, you will need to set either the tiktok_ads_union_schemas
OR tiktok_ads_union_databases
variables (cannot do both) in your root dbt_project.yml
file:
vars:
tiktok_ads_union_schemas: ['tiktok_ads_usa','tiktok_ads_canada'] # use this if the data is in different schemas/datasets of the same database/project
tiktok_ads_union_databases: ['tiktok_ads_usa','tiktok_ads_canada'] # use this if the data is in different databases/projects but uses the same schema name
NOTE: The native
source.yml
connection set up in the package will not function when the union schema/database feature is utilized. Although the data will be correctly combined, you will not observe the sources linked to the package models in the Directed Acyclic Graph (DAG). This happens because the package includes only one definedsource.yml
.
To connect your multiple schema/database sources to the package models, follow the steps outlined in the Union Data Defined Sources Configuration section of the Fivetran Utils documentation for the union_data macro. This will ensure a proper configuration and correct visualization of connections in the DAG.
By default, this package will select clicks
, impressions
, and cost
from the source reporting tables to store into the staging models. If you would like to pass through additional metrics to the staging models, add the below configurations to your dbt_project.yml
file. These variables allow for the pass-through fields to be aliased (alias
) if desired, but not required. Use the below format for declaring the respective pass-through variables:
IMPORTANT: Make sure to exercise due diligence when adding metrics to these models. The metrics added by default (taps, impressions, and spend) have been vetted by the Fivetran team, maintaining this package for accuracy. There are metrics included within the source reports, such as metric averages, which may be inaccurately represented at the grain for reports created in this package. You must ensure that whichever metrics you pass through are appropriate to aggregate at the respective reporting levels in this package.
vars:
tiktok_ads__ad_group_hourly_passthrough_metrics:
- name: "new_custom_field"
alias: "custom_field"
- name: "my_other_field"
tiktok_ads__ad_hourly_passthrough_metrics:
- name: "this_field"
tiktok_ads__campaign_hourly_passthrough_metrics:
- name: "unique_string_field"
alias: "field_id"
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:
# dbt_project.yml
...
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
If an individual source table has a different name than the package expects, add the table name as it appears in your destination to the respective variable:
IMPORTANT: See this project's
dbt_project.yml
variable declarations to see the expected names.
vars:
tiktok_ads_<default_source_table_name>_identifier: your_table_name
This dbt package is dependent on the following dbt packages. These dependencies are installed by default within this package. For more information on the following packages, refer to the dbt hub site.
IMPORTANT: If you have any of these dependent packages in your own
packages.yml
file, we highly recommend that you remove them from your rootpackages.yml
to avoid package version conflicts.
packages:
- package: fivetran/tiktok_ads_source
version: [">=0.5.0", "<0.6.0"]
- package: fivetran/fivetran_utils
version: [">=0.4.0", "<0.5.0"]
- package: dbt-labs/dbt_utils
version: [">=1.0.0", "<2.0.0"]
- package: dbt-labs/spark_utils
version: [">=0.3.0", "<0.4.0"]
The Fivetran team maintaining this package only maintains the latest version of the package. We highly recommend you stay consistent with the latest version of the package and refer to the CHANGELOG and release notes for more information on changes across versions.
A small team of analytics engineers at Fivetran develops these dbt packages. However, the packages are made better by community contributions.
We highly encourage and welcome contributions to this package. Check out this dbt Discourse article on the best workflow for contributing to a package.