Set up your development environment

Follow the instructions on this page to set up the Privacy Sandbox on Android SDK in Android Studio.

Within Android Studio, install the SDK as follows:

  1. Install the latest Canary build or Stable build of Android Studio.
  2. In Android Studio, go to Tools > SDK Manager.
  3. In the SDK Platforms tab, select Android 13.0, Extension Level 5. This version includes API level 33 and AdServices APIs.
  4. Developer Preview only: In the SDK Platforms tab, select Android UpsideDownCakePrivacySandbox Preview.
  5. In the SDK Tools tab, select Android SDK Build-Tools 33 or later.
  6. Click OK to install the SDK.

Declare the correct API levels

Declare the correct API levels for your app as required.

Beta

To use the Privacy Sandbox on Android APIs in the latest AdServices SDK extension, declare your app's compile API level and SDK extension level as follows:

android {
    compileSdk = 33
    compileSdkExtension = 5
    // etc...
}

Developer Preview

To use the Privacy Sandbox on Android APIs, declare your app's compile API level and target API level as follows, based on your version of the Android Gradle plugin (AGP)

AGP 7.0.0 or higher:

compileSdkPreview "UpsideDownCakePrivacySandbox"
targetSdkPreview "UpsideDownCakePrivacySandbox"

AGP 4.2.0 or lower:

compileSdkVersion "android-UpsideDownCakePrivacySandbox"
targetSdkVersion "android-UpsideDownCakePrivacySandbox"

Get the Privacy Sandbox on Android on a supported device

After you complete the preceding setup steps, you can then test Privacy Sandbox on Android. See Configure a device or emulator image for more information.