release/v1.11.0 (#127)

* release/v0.11.0 * Update CHANGELOG.md * Feature/linkedin click uri updates (#120) * feature/linkedin-click-uri-updates * docs regen and integration schema change * changelog update * integration test merge conflict address * changelog fix * another changelog fix * schema change * Apply suggestions from code review * Update README.md (#124) * Update README.md :) * Apply suggestions from code review --------- Co-authored-by: Joe Markiewicz <74217849+fivetran-joemarkiewicz@users.noreply.github.com> * contributor changelog update * Update CHANGELOG.md * regen docs --------- Co-authored-by: Joe Markiewicz <74217849+fivetran-joemarkiewicz@users.noreply.github.com> Co-authored-by: conrad-mal <conraddick@gmail.com>
fivetran · Dec 18, 2024 · e3cc112 · e3cc112
1 parent ab30c27
commit e3cc112
Show file tree

Hide file tree

Showing 11 changed files with 425 additions and 379 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,36 @@
-# dbt_ad_reporting v1.10.0
+# dbt_ad_reporting v1.11.0
+
+## Breaking Changes
+
+### LinkedIn Ads
+- The `dbt_linkedin` dependency has been updated to `[">=0.10.0", "<0.11.0"]`, and the `dbt_linkedin_source` dependency has been updated to `[">=0.10.0", "<0.11.0"]`. These upstream versions introduce breaking changes. For details, refer to the [dbt_linkedin_source v0.10.0](https://github.com/fivetran/dbt_linkedin_source/releases/tag/v0.10.0) and [dbt_linkedin v0.10.0](https://github.com/fivetran/dbt_linkedin/releases/tag/v0.10.0) release notes. ([PR #120](https://github.com/fivetran/dbt_ad_reporting/pull/120))
+  - Added the `click_uri_type` field to the following models. This field allows users to differentiate which click uri type (`text_ad` or `spotlight`) was used to populate the `click_uri` field.
+    - `stg_linkedin_ads__creative_history`
+    - `linkedin_ads__creative_report`
+    - `linkedin_ads__url_report`
+    - Note: Only `text_ad` and `spotlight` click URI types are supported. To request support for additional types, submit a [Feature Request](https://github.com/fivetran/dbt_linkedin_source/issues/70).
+  - The `click_uri` field now populates values using a `COALESCE` of `text_ad_landing_page`, `spotlight_landing_page`, and `click_uri`. For details, refer to the [dbt_linkedin_source v0.10.0](https://github.com/fivetran/dbt_linkedin_source/releases/tag/v0.10.0) release notes. ([PR #120](https://github.com/fivetran/dbt_ad_reporting/pull/120))
+    - This change aligns with the [LinkedIn Ads API migration](https://learn.microsoft.com/en-us/linkedin/marketing/community-management/contentapi-migration-guide?view=li-lms-2024-05#adcreativesv2-api-creatives-api) and [Fivetran LinkedIn Ads connector update](https://fivetran.com/docs/connectors/applications/linkedin-ads/changelog#january2024), which moved `click_uri` data to `text_ad_landing_page` or `spotlight_landing_page` based on creative type.
+
+### TikTok Ads
+- The `dbt_tiktok_ads` dependency has been updated to `[">=0.7.0", "<0.8.0"]`, and the `dbt_tiktok_source` dependency has been updated to `[">=0.7.0", "<0.8.0"]`. These upstream versions introduce breaking changes. For details, refer to the [dbt_tiktok_ads_source v0.7.0](https://github.com/fivetran/dbt_tiktok_ads_source/releases/tag/v0.7.0) and [dbt_tiktok_ads v0.7.0](https://github.com/fivetran/dbt_tiktok_ads/releases/tag/v0.10.0) release notes. ([PR #127](https://github.com/fivetran/dbt_ad_reporting/pull/127))
+- The `age` column in the `ADGROUP_HISTORY` table was renamed to `age_groups` in the [July 2023 TikTok update](https://fivetran.com/docs/connectors/applications/tiktok-ads/changelog#july2023). ([PR #127](https://github.com/fivetran/dbt_ad_reporting/pull/127))
+  - Previously, the `stg_tiktok_ads__ad_group_history` model coalesced `age` and `age_groups` to handle legacy data. Due to incompatible data types (string and JSON), this coalesced field has been removed in favor of solely the `age_groups` column.
+  - To populate historical data in the `age_groups` column, perform a resync of the `ADGROUP_HISTORY` table. TikTok provides all data regardless of the previous sync state.
+  - For more details, see the [Tiktok Ads DECISIONLOG](https://github.com/fivetran/dbt_tiktok_ads_source/blob/main/DECISIONLOG.md).
+
+## Documentation Changes
+- Improved README structure by moving the Ad Reporting heading above the README tags and aligning it to the left. ([PR #124](https://github.com/fivetran/dbt_ad_reporting/pull/124))
+
+## Under the Hood
+- Added consistency validation tests for the following models to enhance integration testing (used internally by Fivetran maintainers) ([PR #127](https://github.com/fivetran/dbt_ad_reporting/pull/127)):
+  - `ad_reporting__ad_report`
+  - `ad_reporting__url_report`
+
+## Contributors
+- [@conrad-mal](https://github.com/conrad-mal) ([PR #124](https://github.com/fivetran/dbt_ad_reporting/pull/124))
 
+# dbt_ad_reporting v1.10.0
 [PR #122](https://github.com/fivetran/dbt_ad_reporting/pull/122) introduces the following **BREAKING CHANGES:**
 
 ## Feature Updates: Native Conversion Support

diff --git a/README.md b/README.md
@@ -1,4 +1,6 @@
-<p align="center">
+# Ad Reporting dbt Package ([Docs](https://fivetran.github.io/dbt_ad_reporting/))
+
+<p align="left">
     <a alt="License"
         href="https://github.com/fivetran/dbt_ad_reporting/blob/main/LICENSE">
         <img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" /></a>
@@ -10,7 +12,6 @@
         <img src="https://img.shields.io/badge/Contributions-welcome-blueviolet" /></a>
 </p>
 
-# Ad Reporting dbt Package ([Docs](https://fivetran.github.io/dbt_ad_reporting/))
 ## What does this dbt package do?
 - Standardizes schemas from various ad platform connectors and creates reporting models for clicks, spend and impressions aggregated to the account, campaign, ad group, ad, keyword and search levels.
 - Currently supports the following Fivetran ad platform connectors:
@@ -80,7 +81,7 @@ Include the following github package version in your `packages.yml`
 ```yaml
 packages:
   - package: fivetran/ad_reporting
-    version: [">=1.10.0", "<1.11.0"] # we recommend using ranges to capture non-breaking changes automatically
+    version: [">=1.11.0", "<1.12.0"] # we recommend using ranges to capture non-breaking changes automatically
 ```
 
 Do NOT include the individual ad platform packages in this file. The ad reporting package itself has dependencies on these packages and will install them as well.
@@ -563,23 +564,23 @@ packages:
   - package: fivetran/google_ads_source
     version: [">=0.11.0", "<0.12.0"]
 
-  - package: fivetran/pinterest
-    version: [">=0.11.0", "<0.12.0"]
+  - package: fivetran/linkedin
+    version: [">=0.10.0", "<0.11.0"]
 
-  - package: fivetran/pinterest_source
-    version: [">=0.11.0", "<0.12.0"]
+  - package: fivetran/linkedin_source
+    version: [">=0.10.0", "<0.11.0"]
 
   - package: fivetran/microsoft_ads
     version: [">=0.9.0", "<0.10.0"]
 
   - package: fivetran/microsoft_ads_source
     version: [">=0.10.0", "<0.11.0"]
 
-  - package: fivetran/linkedin
-    version: [">=0.9.0", "<0.10.0"]
+  - package: fivetran/pinterest
+    version: [">=0.11.0", "<0.12.0"]
 
-  - package: fivetran/linkedin_source
-    version: [">=0.9.0", "<0.10.0"]
+  - package: fivetran/pinterest_source
+    version: [">=0.11.0", "<0.12.0"]
 
   - package: fivetran/reddit_ads
     version: [">=0.3.0", "<0.4.0"]
@@ -594,10 +595,10 @@ packages:
     version: [">=0.7.0", "<0.8.0"]
 
   - package: fivetran/tiktok_ads
-    version: [">=0.6.0", "<0.7.0"]
+    version: [">=0.7.0", "<0.8.0"]
 
   - package: fivetran/tiktok_ads_source
-    version: [">=0.6.0", "<0.7.0"]
+    version: [">=0.7.0", "<0.8.0"]
 
   - package: fivetran/twitter_ads
     version: [">=0.8.0", "<0.9.0"]

diff --git a/dbt_project.yml b/dbt_project.yml
@@ -1,5 +1,5 @@
 name: 'ad_reporting'
-version: '1.10.0'
+version: '1.11.0'
 
 config-version: 2
 

diff --git a/docs/catalog.json b/docs/catalog.json
diff --git a/docs/manifest.json b/docs/manifest.json
diff --git a/integration_tests/ci/sample.profiles.yml b/integration_tests/ci/sample.profiles.yml
@@ -16,13 +16,13 @@ integration_tests:
       pass: "{{ env_var('CI_REDSHIFT_DBT_PASS') }}"
       dbname: "{{ env_var('CI_REDSHIFT_DBT_DBNAME') }}"
       port: 5439
-      schema: ad_reporting_integration_tests_7
+      schema: ad_reporting_integration_tests_8
       threads: 8
     bigquery:
       type: bigquery
       method: service-account-json
       project: 'dbt-package-testing'
-      schema: ad_reporting_integration_tests_7
+      schema: ad_reporting_integration_tests_8
       threads: 8
       keyfile_json: "{{ env_var('GCLOUD_SERVICE_KEY') | as_native }}"
     snowflake:
@@ -33,7 +33,7 @@ integration_tests:
       role: "{{ env_var('CI_SNOWFLAKE_DBT_ROLE') }}"
       database: "{{ env_var('CI_SNOWFLAKE_DBT_DATABASE') }}"
       warehouse: "{{ env_var('CI_SNOWFLAKE_DBT_WAREHOUSE') }}"
-      schema: ad_reporting_integration_tests_7
+      schema: ad_reporting_integration_tests_8
       threads: 8
     postgres:
       type: postgres
@@ -42,13 +42,13 @@ integration_tests:
       pass: "{{ env_var('CI_POSTGRES_DBT_PASS') }}"
       dbname: "{{ env_var('CI_POSTGRES_DBT_DBNAME') }}"
       port: 5432
-      schema: ad_reporting_integration_tests_7
+      schema: ad_reporting_integration_tests_8
       threads: 8
     databricks:
       catalog: "{{ env_var('CI_DATABRICKS_DBT_CATALOG') }}"
       host: "{{ env_var('CI_DATABRICKS_DBT_HOST') }}"
       http_path: "{{ env_var('CI_DATABRICKS_DBT_HTTP_PATH') }}"
-      schema: ad_reporting_integration_tests_7
+      schema: ad_reporting_integration_tests_8
       threads: 8
       token: "{{ env_var('CI_DATABRICKS_DBT_TOKEN') }}"
       type: databricks