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

ユーザーが開始するデータ転送

長時間かかる可能性のあるデータ転送を実行する必要がある場合は、JobScheduler ジョブを作成し、ユーザーが開始したデータ転送（UIDT）ジョブとして識別できます。UIDT ジョブは、デバイスユーザーが開始するデータ転送（リモートサーバーからのファイルのダウンロードなど）で、転送に時間がかかることが予想される場合を想定しています。UIDT ジョブは Android 14（API レベル 34）で導入されました。

ユーザーが開始するデータ転送ジョブは、ユーザーによって開始されます。これらのジョブは通知を必要とし、直ちに開始されるとともに、システム条件が許せば実行時間が延長される可能性があります。ユーザーが開始するデータ転送ジョブは、同時に複数実行できます。

ユーザーが開始するジョブのスケジュールは、アプリがユーザーに表示されている状態（または許可された条件のいずれかで）設定される必要があります。システムの健全性に関わる制約にもよりますが、すべての制約が満たされていれば、ユーザーが開始するジョブは OS で実行できます。また、システムは提供された推定ペイロードサイズを使用して、ジョブの実行にかかる時間を推定することもできます。

ユーザーが開始するデータ転送ジョブのスケジュールを設定する

如需运行用户发起的数据传输作业，请执行以下操作：

确保您的应用已在其清单中声明 JobService 和关联的权限：

<service android:name="com.example.app.CustomTransferService"
        android:permission="android.permission.BIND_JOB_SERVICE"
        android:exported="false">
        ...
</service>

此外，还要为数据转移定义 JobService 的具体子类：

Kotlin

class CustomTransferService : JobService() {
  ...
}

Java

class CustomTransferService extends JobService() {

    ....

}

在清单中声明 RUN_USER_INITIATED_JOBS 权限：

<manifest ...>
    <uses-permission android:name="android.permission.RUN_USER_INITIATED_JOBS" />
    <application ...>
        ...
    </application>
</manifest>

构建 JobInfo 对象时，调用 setUserInitiated() 方法。（此方法从 Android 14 开始提供。）我们还建议您在创建作业时通过调用 setEstimatedNetworkBytes() 提供载荷大小估算值。

Kotlin

val networkRequestBuilder = NetworkRequest.Builder()
        // Add or remove capabilities based on your requirements.
        // For example, this code specifies that the job won't run
        // unless there's a connection to the internet (not just a local
        // network), and the connection doesn't charge per-byte.
        .addCapability(NET_CAPABILITY_INTERNET)
        .addCapability(NET_CAPABILITY_NOT_METERED)
        .build()

val jobInfo = JobInfo.Builder(jobId,
              ComponentName(mContext, CustomTransferService::class.java))
        // ...
        .setUserInitiated(true)
        .setRequiredNetwork(networkRequestBuilder)
        // Provide your estimate of the network traffic here
        .setEstimatedNetworkBytes(1024 * 1024 * 1024, 1024 * 1024 * 1024)
        // ...
        .build()

Java

NetworkRequest networkRequest = new NetworkRequest.Builder()
    // Add or remove capabilities based on your requirements.
    // For example, this code specifies that the job won't run
    // unless there's a connection to the internet (not just a local
    // network), and the connection doesn't charge per-byte.
    .addCapability(NET_CAPABILITY_INTERNET)
    .addCapability(NET_CAPABILITY_NOT_METERED)
    .build();

JobInfo jobInfo = JobInfo.Builder(jobId,
        new ComponentName(mContext, CustomTransferService.class))
    // ...
    .setUserInitiated(true)
    .setRequiredNetwork(networkRequest)
    // Provide your estimate of the network traffic here
    .setEstimatedNetworkBytes(1024 * 1024 * 1024, 1024 * 1024 * 1024)
    // ...
    .build();

在作业执行期间，对 JobService 对象调用 setNotification()。调用 setNotification() 会在任务管理器和状态栏通知区域中告知用户作业正在运行。

执行完成后，调用 jobFinished() 以向系统表明作业已完成，或者应重新调度作业。

Kotlin

class CustomTransferService: JobService() {
    private val scope = CoroutineScope(Dispatchers.IO)

    @RequiresApi(Build.VERSION_CODES.UPSIDE_DOWN_CAKE)
    override fun onStartJob(params: JobParameters): Boolean {
        val notification = Notification.Builder(applicationContext,
                              NOTIFICATION_CHANNEL_ID)
            .setContentTitle("My user-initiated data transfer job")
            .setSmallIcon(android.R.mipmap.myicon)
            .setContentText("Job is running")
            .build()

        setNotification(params, notification.id, notification,
                JobService.JOB_END_NOTIFICATION_POLICY_DETACH)
        // Execute the work associated with this job asynchronously.
        scope.launch {
            doDownload(params)
        }
        return true
    }

    private suspend fun doDownload(params: JobParameters) {
        // Run the relevant async download task, then call
        // jobFinished once the task is completed.
        jobFinished(params, false)
    }

    // Called when the system stops the job.
    override fun onStopJob(params: JobParameters?): Boolean {
        // Asynchronously record job-related data, such as the
        // stop reason.
        return true // or return false if job should end entirely
    }
}

Java

class CustomTransferService extends JobService{
    @RequiresApi(Build.VERSION_CODES.UPSIDE_DOWN_CAKE)
    @Override
    public boolean onStartJob(JobParameters params) {
        Notification notification = Notification.Builder(getBaseContext(),
                                        NOTIFICATION_CHANNEL_ID)
                .setContentTitle("My user-initiated data transfer job")
                .setSmallIcon(android.R.mipmap.myicon)
                .setContentText("Job is running")
                .build();

        setNotification(params, notification.id, notification,
                          JobService.JOB_END_NOTIFICATION_POLICY_DETACH)
        // Execute the work associated with this job asynchronously.
        new Thread(() -> doDownload(params)).start();
        return true;
    }

    private void doDownload(JobParameters params) {
        // Run the relevant async download task, then call
        // jobFinished once the task is completed.
        jobFinished(params, false);
    }

    // Called when the system stops the job.
    @Override
    public boolean onStopJob(JobParameters params) {
        // Asynchronously record job-related data, such as the
        // stop reason.
        return true; // or return false if job should end entirely
    }
}

定期更新通知，让用户了解作业的状态和进度。如果在安排作业之前无法确定传输大小，或者需要更新估计的传输大小，请在知道传输大小之后使用新的 API updateEstimatedNetworkBytes() 更新传输大小。

建议

如需有效运行 UIDT 作业，请执行以下操作：

明确定义网络限制和作业执行限制，以指定作业的执行时间。
在 onStartJob() 中异步执行任务；例如，您可以使用协程来执行此操作。如果您不异步运行任务，工作将在主线程上运行，可能会阻塞主线程，从而导致 ANR。
为避免作业运行时间过长，请在转移完成后（无论成功还是失败）调用 jobFinished()。这样，作业就不会运行过长时间。如需了解作业停止的原因，请实现 onStopJob() 回调方法并调用 JobParameters.getStopReason()。

下位互換性

現在、UIDT ジョブをサポートする Jetpack ライブラリはありません。そのため、Android 14 以降で実行されていることを確認するコードで変更をゲートすることをおすすめします。Android の古いバージョンでは、フォールバックアプローチとして WorkManager のフォアグラウンドサービス実装を使用できます。

適切なシステムバージョンを確認するコードの例を次に示します。

Kotlin

fun beginTask() {
    if (Build.VERSION.SDK_INT < Build.VERSION_CODES.UPSIDE_DOWN_CAKE) {
        scheduleDownloadFGSWorker(context)
    } else {
        scheduleDownloadUIDTJob(context)
    }
}

private fun scheduleDownloadUIDTJob(context: Context) {
    // build jobInfo
    val jobScheduler: JobScheduler =
        context.getSystemService(Context.JOB_SCHEDULER_SERVICE) as JobScheduler
    jobScheduler.schedule(jobInfo)
}

private fun scheduleDownloadFGSWorker(context: Context) {
    val myWorkRequest = OneTimeWorkRequest.from(DownloadWorker::class.java)
    WorkManager.getInstance(context).enqueue(myWorkRequest)
}

Java

public void beginTask() {
    if (Build.VERSION.SDK_INT < Build.VERSION_CODES.UPSIDE_DOWN_CAKE) {
        scheduleDownloadFGSWorker(context);
    } else {
        scheduleDownloadUIDTJob(context);
    }
}

private void scheduleDownloadUIDTJob(Context context) {
    // build jobInfo
    JobScheduler jobScheduler =
            (JobScheduler) context.getSystemService(Context.JOB_SCHEDULER_SERVICE);
    jobScheduler.schedule(jobInfo);
}

private void scheduleDownloadFGSWorker(Context context) {
    OneTimeWorkRequest myWorkRequest = OneTimeWorkRequest.from(DownloadWorker.class);
    WorkManager.getInstance(context).enqueue(myWorkRequest)
}

UIDT ジョブを停止する

ユーザーとシステムの両方が、ユーザーが開始した転送ジョブを停止できます。

ユーザーがタスクマネージャーから停止

ユーザーは、タスクマネージャーに表示されるユーザーが開始したデータ転送ジョブを停止できます。

ユーザーが [停止] を押すと、以下の処理が行われます。

アプリのプロセス（実行中の他のすべてのジョブまたはフォアグラウンドサービスを含む）をすぐに終了します。
実行中のジョブについて onStopJob() を呼び出しません。
ユーザーに表示されるジョブのスケジュール変更が行われないようにします。

そのため、ジョブを正常に停止してスケジュールを変更できるように、ジョブに関して送信された通知でコントロールを提供することをおすすめします。

なお、特別な状況では、タスクマネージャーのジョブの横に [停止] ボタンが表示されないか、タスクマネージャーにジョブがまったく表示されません。

システムによる停止

与常规作业不同，用户发起的数据传输作业不受应用待机模式存储分区配额的影响。但是，如果出现以下任一情况，系统仍会停止作业：

不再满足开发者定义的约束条件。
系统确定该作业的运行时间超出了完成数据传输任务所需的时间。
系统需要优先考虑系统运行状况，并因发热程度上升而停止作业。
应用进程因设备内存不足而被终止。

如果系统因设备内存不足以外的原因停止作业，系统会调用 onStopJob()，并在系统认为最佳的时间重试作业。确保您的应用可以保留数据传输状态（即使未调用 onStopJob()），并且您的应用可以在再次调用 onStartJob() 时恢复此状态。

ユーザーが開始するデータ転送ジョブのスケジュールを設定できる条件

アプリがユーザー開始型データ転送ジョブを開始できるのは、アプリが可視ウィンドウ内にある場合、または次の特定の条件を満たしている場合のみです。

アプリがバックグラウンドからアクティビティを開始できる場合、ユーザー開始型データ転送ジョブもバックグラウンドから開始できます。
アプリのアクティビティが [最近] 画面の既存タスクのバックスタックにあるだけでは、ユーザー開始型データ転送ジョブを実行することはできません。

必要な条件が満たされていないタイミングでジョブの実行がスケジュールされている場合、ジョブは失敗し、RESULT_FAILURE エラーコードが返されます。

ユーザーが開始するデータ転送ジョブで許可される制約

Android には、最適なポイントで実行されるジョブをサポートするために、ジョブタイプごとに制約を割り当てる機能があります。これらの制約は、Android 13 以降で利用できます。

注: 次の表では、ジョブタイプによって異なる制約のみを比較しています。すべての制約については、JobScheduler のデベロッパーページまたは処理の制約をご覧ください。

次の表に、特定のジョブ制約をサポートするさまざまなジョブタイプと、WorkManager がサポートするジョブ制約のセットを示します。表の前の検索バーを使用して、ジョブ制約メソッドの名前で表をフィルタできます。

ユーザーが開始するデータ転送ジョブで許可される制約は次のとおりです。

setBackoffCriteria(JobInfo.BACKOFF_POLICY_EXPONENTIAL)
setClipData()
setEstimatedNetworkBytes()
setMinimumNetworkChunkBytes()
setPersisted()
setNamespace()
setRequiredNetwork()
setRequiredNetworkType()
setRequiresBatteryNotLow()
setRequiresCharging()
setRequiresStorageNotLow()

テスト

下面列出了有关如何手动测试应用作业的一些步骤：

如需获取作业 ID，请获取在构建作业时定义的值。
如需立即运行作业或重试已停止的作业，请在终端窗口中运行以下命令：
```
adb shell cmd jobscheduler run -f APP_PACKAGE_NAME JOB_ID
```
如需模拟系统强行停止作业（由于系统运行状况或超出配额条件），请在终端窗口中运行以下命令：
```
adb shell cmd jobscheduler timeout TEST_APP_PACKAGE TEST_JOB_ID
```

参考情報

ユーザーが開始したデータ転送の詳細については、次のリソースをご覧ください。

UIDT 統合に関する事例紹介: Google マップはユーザーが開始したデータ転送 API を使用してダウンロードの信頼性を 10% 向上させました

ユーザーが開始するデータ転送 コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

ユーザーが開始するデータ転送ジョブのスケジュールを設定する

Kotlin

Java

Kotlin

Java

Kotlin

Java

建议

下位互換性

Kotlin

Java

UIDT ジョブを停止する

ユーザーがタスク マネージャーから停止

システムによる停止

ユーザーが開始するデータ転送ジョブのスケジュールを設定できる条件

ユーザーが開始するデータ転送ジョブで許可される制約

テスト

関連ドキュメント

参考情報

ユーザーが開始するデータ転送

ユーザーがタスクマネージャーから停止