deprecation/impressions-and-other-fields (#22)

fivetran-joemarkiewicz · github-actions[bot] · web-flow · commit 38cc671be246 · 2025-11-20T10:45:55.000-06:00
* deprecation/impressions-and-other-fields

* changelog update

* Generate dbt docs via GitHub Actions

* readme update

* docs fix

* seed data update

* datatype fix for integration tests

* Generate dbt docs via GitHub Actions

---------

Co-authored-by: github-actions[bot] &lt;github-actions[bot]@users.noreply.github.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,24 @@
+# dbt_facebook_pages v1.1.0
+
+[PR #22](https://github.com/fivetran/dbt_facebook_pages/pull/22) includes the following updates:
+
+## Schema/Data Change
+**2 total changes • 0 possible breaking changes**
+
+| Data Model(s) | Change type | Old | New | Notes |
+| ---------- | ----------- | -------- | -------- | ----- |
+| `facebook_pages__pages_report`, `stg_facebook_pages__daily_page_metrics_total` | New Field | N/A | `media_views` | Added new field to track media/content views on the page |
+| `facebook_pages__pages_report`, `facebook_pages__posts_report`, `stg_facebook_pages__daily_page_metrics_total`, `stg_facebook_pages__lifetime_post_metrics_total` | Deprecated Fields | Multiple impression and fan-related fields | Marked as [DEPRECATED] | Fields deprecated as of November 2025 and will not be populated by the Fivetran Facebook Pages connector after this date. Fields will be removed in a future release. Deprecated fields include: `fan_adds`, `fan_removes`, `fans`, `fans_online_per_day`, `impressions`, `impressions_nonviral`, `impressions_organic`, `impressions_paid`, `impressions_viral`, `impressions_fan`, `negative_feedback`, and `places_checkin_total` |
+
+## Documentation
+- Added deprecation notices to all affected fields in yml documentation files, clearly indicating these fields will not be populated by the Fivetran Facebook Pages connector following November 2025 and will be removed in a future release.
+- Updated inline comments in staging models to indicate deprecated fields.
+
+## Under the Hood
+- Updated integration test schema names to standardize naming convention.
+- Added `integration_tests/tests/` directory for validation tests.
+- Updated integration test configuration to include models schema setting.
+
 # dbt_facebook_pages v1.0.0
 [PR #18](https://github.com/fivetran/dbt_facebook_pages/pull/18) includes the following updates:
 
diff --git a/README.md b/README.md
@@ -57,7 +57,7 @@ Include the following Facebook Pages package version in your `packages.yml`
 ```yaml
 packages:
   - package: fivetran/facebook_pages
-    version: [">=1.0.0", "<1.1.0"] # we recommend using ranges to capture non-breaking changes automatically
+    version: [">=1.1.0", "<1.2.0"] # we recommend using ranges to capture non-breaking changes automatically
 ```
 
 > All required sources and staging models are now bundled into this transformation package. Do not include `fivetran/facebook_pages_source` in your `packages.yml` since this package has been deprecated.
diff --git a/dbt_project.yml b/dbt_project.yml
@@ -1,5 +1,5 @@
 name: 'facebook_pages'
-version: '1.0.0'
+version: '1.1.0'
 config-version: 2
 require-dbt-version: [">=1.3.0", "<2.0.0"]
 vars:
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
@@ -12,13 +12,13 @@ integration_tests:
       pass: "{{ env_var('CI_REDSHIFT_DBT_PASS') }}"
       dbname: "{{ env_var('CI_REDSHIFT_DBT_DBNAME') }}"
       port: 5439
-      schema: facebook_pages_integrations_tests_1
+      schema: facebook_pages_integrations_tests
       threads: 8
     bigquery:
       type: bigquery
       method: service-account-json
       project: 'dbt-package-testing'
-      schema: facebook_pages_integrations_tests_1
+      schema: facebook_pages_integrations_tests
       threads: 8
       keyfile_json: "{{ env_var('GCLOUD_SERVICE_KEY') | as_native }}"
     snowflake:
@@ -29,7 +29,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: facebook_pages_integrations_tests_1
+      schema: facebook_pages_integrations_tests
       threads: 8
     postgres:
       type: postgres
@@ -38,13 +38,13 @@ integration_tests:
       pass: "{{ env_var('CI_POSTGRES_DBT_PASS') }}"
       dbname: "{{ env_var('CI_POSTGRES_DBT_DBNAME') }}"
       port: 5432
-      schema: facebook_pages_integrations_tests_1
+      schema: facebook_pages_integrations_tests
       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: facebook_pages_integrations_tests_1
+      schema: facebook_pages_integrations_tests
       threads: 8
       token: "{{ env_var('CI_DATABRICKS_DBT_TOKEN') }}"
       type: databricks
diff --git a/integration_tests/dbt_project.yml b/integration_tests/dbt_project.yml
@@ -1,5 +1,5 @@
 name: 'facebook_pages_integration_tests'
-version: '1.0.0'
+version: '1.1.0'
 profile: 'integration_tests'
 config-version: 2
 
@@ -9,7 +9,11 @@ vars:
     facebook_pages_lifetime_post_metrics_total_identifier: "facebook_pages_lifetime_post_metrics_total_data"
     facebook_pages_page_identifier: "facebook_pages_page_data"
     facebook_pages_post_history_identifier: "facebook_pages_post_history_data"
-    facebook_pages_schema: facebook_pages_integrations_tests_1
+    facebook_pages_schema: facebook_pages_integrations_tests
+
+models:
+  facebook_pages:
+    +schema: "facebook_pages_{{ var('directed_schema','dev') }}"
 
 dispatch:
   - macro_namespace: dbt_utils
@@ -33,6 +37,7 @@ seeds:
     facebook_pages_daily_page_metrics_total_data:
       +column_types:
         page_id: "{{ 'int64' if target.type == 'bigquery' else 'bigint' }}"
+        page_media_views: float
 flags:
   send_anonymous_usage_stats: False
   use_colors: True
diff --git a/integration_tests/packages.yml b/integration_tests/packages.yml
@@ -1,2 +1,2 @@
 packages:
-  - local: ../
+  - local: ../
diff --git a/integration_tests/seeds/facebook_pages_daily_page_metrics_total_data.csv b/integration_tests/seeds/facebook_pages_daily_page_metrics_total_data.csv
@@ -1,7 +1,7 @@
-date,page_id,_fivetran_synced,page_actions_post_reactions_anger_total,page_actions_post_reactions_haha_total,page_actions_post_reactions_like_total,page_actions_post_reactions_love_total,page_actions_post_reactions_sorry_total,page_actions_post_reactions_total,page_actions_post_reactions_wow_total,page_fan_adds,page_fan_removes,page_fans,page_impressions,page_impressions_nonviral,page_impressions_organic,page_impressions_paid,page_impressions_viral,page_negative_feedback,page_places_checkin_total,page_post_engagements,page_posts_impressions,page_posts_impressions_nonviral,page_posts_impressions_organic,page_posts_impressions_paid,page_posts_impressions_viral,page_total_actions,page_video_complete_views_30_s,page_video_complete_views_30_s_autoplayed,page_video_complete_views_30_s_click_to_play,page_video_complete_views_30_s_organic,page_video_complete_views_30_s_paid,page_video_complete_views_30_s_repeat_views,page_video_repeat_views,page_video_view_time,page_video_views,page_video_views_10_s,page_video_views_10_s_autoplayed,page_video_views_10_s_click_to_play,page_video_views_10_s_organic,page_video_views_10_s_paid,page_video_views_10_s_repeat,page_video_views_autoplayed,page_video_views_click_to_play,page_video_views_organic,page_video_views_paid,page_views_total,page_fans_online_per_day
-2020-04-10 07:00:00 UTC,514435155248879,2021-09-09 15:05:33.416 UTC,0,0,0,68,0,,0,0,1,256,6696,250,340,6305,90,0,0,123,6641,250,336,6305,86,0,6,6,0,1,5,0,7,1362884,78,22,22,0,2,20,0,78,0,3,75,81,220
-2020-04-05 07:00:00 UTC,514435155248879,2021-09-09 15:05:33.416 UTC,0,0,4,0,0,,0,1,0,256,7691,67,69,7617,2,0,0,28,7686,67,69,7617,2,0,9,9,0,1,8,0,26,2711260,188,47,45,2,1,46,3,186,2,2,186,12,223
-2020-04-06 07:00:00 UTC,514435155248879,2021-09-09 15:05:33.416 UTC,0,0,6,0,0,,0,1,0,257,8342,10,11,8327,1,0,0,43,8338,10,11,8327,1,0,7,7,0,0,7,0,16,1624807,119,22,22,0,0,22,0,119,0,0,119,22,227
-2020-04-07 07:00:00 UTC,514435155248879,2021-09-09 15:05:33.416 UTC,0,0,4,0,0,,0,0,0,257,9590,36,40,9544,4,0,0,36,9584,36,40,9544,4,0,15,15,0,2,13,1,24,2027200,133,33,33,0,2,31,2,133,0,2,131,49,222
-2020-04-11 07:00:00 UTC,514435155248879,2021-09-09 15:05:33.416 UTC,0,0,0,20,0,,0,1,0,257,4245,217,241,3988,24,0,0,58,4227,217,239,3988,22,0,12,12,0,1,11,1,9,1403092,84,23,23,0,2,21,2,84,0,4,80,50,224
-2020-04-09 07:00:00 UTC,514435155248879,2021-09-09 15:05:33.416 UTC,0,0,0,3,0,,0,0,0,257,6940,41,44,6847,3,0,0,39,6891,41,44,6847,3,0,11,9,2,0,11,0,24,2327161,156,31,29,2,0,31,4,154,2,2,154,80,219
+date,page_id,_fivetran_synced,page_actions_post_reactions_anger_total,page_actions_post_reactions_haha_total,page_actions_post_reactions_like_total,page_actions_post_reactions_love_total,page_actions_post_reactions_sorry_total,page_actions_post_reactions_total,page_actions_post_reactions_wow_total,page_fan_adds,page_fan_removes,page_fans,page_impressions,page_impressions_nonviral,page_impressions_organic,page_impressions_paid,page_impressions_viral,page_negative_feedback,page_places_checkin_total,page_post_engagements,page_posts_impressions,page_posts_impressions_nonviral,page_posts_impressions_organic,page_posts_impressions_paid,page_posts_impressions_viral,page_total_actions,page_video_complete_views_30_s,page_video_complete_views_30_s_autoplayed,page_video_complete_views_30_s_click_to_play,page_video_complete_views_30_s_organic,page_video_complete_views_30_s_paid,page_video_complete_views_30_s_repeat_views,page_video_repeat_views,page_video_view_time,page_video_views,page_video_views_10_s,page_video_views_10_s_autoplayed,page_video_views_10_s_click_to_play,page_video_views_10_s_organic,page_video_views_10_s_paid,page_video_views_10_s_repeat,page_video_views_autoplayed,page_video_views_click_to_play,page_video_views_organic,page_video_views_paid,page_views_total,page_fans_online_per_day,page_media_views
+2020-04-10 07:00:00 UTC,514435155248879,2021-09-09 15:05:33.416 UTC,0,0,0,68,0,,0,0,1,256,6696,250,340,6305,90,0,0,123,6641,250,336,6305,86,0,6,6,0,1,5,0,7,1362884,78,22,22,0,2,20,0,78,0,3,75,81,220,1.0
+2020-04-05 07:00:00 UTC,514435155248879,2021-09-09 15:05:33.416 UTC,0,0,4,0,0,,0,1,0,256,7691,67,69,7617,2,0,0,28,7686,67,69,7617,2,0,9,9,0,1,8,0,26,2711260,188,47,45,2,1,46,3,186,2,2,186,12,223,2.0
+2020-04-06 07:00:00 UTC,514435155248879,2021-09-09 15:05:33.416 UTC,0,0,6,0,0,,0,1,0,257,8342,10,11,8327,1,0,0,43,8338,10,11,8327,1,0,7,7,0,0,7,0,16,1624807,119,22,22,0,0,22,0,119,0,0,119,22,227,3.0
+2020-04-07 07:00:00 UTC,514435155248879,2021-09-09 15:05:33.416 UTC,0,0,4,0,0,,0,0,0,257,9590,36,40,9544,4,0,0,36,9584,36,40,9544,4,0,15,15,0,2,13,1,24,2027200,133,33,33,0,2,31,2,133,0,2,131,49,222,4.0
+2020-04-11 07:00:00 UTC,514435155248879,2021-09-09 15:05:33.416 UTC,0,0,0,20,0,,0,1,0,257,4245,217,241,3988,24,0,0,58,4227,217,239,3988,22,0,12,12,0,1,11,1,9,1403092,84,23,23,0,2,21,2,84,0,4,80,50,224,5.0
+2020-04-09 07:00:00 UTC,514435155248879,2021-09-09 15:05:33.416 UTC,0,0,0,3,0,,0,0,0,257,6940,41,44,6847,3,0,0,39,6891,41,44,6847,3,0,11,9,2,0,11,0,24,2327161,156,31,29,2,0,31,4,154,2,2,154,80,219,6.0
diff --git a/integration_tests/tests/consistency/consistency_pages_report.sql b/integration_tests/tests/consistency/consistency_pages_report.sql
@@ -0,0 +1,47 @@
+
+{{ config(
+    tags="fivetran_validations",
+    enabled=var('fivetran_validation_tests_enabled', false)
+) }}
+
+{% set exclude_columns = var('consistency_test_exclude_metrics', []) %}
+with prod as (
+    select {{ dbt_utils.star(from=ref('facebook_pages__pages_report'), except=exclude_columns) }}
+    from {{ target.schema }}_facebook_pages_prod.facebook_pages__pages_report
+),
+
+dev as (
+    select {{ dbt_utils.star(from=ref('facebook_pages__pages_report'), except=exclude_columns) }}
+    from {{ target.schema }}_facebook_pages_dev.facebook_pages__pages_report
+),
+
+prod_not_in_dev as (
+    -- rows from prod not found in dev
+    select * from prod
+    except distinct
+    select * from dev
+),
+
+dev_not_in_prod as (
+    -- rows from dev not found in prod
+    select * from dev
+    except distinct
+    select * from prod
+),
+
+final as (
+    select
+        *,
+        'from prod' as source
+    from prod_not_in_dev
+
+    union all -- union since we only care if rows are produced
+
+    select
+        *,
+        'from dev' as source
+    from dev_not_in_prod
+)
+
+select *
+from final
diff --git a/integration_tests/tests/consistency/consistency_posts_report.sql b/integration_tests/tests/consistency/consistency_posts_report.sql
@@ -0,0 +1,47 @@
+
+{{ config(
+    tags="fivetran_validations",
+    enabled=var('fivetran_validation_tests_enabled', false)
+) }}
+
+{% set exclude_columns = var('consistency_test_exclude_metrics', []) %}
+with prod as (
+    select {{ dbt_utils.star(from=ref('facebook_pages__posts_report'), except=exclude_columns) }}
+    from {{ target.schema }}_facebook_pages_prod.facebook_pages__posts_report
+),
+
+dev as (
+    select {{ dbt_utils.star(from=ref('facebook_pages__posts_report'), except=exclude_columns) }}
+    from {{ target.schema }}_facebook_pages_dev.facebook_pages__posts_report
+),
+
+prod_not_in_dev as (
+    -- rows from prod not found in dev
+    select * from prod
+    except distinct
+    select * from dev
+),
+
+dev_not_in_prod as (
+    -- rows from dev not found in prod
+    select * from dev
+    except distinct
+    select * from prod
+),
+
+final as (
+    select
+        *,
+        'from prod' as source
+    from prod_not_in_dev
+
+    union all -- union since we only care if rows are produced
+
+    select
+        *,
+        'from dev' as source
+    from dev_not_in_prod
+)
+
+select *
+from final
diff --git a/macros/staging/get_daily_page_metrics_total_columns.sql b/macros/staging/get_daily_page_metrics_total_columns.sql
@@ -48,7 +48,8 @@
     {"name": "page_video_views_click_to_play", "datatype": dbt.type_int()},
     {"name": "page_video_views_organic", "datatype": dbt.type_int()},
     {"name": "page_video_views_paid", "datatype": dbt.type_int()},
-    {"name": "page_views_total", "datatype": dbt.type_int()}
+    {"name": "page_views_total", "datatype": dbt.type_int()},
+    {"name": "page_media_view", "datatype": dbt.type_float()}
 ] %}
 
 {{ return(columns) }}
diff --git a/models/facebook_pages.yml b/models/facebook_pages.yml
@@ -23,7 +23,10 @@ models:
       - name: clicks
         description: The number of times the post was clicked.
       - name: impressions
-        description: The number of times the post was shown to users.
+        description: >
+          The number of times the post was shown to users.
+
+          NOTE: This field is deprecated and will not be populated following November, 2025.
       - name: video_avg_time_watched
         description: The average amount of time users watched the video.
       - name: video_view_time
@@ -57,11 +60,22 @@ models:
       - name: actions_post_reactions_total
         description: The total number of reactions on posts.
       - name: fan_adds
-        description: The number of new fans added to the Page.
+        description: >
+          The number of new fans added to the Page.
+
+          NOTE: This field is deprecated and will not be populated following November, 2025.
       - name: fan_removes
-        description: The number of fans removed from the Page. 
+        description: >
+          The number of fans removed from the Page. 
+
+          NOTE: This field is deprecated and will not be populated following November, 2025.
       - name: impressions
-        description: The number of times any content from your Page or about your Page entered a person's screen.
+        description: >
+          The number of times any content from your Page or about your Page entered a person's screen.
+
+          NOTE: This field is deprecated and will not be populated following November, 2025.
+      - name: media_views
+        description: The number of times media/content was viewed on the Page
       - name: post_engagements
         description: The number of times people have engaged with your posts through reactions, comments, shares and more.
       - name: posts_impressions
diff --git a/models/facebook_pages__pages_report.sql b/models/facebook_pages__pages_report.sql
@@ -15,9 +15,10 @@ with pages as (
         pages.page_id,
         pages.page_name,
         page_metrics.actions_post_reactions_total,
-        page_metrics.fan_adds,
-        page_metrics.fan_removes,
-        page_metrics.impressions,
+        page_metrics.fan_adds, -- Deprecated as of November, 2025. Will be removed in future release.
+        page_metrics.fan_removes, -- Deprecated as of November, 2025. Will be removed in future release.
+        page_metrics.impressions, -- Deprecated as of November, 2025. Will be removed in future release.
+        page_metrics.media_views,
         page_metrics.post_engagements,
         page_metrics.posts_impressions,
         page_metrics.video_complete_views_30s,
diff --git a/models/facebook_pages__posts_report.sql b/models/facebook_pages__posts_report.sql
@@ -25,7 +25,7 @@ with posts as (
         pages.page_name,
         post_metrics.date_day,
         post_metrics.clicks,
-        post_metrics.impressions,
+        post_metrics.impressions, -- Deprecated as of November, 2025. Will be removed in future release.
         post_metrics.video_avg_time_watched,
         post_metrics.video_view_time,
         post_metrics.video_views,
diff --git a/models/staging/src_facebook_pages.yml b/models/staging/src_facebook_pages.yml
diff --git a/models/staging/stg_facebook_pages.yml b/models/staging/stg_facebook_pages.yml
diff --git a/models/staging/stg_facebook_pages__daily_page_metrics_total.sql b/models/staging/stg_facebook_pages__daily_page_metrics_total.sql
diff --git a/models/staging/stg_facebook_pages__lifetime_post_metrics_total.sql b/models/staging/stg_facebook_pages__lifetime_post_metrics_total.sql

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`packages:`
`2`		`- - local: ../`
	`2`	`+ - local: ../`