-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Documentation Standard Updates (#16)
* MagicBot/documentation-updates * Update README.md * Update README.md --------- Co-authored-by: Jamie Rodriguez <[email protected]>
- Loading branch information
1 parent
216449e
commit bdb4623
Showing
8 changed files
with
87 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -11,39 +11,43 @@ | |
| </p> | ||
|
|
||
| # Youtube Analytics Transformation dbt Package ([Docs](https://fivetran.github.io/dbt_youtube_analytics/)) | ||
| # 📣 What does this dbt package do? | ||
| ## What does this dbt package do? | ||
| - Produces modeled tables that leverage data in the format described by the [YouTube Channel Report schemas](https://fivetran.com/docs/applications/youtube-analytics#schemainformation) and builds off the output of our [Youtube Analytics source package](https://github.com/fivetran/dbt_youtube_analytics_source). | ||
| - Transform the core object tables into analytics-ready models. | ||
| - Includes options to explore video demographics and a comprehensive overview of video performance that you could combine with other organic ad platform reports. | ||
| - Transform the core object tables into analytics-ready models. | ||
| - Includes options to explore video demographics and a comprehensive overview of video performance that you could combine with other organic ad platform reports. | ||
| - Generates a comprehensive data dictionary of your source and modeled Youtube Analytics data through the [dbt docs site](https://fivetran.github.io/dbt_youtube_analytics/). | ||
|
|
||
| The following table provides a detailed list of all models materialized within this package by default. | ||
| > TIP: See more details about these models in the package's [dbt docs site](https://fivetran.github.io/dbt_youtube_analytics/#!/overview?g_v=1&g_e=seeds). | ||
| <!--section=“youtube_transformation_model"--> | ||
|
|
||
| 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](https://fivetran.github.io/dbt_youtube_analytics/#!/overview?g_v=1&g_e=seeds). | ||
| | **Model** | **Description** | | ||
|
|
||
| | **Table** | **Description** | | ||
| | ------------------------- | ------------------------------------------------------------------------------------------------------------------ | | ||
| | [youtube__video_report](https://fivetran.github.io/dbt_youtube_analytics/#!/model/model.youtube_analytics.youtube__video_report) | Each record represents the daily aggregation of your YouTube video performance. | | ||
| | [youtube__demographics_report](https://fivetran.github.io/dbt_youtube_analytics/#!/model/model.youtube_analytics.youtube__demographics_report) | Each record represents a daily video view percentage by gender, age, and country. | | ||
| | [youtube__age_demographics_pivot](https://fivetran.github.io/dbt_youtube_analytics/#!/model/model.youtube_analytics.youtube__age_demographics_pivot) | Each record represents a daily video view percentage with the age ranges pivoted out for quicker analysis. | | ||
| | [youtube__gender_demographics_pivot](https://fivetran.github.io/dbt_youtube_analytics/#!/model/model.youtube_analytics.youtube__gender_demographics_pivot) | Each record represents a daily video view percentage with the gender options pivoted out for quicker analysis. | | ||
| | [youtube__video_metadata](https://fivetran.github.io/dbt_youtube_analytics/#!/model/model.youtube_analytics.youtube__video_metadata) | Each record represents an individual video enriched with metadata. | | ||
|
|
||
| # 🎯 How do I use the dbt package? | ||
| ## Step 1: Prerequisites | ||
| <!--section-end--> | ||
|
|
||
| ## How do I use the dbt package? | ||
| ### Step 1: Prerequisites | ||
| To use this dbt package, you must have the following: | ||
| - At least one Fivetran Youtube Analytics connector syncing data into your destination. | ||
| - At least one Fivetran Youtube Analytics connector syncing data into your destination. | ||
| - A **BigQuery**, **Snowflake**, **Redshift**, **PostgreSQL**, or **Databricks** destination. | ||
|
|
||
| ### Databricks Dispatch Configuration | ||
| #### 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. | ||
| ```yml | ||
| dispatch: | ||
| - macro_namespace: dbt_utils | ||
| search_order: ['spark_utils', 'dbt_utils'] | ||
| ``` | ||
| ## Step 2: Install the package | ||
| ### Step 2: Install the package | ||
| Include the following Youtube Analytics package version in your `packages.yml` file: | ||
| > TIP: Check [dbt Hub](https://hub.getdbt.com/) for the latest installation instructions or [read the dbt docs](https://docs.getdbt.com/docs/package-management) for more information on installing packages | ||
|
|
||
|
|
@@ -55,7 +59,7 @@ packages: | |
| ``` | ||
| Do NOT include the `youtube_analytics_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 | ||
| ### Step 3: Define database and schema variables | ||
| By default, this package runs using your destination and the `youtube_analytics` schema. If this is not where your Youtube Analytics data is (for example, if your youtube schema is named `youtube_analytics_fivetran`), add the following configuration to your root `dbt_project.yml` file: | ||
|
|
||
| ```yml | ||
|
|
@@ -65,7 +69,7 @@ vars: | |
| youtube_analytics_database: your_database_name | ||
| ``` | ||
|
|
||
| ## Step 4: Disabling Demographics Report | ||
| ### Step 4: Disabling Demographics Report | ||
| This packages assumes you are syncing the YouTube `channel_demographics_a1` report. If you are _not_ syncing this report, you may add the below configuration to your `dbt_project.yml` to disable the `stg_youtube__demographics` model and all downstream references. | ||
| ```yml | ||
| # dbt_project.yml | ||
|
|
@@ -74,9 +78,9 @@ vars: | |
| youtube__using_channel_demographics: false # true by default | ||
| ``` | ||
|
|
||
| ## (Optional) Step 5: Additional configurations | ||
| ### (Optional) Step 5: Additional configurations | ||
|
|
||
| ### Change the build schema | ||
| #### Change the build schema | ||
| By default, this package will build the YouTube Analytics staging models within a schema titled (`<target_schema>` + `_youtube_source`) and the YouTube Analytics final models within a schema titled (`<target_schema>` + `_youtube`) in your target database. If this is not where you would like your modeled YouTube Analytics data to be written to, add the following configuration to your `dbt_project.yml` file: | ||
|
|
||
| ```yml | ||
|
|
@@ -88,7 +92,7 @@ models: | |
| +schema: my_new_schema_name # leave blank for just the target_schema | ||
| ``` | ||
|
|
||
| ### Change the source table references | ||
| #### 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: | ||
| > IMPORTANT: See this project's [`dbt_project.yml`](https://github.com/fivetran/dbt_youtube_analytics_source/blob/main/dbt_project.yml) variable declarations to see the expected names. | ||
|
|
||
|
|
@@ -98,15 +102,16 @@ vars: | |
| youtube_analytics_<default_source_table_name>_identifier: your_table_name | ||
| ``` | ||
|
|
||
| ## (Optional) Step 6: Orchestrate your models with Fivetran Transformations for dbt Core™ | ||
| ### (Optional) Step 6: Orchestrate your models with Fivetran Transformations for dbt Core™ | ||
| <details><summary>Expand for details</summary> | ||
| <br> | ||
|
|
||
| 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). | ||
|
|
||
| </details> | ||
|
|
||
| # 🔍 Does this package have dependencies? | ||
| This dbt package is dependent on the following dbt packages. Please be aware that these dependencies are installed by default within this package. For more information on the following packages, refer to the [dbt hub](https://hub.getdbt.com/) site. | ||
| ## 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](https://hub.getdbt.com/) 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. | ||
|
|
||
| ```yml | ||
|
|
@@ -121,14 +126,13 @@ packages: | |
| version: [">=0.3.0", "<0.4.0"] | ||
| ``` | ||
|
|
||
| # 🙌 How is this package maintained and can I contribute? | ||
| ## Package Maintenance | ||
| ## 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/youtube_analytics/latest/) of the package and refer to the [CHANGELOG](https://github.com/fivetran/dbt_youtube_analytics/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! | ||
| ### Contributions | ||
| A small team of analytics engineers at Fivetran develops these dbt packages. However, the packages are made better by community contributions. | ||
|
|
||
| # 🏪 Are there any resources available? | ||
| - If you have questions or want to reach out for help, please refer to the [GitHub Issue](https://github.com/fivetran/dbt_youtube_analytics/issues/new/choose) section to find the right avenue of support for you. | ||
| ## 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_youtube_analytics/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). | ||
| - Have questions or want to just say hi? Book a time during our office hours [on Calendly](https://calendly.com/fivetran-solutions-team/fivetran-solutions-team-office-hours) or email us at [email protected]. | ||