Runtime-fähiges SDK erstellen und nutzen

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

Test-App erstellen und konfigurieren

In diesem Abschnitt wird erläutert, wie Sie eine App einrichten und vorbereiten, um ein SDK mit Laufzeitfunktion für lokale Tests zu verwenden.

App vorbereiten

Erstellen Sie zuerst ein separates eigenständiges Projekt oder Modul.

In diesem Szenario enthält die App nicht den SDK-Code, sondern deklariert ihn stattdessen als Maven-Abhängigkeit.

Wenn Sie eine App entwickeln, die ein Runtime Enabled SDK verwendet, benötigen Sie Android Studio Ladybug Canary 1 oder höher und das Android Gradle-Plug-in (AGP) 8.7.0-alpha01 oder höher.

  1. Führen Sie dieselben Schritte wie oben beschrieben aus, um Ihre Entwicklungsumgebung und das Gerät/den Emulator für Tests einzurichten.
  2. Aktivieren Sie die SDK Runtime mit dem Flag, das in Schritt 3:SDK-Abschnitt vorbereiten beschrieben wird.

    # This enables the Privacy Sandbox for your project on Android Studio.
    android.experimental.privacysandboxsdk.enable=true
    android.experimental.privacysandboxsdk.requireServices=false
    
  3. Fügen Sie die Maven-URL der Privacy Sandbox in die build.gradle-Datei auf oberster Ebene Ihres Projekts ein.

        allprojects {
            repositories {
                google()
                maven {
                    url "https://maven.privacysandbox.com/v1/repository"
                    }
                }
            }
    
  4. Behalten Sie die Maven-Abhängigkeit vom vorhandenen Maven-Ziel der Anzeigenbibliothek (Ihrem laufzeitfähigen SDK) bei.

  5. Fügen Sie der Datei „build.gradle“ des Projekts einen „privacySandbox“-Block mit einer Abhängigkeit von der SDK-Bibliothek hinzu und legen Sie „enable“ auf „true“ fest.

    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. Die App kann jetzt die APIs des SDK auf dieselbe Weise verwenden, wie im Abschnitt zur API-Nutzung beschrieben.

App erstellen

Sie können Ihre Apps wie gewohnt als Android App Bundle (AAB) erstellen.

SDK lokal testen

Wenn Sie Ihre Test-App ausführen möchten, installieren Sie das SDK mit aktivierter Laufzeit und die App mit Android Studio auf Ihrem Testgerät oder Emulator.

  1. Öffnen Sie das Android Studio-Projekt für Ihre Test-App.
  2. Rufen Sie Run > Edit Configurations auf. Das Konfigurationsfenster „Run/Debug“ (Ausführen/Debuggen) wird angezeigt. Sie können als „Standard-APK“ oder „APK aus Bundle“ bereitstellen.
  3. Legen Sie unter Startoptionen die Option Starten auf Angegebene Aktivität fest.
  4. Klicken Sie neben Aktivität auf das Dreipunkt-Menü und wählen Sie die Hauptaktivität für Ihren Kunden aus.
  5. Klicken Sie auf Übernehmen und dann auf OK.
  6. Klicken Sie auf Run (Ausführen), um die Client-App und das SDK auf Ihrem Testgerät zu installieren.

SDK für die Verteilung erstellen

Sie müssen Ihr SDK als Android SDK-Bundle (ASB) erstellen, bevor Sie es in einem App-Store veröffentlichen können. ASB ist ein nicht signiertes Veröffentlichungspaket, das Android App Bundles entspricht.

Das ASB oder das davon abgeleitete Android SDK-Archiv (ASAR) wird zusammen mit dem AAB der App von Bundletool in eine Reihe von installierbaren APKs umgewandelt. App-Entwickler können Bundletool direkt in Android Studio (derzeit Canary-Version) verwenden, um alle APK-Varianten auszugeben.

Bundletool nimmt ein AAB und ein ASB entgegen und kann eine Reihe von APK-Varianten ausgeben:

  1. Ein APK, das für die Ausführung im abwärtskompatiblen SDK-Laufzeitmodus für Geräte erstellt wurde, die nicht mit der SDK-Laufzeit kompatibel sind (Android 13 und niedriger). Dieses APK enthält den gesamten Code, der sowohl für die App als auch für das SDK erforderlich ist.
  2. Eine APK, die für den SDK-Laufzeitmodus für Geräte entwickelt wurde, die mit der SDK-Laufzeit (Android 14 und höher) kompatibel sind. Dieses APK enthält nur den App-Code mit API-Stubs für das laufzeitfähige SDK.
  3. Das SDK-APK mit dem SDK-Code, der zur Laufzeit aktiviert wird. Es soll vor dem App-APK installiert werden, das im vorherigen Schritt beschrieben wurde.

Sie haben zwei Möglichkeiten, ein ASB zu erstellen:

  • Android Studio
    1. Erstellen Sie Ihr Projekt. Dazu können Sie das Projekt mit Build > Rebuild neu erstellen.
    2. Die ASB-Datei befindet sich in Ihrem laufzeitfähigen ASB-Modul unter build/outputs/asb/single/<your-asb-module-name>.asb.
  • Befehlszeile von Bundletool: Folgen Sie dieser Anleitung.

Das SDK muss mit einem Upload-Schlüssel signiert werden, bevor Sie es veröffentlichen können. Verwenden Sie diesen Uploadschlüssel, um Ihr ASB für den Upload in die SDK Console zu signieren. Google verwendet das Uploadzertifikat, um Ihre Identität zu bestätigen.

Die folgenden Schritte geben einen Überblick darüber, was Sie tun müssen, um Ihr ASB zu signieren:

  1. Erstellen Sie einen Schlüsselspeicher und einen Uploadschlüssel. Das ist identisch mit dem Generieren eines Schlüsselspeichers und Uploadschlüssels für Apps.
  2. Signieren Sie Ihr ASB mit dem Uploadschlüssel. Fügen Sie dazu Ihrer build.gradle-Datei einen signingConfig-Block hinzu, in dem Sie den neu erstellten Schlüssel und den Keystore angeben:
android {
  signingConfig {
    storeFile file(path-to-keystore.jks)
    storePassword "keystorePassword"
    keyAlias "UploadKey"
    keyPassword "keyPassword"
  }
}

App-Shops können unterschiedliche Strategien entwickeln, um diese Komponenten zur Unterstützung der Laufzeit-fähigen App-Verteilung zu verwenden. SDK Runtime arbeitet kontinuierlich mit App-Stores zusammen, um die Unterstützung für laufzeitfähige SDKs zu erweitern.

Schritt 4: Laufzeitfähiges SDK verwenden