Migrating dev-preview-main into main

Author: notmariazoe

PrivacySandboxKotlin/README.md

@@ -13,29 +13,46 @@ and can follow the commands described in this README as is. For OEMs to use the
 flavor, you will need to update the "Preview" part of the commands to "Oems", all other instructions
 are the same.
 
-## Running the Sample
+## Defining the SDK API
+The SDK running in the Privacy Sandbox needs a public API defined with Kotlin interfaces and
+annotated with Privacy Sandbox tool annotations. This allows us to generate an SDK provider that
+compatible with your custom interfaces. To use it just extend `AbstractSandboxedSdkProviderCompat`,
+it will be generated in the same package that defined the `@PrivacySandboxService` interface.
 
-The Privacy Sandbox should have a class which extends `SandboxedSdkProvider`.
-This class works as an entry point for the sandbox to interact with the SDK.
-The Privacy Sandbox SDK provider library is implemented in the `sdk-implementation` module.
+## Running the Sample
+The sample contains a working SDK in the `example-sdk` module. The SDK is bundled for release and
+app consumption in the `example-sdk-bundle` module, this is where the SDK version, package name and
+signing information is defined.
 
-The client app is implemented in the `client-app` module. This app interacts with the SDK running
-in the Privacy Sandbox.
+The client app is implemented in the `client-app` module. The `existing-sdk` module represents a
+modified version of a regular SDK that runs in the app as usual but is also capable of loading and
+interacting with the example SDK.
 
 There are two methods for building and installing the SDK. The preferred option is use Android
-Studio's UI to handle building and deploying the SDK and launching the client app. However, it is 
+Studio's UI to handle building and deploying the SDK and launching the client app. However, it is
 possible to build the app bundle and install the APK via the command line, then run the client app.
 
-### From the UI
+### Setting up your device
+You will need to override a few flags to get the Privacy Sandbox enabled on your device. Before
+installing the app, run the following commands:
+
+```shell
+adb shell device_config put adservices adservice_system_service_enabled false
+adb shell device_config put adservices global_kill_switch false
+adb shell device_config put adservices disable_sdk_sandbox false
+adb shell device_config put adservices sdksandbox_customized_sdk_context_enabled true
+```
+
+### Launch sample from the UI
 In Android Studio, edit your run configuration as follows:
-Edit run configurations > client-app > Deploy > Default APK. Then, under Launch Options,
+Edit run configurations > client-app > Deploy > APK from app bundle. Then, under Launch Options,
 Launch > Specified Activity > Activity > `com.example.client.MainActivity`
 
 Press the run button. Your app should launch and you can proceed to the
 [Testing the client](#testing-the-client) section.
 
 ### Command Line
-Build the APK bundle by running 
+Build the APK bundle by running
 
 ```shell
 ./gradlew client-app:buildPrivacySandboxSdkApksForPreviewDebug
@@ -54,8 +71,7 @@ Finally, run the client app via Android Studio's UI.
 ### Testing the client
 
 - Click on the "load SDK" button, a toast should show that SDK loaded successfully.
-- Click on the "Request Webview", this should remote render a webview from the
-  sandbox to be viewed inside the activity.
+- Click on the "Show banner view" after the SDK is loaded and a banner rendered by the SDK will be
+  displayed. If you click it, an Activity customized by the SDK will be launched.
 
 - For more information, please read the [documentation](https://developer.android.com/design-for-safety/privacy-sandbox/guides/sdk-runtime).
-

PrivacySandboxKotlin/build.gradle

@@ -1,6 +1,11 @@
 // Top-level build file where you can add configuration options common to all sub-projects/modules.
 buildscript {
-    ext.kotlin_version = '1.6.21'
+    ext.kotlin_version = '1.9.10'
+    ext.ksp_version = "$kotlin_version-1.0.13"
+    ext.privacy_sandbox_activity_version = "1.0.0-alpha01"
+    ext.privacy_sandbox_sdk_runtime_version = "1.0.0-alpha13"
+    ext.privacy_sandbox_tools_version = "1.0.0-alpha07"
+    ext.privacy_sandbox_ui_version = "1.0.0-alpha07"
     repositories {
         mavenCentral()
     }
@@ -9,8 +14,13 @@ buildscript {
     }
 }
 plugins {
-    id 'com.android.application' version '8.3.0-alpha10' apply false
-    id 'com.android.library' version '8.3.0-alpha10' apply false
+    id 'com.android.application' version '8.4.0-alpha13' apply false
+    id 'com.android.library' version '8.4.0-alpha13' apply false
+
+    // These two plugins do annotation processing and code generation for the sdk-implementation.
+    id 'androidx.privacysandbox.library' version '1.0.0-alpha02' apply false
+    id 'com.google.devtools.ksp' version "$ksp_version" apply false
+    id 'org.jetbrains.kotlin.jvm' version '1.9.10' apply false
 }
 
 task clean(type: Delete) {

PrivacySandboxKotlin/client-app/build.gradle

@@ -14,52 +14,58 @@
  * limitations under the License.
  */
 plugins {
-    id 'com.android.application'
+    id "com.android.application"
 }
-apply plugin: 'kotlin-android'
+apply plugin: "kotlin-android"
+
 android {
-    compileSdk = 33
-    compileSdkExtension = 5
+
+    privacySandbox {
+        enable = true
+    }
+
     defaultConfig {
         applicationId "com.example.privacysandbox.client"
-        minSdkVersion 33
-        targetSdkVersion 33
+        minSdkVersion 21
+        compileSdk 34
+        compileSdkExtension 10
+        targetSdkVersion 34
         versionCode 2
         versionName "1.01"
+
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
     }
-    flavorDimensions 'androidSdk'
-    productFlavors {
-        preview {
-            dimension 'androidSdk'
-        }
-        oem {
-            dimension 'androidSdk'
-            minSdkVersion 33
-            targetSdkVersion 33
-        }
-    }
+
     buildTypes {
         release {
             minifyEnabled false
-            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+            proguardFiles getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro"
         }
     }
     compileOptions {
-        sourceCompatibility JavaVersion.VERSION_1_8
-        targetCompatibility JavaVersion.VERSION_1_8
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
     }
-    namespace 'com.example.privacysandbox.client'
+    namespace "com.example.privacysandbox.client"
+
+    experimentalProperties["android.privacySandboxSdk.apiGenerator"] =
+            project.dependencies.create(
+                    "androidx.privacysandbox.tools:tools-apigenerator:$privacy_sandbox_tools_version")
+
+    experimentalProperties["android.privacySandboxSdk.apiGenerator.generatedRuntimeDependencies"] = [
+            project.dependencies.create("org.jetbrains.kotlin:kotlin-stdlib:1.7.20-RC"),
+            project.dependencies.create("org.jetbrains.kotlinx:kotlinx-coroutines-android:1.0.1"),
+            project.dependencies.create("androidx.privacysandbox.activity:activity-core:$privacy_sandbox_activity_version"),
+            project.dependencies.create("androidx.privacysandbox.activity:activity-client:$privacy_sandbox_activity_version"),
+            project.dependencies.create("androidx.privacysandbox.ui:ui-core:$privacy_sandbox_ui_version"),
+            project.dependencies.create("androidx.privacysandbox.ui:ui-client:$privacy_sandbox_ui_version"),
+    ]
 }
+
 dependencies {
-    implementation 'androidx.appcompat:appcompat:1.4.1'
-    implementation 'com.google.android.material:material:1.5.0'
-    implementation 'androidx.constraintlayout:constraintlayout:2.1.3'
-    implementation project(':example-aidl-library')
-    implementation project(':example-sdk')
-    testImplementation 'junit:junit:4.13.2'
-    androidTestImplementation 'androidx.test.ext:junit:1.1.3'
-    androidTestImplementation 'androidx.test.espresso:espresso-core:3.4.0'
-    implementation "androidx.core:core-ktx:1.7.0"
-    implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
-}
+    // Depend on the SDK library that will run inside the app.
+    implementation project(':existing-sdk')
+
+    implementation "androidx.appcompat:appcompat:1.6.1"
+    implementation "com.google.android.material:material:1.9.0"
+}

PrivacySandboxKotlin/client-app/src/main/AndroidManifest.xml

@@ -11,8 +11,7 @@
      See the License for the specific language governing permissions and
      limitations under the License.
 -->
-<manifest xmlns:android="http://schemas.android.com/apk/res/android"
-    package="com.example.privacysandbox.client">
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
 
   <uses-permission android:name="android.permission.INTERNET"/>
   <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>