feature/api-v3-updates (#27)

* feature/api-v3-updates

* update macros

* fix docs

* fix docs & vars

* fix docs

* fix docs

* fix dispatch

* update docs

* update seeds

* ym

* docs

* Generate dbt docs via GitHub Actions

* updates

* changelog

* updates

* updates

* Generate dbt docs via GitHub Actions

* fix seeds & changelog

* Generate dbt docs via GitHub Actions

* fix seeds

* Generate dbt docs via GitHub Actions

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

Author: fivetran-catfritz

CHANGELOG.md

@@ -1,3 +1,23 @@
+# dbt_reddit_ads v1.0.1
+
+[PR #27](https://github.com/fivetran/dbt_reddit_ads/pull/27) includes the following updates:
+
+## Schema Updates
+
+**10 total changes • 0 possible breaking changes**
+
+| Data Model(s) | Change type | Old | New | Notes |
+| ---------- | ----------- | -------- | -------- | ----- |
+| [stg_reddit_ads__account_conversions_report_tmp](https://fivetran.github.io/dbt_reddit_ads/#!/model/model.reddit_ads.stg_reddit_ads__account_conversions_report)<br>[stg_reddit_ads__ad_group_conversions_report_tmp](https://fivetran.github.io/dbt_reddit_ads/#!/model/model.reddit_ads.stg_reddit_ads__ad_group_conversions_report)<br>[stg_reddit_ads__ad_conversions_report_tmp](https://fivetran.github.io/dbt_reddit_ads/#!/model/model.reddit_ads.stg_reddit_ads__ad_conversions_report)<br>[stg_reddit_ads__campaign_conversions_report_tmp](https://fivetran.github.io/dbt_reddit_ads/#!/model/model.reddit_ads.stg_reddit_ads__campaign_conversions_report)<br>[stg_reddit_ads__campaign_country_conversions_report_tmp](https://fivetran.github.io/dbt_reddit_ads/#!/model/model.reddit_ads.stg_reddit_ads__campaign_country_conversions_report) | New Columns |  | `clicks`<br>`views` | Added to support API v3. |
+| [stg_reddit_ads__account_conversions_report_tmp](https://fivetran.github.io/dbt_reddit_ads/#!/model/model.reddit_ads.stg_reddit_ads__account_conversions_report)<br>[stg_reddit_ads__ad_group_conversions_report_tmp](https://fivetran.github.io/dbt_reddit_ads/#!/model/model.reddit_ads.stg_reddit_ads__ad_group_conversions_report)<br>[stg_reddit_ads__ad_conversions_report_tmp](https://fivetran.github.io/dbt_reddit_ads/#!/model/model.reddit_ads.stg_reddit_ads__ad_conversions_report)<br>[stg_reddit_ads__campaign_conversions_report_tmp](https://fivetran.github.io/dbt_reddit_ads/#!/model/model.reddit_ads.stg_reddit_ads__campaign_conversions_report)<br>[stg_reddit_ads__campaign_country_conversions_report_tmp](https://fivetran.github.io/dbt_reddit_ads/#!/model/model.reddit_ads.stg_reddit_ads__campaign_country_conversions_report) | Deprecated Columns | `click_through_conversion_attribution_window_month`<br>`view_through_conversion_attribution_window_month` |  | These were replaced by `clicks` and `views`. |
+| [stg_reddit_ads__account_conversions_report](https://fivetran.github.io/dbt_reddit_ads/#!/model/model.reddit_ads.stg_reddit_ads__account_conversions_report)<br>[stg_reddit_ads__ad_group_conversions_report](https://fivetran.github.io/dbt_reddit_ads/#!/model/model.reddit_ads.stg_reddit_ads__ad_group_conversions_report)<br>[stg_reddit_ads__ad_conversions_report](https://fivetran.github.io/dbt_reddit_ads/#!/model/model.reddit_ads.stg_reddit_ads__ad_conversions_report)<br>[stg_reddit_ads__campaign_conversions_report](https://fivetran.github.io/dbt_reddit_ads/#!/model/model.reddit_ads.stg_reddit_ads__campaign_conversions_report)<br>[stg_reddit_ads__campaign_country_conversions_report](https://fivetran.github.io/dbt_reddit_ads/#!/model/model.reddit_ads.stg_reddit_ads__campaign_country_conversions_report) | Column Modification | | `conversions`<br>`view_through_conversions` | `clicks` coalesced with `click_through_conversion_attribution_window_month`<br>`views` coalesced with `view_through_conversion_attribution_window_month` |
+
+## Documentation
+- Updated documentation with the added and deprecated columns.
+
+## Under the Hood
+- Updated integration test seeds and macro dispatch settings.
+
 # dbt_reddit_ads v1.0.0
 
 [PR #26](https://github.com/fivetran/dbt_reddit_ads/pull/26) includes the following updates:

dbt_project.yml

@@ -1,11 +1,12 @@
 name: 'reddit_ads'
-version: '1.0.0'
+version: '1.0.1'
 config-version: 2
 require-dbt-version: [">=1.3.0", "<2.0.0"]
 
 vars:
   reddit_ads:
     account: "{{ source('reddit_ads', 'account') }}"
+    business_account: "{{ source('reddit_ads','business_account') }}"
     account_conversions_report: "{{ source('reddit_ads', 'account_conversions_report') }}"
     account_daily_report: "{{ source('reddit_ads', 'account_report') }}"
     ad: "{{ source('reddit_ads', 'ad') }}"

docs/catalog.json

@@ -1,5 +1,5 @@
 name: 'reddit_ads_integration_tests'
-version: '1.0.0'
+version: '1.0.1'
 profile: 'integration_tests'
 config-version: 2
 
@@ -53,10 +53,10 @@ vars:
       transform_sql: "cast(installs2 as bigint)" # @docs-ignore
 
   # For validation testing
-  reddit_ads__conversion_event_types:
-    - 'lead'
-    - 'purchase'
-    - 'custom'
+  reddit_ads__conversion_event_types: # @docs-ignore
+    - 'lead' # @docs-ignore
+    - 'purchase' # @docs-ignore
+    - 'custom' # @docs-ignore
 
 dispatch:
   - macro_namespace: dbt_utils
@@ -72,16 +72,19 @@ seeds:
     reddit_ads_account_conversions:
       +column_types:
         account_id: "{{ 'string' if target.type in ['bigquery','spark','databricks'] else 'varchar(255)' }}"
+        total_items: "{{ 'INT64' if target.type == 'bigquery' else 'bigint' }}"
     reddit_ads_account_data:
       +column_types:
         id: "{{ 'string' if target.type in ['bigquery','spark','databricks'] else 'varchar(255)' }}"
     reddit_ads_account_report_data:
       +column_types:
         account_id: "{{ 'string' if target.type in ['bigquery','spark','databricks'] else 'varchar(255)' }}"
+        total_items: "{{ 'INT64' if target.type == 'bigquery' else 'bigint' }}"
     reddit_ads_ad_conversions:
       +column_types:
         account_id: "{{ 'string' if target.type in ['bigquery','spark','databricks'] else 'varchar(255)' }}"
         ad_id: "{{ 'string' if target.type in ['bigquery','spark','databricks'] else 'varchar(255)' }}"
+        total_items: "{{ 'INT64' if target.type == 'bigquery' else 'bigint' }}"
     reddit_ads_ad_data:
       +column_types:
         account_id: "{{ 'string' if target.type in ['bigquery','spark','databricks'] else 'varchar(255)' }}"
@@ -92,6 +95,7 @@ seeds:
       +column_types:
         account_id: "{{ 'string' if target.type in ['bigquery','spark','databricks'] else 'varchar(255)' }}"
         ad_group_id: "{{ 'string' if target.type in ['bigquery','spark','databricks'] else 'varchar(255)' }}"
+        total_items: "{{ 'INT64' if target.type == 'bigquery' else 'bigint' }}"
     reddit_ads_ad_group_data:
       +column_types:
         account_id: "{{ 'string' if target.type in ['bigquery','spark','databricks'] else 'varchar(255)' }}"
@@ -112,10 +116,12 @@ seeds:
       +column_types:
         account_id: "{{ 'string' if target.type in ['bigquery','spark','databricks'] else 'varchar(255)' }}"
         campaign_id: "{{ 'string' if target.type in ['bigquery','spark','databricks'] else 'varchar(255)' }}"
+        total_items: "{{ 'INT64' if target.type == 'bigquery' else 'bigint' }}"
     reddit_ads_campaign_country_conversions_report_data:
       +column_types:
         account_id: "{{ 'string' if target.type in ['bigquery','spark','databricks'] else 'varchar(255)' }}"
         campaign_id: "{{ 'string' if target.type in ['bigquery','spark','databricks'] else 'varchar(255)' }}"
+        total_items: "{{ 'INT64' if target.type == 'bigquery' else 'bigint' }}"
     reddit_ads_campaign_country_report_data:
       +column_types:
         account_id: "{{ 'string' if target.type in ['bigquery','spark','databricks'] else 'varchar(255)' }}"

docs/manifest.json

@@ -1,9 +1,10 @@
-_fivetran_synced,account_id,avg_value,click_through_conversion_attribution_window_day,click_through_conversion_attribution_window_month,click_through_conversion_attribution_window_week,date,event_name,total_items,total_value,view_through_conversion_attribution_window_day,view_through_conversion_attribution_window_month,view_through_conversion_attribution_window_week
-2023-01-10 12:00:00,1234,25.50,10,15,7,2022-10-09,purchase,5,127.50,1,3,2
-2023-01-10 12:00:00,1234,30.75,10,15,7,2022-10-10,purchase,8,246.00,1,3,2
-2023-01-10 12:00:00,1234,22.80,10,15,7,2022-10-11,purchase,6,136.80,1,3,2
-2023-01-10 12:00:00,1234,28.60,10,15,7,2022-10-12,purchase,7,200.20,1,3,2
-2023-01-10 12:00:00,1234,35.20,10,15,7,2022-10-13,purchase,9,316.80,1,3,2
-2023-01-10 12:00:00,1234,27.90,10,15,7,2022-10-14,purchase,6,167.40,1,3,2
-2023-01-10 12:00:00,1234,31.50,10,15,7,2022-10-15,purchase,4,126.00,1,3,2
-2023-01-10 12:00:00,1234,29.75,10,15,7,2022-10-16,purchase,8,238.00,1,3,2
+account_id,date,event_name,"click_through_conversion_attribution_window_week","click_through_conversion_attribution_window_month","click_through_conversion_attribution_window_day","view_through_conversion_attribution_window_week","view_through_conversion_attribution_window_day","view_through_conversion_attribution_window_month",avg_value,total_items,total_value,_fivetran_synced,clicks,views
+account_id_123,2025-01-01,lead,,,,,,,0,,0,2025-06-19T10:18:14,1,0
+account_id_123,2025-01-07,custom_event_2,,,,,,,,,,2025-06-19T10:18:14,,
+account_id_123,2025-01-02,custom_event_14,,,,,,,,,,2025-06-19T10:18:14,,
+account_id_123,2025-01-03,add_to_wishlist,,,,,,,0,0,0,2025-06-19T10:18:14,0,0
+account_id_123,2025-01-05,custom_event_9,,,,,,,,,,2025-06-19T10:18:14,,
+account_id_123,2025-01-01,custom_event_10,,,,,,,,,,2025-06-19T10:18:14,,
+account_id_123,2025-01-06,custom_event_16,,,,,,,,,,2025-06-19T10:18:14,,
+account_id_123,2025-01-04,custom_event_4,,,,,,,,,,2025-06-19T10:18:14,,
+account_id_123,2025-01-01,add_to_cart,,,,,,,0,0,0,2025-06-19T10:18:14,2,0

integration_tests/dbt_project.yml

@@ -1,9 +1,10 @@
-_fivetran_synced,account_id,ad_id,avg_value,click_through_conversion_attribution_window_day,click_through_conversion_attribution_window_month,click_through_conversion_attribution_window_week,date,event_name,total_items,total_value,view_through_conversion_attribution_window_day,view_through_conversion_attribution_window_month,view_through_conversion_attribution_window_week
-2023-01-10 12:00:00,1234,1510393835426777445,27.50,10,15,7,2022-10-09,purchase,2,55.00,1,3,2
-2023-01-10 12:00:00,1234,1510393835426777445,32.75,10,15,7,2022-10-10,purchase,3,98.25,1,3,2
-2023-01-10 12:00:00,1234,1522247232378637129,24.80,10,15,7,2022-10-11,purchase,2,49.60,1,3,2
-2023-01-10 12:00:00,1234,1522247232378637129,30.60,10,15,7,2022-10-12,purchase,3,91.80,1,3,2
-2023-01-10 12:00:00,1234,1535743348805779455,37.20,10,15,7,2022-10-13,purchase,4,148.80,1,3,2
-2023-01-10 12:00:00,1234,1535743348805779455,29.90,10,15,7,2022-10-14,purchase,2,59.80,1,3,2
-2023-01-10 12:00:00,1234,1542438385001795138,33.50,10,15,7,2022-10-15,purchase,1,33.50,1,3,2
-2023-01-10 12:00:00,1234,1542438385001795138,31.75,10,15,7,2022-10-16,purchase,3,95.25,1,3,2
+account_id,ad_id,date,event_name,"click_through_conversion_attribution_window_week","click_through_conversion_attribution_window_month","click_through_conversion_attribution_window_day","view_through_conversion_attribution_window_week","view_through_conversion_attribution_window_day","view_through_conversion_attribution_window_month",avg_value,total_items,total_value,_fivetran_synced,clicks,views
+account_id_123,ad_id_123,2025-01-05,custom_event_20,,,,,,,,,,2025-06-19T10:19:24,,
+account_id_123,ad_id_456,2025-01-14,custom_event_12,,,,,,,,,,2025-06-19T10:19:24,,
+account_id_123,ad_id_123,2025-01-02,custom_event_1,,,,,,,0,0,0,2025-06-19T10:19:24,0,0
+account_id_123,ad_id_789,2025-01-14,custom_event_6,,,,,,,,,,2025-06-19T10:19:24,,
+account_id_123,ad_id_012,2025-01-14,custom_event_6,,,,,,,,,,2025-06-19T10:19:24,,
+account_id_123,ad_id_234,2025-01-14,custom_event_16,,,,,,,,,,2025-06-19T10:19:24,,
+account_id_123,ad_id_345,2025-01-08,custom_event_1,,,,,,,0,0,0,2025-06-19T10:19:24,0,0
+account_id_123,ad_id_567,2025-01-14,custom_event_17,,,,,,,,,,2025-06-19T10:19:24,,
+account_id_123,ad_id_678,2025-01-14,custom_event_9,,,,,,,,,,2025-06-19T10:19:24,,

integration_tests/seeds/reddit_ads_account_conversions.csv

@@ -1,9 +1,10 @@
-_fivetran_synced,account_id,ad_group_id,avg_value,click_through_conversion_attribution_window_day,click_through_conversion_attribution_window_month,click_through_conversion_attribution_window_week,date,event_name,total_items,total_value,view_through_conversion_attribution_window_day,view_through_conversion_attribution_window_month,view_through_conversion_attribution_window_week
-2023-01-10 12:00:00,1234,1510393829097718070,28.50,10,15,7,2022-10-09,purchase,1,28.50,1,3,2
-2023-01-10 12:00:00,1234,1510393829097718070,33.75,10,15,7,2022-10-10,purchase,2,67.50,1,3,2
-2023-01-10 12:00:00,1234,1522247226241194321,25.80,10,15,7,2022-10-11,purchase,1,25.80,1,3,2
-2023-01-10 12:00:00,1234,1522247226241194321,31.60,10,15,7,2022-10-12,purchase,2,63.20,1,3,2
-2023-01-10 12:00:00,1234,1535743345604192832,38.20,10,15,7,2022-10-13,purchase,3,114.60,1,3,2
-2023-01-10 12:00:00,1234,1535743345604192832,30.90,10,15,7,2022-10-14,purchase,1,30.90,1,3,2
-2023-01-10 12:00:00,1234,1542438363648999385,34.50,10,15,7,2022-10-15,purchase,1,34.50,1,3,2
-2023-01-10 12:00:00,1234,1542438363648999385,32.75,10,15,7,2022-10-16,purchase,2,65.50,1,3,2
+account_id,ad_group_id,date,event_name,"click_through_conversion_attribution_window_week","click_through_conversion_attribution_window_month","click_through_conversion_attribution_window_day","view_through_conversion_attribution_window_week","view_through_conversion_attribution_window_day","view_through_conversion_attribution_window_month",avg_value,total_items,total_value,_fivetran_synced,clicks,views
+account_id_123,ad_group_id_456,2025-01-05,custom,,,,,,,0,0,0,2025-06-19T10:17:27,0,0
+account_id_123,ad_group_id_123,2025-01-14,custom_event_13,,,,,,,,,,2025-06-19T10:17:27,,
+account_id_123,ad_group_id_456,2025-01-02,custom_event_9,,,,,,,,,,2025-06-19T10:17:27,,
+account_id_123,ad_group_id_456,2025-01-03,custom_event_16,,,,,,,,,,2025-06-19T10:17:27,,
+account_id_123,ad_group_id_456,2025-01-01,custom_event_4,,,,,,,,,,2025-06-19T10:17:27,,
+account_id_123,ad_group_id_456,2025-01-07,custom_event_8,,,,,,,,,,2025-06-19T10:17:27,,
+account_id_123,ad_group_id_234,2025-01-14,custom_event_7,,,,,,,,,,2025-06-19T10:17:27,,
+account_id_123,ad_group_id_456,2025-01-02,custom_event_12,,,,,,,,,,2025-06-19T10:17:27,,
+account_id_123,ad_group_id_456,2025-01-06,custom_event_3,,,,,,,,,,2025-06-19T10:17:27,,

integration_tests/seeds/reddit_ads_ad_conversions.csv

@@ -1,9 +1,10 @@
-_fivetran_synced,account_id,avg_value,campaign_id,click_through_conversion_attribution_window_day,click_through_conversion_attribution_window_month,click_through_conversion_attribution_window_week,date,event_name,total_items,total_value,view_through_conversion_attribution_window_day,view_through_conversion_attribution_window_month,view_through_conversion_attribution_window_week
-2023-01-10 12:00:00,1234,26.50,1510393823694638543,10,15,7,2022-10-09,purchase,3,79.50,1,3,2
-2023-01-10 12:00:00,1234,31.75,1510393823694638543,10,15,7,2022-10-10,purchase,4,127.00,1,3,2
-2023-01-10 12:00:00,1234,23.80,1542438351052756282,10,15,7,2022-10-11,purchase,3,71.40,1,3,2
-2023-01-10 12:00:00,1234,29.60,1542438351052756282,10,15,7,2022-10-12,purchase,4,118.40,1,3,2
-2023-01-10 12:00:00,1234,36.20,1576385495765735715,10,15,7,2022-10-13,purchase,5,181.00,1,3,2
-2023-01-10 12:00:00,1234,28.90,1576385495765735715,10,15,7,2022-10-14,purchase,3,86.70,1,3,2
-2023-01-10 12:00:00,1234,32.50,1593209133449106285,10,15,7,2022-10-15,purchase,2,65.00,1,3,2
-2023-01-10 12:00:00,1234,30.75,1593209133449106285,10,15,7,2022-10-16,purchase,4,123.00,1,3,2
+account_id,campaign_id,date,event_name,"click_through_conversion_attribution_window_week","click_through_conversion_attribution_window_month","click_through_conversion_attribution_window_day","view_through_conversion_attribution_window_week","view_through_conversion_attribution_window_day","view_through_conversion_attribution_window_month",avg_value,total_items,total_value,_fivetran_synced,clicks,views
+account_id_123,campaign_id_123,2025-01-07,custom_event_15,,,,,,,,,,2025-06-19T10:17:24,,
+account_id_123,campaign_id_123,2025-01-05,custom_event_7,,,,,,,,,,2025-06-19T10:17:24,,
+account_id_123,campaign_id_123,2025-01-04,custom_event_2,,,,,,,,,,2025-06-19T10:17:24,,
+account_id_123,campaign_id_123,2025-01-08,custom_event_17,,,,,,,,,,2025-06-19T10:17:24,,
+account_id_123,campaign_id_123,2025-01-06,custom_event_11,,,,,,,,,,2025-06-19T10:17:24,,
+account_id_123,campaign_id_123,2025-01-05,custom,,,,,,,0,0,0,2025-06-19T10:17:24,0,0
+account_id_123,campaign_id_123,2025-01-02,custom_event_9,,,,,,,,,,2025-06-19T10:17:24,,
+account_id_123,campaign_id_456,2025-01-14,custom_event_1,,,,,,,0,0,0,2025-06-19T10:17:24,0,0
+account_id_123,campaign_id_123,2025-01-03,custom_event_16,,,,,,,,,,2025-06-19T10:17:24,,

integration_tests/seeds/reddit_ads_ad_group_conversions.csv

@@ -1,11 +1,10 @@
-_fivetran_synced,account_id,campaign_id,click_through_conversion_attribution_window_month,country,date,event_name,total_items,total_value,view_through_conversion_attribution_window_month
-2024-04-01 12:00:00,1234,1576385495765735715,1,country1,2024-04-01,lead,4,63,1
-2024-04-02 12:00:00,1234,1456360336221951846,2,country2,2024-04-02,lead,3,60,1
-2024-04-03 12:00:00,1234,1542438351052756282,6,country3,2024-04-03,lead,5,92,2
-2024-04-04 12:00:00,1234,1542438351052756282,2,country1,2024-04-04,lead,2,46,1
-2024-04-05 12:00:00,1234,1542438351052756282,1,country1,2024-04-05,lead,6,119,1
-2024-04-06 12:00:00,1234,1542438351052756282,3,country1,2024-04-06,lead,4,71,1
-2024-04-07 12:00:00,1234,1542438351052756282,1,country2,2024-04-07,lead,3,43,1
-2024-04-08 12:00:00,1234,1542438351052756282,4,country2,2024-04-08,lead,5,125,2
-2024-04-09 12:00:00,1234,1542438351052756282,2,country2,2024-04-09,lead,6,131,1
-2024-04-10 12:00:00,1234,1542438351052756282,2,country2,2024-04-10,lead,4,88,2
+account_id,campaign_id,country,date,event_name,"click_through_conversion_attribution_window_week","click_through_conversion_attribution_window_month","click_through_conversion_attribution_window_day","view_through_conversion_attribution_window_week","view_through_conversion_attribution_window_day","view_through_conversion_attribution_window_month",avg_value,total_items,total_value,_fivetran_synced,clicks,views
+account_id_123,campaign_id_123,US,2025-01-01,purchase,,,,,,,2550,0,5100,2025-06-19T10:17:51,2,0
+account_id_123,campaign_id_123,US,2025-01-01,lead,,,,,,,0,,0,2025-06-19T10:17:51,1,0
+account_id_123,campaign_id_123,US,2025-01-07,custom_event_2,,,,,,,,,,2025-06-19T10:17:59,,
+account_id_123,campaign_id_456,US,2025-01-14,custom_event_6,,,,,,,,,,2025-06-19T10:18:08,,
+account_id_123,campaign_id_123,US,2025-01-02,custom_event_14,,,,,,,,,,2025-06-19T10:17:52,,
+account_id_123,campaign_id_123,US,2025-01-03,add_to_wishlist,,,,,,,0,0,0,2025-06-19T10:17:54,0,0
+account_id_123,campaign_id_123,US,2025-01-05,custom_event_9,,,,,,,,,,2025-06-19T10:17:57,,
+account_id_123,campaign_id_123,US,2025-01-01,custom_event_10,,,,,,,,,,2025-06-19T10:17:51,,
+account_id_123,campaign_id_456,US,2025-01-14,custom_event_13,,,,,,,,,,2025-06-19T10:18:08,,