update field descriptions #14

fivetran-reneeli · 2023-07-18T18:33:32Z

PR Overview

This PR will address the following Issue/Feature:
fivetran/dbt_app_reporting#18
This PR will result in the following new package version: v0.3.1

Updates the description for field source_type to reduce the number of characters. As such this is not a breaking change.

Please detail what change(s) this PR introduces and any additional information that should be known during the review of this PR:
See above

PR Checklist

Basic Validation

Please acknowledge that you have successfully performed the following commands locally:

Before marking this PR as "ready for review" the following have been applied:

The appropriate issue has been linked and tagged
You are assigned to the corresponding issue and this PR
BuildKite integration tests are passing

Detailed Validation

Please acknowledge that the following validation checks have been performed prior to marking this PR as "ready for review":

You have validated these changes and assure this PR will address the respective Issue/Feature.
You are reasonably confident these changes will not impact any other components of this package or any dependent packages.
You have provided details below around the validation steps performed to gain confidence in these changes.

View new docs

Standard Updates

Please acknowledge that your PR contains the following standard updates:

Package versioning has been appropriately indexed in the following locations:
- indexed within dbt_project.yml
- indexed within integration_tests/dbt_project.yml
CHANGELOG has individual entries for each respective change in this PR
[n/a] README updates have been applied (if applicable)
[n/a] DECISIONLOG updates have been updated (if applicable)
Appropriate yml documentation has been added (if applicable)

dbt Docs

Please acknowledge that after the above were all completed the below were applied to your branch:

[ not yet] docs were regenerated (unless this PR does not include any code or yml updates)

If you had to summarize this PR in an emoji, which would it be?

💃

fivetran-reneeli · 2023-07-19T19:55:52Z

dbt docs after review is completed

fivetran-joemarkiewicz

@fivetran-reneeli thanks for making this update! There are just a few more updates needed to be applied before this will be good to approve.

Let me know once this is ready for re-review!

CHANGELOG.md

models/apple_store.yml

fivetran-joemarkiewicz · 2023-07-25T15:53:22Z

packages.yml

+#   version: [">=0.3.0", "<0.4.0"]
+
+- git: https://github.com/fivetran/dbt_apple_store_source.git
+  revision: bugfix/persist_docs_max_length
+  warn-unpinned: false


Reminder to update before merge

…ivetran/dbt_apple_store into bugfix/persist_docs_max_length

fivetran-joemarkiewicz

@fivetran-reneeli thanks for working through this. This looks good, but I do wonder if we are including more changes than necessary. I am fairly certain if you update the docs.md in the source package, they persist to the transform package. If that is in fact the case, may you remove those updates in this PR and update the changelog accordingly.

fivetran-joemarkiewicz · 2023-07-25T19:42:22Z

CHANGELOG.md

+
+## Bug Fix
+[PR #14](https://github.com/fivetran/dbt_apple_store/pull/14) includes the following update:
+- Shortened the field description for `source_type`. This was causing an error if the persist docs config was enabled because the description size exceeded warehouse constraints.

 ## Under the Hood:


I would also include an under the hood of adding some additional fields to the yml descriptions as this was also done in the PR and there were a number of them.

Would you also be able to add that yml descriptions were added/removed to the under the hood section. You don't need to include all the fields that were added/removed, but still reference that this was done.

fivetran-joemarkiewicz · 2023-07-25T19:46:45Z

models/docs.md

+{% docs _fivetran_synced %} Timestamp of when Fivetran synced a record. {% enddocs %}
+
+{% docs account_id %} Sales Account ID associated with the app name or app ID. {% enddocs%}
+
+{% docs account_name %} Sales Account Name associated with the Sales Account ID, app name or app ID. {% enddocs %}
+
+{% docs active_devices %} The count of active_device is the count of devices that ran the app at least one time and for at least two seconds on a given day (User Opt-In only); this metric is presumed to be de-duplicated daily as received from the source data, therefore, aggregating over a span of days is better done in the UI. A value of 0 indicates there were 0 active devices or no value from the source report that day. {% enddocs %}
+
+{% docs active_devices_last_30_days %} The count of active_devices_last_30_days is the count of devices that ran the app at least one time and for at least two seconds on the date_day of the report minus 30 days (User Opt-In only); this metric is presumed to be de-duplicated daily as received from the source data, therefore, aggregating over a span of days is better done in the UI. A value of 0 indicates there were 0 active devices last 30 days or no value from the source report that day.{% enddocs %}
+
+{% docs active_free_trial_introductory_offer_subscriptions %} Total number of introductory offer subscriptions currently in a free trial. {% enddocs %}
+
+{% docs active_pay_as_you_go_introductory_offer_subscriptions %} Total number of introductory offer subscriptions currently with a pay as you go introductory price. {% enddocs %}
+
+{% docs active_pay_up_front_introductory_offer_subscriptions %} Total number of introductory offer subscriptions currently with a pay up front introductory price. {% enddocs %}
+
+{% docs active_standard_price_subscriptions %} Total number of auto-renewable standard paid subscriptions currently active, excluding free trials, 
+subscription offers, introductory offers, and marketing opt-ins. Subscriptions are active during the period for which the customer has paid without cancellation. {% enddocs %}
+
+{% docs alternative_country_name %} Due to differences in the official ISO country names and Apple's naming convention, we've added an alternative territory name that will allow us to join reports and infer ISO fields. {% enddocs %}
+
+{% docs app_id %} Application ID. {% enddocs%}
+
+{% docs app_name %} Application Name. {% enddocs %}
+
+{% docs app_version %} The app version of the app that the user is engaging with. {% enddocs %}
+
+{% docs country %} The country associated with the subscription event metrics and subscription summary metric(s). This country code maps to ISO-3166 Alpha-2. {% enddocs %}
+
+{% docs country_code_alpha_2 %} The 2 character ISO-3166 country code. ([Original Source](https://github.com/lukes/ISO-3166-Countries-with-Regional-Codes/blob/master/all/all.csv)) {% enddocs%}
+
+{% docs country_code_alpha_3 %} The 3 character ISO-3166 country code. ([Original Source](https://github.com/lukes/ISO-3166-Countries-with-Regional-Codes/blob/master/all/all.csv)) {% enddocs%}
+
+{% docs country_code_numeric %} The 3 digit ISO-3166 country code. ([Original Source](https://github.com/lukes/ISO-3166-Countries-with-Regional-Codes/blob/master/all/all.csv)) {% enddocs%}
+
+{% docs country_name %} The ISO-3166 English country name. ([Original Source](https://github.com/lukes/ISO-3166-Countries-with-Regional-Codes/blob/master/all/all.csv)) {% enddocs%}
+
+{% docs crashes %} The number of recorded crashes experienced (User Opt-In only); a value of 0 indicates there were 0 crash reports or no value from the source report that day. {% enddocs %}
+
+{% docs date_day %} The date of the report and respective recorded metric(s); follows the format `YYYY-MM-DD`. {% enddocs %}
+
+{% docs deletions %} A deletion occurs when a user removes your app from their device (User Opt-In only). Data from resetting or erasing a device’s content and settings is not included. A value of 0 indicates there were 0 deletions or no value from the source report that day. {% enddocs %}
+
+{% docs device %} Device type associated with the respective metric(s). {% enddocs %}
+
+{% docs event %} The subscription event associated with the respective metric(s). {% enddocs %}
+
+{% docs first_time_downloads %} The number of first time downloads for your app; credit is attributed to the referring app, website, or App Clip of the first time download. {% enddocs %}
+
+{% docs impressions %} The number of times your app was viewed in the App Store for more than one second. This includes search results, Featured, Explore, Top Charts and App Product Page views. (Source: [BusinessofApps](https://www.businessofapps.com/insights/understanding-the-app-store-metrics/#:~:text=Impressions%20%E2%80%93%20%E2%80%9CThe%20number%20of%20times,was%20clicked%20on%20and%20viewed.)) {% enddocs %}
+
+{% docs impressions_unique_device %} The number of unique devices that have viewed your app for more than one second on on the Today, Games, Apps, Featured, Explore, Top Charts, Search tabs of the App Store and App Product Page views. This metric is presumed to be de-duplicated daily as received from the source data, therefore, aggregating over a span of days is better done in the UI. {% enddocs %}
+
+{% docs installations%} An installation event is when the user opens the App after they've downloaded it (User Opt-In only). If the App was downloaded but not opened or opened offline, this will not count; if the user opts out of sending data back to Apple, there will also be no data here. A value of 0 indicates there were 0 installations or no value from the source report that day. {% enddocs %}
+
+{% docs page_views %} The total number of times your App Store product page was clicked and viewed; when a user taps on a link from an app, website or App Clip card that brings them to your App Store product page, the immediate product page_view is attributed to the referring app, website, or App Clip. (Sources: [Apple](https://help.apple.com/app-store-connect/#/itcf19c873df), [BusinessofApps](https://www.businessofapps.com/insights/understanding-the-app-store-metrics/#:~:text=Impressions%20%E2%80%93%20%E2%80%9CThe%20number%20of%20times,was%20clicked%20on%20and%20viewed.)) {% enddocs %}
+
+{% docs page_views_unique_device %} The number of unique devices that have viewed your App Store product page; this metric is presumed to be de-duplicated daily as received from the source data, therefore, aggregating over a span of days is better done in the UI. {% enddocs %}
+
+{% docs platform_version %} The platform version of the device engaging with your app. {% enddocs %}
+
+{% docs quantity %} The number of occurrences of a given subscription event. {% enddocs %}
+
+{% docs sessions %} Sessions is the count of the number of times the app has been used for at least two seconds (User Opt-In only). If the app is in the background and is later used again, that counts as another session. A value of 0 indicates there were 0 sessions or no value from the source report that day. {% enddocs %}
+
+{% docs redownloads %} The count of redownloads where a redownload occurs when a user who previously downloaded your app adds it to their device again (User Opt-In only); credit is attributed to the source recorded when a user tapped to download/launch your app for the first time. A value of 0 indicates there were 0 redownloads or no value from the source report that day. {% enddocs %}
+
+{% docs region %} The UN Statistics region name assignment. ([Original Source](https://github.com/lukes/ISO-3166-Countries-with-Regional-Codes/blob/master/all/all.csv)) {% enddocs %}
+
+{% docs region_code %} The UN Statistics region numerical code assignment. ([Original Source](https://github.com/lukes/ISO-3166-Countries-with-Regional-Codes/blob/master/all/all.csv)) {% enddocs %}
+
+{% docs source_type %} A source is counted when a customer follows a link to your App Store product page. 
+There are five types of sources: App Store Browse, App Store Search, App Referrers, Web Referrers, and App Clips. Null is the default value for data that does not provide source types, including: crashes, subscription events and subscription summary.
+More information can be found in the Apple App Store developer [docs](https://developer.apple.com/help/app-store-connect/view-app-analytics/view-acquisition-sources/).
+{% enddocs %}
+
+{% docs state %} The state associated with the subscription event metrics or subscription summary metrics. {% enddocs %}
+
+{% docs sub_region %} The UN Statistics sub-region name. ([Original Source](https://github.com/lukes/ISO-3166-Countries-with-Regional-Codes/blob/master/all/all.csv)) {% enddocs%}
+
+{% docs sub_region_code %} The UN Statistics sub-region numerical code. ([Original Source](https://github.com/lukes/ISO-3166-Countries-with-Regional-Codes/blob/master/all/all.csv)) {% enddocs %}
+
+{% docs subscription_name %} The subscription name associated with the subscription event metric or subscription summary metric. {% enddocs %}
+
+{% docs territory %} The territory (aka country) full name associated with the report's respective metric(s). {% enddocs %}
+
+{% docs total_downloads %} Total Downloads is the sum of Redownloads and First Time Downloads. {% enddocs %}


Do these need to be added? I actually am pretty sure that the source package docs.md are automatically leveraged in the downstream models. This is a big benefit so we don't need to maintain the same descriptions in multiple places. If you remove these, do you see the docs still persist?

Ah you're right, the docs from source do persist which is why they weren't here in the first place. I thought of bringing it here just to keep things standard across both packages but that's true, it'd just be one more thing to maintain and it'll persist downstream anyways. I'll remove it from the transforms

fivetran-joemarkiewicz · 2023-07-25T19:48:04Z

CHANGELOG.md

+
+## Bug Fix
+[PR #14](https://github.com/fivetran/dbt_apple_store/pull/14) includes the following update:
+- Shortened the field description for `source_type`. This was causing an error if the persist docs config was enabled because the description size exceeded warehouse constraints.


Following my previous comment, this may not actually need to be done in this PR. I am pretty sure this is covered by the source package PR. If that is the case, you can mention that this was updated in the upstream release.

changelog is updated

fivetran-joemarkiewicz

One small comment. Once that is addressed this is good to go!

fivetran-joemarkiewicz · 2023-07-25T20:37:31Z

CHANGELOG.md

+
+## Bug Fix
+[PR #14](https://github.com/fivetran/dbt_apple_store/pull/14) includes the following update:
+- Shortened the field description for `source_type`. This was causing an error if the persist docs config was enabled because the description size exceeded warehouse constraints.

 ## Under the Hood:


Would you also be able to add that yml descriptions were added/removed to the under the hood section. You don't need to include all the fields that were added/removed, but still reference that this was done.

fivetran-reneeli added 2 commits July 18, 2023 14:33

update field descriptions

5073f93

docs regen

f147f9e

fivetran-reneeli self-assigned this Jul 18, 2023

fivetran-reneeli added 4 commits July 18, 2023 16:56

change deps temp

9679d91

add persist docs config

7ca0840

add databricks catalog

bd4e7f7

missing fields

ce2ccf7

fivetran-joemarkiewicz and others added 3 commits July 20, 2023 14:10

removed persist docs for databricks

e9cfeda

schema update

a75f71e

disable persist docs for databricks

623af26

fivetran-reneeli requested a review from fivetran-joemarkiewicz July 25, 2023 13:08

fivetran-joemarkiewicz requested changes Jul 25, 2023

View reviewed changes

fivetran-reneeli added 3 commits July 25, 2023 20:36

docs

3f64359

Merge branch 'bugfix/persist_docs_max_length' of https://github.com/f…

ebafad3

…ivetran/dbt_apple_store into bugfix/persist_docs_max_length

docs

410ca5f

fivetran-reneeli requested a review from fivetran-joemarkiewicz July 25, 2023 19:34

new schema

388edb3

fivetran-joemarkiewicz requested changes Jul 25, 2023

View reviewed changes

fivetran-reneeli added 2 commits July 25, 2023 21:57

update changelog and rm docs

e3befa7

docs fix

ab1ae52

fivetran-joemarkiewicz approved these changes Jul 25, 2023

View reviewed changes

fivetran-reneeli added 4 commits July 26, 2023 00:38

changelogl

cd8adcb

update docs and packages

a4a8b4c

try new schema

4052a87

this didn't get pushed through

8b17ba5

fivetran-reneeli merged commit 05ad8ef into main Jul 26, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

update field descriptions #14

update field descriptions #14

fivetran-reneeli commented Jul 18, 2023 •

edited

Loading

fivetran-reneeli commented Jul 19, 2023

fivetran-joemarkiewicz left a comment

fivetran-joemarkiewicz Jul 25, 2023

fivetran-joemarkiewicz left a comment

fivetran-joemarkiewicz Jul 25, 2023

fivetran-joemarkiewicz Jul 25, 2023

fivetran-joemarkiewicz Jul 25, 2023

fivetran-reneeli Jul 25, 2023

fivetran-joemarkiewicz Jul 25, 2023

fivetran-reneeli Jul 25, 2023

fivetran-joemarkiewicz left a comment

fivetran-joemarkiewicz Jul 25, 2023

update field descriptions #14

update field descriptions #14

Conversation

fivetran-reneeli commented Jul 18, 2023 • edited Loading

PR Overview

PR Checklist

Basic Validation

Detailed Validation

Standard Updates

dbt Docs

If you had to summarize this PR in an emoji, which would it be?

fivetran-reneeli commented Jul 19, 2023

fivetran-joemarkiewicz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fivetran-joemarkiewicz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fivetran-joemarkiewicz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fivetran-reneeli commented Jul 18, 2023 •

edited

Loading