使用 AMAPI 管理自訂應用程式

您是採用 Android Management API 的 EMM，因此可以遠端管理裝置上的自訂應用程式。包括安裝和解除安裝這些應用程式。如要實現這項功能，請使用 AMAPI SDK 在本機開發擴充應用程式。

必要條件

  • 擴充應用程式已整合 AMAPI SDK。
  • 裝置為全代管裝置。
  • 需要 AMAPI SDK v1.6.0-rc01 以上版本。

1. 準備好應用程式以使用這項功能

1.1. 在擴充應用程式中整合 AMAPI SDK

如要進行自訂應用程式管理程序，您必須在擴充功能應用程式中整合 AMAPI SDK。如要進一步瞭解這個程式庫，以及如何將其新增至應用程式，請參閱 AMAPI SDK 整合指南。

1.2. 更新應用程式資訊清單，支援 FileProvider

  • 如 AMAPI SDK 整合指南所示，將 Android 裝置政策 (ADP) 應用程式的 <queries> 元素新增至 AndroidManifest.xml。
  • 在應用程式的 AndroidManifest.xml 中，於 <application> 標記內實作下列 <provider> 程式碼片段。這個程式碼片段用於儲存檔案，以便分享自訂應用程式 APK，並透過 AMAPI 安裝自訂應用程式。

AndroidManifest.xml：

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="com.example.customapp">
  <queries>
    <package android:name="com.google.android.apps.work.clouddpc" />
  </queries>

  <application>

    <!--This is used to store files when sharing the custom app apk.-->
    <provider
        android:name="com.google.android.managementapi.customapp.provider.CustomAppProvider"
        android:authorities="${applicationId}.AmapiCustomAppProvider"
        android:exported="false"
        android:grantUriPermissions="true">
      <meta-data
          android:name="android.support.FILE_PROVIDER_PATHS"
          android:resource="@xml/file_provider_paths" />
    </provider>
  </application>
</manifest>
  • 在應用程式的 res/xml/ 目錄中建立新的 XML 檔案，其中包含自訂 APK 的儲存路徑。

file_provider_paths.xml：

<?xml version="1.0" encoding="utf-8"?>
<paths xmlns:android="http://schemas.android.com/apk/res/android">
  <cache-path
      name="android_managementapi_custom_apks"
      path="com.google.android.managementapi/customapp/apks/" />
</paths>

2. 與 AMAPI SDK 的自訂應用程式功能整合

2.1. 準備安裝自訂 APK 檔案

部署前，請先準備好應用程式的 APK 檔案，以供安裝。 以下程式碼片段示範這個程序：

Kotlin

import android.net.Uri
import androidx.core.net.Uri
import java.io.File
...
import com.google.android.managementapi.commands.LocalCommandClient
import com.google.android.managementapi.commands.LocalCommandClient.InstallCustomAppCommandHelper
import com.google.android.managementapi.commands.LocalCommandClientFactory

...

fun prepareApkFile(): Uri? {
    // Get the storage location of custom APK files from AM API
    val client: LocalCommandClient = LocalCommandClientFactory.create(context)
    val installCustomAppCommandHelper = client.installCustomAppCommandHelper

    val customApksStorageDir: File = installCustomAppCommandHelper.customApksStorageDirectory ?: return null

    // Once you get hold of the custom APKs storage directory, you must store your custom APK
    // in that location before issuing the install command.
    val customApkFile: File = fetchMyAppToDir(customApksStorageDir) ?: return null
    val customApkFileUri: Uri = customApkFile.toUri()

    return customApkFileUri
}

Java

import android.net.Uri;
import androidx.core.net.Uri;
import java.io.File;
...
import com.google.android.managementapi.commands.LocalCommandClient;
import com.google.android.managementapi.commands.LocalCommandClient.InstallCustomAppCommandHelper;
import com.google.android.managementapi.commands.LocalCommandClientFactory;

...

Uri prepareApkFile() {
  // Get the storage location of custom APK files from AM API
  LocalCommandClient client = LocalCommandClientFactory.create();
  InstallCustomAppCommandHelper installCustomAppCommandHelper = client.getInstallCustomAppCommandHelper();
  File customApksStorageDir = installCustomAppCommandHelper.getCustomApksStorageDirectory();

  // Once you get hold of the custom APKs storage directory, you must store your custom APK
  // in that location before issuing the install command.
  File customApkFile = fetchMyAppToDir(customApksStorageDir);
  Uri customApkFileUri = Uri.fromFile(customApkFile);
  ...
}

2.2. 發出要求安裝自訂應用程式

下列程式碼片段顯示如何發出要求，安裝自訂應用程式：

Kotlin

import android.content.Context
import android.net.Uri
import android.util.Log
import com.google.android.managementapi.commands.LocalCommandClientFactory
import com.google.android.managementapi.commands.model.Command
import com.google.android.managementapi.commands.model.IssueCommandRequest
import com.google.android.managementapi.commands.model.IssueCommandRequest.InstallCustomApp
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.launch
import kotlinx.coroutines.guava.await
import kotlinx.coroutines.withContext
import java.lang.Exception

private const val TAG = "MyClass"

...

    // Requires a file URI of the APK file.
    fun issueInstallCustomAppCommand(packageName: String, fileUri: Uri) {
        coroutineScope.launch {
            try {
                withContext(coroutineScope.coroutineContext) {
                    val result: Command = LocalCommandClientFactory.create(context)
                        .issueCommand(createInstallCustomAppRequest(packageName, fileUri)).await()
                    // Process the returned command result here.
                    Log.i(TAG, "Successfully issued command: $result")
                }
            } catch (t: Exception) {
                Log.e(TAG, "Failed to issue command", t)
                // Handle the exception (e.g., show an error message)
            } finally {
                // Make sure to clean up the apk file after the command is executed.
                cleanUpApkFile(fileUri)
            }
        }
    }

    private fun createInstallCustomAppRequest(packageName: String, fileUri: Uri): IssueCommandRequest {
        return IssueCommandRequest.builder()
            .setInstallCustomApp(
                InstallCustomApp.builder()
                    .setPackageName(packageName)
                    .setPackageUri(fileUri.toString())
                    .build()
            )
            .build()
    }
}

Java

import android.util.Log;
...
import com.google.android.managementapi.commands.LocalCommandClientFactory;
import com.google.android.managementapi.commands.model.Command;
import com.google.android.managementapi.commands.model.GetCommandRequest;
import com.google.android.managementapi.commands.model.IssueCommandRequest;
import com.google.android.managementapi.commands.model.IssueCommandRequest.ClearAppsData;
import com.google.common.collect.ImmutableList;
import com.google.common.util.concurrent.FutureCallback;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.MoreExecutors;

...

  // Requires a file URI of the APK file.
  void issueInstallCustomAppCommand(String packageName, Uri fileUri) {
    Futures.addCallback(
        LocalCommandClientFactory.create(getContext())
            .issueCommand(createInstallCustomAppRequest(packageName, fileUri)),
        new FutureCallback() {
          @Override
          public void onSuccess(Command result) {
            // Process the returned command result here.
            Log.i(TAG, "Successfully issued command");
          }

          @Override
          public void onFailure(Throwable t) {
            Log.e(TAG, "Failed to issue command", t);
          }
        },
        MoreExecutors.directExecutor());
  }

  IssueCommandRequest createInstallCustomAppRequest(String packageName, Uri fileUri) {
    return IssueCommandRequest.builder()
        .setInstallCustomApp(
            InstallCustomApp.builder()
                .setPackageName(packageName)
                .setPackageUri(fileUri.toString())
                .build()
        )
        .build();
  }

2.3. 發出要求來取得已安裝的應用程式

Kotlin

import android.content.Context
import com.google.android.managementapi.device.DeviceClientFactory
import com.google.android.managementapi.device.model.GetDeviceRequest
import kotlinx.coroutines.guava.await

  suspend fun getInstalledApps(context: Context) =
    DeviceClientFactory.create(context)
      .getDevice(GetDeviceRequest.getDefaultInstance())
      .await()
      .getApplicationReports()

Java

import android.content.Context;
import com.google.android.managementapi.device.DeviceClientFactory;
import com.google.android.managementapi.device.model.GetDeviceRequest;
import com.google.android.managementapi.device.model.Device;
import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.MoreExecutors;
import java.util.List;
import java.util.concurrent.Executor;

public ListenableFuture<List> getInstalledApps() {
        ListenableFuture deviceFuture =
            DeviceClientFactory.create(context)
                .getDevice(GetDeviceRequest.getDefaultInstance());

        return Futures.transform(
            deviceFuture,
            Device::getApplicationReports,
            executor // Use the provided executor
        );
    }

3. 為裝置佈建自訂應用程式管理政策

  1. 使用您要管理的自訂應用程式設定 policy。

      {
    "statusReportingSettings": {
      "applicationReportsEnabled": true
    },
    "applications": [
    {
      "signingKeyCerts": [
        {
        "signingKeyCertFingerprintSha256": <sha256 signing key certificate hash value>
        }
      ],
      "packageName": "<emm_extensibility_app>",
      "installType": "AVAILABLE",
      "lockTaskAllowed": true,
      "defaultPermissionPolicy": "GRANT",
      "extensionConfig": {
          "notificationReceiver": "com.example.customapp.NotificationReceiverService"
      }
    },
    {
      "signingKeyCerts": [
        {
        "signingKeyCertFingerprintSha256": <sha256 signing key certificate hash value>
        },
      ],
      "packageName": "<custom_app>",
      "installType": "CUSTOM",
      "lockTaskAllowed": true,
      "defaultPermissionPolicy": "GRANT",
      "customAppConfig": {
    "userUninstallSettings": "DISALLOW_UNINSTALL_BY_USER"
      }
    }
    ]
  }
  ```

  2. 呼叫 enterprises.enrollmentTokens.create，為裝置建立註冊權杖，並將 allowPersonalUsage 設為 PERSONAL_USAGE_DISALLOWED。

  3. 使用註冊權杖，以全代管模式佈建裝置。

  4. 從 Google Play 管理版安裝擴充性應用程式。

  5. 您的擴充性應用程式：

    • 可以下載自訂應用程式的 APK 檔案
    • 可以發出要求，安裝自訂應用程式 (請參閱稍早顯示的程式碼片段)
    • 應該會收到回應

API

伺服器用戶端 API

請參閱下列新欄位和列舉：