[action] NEW ACTION for App Data Usages: upload_app_data_usage_to_app_store #17592

joshdholtz · 2020-11-11T16:21:52Z

Motivation

App support for updating App Data Usage for new app privacy policies

Description

Adds a new action called upload_app_privacy_details_to_app_store . Not only does this new action upload App Data Usage to App Store Connect API, it will provide interactive questions (similar to what the App Store Connect dashboard does). The answers from the interactive questions will upload the App Data Usage to App Store Connect but also create a JSON file that can be put into source control and used again without needing to answer the questions.

Interactive questions

With JSON from previously answered questions

JSON File

The questions are tedious to answer. The JSON file is not straight forward to manually put together since it can have a lot of options. This action generating and reusing the JSON file should help make this process much easier for the user while also keeping a history of what was answered in source control 😊

Purposes

THIRD_PARTY_ADVERTISING, DEVELOPERS_ADVERTISING, ANALYTICS, PRODUCT_PERSONALIZATION, APP_FUNCTIONALITY, OTHER_PURPOSES

Data Protections

Use DATA_LINKED_TO_YOU or DATA_NOT_LINKED_TO_YOU
Optionally add DATA_USED_TO_TRACK_YOU

Example: Not Collecting Data

[
  {
    "data_protections": [
      "DATA_NOT_COLLECTED"
    ]
  }
]

Example: Collecting Data

[
  {
    "category": "NAME",
    "purposes": [
      "PRODUCT_PERSONALIZATION",
      "APP_FUNCTIONALITY"
    ],
    "data_protections": [
      "DATA_LINKED_TO_YOU"
    ]
  },
  {
    "category": "PURCHASE_HISTORY",
    "purposes": [
      "APP_FUNCTIONALITY"
    ],
    "data_protections": [
      "DATA_LINKED_TO_YOU",
      "DATA_USED_TO_TRACK_YOU"
    ]
  }
]

Run through CLI

With interactive questions

fastlane run upload_app_privacy_details_to_app_store \
  username:"your@email.com" \
  team_name:"Your Team" \
  app_identifier:"com.your.bundle"

With JSON file output from first step

fastlane run upload_app_privacy_details_to_app_store \
  username:"your@email.com" \
  team_name:"Your Team" \
  app_identifier:"com.your.bundle" \
  json_path:"fastlane/app_data_usages.json"

Run with Fastfile

With interactive questions

upload_app_privacy_details_to_app_store(
  username: "your@email.com",
  team_name: "Your Team”,
  app_identifier: "com.your.bundle"
)

With JSON file output from first step

upload_app_privacy_details_to_app_store(
  username: "your@email.com",
  team_name: "Your Team”,
  app_identifier: "com.your.bundle",
  json_path: "fastlane/app_data_usages.json"
)

fastlane-bot-helper · 2020-11-11T16:25:56Z

	1 Warning
⚠️	Big PR

Generated by 🚫 Danger

markreynoso · 2020-11-12T15:56:31Z

Thank you!! 🥇

Lukasz2891 · 2020-12-02T09:58:52Z

Are you going to release that :)?

ryechus · 2020-12-02T17:19:44Z

@joshdholtz Apple is making a change where this will be required on Dec 8th, 2020.

joshdholtz · 2020-12-02T17:20:35Z

@ryechus Yup yup! Finishing this PR up today 😊

milch

Mostly LGTM, just have a few minor comments and some questions

fastlane/lib/fastlane/actions/upload_app_data_usage_to_app_store.rb

spaceship/lib/spaceship/connect_api/models/app_data_usage.rb

spaceship/lib/spaceship/connect_api/models/app_data_usage_category.rb

spaceship/lib/spaceship/connect_api/models/app_data_usage_data_protection.rb

spaceship/lib/spaceship/connect_api/tunes/tunes.rb

milch

🚀

I just marked some minor things which looked like typos to me

fastlane/lib/fastlane/actions/upload_app_privacy_details_to_app_store.rb

…p_store.rb Co-authored-by: Manu Wallner <manu@supermil.ch>

fastlane-bot · 2020-12-04T19:30:47Z

Hey @joshdholtz 👋

Thank you for your contribution to fastlane and congrats on getting this pull request merged 🎉
The code change now lives in the master branch, however it wasn't released to RubyGems yet.
We usually ship about once a week, and your PR will be included in the next one.

Please let us know if this change requires an immediate release by adding a comment here 👍
We'll notify you once we shipped a new release with your changes 🚀

fastlane-bot

Congratulations! 🎉 This was released as part of fastlane 2.170.0 🚀

ryechus · 2020-12-04T22:32:32Z

@joshdholtz Thank you so much! In case anyone else is confused, if your app isn't collecting data for a category you don't need to include the dictionary in the json file.

sonjz · 2020-12-11T16:40:48Z

i have it working for non-Admin 🎉
... but is there a way to check if App Privacy is completed?

we currently flag it in our system if we completed the app privacy for a non-Admin,
but for other team Admin/Account Holders that have to complete this manually, i'm not quite sure how to track it.

the only place i've seen an error during deliver, which is a bit further along the process than we'd like.

guyaumetremblay · 2020-12-11T19:11:44Z

Don't know if it's linked with @sonjz comment but in our case, we did completed this informations directly in App Store Connect some weeks ago but we get the error
Answers to what data your app collects and how it's used are needed
when we try to deliver with "submit to review"! Do we need to answer (or use this new action) every each time we deliver a new version?

sonjz · 2020-12-12T00:02:20Z

@guyaumetremblay that doesn't sound related. is it possible on the App Privacy page that one of your categories was missed or Publish at the top wasn't hit?

For my issue, received a thoughtful comment about download_app_privacy_details_from_app_store in the pipe: #17780 (comment)

guyaumetremblay · 2020-12-12T14:48:36Z

@sonjz OMG we didn't see the Publish button at the top!! Thanks a lot!!

AliSoftware · 2021-01-02T00:24:28Z

FYI and for anyone curious, we started a proposal for implementing a new feature on CocoaPods that would hopefully work nicely with this fastlane feature here, as it would generate the json file used here by this fastlane action… from all the info extracted from the libs/pods you use in your app 🙂 (feedbacks on the proposal welcome)

google-cla bot added the cla: yes label Nov 11, 2020

max-ott mentioned this pull request Nov 24, 2020

Add support for Privacy Choices URL #17665

Merged

4 tasks

fastlane-bot added the status: needs-attention label Nov 25, 2020

max-ott added the tool: spaceship label Dec 1, 2020

Initial app privacy

c4ac030

joshdholtz force-pushed the joshdholtz-app-privacy branch from 1cf7a89 to c4ac030 Compare December 3, 2020 15:24

joshdholtz changed the title ~~Initial app privacy~~ [action] NEW ACTION: upload_app_data_usage_to_app_store for App Data Usages Dec 3, 2020

joshdholtz changed the title ~~[action] NEW ACTION: upload_app_data_usage_to_app_store for App Data Usages~~ [action] NEW ACTION for App Data Usages: upload_app_data_usage_to_app_store Dec 3, 2020

Josh Holtz added 2 commits December 3, 2020 10:08

Comments and some other fixes

8b5ca65

Grab by string

eab8be0

joshdholtz marked this pull request as ready for review December 3, 2020 16:38

joshdholtz requested review from milch and max-ott December 3, 2020 16:38

Josh Holtz and others added 3 commits December 3, 2020 10:48

Fix example

edbf6eb

Fix a few typos

0804adc

ugh smart quotes

ae2ebb0

milch reviewed Dec 3, 2020

View reviewed changes

Josh Holtz added 3 commits December 3, 2020 18:38

New options to skip things and other PR improvements

ba82832

Whoops

53248e3

Rename and links to docs

ec4bb3d

joshdholtz requested a review from milch December 4, 2020 01:55

milch approved these changes Dec 4, 2020

View reviewed changes

Josh Holtz and others added 3 commits December 4, 2020 07:55

Update fastlane/lib/fastlane/actions/upload_app_privacy_details_to_ap…

55838c8

…p_store.rb Co-authored-by: Manu Wallner <manu@supermil.ch>

Update fastlane/lib/fastlane/actions/upload_app_privacy_details_to_ap…

398383d

…p_store.rb Co-authored-by: Manu Wallner <manu@supermil.ch>

Update fastlane/lib/fastlane/actions/upload_app_privacy_details_to_ap…

edac18e

…p_store.rb Co-authored-by: Manu Wallner <manu@supermil.ch>

Josh Holtz and others added 2 commits December 4, 2020 07:55

Update fastlane/lib/fastlane/actions/upload_app_privacy_details_to_ap…

c2bbcb6

…p_store.rb Co-authored-by: Manu Wallner <manu@supermil.ch>

Adding conflicting options

df9219e

joshdholtz merged commit 600bcdf into master Dec 4, 2020

joshdholtz deleted the joshdholtz-app-privacy branch December 4, 2020 14:58

This was referenced Dec 4, 2020

Version bump to 2.170.0 #17735

Merged

Added doc for app privacy details fastlane/docs#1010

Merged

fastlane-bot removed the status: needs-attention label Dec 4, 2020

fastlane-bot added the status: included-in-next-release label Dec 4, 2020

fastlane-bot reviewed Dec 4, 2020

View reviewed changes

fastlane-bot added status: released and removed status: included-in-next-release labels Dec 4, 2020

bachvanthe1994 mentioned this pull request Dec 8, 2020

Successfully distributed build to Internal testers, but build number in testflight is: Ready to submit #17744

Closed

1 task

gracegyu mentioned this pull request Dec 16, 2020

"HTTPClient::KeepAliveDisconnected: Broken pipe" error #17812

Closed

mfaani mentioned this pull request Jan 1, 2021

[New Feature / Proposal] Add new required attribute in podspec to provide privacy details CocoaPods/CocoaPods#10325

Open

1 task

fastlane locked and limited conversation to collaborators Mar 3, 2021

[action] NEW ACTION for App Data Usages: upload_app_data_usage_to_app_store #17592

[action] NEW ACTION for App Data Usages: upload_app_data_usage_to_app_store #17592

Uh oh!

Conversation

joshdholtz commented Nov 11, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Motivation

Description

Interactive questions

With JSON from previously answered questions

JSON File

Categories

Purposes

Data Protections

Example: Not Collecting Data

Example: Collecting Data

Run through CLI

With interactive questions

With JSON file output from first step

Run with Fastfile

With interactive questions

With JSON file output from first step

Uh oh!

fastlane-bot-helper commented Nov 11, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

markreynoso commented Nov 12, 2020

Uh oh!

Lukasz2891 commented Dec 2, 2020

Uh oh!

ryechus commented Dec 2, 2020

Uh oh!

joshdholtz commented Dec 2, 2020

Uh oh!

milch left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

milch left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fastlane-bot commented Dec 4, 2020

Uh oh!

fastlane-bot left a comment

Choose a reason for hiding this comment

Uh oh!

ryechus commented Dec 4, 2020

Uh oh!

sonjz commented Dec 11, 2020

Uh oh!

guyaumetremblay commented Dec 11, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sonjz commented Dec 12, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

guyaumetremblay commented Dec 12, 2020

Uh oh!

AliSoftware commented Jan 2, 2021

Uh oh!

Uh oh!

joshdholtz commented Nov 11, 2020 •

edited

Loading

fastlane-bot-helper commented Nov 11, 2020 •

edited

Loading

guyaumetremblay commented Dec 11, 2020 •

edited

Loading

sonjz commented Dec 12, 2020 •

edited

Loading