Api v5 #29
Api v5 #29
Conversation
|
will hold to regen docs after approval |
| @@ -56,7 +56,7 @@ Include the following apple_search_ads package version in your `packages.yml` fi | |||
| ```yaml | |||
| packages: | |||
| - package: fivetran/apple_search_ads | |||
| version: [">=0.4.0", "<0.5.0"] # we recommend using ranges to capture non-breaking changes automatically | |||
| version: [">=0.5.0", "<0.6.0"] # we recommend using ranges to capture non-breaking changes automatically | |||
There was a problem hiding this comment.
We also need to update this section of the README to reflect the new default metric fields (and maybe note that certain ones are being deprecated)
There was a problem hiding this comment.
updated and added that note
models/apple_search_ads.yml
Outdated
| @@ -43,17 +43,25 @@ models: | |||
| - name: taps | |||
| description: Number of taps on ad group on given day. | |||
| - name: new_downloads | |||
| description: App downloads from new users who have never before installed app of ad group in a given day. | |||
| description: App downloads from new users who have never before installed app of ad group in a given day. This will be deprecated by April 2025; please refer to the new field which is prefixed with "tap_". | |||
There was a problem hiding this comment.
| description: App downloads from new users who have never before installed app of ad group in a given day. This will be deprecated by April 2025; please refer to the new field which is prefixed with "tap_". | |
| description: App downloads from new users who have never before installed app of ad group in a given day. Following the [release](https://fivetran.com/docs/changelog/2025/february-2025#applesearchads) of Apple Search Ads API v5, the package will sunset this field by April 2025. Please refer to its replacement, `tap_new_downloads`, instead. |
There was a problem hiding this comment.
If this sounds good, apply to all new_downloads descriptions in this file
There was a problem hiding this comment.
updated this and moved new_downloads description to the docs file
models/apple_search_ads.yml
Outdated
| - name: redownloads | ||
| description: Number of user downloads where user deletes app and downloads the same app again following a tap on an ad on the App Store, or downloads the same app to an additional device of ad group in a given day. | ||
| description: Number of user downloads where user deletes app and downloads the same app again following a tap on an ad on the App Store, or downloads the same app to an additional device of ad group in a given day. This will be deprecated by April 2025; please refer to the new field which is prefixed with "tap_". |
There was a problem hiding this comment.
| description: Number of user downloads where user deletes app and downloads the same app again following a tap on an ad on the App Store, or downloads the same app to an additional device of ad group in a given day. This will be deprecated by April 2025; please refer to the new field which is prefixed with "tap_". | |
| description: Number of user downloads where user deletes app and downloads the same app again following a tap on an ad on the App Store, or downloads the same app to an additional device of ad group in a given day. Following the [release](https://fivetran.com/docs/changelog/2025/february-2025#applesearchads) of Apple Search Ads API v5, the package will sunset this field by April 2025. Please refer to its replacement, `tap_redownloads`, instead. |
There was a problem hiding this comment.
If this sounds good, apply to all redownloads descriptions in this file
models/apple_search_ads.yml
Outdated
| - name: total_downloads | ||
| description: The sum of new_downloads and redownloads. | ||
| description: The sum of new_downloads and redownloads. This will be deprecated by April 2025; please refer to the new field which is prefixed with "tap_". |
There was a problem hiding this comment.
| description: The sum of new_downloads and redownloads. This will be deprecated by April 2025; please refer to the new field which is prefixed with "tap_". | |
| description: The sum of `new_downloads` and `redownloads`. Following the [release](https://fivetran.com/docs/changelog/2025/february-2025#applesearchads) of Apple Search Ads API v5, the package will sunset this field by April 2025. Please refer to its replacement, `tap_total_downloads`, instead. |
There was a problem hiding this comment.
If this sounds good, apply to all total_downloads descriptions in this file
There was a problem hiding this comment.
You added a doc block for this field in the source package right? Can you update to use that?
models/apple_search_ads.yml
Outdated
| - name: conversions | ||
| description: Total installs resulting from a view or a tap. | ||
| description: Total installs resulting from a view or a tap. This will be deprecated by April 2025; please refer to the new field which is tap_installs. |
There was a problem hiding this comment.
| description: Total installs resulting from a view or a tap. This will be deprecated by April 2025; please refer to the new field which is tap_installs. | |
| description: Total installs resulting from a view or a tap. Following the [release](https://fivetran.com/docs/changelog/2025/february-2025#applesearchads) of Apple Search Ads API v5, the package will sunset this field by April 2025. Please refer to its replacement, `tap_installs`, instead. |
There was a problem hiding this comment.
If this sounds good, apply to all conversions descriptions in this file
| sum(report.new_downloads) as new_downloads, | ||
| sum(report.tap_new_downloads) as tap_new_downloads, | ||
| sum(report.redownloads) as redownloads, | ||
| sum(report.tap_redownloads) as tap_redownloads, | ||
| sum(report.new_downloads + report.redownloads) as total_downloads, | ||
| sum(report.tap_new_downloads + report.tap_redownloads) as total_tap_downloads, | ||
| sum(report.conversions) as conversions, | ||
| sum(report.tap_installs) as tap_installs, |
There was a problem hiding this comment.
Same request:
Can you add in-line comments pointing out that the old fields are deprecated and users should reference the new fields instead?
| sum(report.new_downloads) as new_downloads, | ||
| sum(report.tap_new_downloads) as tap_new_downloads, | ||
| sum(report.redownloads) as redownloads, | ||
| sum(report.tap_redownloads) as tap_redownloads, | ||
| sum(report.new_downloads + report.redownloads) as total_downloads, | ||
| sum(report.tap_new_downloads + report.tap_redownloads) as total_tap_downloads, | ||
| sum(report.conversions) as conversions, | ||
| sum(report.tap_installs) as tap_installs, |
There was a problem hiding this comment.
Same request:
Can you add in-line comments pointing out that the old fields are deprecated and users should reference the new fields instead?
packages.yml
Outdated
| # version: [">=0.5.0", "<0.6.0"] | ||
|
|
||
| - git: https://github.com/fivetran/dbt_apple_search_ads_source.git | ||
| revision: api_v5 | ||
| warn-unpinned: false |
There was a problem hiding this comment.
obligatory reminder to update before merging
CHANGELOG.md
Outdated
| - Following the connector updates surrounding the Apple Search Ads API v5 release, the following fields have been added to the upstream `*_report` staging models and will be used to sunset the below fields: | ||
| - `tap_installs` - replacing `conversions` | ||
| - `tap_new_downloads` - replacing `new_downloads` | ||
| - `tap_redownloads` - replacing `redownloads` |
There was a problem hiding this comment.
Again, I know i'm not supposed to look at the changelog rn, but I think it could be good to mention that we are coalescing the new fields with the old to ensure historical data is persisted
There was a problem hiding this comment.
yes updated this! thanks!
CHANGELOG.md
Outdated
| - `tap_redownloads` - replacing `tap_redownloads` | ||
| - `total_tap_downloads` - replacing `total_downloads` | ||
| - `tap_installs` - replacing `conversions` | ||
| - We encourage referencing the new fields, as the fields being replaced will be deprecated by April 2025 in an upcoming release. |
There was a problem hiding this comment.
| - We encourage referencing the new fields, as the fields being replaced will be deprecated by April 2025 in an upcoming release. | |
| - **We encourage referencing the new fields, as the fields being replaced will be deprecated by April 2025 in an upcoming release.** |
or something to make this stick out
|
Thanks Jamie for the thorough reviews! I moved the field descriptions to the upstream docs file and reference that instead. In addition, I switched "total_tap_downloads" to "tap_total_downloads" to keep with the naming conventions. I also added the inline comments and made the changelog/readme udpates! |
models/apple_search_ads.yml
Outdated
| - name: total_downloads | ||
| description: The sum of new_downloads and redownloads. | ||
| description: The sum of new_downloads and redownloads. This will be deprecated by April 2025; please refer to the new field which is prefixed with "tap_". |
There was a problem hiding this comment.
You added a doc block for this field in the source package right? Can you update to use that?
CHANGELOG.md
Outdated
| - `tap_total_downloads` - replacing `total_downloads` | ||
| - `tap_installs` - replacing `conversions` | ||
| - In order to maintain backwards compatibility and historical data, we have coalesced the new and existing versions of each field. | ||
| - **We encourage referencing the new fields, as the fields being replaced will be deprecated by April 2025 in an upcoming release.** |
There was a problem hiding this comment.
Has this issue been created? Can we create this for the GitHub repo and link it here. Following our new deprecation process.
Co-authored-by: Joe Markiewicz <74217849+fivetran-joemarkiewicz@users.noreply.github.com>
Co-authored-by: Jamie Rodriguez <65564846+fivetran-jamie@users.noreply.github.com>
PR Overview
This PR will address the following Issue/Feature: Update package to align with connector update to API v5
Submission Checklist
Submitter:
Validation Steps: See internal ticket
[] Testing Instructions: Clear steps for running/testing (e.g., scripts, sample data)
See internal ticket
Reviewer:
Changelog