search

fivetran / dbt_apple_search_ads_source

Fivetran's Apple Search Ads dbt package
https://fivetran.github.io/dbt_apple_search_ads_source/#!/overview
Apache License 2.0
3 stars 2 forks source link
apple apple-search-ads dbt dbt-packages fivetran

readme

Apple Search Ads Source dbt Package (Docs)

What does this dbt package do?

How do I use the dbt package?

Step 1: Prerequisites

To use this dbt package, you must have the following:

Databricks Dispatch Configuration

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']

Step 2: Install the package (skip if also using the apple_search_ads transformation package or ad_reporting combination package)

If you are not using the Apple Search Ads transformation package or the Ad Reporting combination package, include the following apple_search_ads_source 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/apple_search_ads_source
version: [">=0.4.0", "<0.5.0"] # we recommend using ranges to capture non-breaking changes automatically

Step 3: Define database and schema variables

By default, this package runs using your destination and the apple_search_ads schema. If this is not where your Apple Search Ads data is (for example, if your Apple Search Ads schema is named apple_search_ads_fivetran), add the following configuration to your root dbt_project.yml file:

vars:
    apple_search_ads_database: your_destination_name
    apple_search_ads_schema: your_schema_name

(Optional) Step 4: Additional configurations

Expand/Collapse details #### Union multiple connectors If you have multiple apple_search_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 `apple_search_ads_union_schemas` OR `apple_search_ads_union_databases` variables (cannot do both) in your root `dbt_project.yml` file: ```yml vars: apple_search_ads_union_schemas: ['apple_search_ads_usa','apple_search_ads_canada'] # use this if the data is in different schemas/datasets of the same database/project apple_search_ads_union_databases: ['apple_search_ads_usa','apple_search_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 defined `source.yml`. To connect your multiple schema/database sources to the package models, follow the steps outlined in the [Union Data Defined Sources Configuration](https://github.com/fivetran/dbt_fivetran_utils/tree/releases/v0.4.latest#union_data-source) 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. #### Passing Through Additional Metrics By default, this package will select `taps`, `impressions`, `spend` (aliased from source `local_spend_amount` field), `new_downloads`, `redownloads`, and `conversions` (installs resulting from a view or a tap) 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: > NOTE: There is no direct `conversion_value` field available in Apple Search Ads data. See the Apple Search Ads transform package [DECISIONLOG](https://github.com/fivetran/dbt_apple_search_ads/blob/main/DECISIONLOG.md#conversion-value) for more details on alternatives. ```yml vars: apple_search_ads__ad_group_passthrough_metrics: - name: "new_custom_field" alias: "custom_field" - name: "another_one" apple_search_ads__ad_passthrough_metrics: - name: "this_field" apple_search_ads__campaign_passthrough_metrics: - name: "unique_string_field" alias: "field_id" apple_search_ads__keyword_passthrough_metrics: - name: "that_field" apple_search_ads__search_term_passthrough_metrics: - name: "other_id" alias: "another_id" ``` > IMPORTANT: Make sure to exercise due diligence when adding metrics to these models. The metrics added by default 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. #### Disabling Additional Models It's possible that your Apple Search Ads connector does not sync every table that this package expects. If your syncs exclude certain tables, it is because you either don't use that functionality in Apple Search Ads or actively excluded some tables from your syncs. To disable the corresponding functionality in the package, you must add the relevant variables. By default, the package assumes that all variables are true. Add variables for only the tables you want to disable. The `apple_search_ads__using_search_terms` variable below refers to the `search_terms_report` table. You must enable the [search match](https://searchads.apple.com/help/campaigns/0006-understand-search-match) function within each ad group to populate this table with data. ```yml # dbt_project.yml vars: apple_search_ads__using_search_terms: False # by default this is true ``` #### Change the build schema By default, this package builds the Apple Search Ads staging models (10 views, 10 tables) within a schema titled (`` + `_apple_search_ads_source`) in your destination. If this is not where you would like your apple_search_ads staging data to be written to, add the following configuration to your root `dbt_project.yml` file: ```yml models: apple_search_ads_source: +schema: my_new_schema_name # leave blank for just the target_schema ``` #### Change the source table references 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. This is not available when running the package on multiple unioned connectors. > IMPORTANT: See this project's [`dbt_project.yml`](https://github.com/fivetran/dbt_apple_search_ads_source/blob/main/dbt_project.yml) variable declarations to see the expected names. ```yml vars: apple_search_ads__identifier: your_table_name ```

(Optional) Step 5: Orchestrate your models with Fivetran Transformations for dbt Core™

Expand for more details Fivetran offers the ability for you to orchestrate your dbt project through [Fivetran Transformations for dbt Core™](https://fivetran.com/docs/transformations/dbt). Learn how to set up your project for orchestration through Fivetran in our [Transformations for dbt Core™ setup guides](https://fivetran.com/docs/transformations/dbt#setupguide).

Does this package have dependencies?

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 root packages.yml to avoid package version conflicts.


packages:
- 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"]


## How is this package maintained and can I contribute?
### Package Maintenance
The Fivetran team maintaining this package _only_ maintains the latest version of the package. We highly recommend that you stay consistent with the [latest version](https://hub.getdbt.com/fivetran/apple_search_ads_source/latest/) of the package and refer to the [CHANGELOG](https://github.com/fivetran/dbt_apple_search_ads_source/blob/main/CHANGELOG.md) and release notes for more information on changes across versions.

### Contributions
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](https://discourse.getdbt.com/t/contributing-to-a-dbt-package/657) on the best workflow for contributing to a package.

#### Contributors
We thank [everyone](https://github.com/fivetran/dbt_apple_search_ads_source/graphs/contributors) who has taken the time to contribute. Each PR, bug report, and feature request has made this package better and is truly appreciated.

A special thank you to [Seer Interactive](https://www.seerinteractive.com/?utm_campaign=Fivetran%20%7C%20Models&utm_source=Fivetran&utm_medium=Fivetran%20Documentation), who we closely collaborated with to introduce native conversion support to our Ad packages.

## Are there any resources available?
- If you have questions or want to reach out for help, see the [GitHub Issue](https://github.com/fivetran/dbt_apple_search_ads_source/issues/new/choose) section to find the right avenue of support for you.
- If you would like to provide feedback to the dbt package team at Fivetran or would like to request a new dbt package, fill out our [Feedback Form](https://www.surveymonkey.com/r/DQ7K7WW).