ヘルプセンター HealthyApps
日本語
ヘルプセンター
メインサイト ↗

ヘルプを検索

ディープリンク自動化

iPhone または iPad で URL を開き、REST API 自動化を作成します。

最終更新: 2026年10月31日

このページの内容
URL 形式
パラメータリファレンス パラメータリファレンス 基本設定ヘルス指標ワークアウト間隔と通知
認証とエンコード
例 例 選択した指標、時間単位で要約ルート付きワークアウト
トラブルシューティング関連ドキュメント

iPhone または iPad で URL を開き、REST API 自動化を作成します。ディープリンクではほかの送信先は設定しません。

URL 形式

com.HealthExport://automation?url=https%3A%2F%2Fapi.example.com%2Fhealth&name=Daily%20Export

url は必須です。わかりやすい name を指定します。省略するとデフォルトは Automation です。パラメータ名は大文字小文字を区別しません。スペースや予約文字を含むパラメータ値は URL エンコードします。

デバイスで URL を開くか、ショートカットの URL を開く を使います。有効にする前に Health Auto Export で作成された自動化を確認してください。

パラメータリファレンス

真偽値は true/false、1/0、または yes/no を受け付けます。データ固有のオプションの前に datatype を設定し、format を aggregatedata の前に設定して、後の選択が前の設定を置き換えないようにします。

基本設定

パラメータ 値または意味 デフォルト
url デバイスから到達可能なエンドポイント URL 必須
name 空でない自動化名 Automation
enabled 自動実行を有効にする false
datatype 下記のデータタイプ healthMetrics
format json、csv、markdown、または md json
exportversion v1、v2、1、または 2 v2
period none、lastsync、today、yesterday、previous7days none
requesttimeout 整数秒、60–86400 60
headers カンマ区切りのキー/値ペア なし
batchrequests 真偽値。JSON のみ false

有効なデータタイプは healthMetrics、workouts、symptoms、ecg、heartRateNotification、stateOfMind、cycleTracking、medications です。心の状態は iOS 18 以降、薬のエクスポートは iOS 26 以降が必要です。

日付範囲の意味は 日付範囲 を参照してください。ディープリンクはすべて REST API 自動化を作成します。exportDestination パラメータはありません。

ヘルス指標

パラメータ 値または意味 デフォルト
metrics Step Count,Heart Rate のようなカンマ区切りの正確な指標名 利用可能なすべての指標
aggregatedata 真偽値。対応する場合は個別測定値に false true
interval none、minutes、hours、days、weeks、months、years none
aggregatesleep 睡眠要約を制御する真偽値 true

metrics、aggregatedata、interval はヘルス指標に適用されます。CSV 選択では要約がオンになります。個別測定値には JSON を使います。リンク生成時は希望する要約を明示してください。

ワークアウト

パラメータ 値または意味 datatype=workouts 時のデフォルト
includeroutes 真偽値 true
includeworkoutmetadata 真偽値 true
workoutsmetadatainterval minutes または seconds。バージョン 2 minutes
workouttypes カンマ区切りの符号なし Apple ワークアウトタイプ識別子 すべての種類

ワークアウトリンクにヘルス指標の集計オプションを含めないでください。

間隔と通知

パラメータ 値または意味 デフォルト
syncinterval minutes、hours、days、weeks minutes
syncquantity 正の整数の間隔数 5
notifyonupdate 真偽値。データ準備後に通知 true
notifywhenrun 真偽値。送信先アクション成功後に通知 true

間隔は バックグラウンドとヘルスデータの制限 の対象であり、正確なスケジュールではありません。

認証とエンコード

headers の値はキーと値が交互に並びます:

headers=Authorization,Bearer%20YOUR_TOKEN,X-API-Key,YOUR_KEY

各キーには値が必要です。カンマがペアを区切るため、このリンク形式ではカンマを含むヘッダー値は避けてください。スペースは %20、プラスは %2B、アンパサンドは %26 にエンコードします。エンドポイント URL に独自のクエリパラメータがある場合は、URL 全体をエンコードします。

例

選択した指標、時間単位で要約

com.HealthExport://automation?url=https%3A%2F%2Fapi.example.com%2Fmetrics&name=Steps%20and%20Heart%20Rate&datatype=healthMetrics&format=json&metrics=Step%20Count,Heart%20Rate&aggregatedata=true&interval=hours

ルート付きワークアウト

com.HealthExport://automation?url=https%3A%2F%2Fapi.example.com%2Fworkouts&name=Workout%20Export&datatype=workouts&format=json&includeroutes=true&includeworkoutmetadata=true&exportversion=v2&workoutsmetadatainterval=minutes

どちらの例も、自動化を確認して有効にするまで自動実行は無効のままです。

トラブルシューティング

  • URL またはパラメータエラー: 最小の URL から始め、スペルとエンコードを確認してから、オプションを個別に追加します。
  • 無効な指標: スペースと大文字小文字を含め、正確な指標名を使います。
  • 集計エラー: ヘルス指標オプションは datatype=healthMetrics でのみ使います。
  • ワークアウト設定エラー: ワークアウトオプションは datatype=workouts で使い、秒グループ化にはバージョン 2 が必要です。
  • バッチエラー: format=json にするか、batchrequests を無効にします。
  • 無効な間隔/タイムアウト: 対応する間隔、正の数量、60〜86400 秒のタイムアウトを使います。
  • URL が長すぎる: 指標/ヘッダーリストを減らすか、残りの設定をアプリで行います。

作成後は REST API — 履歴または漏れたデータをエクスポートする で選択範囲をアップロードするか、設定を確認します。

関連ドキュメント