privacysandbox ads

  
This library enables integration with Privacy Preserving APIs, which are part of Privacy Sandbox on Android.
Latest Update Stable Release Release Candidate Beta Release Alpha Release
March 12, 2025 - - 1.1.0-beta12 -

Declaring dependencies

To add a dependency on privacysandbox-ads, 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 {
 
    implementation "androidx.privacysandbox.ads:ads-adservices:1.1.0-beta12"
   
    implementation "androidx.privacysandbox.ads:ads-adservices-java:1.1.0-beta12"
 
}

Kotlin

dependencies {

    implementation("androidx.privacysandbox.ads:ads-adservices:1.1.0-beta12")

    implementation "androidx.privacysandbox.ads:ads-adservices-java:1.1.0-beta12"
   
}

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.1

Version 1.1.0-beta12

March 12, 2025

androidx.privacysandbox.ads:ads-adservices:1.1.0-beta12 and androidx.privacysandbox.ads:ads-adservices-java:1.1.0-beta12 are released. Version 1.1.0-beta12 contains these commits.

New Features

  • Custom Audience Priority: We have added a priority field in the custom audience. This allows buyers to specify a priority value in a CustomAudience. This value would be used to identify custom audiences which should be included in an auction if the set of buyer custom audiences exceed the per-buyer size limits
  • Seller Configuration: This feature allows sellers to define auction parameters to control payload size and auction participants. The seller auction configuration would allow sellers to specify:
    • Allowed buyer list
    • For auctions initiated by the given seller, only the buyers in the allowlist would be able to contribute CustomAudiences for the auction
    • Per-buyer size limit
    • Sellers could specify a per-buyer limit to regulate the data size uploaded by each buyer into the payload being sent to SellerFrontendService. If the buyer exceeds the per-buyer size limit, the CustomAudience priority set in buyer payload configuration would be used to get the data in the expected limits.
    • Max size limit for the payload
    • Different sellers might have different resource allocation and might want to set a max size limit for the per-request auction payload. The max size limit would respect the fixed size buckets set by the ProtectedAudience API.
  • Delayed Custom Audience Updates: This feature enables buyers to schedule deferred updates for Custom Audiences. Each update request allows the caller to schedule a delayed update using the new scheduleCustomAudienceUpdate() API. For each update, the user can specify sets of Custom Audiences to join or leave.

API Changes

  • Add Seller Configuration in GetAdSelectionRequest API (Ibb5c7)
  • Introduce ScheduleCustomAudienceUpdate API as experimental (I6b905)

Version 1.1.0-beta11

October 30, 2024

androidx.privacysandbox.ads:ads-adservices:1.1.0-beta11 and androidx.privacysandbox.ads:ads-adservices-java:1.1.0-beta11 are released. Version 1.1.0-beta11 contains these commits.

New Features

  • This update removes support for privacysandbox measurement and adid APIs on Android R, which has been deprecated. Calls to get the manager classes on Android R will now return null.

Version 1.1.0-beta10

August 21, 2024

androidx.privacysandbox.ads:ads-adservices:1.1.0-beta10 and androidx.privacysandbox.ads:ads-adservices-java:1.1.0-beta10 are released. Version 1.1.0-beta10 contains these commits.

API Changes

  • Add missing Java constructor overloads for GetAdSelectionDataOutcome, PersistAdSelectionResultRequest, ReportEventRequest, and FetchAndJoinCustomAudienceRequest Experimental APIs. (I19e7f)

Version 1.1.0-beta09

July 10, 2024

androidx.privacysandbox.ads:ads-adservices:1.1.0-beta09 and androidx.privacysandbox.ads:ads-adservices-java:1.1.0-beta09 are released. Version 1.1.0-beta09 contains these commits.

API Changes

  • Add missing Java constructor overloads for GetAdSelectionDataRequest Experimental API. (Ifbf88).

Version 1.1.0-beta08

June 26, 2024

androidx.privacysandbox.ads:ads-adservices:1.1.0-beta08 and androidx.privacysandbox.ads:ads-adservices-java:1.1.0-beta08 are released. Version 1.1.0-beta08 contains these commits.

New Features

  • Added support for protected app signals.
  • Support multiple cloud providers for B&A server auctions.

API Changes

  • Experimental API GetAdSelectionDataRequest::seller is non-nullable. (I68044)
  • Add GetAdSelectionDataRequest::coordinatorOriginUri Experimental API. (I18c0b)
  • Added updateSignals API. (Ia8512)

Version 1.1.0-beta07

May 14, 2024

androidx.privacysandbox.ads:ads-adservices:1.1.0-beta07 and androidx.privacysandbox.ads:ads-adservices-java:1.1.0-beta07 are released. Version 1.1.0-beta07 contains these commits.

New Features

  • GetTopics now supports encrypted responses as part of GetTopicsResponse.

API Changes

  • Added EncryptedTopic to GetTopicResponse class. (Iab362)

Version 1.1.0-beta06

April 17, 2024

androidx.privacysandbox.ads:ads-adservices:1.1.0-beta06 and androidx.privacysandbox.ads:ads-adservices-java:1.1.0-beta06 are released. Version 1.1.0-beta06 contains these commits.

Note

  • As of privacysandbox-ads jetpack release 1.1.0-beta06, all flags-enabled Android R devices will be able to access the PPAPIs. For any use case that should not support Android R, additional guards will be required within the code using privacysandbox-ads jetpack code.

New Features

  • Backward compatibility support for Android R.

Version 1.1.0-beta05

April 3, 2024

androidx.privacysandbox.ads:ads-adservices:1.1.0-beta05 and androidx.privacysandbox.ads:ads-adservices-java:1.1.0-beta05 are released. Version 1.1.0-beta05 contains these commits.

Bug Fixes

  • Added error catching when a class definition is not found on Android S devices due to missing uses-library tag in manifest.

Version 1.1.0-beta04

January 24, 2024

androidx.privacysandbox.ads:ads-adservices:1.1.0-beta04 and androidx.privacysandbox.ads:ads-adservices-java:1.1.0-beta04 are released. Version 1.1.0-beta04 contains these commits.

New Features

  • New API to support post-auction user event reporting
  • Added support for Frequency cap filtering for remarketing ads
  • Supporting Join Custom Audience delegation
  • Waterfall mediation chain truncation support
  • Support for Protected Auctions on Bidding and Auction Servers

API Changes

  • Introduce AdSelectionManager::selectAds(AdSelectionFromOutcomesConfig) experimental API (I86cd2)
  • Introduce ReportEventRequest::inputEvent experimental API (Ib94f3)
  • Make ReportImpressionRequest::adSelectionConfig optional (Ief280)
  • Introduce AdSelectionManager::getAdSelectionData and AdSelectionManager::persistAdSelectionResultUnified experimental APIs (Ie4d0e)
  • Introduce CustomAudienceManager::fetchAndJoinCustomAudience experimental API (I09152)
  • Introduce AdSelectionManager::reportEvent experimental API (I0d7dc)
  • Introduced AdSelectionManager::updateAdCounterHistogram experimental API and altered AdData to indicate a series of AdFilters (I87b83)

Bug Fixes

  • Input URIs are now matched on a shared site/origin instead of requiring an exact host name match.
  • Fix test failing due to missing HTTPS scheme (d573058)
  • Fix missing HTTPS scheme from web URLs (cecdcb8)
  • Add throws annotation to the measurement APIs (2dba359)

Version 1.1.0-beta03

November 15, 2023

androidx.privacysandbox.ads:ads-adservices:1.1.0-beta03 and androidx.privacysandbox.ads:ads-adservices-java:1.1.0-beta03 are released. Version 1.1.0-beta03 contains these commits.

New Features

  • Backward compatibility support for Android S.

Version 1.1.0-beta02

October 4, 2023

androidx.privacysandbox.ads:ads-adservices:1.1.0-beta02 and androidx.privacysandbox.ads:ads-adservices-java:1.1.0-beta02 are released. Version 1.1.0-beta02 contains these commits.

API Changes

  • Removed T+ version check from measurement request classes. Clients do not need a T+ platform version check on their side to access the privacysandbox MeasurementManager request classes. MeasurementManager will be null with the new behaviour. (Ieb105)

Version 1.1.0-beta01

August 23, 2023

androidx.privacysandbox.ads:ads-adservices:1.1.0-beta01 and androidx.privacysandbox.ads:ads-adservices-java:1.1.0-beta01 are released with no changes. Version 1.1.0-beta01 contains these commits.

Version 1.1.0-alpha01

August 9, 2023

androidx.privacysandbox.ads:ads-adservices:1.1.0-alpha01 and androidx.privacysandbox.ads:ads-adservices-java:1.1.0-alpha01 are released. Version 1.1.0-alpha01 contains these commits.

API Changes

Bug Fixes

Version 1.0

Version 1.0.0-beta05

June 7, 2023

androidx.privacysandbox.ads:ads-adservices:1.0.0-beta05 and androidx.privacysandbox.ads:ads-adservices-java:1.0.0-beta05 are released. Version 1.0.0-beta05 contains these commits.

Bug Fixes

  • Adds an sdk extension 5 check to TopicsManager
  • Bumps Kotlin coroutines dependency to 1.7.1 to prevent duplicate class build errors in gradle

Version 1.0.0-beta04

May 10, 2023

androidx.privacysandbox.ads:ads-adservices:1.0.0-beta04 and androidx.privacysandbox.ads:ads-adservices-java:1.0.0-beta04 are released. Version 1.0.0-beta04 contains these commits.

Bug Fixes

  • Resolve deadlock issue when adservices measurement APIs are invoked on main thread by the caller. (I65361)

Version 1.0.0-beta03

April 19, 2023

androidx.privacysandbox.ads:ads-adservices:1.0.0-beta03 and androidx.privacysandbox.ads:ads-adservices-java:1.0.0-beta03 are released. Version 1.0.0-beta03 contains these commits.

New Features

  • Enabled Preview API for Topics.

Version 1.0.0-beta02

March 22, 2023

androidx.privacysandbox.ads:ads-adservices:1.0.0-beta02 and androidx.privacysandbox.ads:ads-adservices-java:1.0.0-beta02 are released. Version 1.0.0-beta02 contains these commits.

Bug Fixes

  • Enabled the MeasurementManager APIs for SDK Extension version 5 and above.
  • Disabled the MeasurementManager APIs for SDK Extension version 4 and below.

Version 1.0.0-beta01

February 22, 2023

androidx.privacysandbox.ads:ads-adservices:1.0.0-beta01 and androidx.privacysandbox.ads:ads-adservices-java:1.0.0-beta01 are released with no notable changes. Version 1.0.0-beta01 was released from an internal branch.

Behavior Changes

  • Attribution Reporting has been disabled and is not available for use in this release.

Version 1.0.0-alpha01

January 11, 2023

androidx.privacysandbox.ads:ads-adservices:1.0.0-alpha01 and androidx.privacysandbox.ads:ads-adservices-java:1.0.0-alpha01 are released. Version 1.0.0-alpha01 was released from an internal branch.

  • This is a new Jetpack library that enables integration with Privacy Sandbox’s Privacy Preserving APIs (Topics, FLEDGE and Attribution Reporting).
  • The Jetpack Privacy Sandbox APIs can be used as a drop-in replacement for the Privacy Sandbox APIs provided in the Extension SDK 4.