构建和使用支持运行时的 SDK

1
 Key concepts
2
 Set up your development environment
3
 Build an RE SDK
4
 Consume the RE SDK
5
 Testing, and building for distribution

构建和配置测试应用

本部分将介绍如何设置和准备应用，以使用已启用运行时的 SDK 进行本地测试。

准备应用

首先，创建一个单独的独立项目或模块。

在这种情况下，应用不包含 SDK 代码，而是将其声明为 Maven 依赖项。

构建使用已启用运行时的 SDK 的应用需要 Android Studio Ladybug Canary 1 或更高版本，以及 Android Gradle 插件 (AGP) 8.7.0-alpha01 或更高版本。

  1. 按照前面所述的相同步骤设置开发环境和用于测试的设备/模拟器。

  2. 使用第 3 步：准备 SDK 部分中所述的标志启用 SDK 运行时。

    # This enables the Privacy Sandbox for your project on Android Studio.
android.experimental.privacysandboxsdk.enable=true
android.experimental.privacysandboxsdk.requireServices=false

  3. 将 Privacy Sandbox Maven 网址添加到项目的顶级 build.gradle 文件中。

        allprojects {
        repositories {
            google()
            maven {
                url "https://maven.privacysandbox.com/v1/repository"
                }
            }
        }

  4. 保留对现有广告库（您的运行时感知 SDK）Maven 制品的 Maven 依赖项。

  5. 向项目 build.gradle 添加一个 privacySandbox 代码块，其中包含对 SDK 库的依赖项，并将 enable 设置为 true

    plugins {
    id 'com.android.application'
    id 'org.jetbrains.kotlin.android'
}

android {
    //...
    privacySandbox {
        enable true
    }
    //...
}

dependencies {
    // SDK library dependency
    implementation(<maven coordinates to SDK library>)
}

  6. 现在，应用可以按照 API 使用部分中所述的方式使用 SDK 的 API。

构建应用

您可以像往常一样将应用构建为 Android App Bundle (AAB)。

在本地测试 SDK

如需运行测试应用，请使用 Android Studio 将已启用运行时的 SDK 和应用安装到测试设备或模拟器上。

  1. 打开测试应用的 Android Studio 项目。
  2. 依次进入 Run > Edit Configurations。系统会显示“Run/Debug”配置窗口。您可以部署为“默认 APK”或“来自 Bundle 的 APK”。
  3. 在 Launch Options 下，将 Launch 设为 Specspecified Activity。
  4. 点击活动旁边的三点状菜单，然后为您的客户端选择 Main Activity。
  5. 点击 Apply，然后点击 OK。
  6. 点击 Run 以在测试设备上安装客户端应用和 SDK。

构建 SDK 以进行分发

您需要先将 SDK 构建为 Android SDK Bundle (ASB)，然后才能将其发布到应用商店。ASB 是一种未签名的发布软件包，相当于 Android App Bundle。

ASB 或其衍生产品 Android SDK 归档 (ASAR) 与应用的 AAB 一起由 Bundletool 转换为一组可安装的 APK。应用开发者可以直接在 Android Studio（目前为 Canary 版）中使用 BundleTool 来输出所有 APK 变体。

Bundletool 接受 AAB 和 ASB，并可输出一组 APK 变体：

  1. 为在 SDK 运行时向后兼容模式下运行而构建的 APK，适用于与 SDK 运行时（Android 13 及更低版本）不兼容的设备。此 APK 包含应用和 SDK 所需的所有代码。
  2. 为在与 SDK 运行时兼容的设备（Android 14 及更高版本）上运行 SDK 运行时模式而构建的 APK。此 APK 仅包含应用代码，以及支持运行时的 SDK 的 API 桩。
  3. 包含支持运行时的 SDK 代码的 SDK APK，旨在安装在上一步中所述的应用 APK 之前。

您可以通过以下两种方式构建 ASB：

  • Android Studio
    1. 构建项目。您可以通过调用 Build > Rebuild 项目来完成此操作。
    2. ASB 文件位于启用运行时的 ASB 模块中的 build/outputs/asb/single/<your-asb-module-name>.asb 下
  • Bundletool 的命令行 - 请按照这些说明操作。

必须先使用上传密钥为 SDK 签名，然后才能发布。使用此上传密钥为 ASB 签名，以便上传到 SDK 控制台。Google 会使用该上传证书验证您的身份。

以下步骤简要介绍了您需要执行哪些操作才能为 ASB 签名：

  1. 生成密钥库和上传密钥。这与为应用生成密钥库和上传密钥完全相同。
  2. 使用上传密钥为 ASB 签名。为此，请向 build.gradle 文件添加 signingConfig 块，以指定新创建的密钥和密钥库：
android {
  signingConfig {
    storeFile file(path-to-keystore.jks)
    storePassword "keystorePassword"
    keyAlias "UploadKey"
    keyPassword "keyPassword"
  }
}

应用商店可以制定不同的策略来使用这些组件，以支持启用运行时应用分发。SDK 运行时会不断与应用商店合作，以扩大对支持运行时的 SDK 的支持范围。

第 4 步：使用启用运行时功能的 SDK