[iOS][HealthKit] HealthKit アクセスのための Property List Key まとめ

環境＆対象

HealthKit

HealthKit のデータを読み込むアプリ、HealthKit にデータを書き込むアプリ は、ユーザーに許諾を得なければいけないのですが、同時に、Info.plist(Custom iOS Target Properties) に、特定のキーを追加し、その目的を記述しつつ、アプリが HealthKit を利用することを宣言しないといけません。

なお、キーを追加するだけでは、ユーザー許諾を得るためのスクリーンは表示されませんので、HealthKit の API を使用して、ユーザーに許諾をリクエストしなければいけません。

[iOS][HealthKit] HealthKit のセットアップ async/await 対応板

関連する Property List Key

以下のキーが関連するキーです。カッコ内は、Apple のドキュメントで Key として使われている文字列です。

Apple のドキュメントは、こちら。

• Privacy – Health Share Usage Description (NSHealthShareUsageDescription)
• Privacy – Health Update Usage Description　(NSHealthUpdateUsageDescription)
• Privacy – Health Records Usage Description (NSHealthUpdateUsageDescription)
• NSHealthRequiredReadAuthorizationTypeIdentifiers

Privacy – Health Share Usage Description (NSHealthShareUsageDescription)

HealthKit のデータを読み込むアプリケーションは、このキーの追加が必要です。

Apple のドキュメントは、こちら。

Privacy – Health Update Usage Description　(NSHealthUpdateUsageDescription)

HealthKit にデータを書き込むアプリケーションは、このキーの追加が必要です。

Apple のドキュメントは、こちら。

キーの名前である Update からは、更新のみかと考えるかもしれませんが、ドキュメントでは、”save” するなら必要であると 明確に説明されてます。

Privacy – Health Records Usage Description (NSHealthClinicalHealthRecordsShareUsageDescription)

HealthkKit　から医療記録を読み出すアプリケーションは、このキーの追加が必要です。

# 自分のアプリケーションで指定したことはありません。

NSHealthRequiredReadAuthorizationTypeIdentifiers

HealthKit から医療記録を読み出すアプリケーションでは、具体的にどの情報を読み出すかの宣言が必要でそのためのキーです。

＃ こちらも自アプリで使用したことがありません。

まとめ：HealthKit を使うアプリで設定する Property List Key

説明は以上です。
不明な点やおかしな点ありましたら、こちらまで。

関連記事:

[iOS][HealthKit] HealthKit のセットアップ async/await 対応板 [Swift] Property Wrapperを理解する 0258-property-wrappersの写経 日本語訳 [iOS] [Acknowledgement] 謝辞の表示方法@iOSアプリ [Xcode] Xcode13 で作成した新規プロジェクトに Info.plist がない件