privacysandbox-tools

  
A library to utilize the Privacy Sandbox functionality in Android
Latest Update Stable Release Release Candidate Beta Release Alpha Release
March 26, 2025 - - - 1.0.0-alpha13

Declaring dependencies

To add a dependency on privacysandbox-tools, you must add the Google Maven repository to your project. Read Google's Maven repository for more information.

Add the dependencies for the artifacts you need in the build.gradle file for your app or module:

Groovy

dependencies {
    // Use to implement privacysandbox libraries

    implementation "androidx.privacysandbox.tools:tools:1.0.0-alpha13"
    Implementation "androidx.privacysandbox.tools:tools-apicompiler:1.0.0-alpha13"
    implementation "androidx.privacysandbox.tools:tools-apigenerator:1.0.0-alpha13"
    implementation "androidx.privacysandbox.tools:tools-core:1.0.0-alpha13"
    implementation "androidx.privacysandbox.tools:tools-testing:1.0.0-alpha13"
    implementation "androidx.privacysandbox.tools:tools-apipackager:1.0.0-alpha13"
    
    
}

Kotlin

dependencies {
    // Use to implement privacysandbox libraries
    
    implementation("androidx.privacysandbox.tools:tools:1.0.0-alpha13")
    implementation("androidx.privacysandbox.tools:tools-apicompiler:1.0.0-alpha13")
    implementation("androidx.privacysandbox.tools:tools-apigenerator:1.0.0-alpha13")
    implementation("androidx.privacysandbox.tools:tools-core:1.0.0-alpha13")
    implementation("androidx.privacysandbox.tools:tools-testing:1.0.0-alpha13")
    implementation("androidx.privacysandbox.tools:tools-apipackager:1.0.0-alpha13")

}

For more information about dependencies, see Add build dependencies.

Feedback

Your feedback helps make Jetpack better. Let us know if you discover new issues or have ideas for improving this library. Please take a look at the existing issues in this library before you create a new one. You can add your vote to an existing issue by clicking the star button.

Create a new issue

See the Issue Tracker documentation for more information.

Version 1.0

Version 1.0.0-alpha13

March 26, 2025

androidx.privacysandbox.tools:tools-*:1.0.0-alpha13 is released. Version 1.0.0-alpha13 contains these commits.

New Features

  • Added support for the SessionData parameter in openSession, which replaces SessionConstants.
  • Removed the generation of SandboxedSdkProviderCompat.getView(), which is now deprecated.

Version 1.0.0-alpha12

February 26, 2025

androidx.privacysandbox.tools:tools-*:1.0.0-alpha12 is released. Version 1.0.0-alpha12 contains these commits.

New Features

  • @PrivacySandboxInterface-annotated interfaces can now extend the SharedUiAdapter interface introduced in androidx.privacysandbox.ui:ui-core:1.0.0-alpha14, similarly to SandboxedUiAdapter. An interface may only extend one UI adapter type.

Version 1.0.0-alpha11

January 29, 2025

androidx.privacysandbox.tools:tools-*:1.0.0-alpha11 is released. Version 1.0.0-alpha11 contains these commits.

New Features

  • Added support for the updated SessionConstants parameter in SandboxedUiAdapter.openSession. (I65886)

Version 1.0.0-alpha10

October 2, 2024

androidx.privacysandbox.tools:tools-*:1.0.0-alpha10 is released. Version 1.0.0-alpha10 contains these commits.

New Features

  • Add support for SDK-defined constants using const val in annotated interfaces and annotated values.

API Changes

  • Disallow objects in the apicompiler (these were previously silently ignored)

Bug Fixes

  • Fix crash when there are source directories ending in .class

Version 1.0.0-alpha09

June 26, 2024

androidx.privacysandbox.tools:tools-*:1.0.0-alpha09 is released. Version 1.0.0-alpha09 contains these commits.

New Features

  • Add support for enum classes annotated with @PrivacySandboxValue.
  • Support for Privacy Sandbox UI alpha 09.

Version 1.0.0-alpha08

March 20, 2024

androidx.privacysandbox.tools:tools-*:1.0.0-alpha08 is released. Version 1.0.0-alpha08 contains these commits.

New Features

  • Interfaces annotated with @PrivacySandboxCallback can now have methods that return values as long as the method suspends.(I16063)
  • Bundles are now accepted as valid parameters and return types in annotated interfaces and values. (I52995)

Version 1.0.0-alpha07

February 7, 2024

androidx.privacysandbox.tools:tools-*:1.0.0-alpha07 is released. Version 1.0.0-alpha07 contains these commits.

API Changes

  • Support the new SDK Activity launcher interfaces. The new interfaces live in androidx.privacysandbox.activity.core. The old ones in androidx.privacysandbox.ui.core are no longer supported. (Ia9079)

Version 1.0.0-alpha06

September 6, 2023

androidx.privacysandbox.tools:tools-*:1.0.0-alpha06 is released. Version 1.0.0-alpha06 contains these commits.

Bug Fixes

  • Use non-android Guava dependencies to avoid classpath clashes in Bazel.
  • Fix crash when API compiler is called from Bazel. (I24c9d)

Version 1.0.0-alpha05

August 9, 2023

androidx.privacysandbox.tools:tools-*:1.0.0-alpha05 is released. Version 1.0.0-alpha05 contains these commits.

New Features

  • Generated SandboxedUiAdapters now have the new windowInputToken set. This makes this release compatible with androidx.privacysandbox.ui:ui-core:1.0.0-alpha05.

Version 1.0.0-alpha04

May 24, 2023

androidx.privacysandbox.tools:tools-*:1.0.0-alpha04 is released. Version 1.0.0-alpha04 contains these commits.

New Features

  • CancellationExceptions are now propagated to apps, so SDKs can now cancel their coroutines as expected.
  • SdkActivityLaunchers can now be used in SDK APIs, so apps can send launchers to SDKs in the Privacy Sandbox. Note that this functionality is only available in developer previews at the moment.

Bug Fixes

  • Non-suspend functions declared by SDKs will now run in the main thread by default. They used to run in Binder threads.
  • Services can no longer inherit from UI interface adapters.
  • Fixed an issue where defining a UI adapter property in a data class would cause a compilation error.

Version 1.0.0-alpha03

March 8, 2023

androidx.privacysandbox.tools:tools-*:1.0.0-alpha03 is released. Version 1.0.0-alpha03 contains these commits.

New Features

  • Added support for Privacy Sandbox UI API integration

API Changes

  • Changed target kotlin version to 1.8.0

Version 1.0.0-alpha02

December 7, 2022

androidx.privacysandbox.tools:tools-*:1.0.0-alpha02 is released. Version 1.0.0-alpha02 contains these commits.

  • These tools are aimed to enhance the integration with the Privacy Sandbox SDK Runtime APIs. These tools will help with auto-generating boilerplate code to define and interact with the client-facing interfaces of the runtime-enabled SDK.

New Features - Adds support for defining client-facing SDK interfaces that accept callbacks and data value objects as parameters and return types - Propagate SDK exceptions to clients - Support for SDK Runtime backward compatibility generation

API Changes

  • Adding @JvmDefaultWithCompatibility annotation (I8f206)

Version 1.0.0-alpha01

November 9, 2022

androidx.privacysandbox.tools:tools-*:1.0.0-alpha01 is released. Version 1.0.0-alpha01 contains these commits.

New Features