このページは Cloud Translation API によって翻訳されました。

エクササイズのルートを追加する

このガイドは、Health Connect バージョン 1.1.0-alpha12 に対応しています。

エクササイズのルートを使用すると、関連するエクササイズアクティビティの GPS ルートを追跡し、ワークアウトのマップを他のアプリと共有できます。

機能の提供状況

ユーザーのデバイスがヘルスコネクトの運動ルートをサポートしているかどうかを判断するには、クライアントで FEATURE_PLANNED_EXERCISE の可用性を確認します。

if (healthConnectClient
     .features
     .getFeatureStatus(
       HealthConnectFeatures.FEATURE_PLANNED_EXERCISE
     ) == HealthConnectFeatures.FEATURE_STATUS_AVAILABLE) {

  // Feature is available
} else {
  // Feature isn't available
}

詳しくは、機能の提供状況を確認するをご覧ください。

このガイドでは、ユーザーに権限をリクエストする方法について説明します。また、エクササイズセッションの一部としてルートデータを書き込む権限をアプリがどのように取得するかについても説明します。

エクササイズのルートの読み取り / 書き込み機能には、次のものが含まれます。

アプリは、エクササイズのルート用の新しい書き込み権限を作成します。
挿入は、ルートをフィールドとしてエクササイズのセッションを書き込むことで行われます。
読み取り:
1. セッションオーナーの場合、セッション読み取りを使用してデータにアクセスします。
2. サードパーティアプリで、ユーザーがルートの 1 回限りの読み取りを許可できるダイアログを表示します。

ユーザーに書き込み権限がなく、ルートが設定されていない場合、ルートは更新されません。

アプリにルート書き込み権限があり、ルートのないセッションオブジェクトを渡してセッションを更新しようとすると、既存のルートが削除されます。

必要な権限

エクササイズルートへのアクセスは、次の権限によって保護されています。

android.permission.health.READ_EXERCISE_ROUTE
android.permission.health.WRITE_EXERCISE_ROUTE

エクササイズのルート機能をアプリに追加するには、まず、ExerciseSession データ型に対する書き込み権限をリクエストします。

エクササイズのルートを記述するために宣言する必要がある権限は次のとおりです。

<application>
  <uses-permission
android:name="android.permission.health.WRITE_EXERCISE_ROUTE" />
...
</application>

エクササイズのルートを読み取るには、次の権限をリクエストする必要があります。

<application>
  <uses-permission
android:name="android.permission.health.READ_EXERCISE_ROUTE" />
...
</application>

また、各ルートはエクササイズセッションに関連付けられているため、エクササイズ権限を宣言する必要があります（1 セッション = 1 ワークアウト）。

権限をリクエストするには、最初にアプリをヘルスコネクトに接続するときに PermissionController.createRequestPermissionResultContract() メソッドを使用します。必要に応じてリクエストする権限は次のとおりです。

健康に関するデータ（ルートデータを含む）の読み取り: HealthPermission.getReadPermission(ExerciseSessionRecord::class)
健康に関するデータ（ルートデータを含む）の書き込み: HealthPermission.getWritePermission(ExerciseSessionRecord::class)
エクササイズのルートデータの書き込み: HealthPermission.PERMISSION_WRITE_EXERCISE_ROUTE

ユーザーに権限をリクエストする

クライアントインスタンスを作成した後、アプリはユーザーに権限をリクエストする必要があります。ユーザーがいつでも権限を付与または拒否できるようにする必要があります。

そのためには、必要なデータ型の権限セットを作成します。まず、セット内の権限が Android マニフェストで宣言されていることを確認します。

// Create a set of permissions for required data types
val PERMISSIONS =
    setOf(
  HealthPermission.getReadPermission(ExerciseSessionRecord::class),
  HealthPermission.getWritePermission(ExerciseSessionRecord::class)
)

getGrantedPermissions を使用して、アプリが必要な権限をすでに持っているかどうかを確認します。持っていない場合は、createRequestPermissionResultContract を使用して権限をリクエストします。ヘルスコネクトの権限画面が表示されます。

// Create the permissions launcher
val requestPermissionActivityContract = PermissionController.createRequestPermissionResultContract()

val requestPermissions = registerForActivityResult(requestPermissionActivityContract) { granted ->
  if (granted.containsAll(PERMISSIONS)) {
    // Permissions successfully granted
  } else {
    // Lack of required permissions
  }
}

suspend fun checkPermissionsAndRun(healthConnectClient: HealthConnectClient) {
  val granted = healthConnectClient.permissionController.getGrantedPermissions()
  if (granted.containsAll(PERMISSIONS)) {
    // Permissions already granted; proceed with inserting or reading data
  } else {
    requestPermissions.launch(PERMISSIONS)
  }
}

ユーザーはいつでも権限を付与または取り消すことができるため、アプリは許可されている権限を定期的に確認し、権限がなくなっている場合に対処できるようにする必要があります。

エクササイズセッションの記録に含まれる情報

各エクササイズセッションレコードには、次の情報が含まれます。

エクササイズの種類（サイクリングなど）。
エクササイズのルート。緯度、経度、高度などの情報が含まれます。

サポートされている集計

このデータ型でサポートされている集計はありません。

使用例

次のコードスニペットは、エクササイズルートを読み書きする方法を示しています。

エクササイズのルートの読み込み

次のコードスニペットは、ヘルスコネクトでセッションを読み取り、そのセッションからルートをリクエストする方法を示しています。

suspend fun readExerciseSessionAndRoute() {
    val endTime = Instant.now()
    val startTime = endTime.minus(Duration.ofHours(1))

    val grantedPermissions =
        healthConnectClient.permissionController.getGrantedPermissions()
    if (!grantedPermissions.contains(
          HealthPermission.getReadPermission(ExerciseSessionRecord::class))) {
        // The user doesn't allow the app to read exercise session data.
        return
    }

    val readResponse =
      healthConnectClient.readRecords(
        ReadRecordsRequest(
          ExerciseSessionRecord::class,
          TimeRangeFilter.between(startTime, endTime)
        )
      )
    val exerciseRecord = readResponse.records.first()
    val recordId = exerciseRecord.metadata.id

    // See https://developer.android.com/training/basics/intents/result#launch
    // for appropriately handling ActivityResultContract.
    val requestExerciseRouteLauncher = fragment.registerForActivityResul
    (ExerciseRouteRequestContract()) { exerciseRoute: ExerciseRoute? ->
            if (exerciseRoute != null) {
                displayExerciseRoute(exerciseRoute)
            } else {
                // Consent was denied
            }
        }

    val exerciseSessionRecord =
      healthConnectClient.readRecord(ExerciseSessionRecord::class, recordId).record

    when (val exerciseRouteResult = exerciseSessionRecord.exerciseRouteResult) {
        is ExerciseRouteResult.Data ->
            displayExerciseRoute(exerciseRouteResult.exerciseRoute)
        is ExerciseRouteResult.ConsentRequired ->
            requestExerciseRouteLauncher.launch(recordId)
        is ExerciseRouteResult.NoData -> Unit // No exercise route to show
        else -> Unit
    }
  }

  fun displayExerciseRoute(route: ExerciseRoute?) {
    val locations = route.route.orEmpty()
    for (location in locations) {
      // Handle location.
    }
  }

エクササイズのルートを書き込む

次のコードはエクササイズのルートを含むセッションを記録する方法を示しています。

suspend fun InsertExerciseRoute(healthConnectClient: HealthConnectClient) {
    val grantedPermissions =
        healthConnectClient.permissionController.getGrantedPermissions()
    if (!grantedPermissions.contains(
          getWritePermission(ExerciseSessionRecord::class))) {
        // The user doesn't allow the app to write exercise session data.
        return
    }

    val sessionStartTime = Instant.now()
    val sessionDuration = Duration.ofMinutes(20)
    val sessionEndTime = sessionStartTime.plus(sessionDuration)

    val exerciseRoute =
        if (grantedPermissions.contains(PERMISSION_WRITE_EXERCISE_ROUTE)) ExerciseRoute(
            listOf(
                ExerciseRoute.Location(
                    // Location times must be on or after the session start time
                    time = sessionStartTime,
                    latitude = 6.5483,
                    longitude = 0.5488,
                    horizontalAccuracy = Length.meters(2.0),
                    verticalAccuracy = Length.meters(2.0),
                    altitude = Length.meters(9.0),
                ), ExerciseRoute.Location(
                    // Location times must be before the session end time
                    time = sessionEndTime.minusSeconds(1),
                    latitude = 6.4578,
                    longitude = 0.6577,
                    horizontalAccuracy = Length.meters(2.0),
                    verticalAccuracy = Length.meters(2.0),
                    altitude = Length.meters(9.2),
                )
            )
        )
        else
        // The user doesn't allow the app to write exercise route data.
            null
    val exerciseSessionRecord = ExerciseSessionRecord(
        startTime = sessionStartTime,
        startZoneOffset = ZoneOffset.UTC,
        endTime = sessionEndTime,
        endZoneOffset = ZoneOffset.UTC,
        exerciseType = ExerciseSessionRecord.EXERCISE_TYPE_BIKING,
        title = "Morning Bike Ride",
        exerciseRoute = exerciseRoute,
        metadata = Metadata.manualEntry(
            device = Device(type = Device.TYPE_PHONE)
        ),
    )
    val response = healthConnectClient.insertRecords(listOf(exerciseSessionRecord))
}

エクササイズセッション

エクササイズセッションには、ランニングからバドミントンまでさまざまなものがあります。

エクササイズセッションを作成する

セッションを含む挿入リクエストの作成方法は以下のとおりです。

suspend fun writeExerciseSession(healthConnectClient: HealthConnectClient) {
    healthConnectClient.insertRecords(
        listOf(
            ExerciseSessionRecord(
                startTime = START_TIME,
                startZoneOffset = START_ZONE_OFFSET,
                endTime = END_TIME,
                endZoneOffset = END_ZONE_OFFSET,
                exerciseType = ExerciseSessionRecord.ExerciseType.RUNNING,
                title = "My Run"
            ),
            // ... other records
        )
    )
}

エクササイズセッションを読み取る

以下はエクササイズセッションを読み取る方法の例です。

suspend fun readExerciseSessions(
    healthConnectClient: HealthConnectClient,
    startTime: Instant,
    endTime: Instant
) {
    val response =
        healthConnectClient.readRecords(
            ReadRecordsRequest(
                ExerciseSessionRecord::class,
                timeRangeFilter = TimeRangeFilter.between(startTime, endTime)
            )
        )
    for (exerciseRecord in response.records) {
        // Process each exercise record
        // Optionally pull in with other data sources of the same time range.
        val distanceRecord =
            healthConnectClient
                .readRecords(
                    ReadRecordsRequest(
                        DistanceRecord::class,
                        timeRangeFilter =
                            TimeRangeFilter.between(
                                exerciseRecord.startTime,
                                exerciseRecord.endTime
                            )
                    )
                )
                .records
    }
}

サブタイプデータを作成する

セッションを必須ではないサブタイプデータで構成することもできます。このような追加情報により、セッションの内容を詳しく記録できます。

たとえば、エクササイズセッションには ExerciseSegment クラス、ExerciseLap クラス、ExerciseRoute クラスを含められます。

val segments = listOf(
  ExerciseSegment(
    startTime = Instant.parse("2022-01-02T10:10:10Z"),
    endTime = Instant.parse("2022-01-02T10:10:13Z"),
    segmentType = ActivitySegmentType.BENCH_PRESS,
    repetitions = 373
  )
)

val laps = listOf(
  ExerciseLap(
    startTime = Instant.parse("2022-01-02T10:10:10Z"),
    endTime = Instant.parse("2022-01-02T10:10:13Z"),
    length = 0.meters
  )
)

ExerciseSessionRecord(
  exerciseType = ExerciseSessionRecord.EXERCISE_TYPE_CALISTHENICS,
    startTime = Instant.parse("2022-01-02T10:10:10Z"),
    endTime = Instant.parse("2022-01-02T10:10:13Z"),
  startZoneOffset = ZoneOffset.UTC,
  endZoneOffset = ZoneOffset.UTC,
  segments = segments,
  laps = laps,
  route = route
)

エクササイズセッションを削除する

エクササイズセッションを削除する方法には次の 2 つがあります。

期間別
UID 別

期間に応じてサブタイプデータを削除する方法は以下のとおりです。

suspend fun deleteExerciseSessionByTimeRange(
    healthConnectClient: HealthConnectClient,
    exerciseRecord: ExerciseSessionRecord,
) {
    val timeRangeFilter = TimeRangeFilter.between(exerciseRecord.startTime, exerciseRecord.endTime)
    healthConnectClient.deleteRecords(ExerciseSessionRecord::class, timeRangeFilter)
    // delete the associated distance record
    healthConnectClient.deleteRecords(DistanceRecord::class, timeRangeFilter)
}

UID ごとにサブタイプデータを削除することもできます。この操作で削除されるのはエクササイズセッションのみで、関連データは削除されません。

suspend fun deleteExerciseSessionByUid(
    healthConnectClient: HealthConnectClient,
    exerciseRecord: ExerciseSessionRecord,
) {
    healthConnectClient.deleteRecords(
        ExerciseSessionRecord::class,
        recordIdsList = listOf(exerciseRecord.metadata.id),
        clientRecordIdsList = emptyList()
    )
}

エクササイズのルートを追加する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

機能の提供状況

必要な権限

ユーザーに権限をリクエストする

エクササイズ セッションの記録に含まれる情報

サポートされている集計

使用例

エクササイズのルートの読み込み

エクササイズのルートを書き込む

エクササイズ セッション

エクササイズ セッションを作成する

エクササイズ セッションを読み取る

サブタイプ データを作成する

エクササイズ セッションを削除する