Didomi - Developers documentation
  • Introduction
  • SDKs
    • Introduction
    • Web SDK
      • Getting started
      • Tags and vendors management
        • Tags management
          • Events & Variables
            • Deprecated
            • Custom events
          • Tag managers
            • Adobe Launch/DTM
            • Eulerian
            • Google Tag Manager
              • Configure the Didomi / GTM integration
              • Didomi's GTM template
            • Tealium
            • Other tag managers
        • Custom Didomi <script> tags
        • Third-party integrations
          • Google Ad Manager / AdSense
            • GDPR via Non-Personalized Ads
              • Share consent and load/refresh ads
              • Share consent without loading or refreshing ads
            • US states laws
          • Google Consent Mode V2
          • Kameleoon
          • Piano Analytics (AT Internet)
          • Prebid
            • GDPR via IAB TCF
            • US states laws
          • Salesforce DMP (Krux)
        • IAB frameworks
        • Programmatic API
      • Configuration
        • Bots (SEO & Performance tools)
        • Configuration by URL
        • Cookies and storage
        • Custom domains for events
        • Notice
          • Behavior
          • Interactions
          • Look and feel
        • Preferences
        • Theme
      • AB tests
      • Custom domain
        • Domain delegation
        • Reverse proxy
      • Share consents between domains
      • Share consents across devices
      • Pass user choices in query string
      • Serve Didomi assets from your domain
      • Reference
        • API
          • Deprecated
        • Events
      • Performance
    • Mobile and TV SDKs
      • Android and Android TV
        • Setup
        • Logging
        • Reference
          • API
            • Deprecated
          • Events
        • Versions
      • iOS and tvOS
        • Setup
        • Logging
        • App Tracking Transparency (iOS 14.5+)
        • Reference
          • API
            • Deprecated
          • Events
        • Versions
      • Unity
        • Setup
        • Reference
        • Versions
        • Troubleshooting
      • React Native
        • Setup
        • Reference
          • Deprecated
        • Versions
      • Flutter
        • Setup
        • Reference
        • Versions
      • Consent notice
        • Getting started
        • Customize the notice
        • Customize the preferences popup
        • Customize the theme & UI
        • Load notice by ID
      • Third-party SDKs
      • Share consents across devices
      • Share consent with WebViews
      • Google Consent Mode v2
      • FAQ
    • AMP SDK
      • Blocking Behaviors
        • Load immediately on page load
        • Load only after consent (positive or negative)
        • Load only after positive consent
      • Consent status for vendors
    • Didomi Consent String
      • Didomi Consent String Structure
      • Purposes & Vendors Numerical IDs
      • Consent String Examples
      • Decoding tools
    • Help & Support
  • API
    • Introduction
      • Authentication
      • Errors
      • Pagination
      • Filters
      • Caching
      • Rate limiting
      • Quotas
      • Translations
    • Data Manager
      • Regulations
      • Configuration Tree
      • Purposes
        • Purposes & Vendors Numerical IDs
      • Preferences Library
      • User Rights
    • Widgets
      • Consent notices
        • Notices
        • Configurations
        • Multi-Regulation Configurations
          • Migration of Existing Notices and API Updates
        • Deployments
        • Tutorials
          • Create and publish a consent notice
          • Create and publish a multi-regulation consent notice
      • Privacy widgets
        • Create a widget
        • Retrieve widgets
        • Edit a widget
          • Content & Design
            • Themes & Shapes
            • Components
              • auth
              • dsar_form
              • footer
              • header
              • preference
              • preference_value
              • save
              • section
              • sections
            • Options
          • Purposes & preferences
          • Settings
        • Deploy a Widget
          • Use your own subdomain
          • Use your own domain
          • Implement an embeddable widget on your website
        • Authentication
          • Manage authentication providers
          • Authenticate your end-user
        • Archive a widget
        • Headless widgets
          • Public Methods
          • Custom elements
          • Custom events
          • Event listeners
        • Tutorial
          • Launch a Preference Center from a mobile app
    • Compliance Reports
      • Properties
      • Reports
      • CSV format reference
      • Websites
    • Consents and Preferences
      • Events
        • Generate IAB TCF consent string
      • Links
      • Proofs
      • Tokens
      • Secrets
      • Users
      • Tutorial
        • Collect and operate data
    • Privacy Requests
      • Requests
      • Notes
      • Links
      • Emails
  • Integrations
    • Introduction
      • Quotas
    • Generic integrations
      • Batch export
        • Destinations
          • AWS S3 Bucket (owned by Didomi)
          • GCP Storage Bucket
        • Exported data
          • Notices consents
        • Logs
      • Webhooks
      • Batch import
      • Analytics export
        • Destinations
          • AWS S3 Bucket (owned by Didomi)
          • GCP Storage Bucket
    • Third-party apps
      • CMP integrations
        • Didomi-mParticle integration for your CMP
        • Deploy Didomi’s SDK for your Adobe Commerce website
      • Preference Management Platform integrations
        • Actito
        • Adobe Campaign Classic
        • Adobe Experience Cloud
        • Adobe Marketo Engage
        • Adobe Source Connector
        • Braze
        • Dotdigital
        • Hubspot
        • Mailchimp
        • Microsoft Dynamics 365
        • Salesforce Marketing Cloud
        • Salesforce Sales & Service Cloud
        • Selligent
        • Brevo (ex Sendinblue)
    • Tutorials
      • Configure a HTTP webhook
      • Configure a batch export
      • Configure an analytics export
    • Emailing
      • Configurations
        • Actito Email
        • Actito SMS
        • Adobe Campaign Classic
        • Adobe Campaign Standard
      • Emails
        • Templates
        • Manage your templates
Powered by GitBook
On this page
  • 2.25.1 (May 28, 2025)
  • 2.24.1 (April 30, 2025)
  • 2.24.0 (April 25, 2025)
  • 2.23.0 (April 16, 2025)
  • 2.22.0 (April 3, 2025)
  • 2.21.0 (March 18, 2025)
  • 2.20.0 (March 4, 2025)
  • 2.19.1 (February 11, 2025)
  • 2.19.0 (January 30, 2025)
  • 2.18.0 (January 9, 2025)
  • 2.17.1 (December 13, 2024)
  • 2.17.0 (December 11, 2024)
  • 2.16.2 (November 29, 2024)
  • 2.16.1 (November 19, 2024)
  • 2.16.0 (November 8, 2024)
  • 2.15.0 (October 24, 2024)
  • 2.14.0 (October 10, 2024)
  • 2.13.1 (October 8, 2024)
  • 2.13.0 (October 1, 2024)
  • 2.12.0 (September 13, 2024)
  • 2.11.0 (August 22, 2024)
  • 2.10.1 (August 20, 2024)
  • 2.10.0 (July 30, 2024)
  • 2.9.0 (July 15, 2024)
  • 2.8.0 (June 21, 2024)
  • 2.7.0 (June 6, 2024)
  • 2.6.1 (May 30, 2024)
  • 2.6.0 (May 10, 2024)
  • 2.5.1 (April 26, 2024)
  • 2.5.0 (April 26, 2024)
  • 2.4.0 (April 10, 2024)
  • 2.3.1 (March 28, 2024)
  • 2.3.0 (March 27, 2024)
  • 2.2.0 (March 18, 2024)
  • 2.1.0 (March 6, 2024)
  • 2.0.1 (February 23, 2024)
  • 2.0.0 (February 15, 2024)
  • 1.90.0 (February 8, 2024)
  • 1.89.0 (January 22, 2024)
  • 1.88.0 (January 11, 2024)
  • 1.87.0 (December 12, 2023)
  • 1.86.3 (December 6, 2023)
  • 1.86.2 (December 4, 2023)
  • 1.86.1 (November 23, 2023)
  • 1.86.0 (November 17, 2023)
  • 1.85.1 (November 7, 2023)
  • 1.85.0 (November 6, 2023)
  • 1.84.1 (October 20, 2023)
  • 1.84.0 (October 17, 2023)
  • 1.83.1 (October 5, 2023)
  • 1.83.0 (October 4, 2023)
  • 1.82.0 (September 19, 2023)
  • 1.81.1 (August 17, 2023)
  • 1.81.0 (July 18, 2023)
  • 1.80.0 (July 7, 2023)
  • 1.79.1 (June 15, 2023)
  • 1.79.0 (June 14, 2023)
  • 1.78.1 (May 4, 2023)
  • 1.78.0 (April 20, 2023)
  • 1.77.0 (April 3, 2023)
  • 1.76.0 (March 20, 2023)
  • 1.75.2 (March 8, 2023)
  • 1.75.1 (February 28, 2023)
  • 1.75.0 (February 22, 2023)
  • 1.74.0 (February 8, 2023)
  • 1.73.0 (January 25, 2023)
  • 1.72.1 (December 15, 2022)
  • 1.72.0 (December 14, 2022)
  • 1.71.0 (November 17, 2022)
  • 1.70.2 (October 27, 2022)
  • 1.70.1 (October 21, 2022)
  • 1.70.0 (October 19, 2022)
  • 1.69.0 (September 16, 2022)
  • 1.68.0 (September 13, 2022)
  • 1.67.0 (September 8, 2022)
  • 1.66.0 (August 26, 2022)
  • 1.65.0 (August 8, 2022)
  • 1.64.0 (July 21, 2022)
  • 1.63.0 (June 27, 2022)
  • 1.62.0 (June 10, 2022)
  • 1.61.1 (May 30, 2022)
  • 1.61.0 (May 17, 2022)
  • 1.60.0 (April 27, 2022)
  • 1.59.1 (April 4, 2022)
  • 1.59.0 (April 4, 2022)
  • 1.58.0 (March 18, 2022)
  • 1.57.0 (March 11, 2022)
  • 1.56.0 (March 4, 2022)
  • 1.55.0 (February 7, 2022)
  • 1.54.0 (January 2022)
  • 1.53.0 (January 2022)
  • 1.52.0 (December 2021)
  • 1.51.2 (December 2021)
  • 1.51.1 (December 2021)
  • 1.51.0 (December 2021)
  • 1.50.0 (November 2021)
  • 1.49.0 (November 2021)
  • 1.48.0 (October 2021)
  • 1.47.1 (October 2021)
  • 1.47.0 (October 2021)
  • 1.46.2 (September 2021)
  • 1.46.1 (September 2021)
  • 1.46.0 (September 2021)
  • 1.45.0 (September 2021)
  • 1.44.0 (August 2021)
  • 1.43.2 (July 2021)
  • 1.43.1 (July 2021)
  • 1.43.0 (July 2021)
  • 1.42.0 (July 2021)
  • 1.41.3 (June 2021)
  • 1.41.2 (June 2021)
  • 1.41.1 (May 2021)
  • 1.41.0 (May 2021)
  • 1.40.2 (May 2021)
  • 1.40.1 (May 2021)
  • 1.40.0 (April 2021)
  • 1.39.0 (April 2021)
  • 1.38.1 (April 2021)
  • 1.37.0 (March 2021)
  • 1.36.0 (March 2021)
  • 1.35.1 (March 2021)
  • 1.34.0 (March 2021)
  • 1.33.0 (February 2021)
  • 1.32.0 (February 2021)
  • 1.31.0 (January 2021)
  • 1.30.0 (January 2021)
  • 1.29.1 (January 2021)
  • 1.29.0 (December 2020)
  • 1.28.0 (December 2020)
  • 1.27.0 (November 2020)
  • 1.26.2 (November 2020)
  • 1.26.1 (October 2020)
  • 1.25.0 (October 2020)
  • 1.24.2 (September 2020)
  • 1.24.0 (September 2020)
  • 1.23.0 (September 2020)
  • 1.22.2 (September 2020)
  • 1.22.1 (September 2020)
  • 1.22.0 (August 2020)
  • 1.21.1 (August 2020)
  • 1.21.0 (August 2020)
  • 1.20.3 (August 2020)
  • 1.20.2 (August 2020)
  • 1.20.1 (July 2020)
  • 1.20.0 (July 2020)
  • 1.19.2 (July 2020)
  • 1.19.1 (July 2020)
  • 1.19.0 (July 2020)
  • 1.18.0 (July 2020)
  • 1.17.1 (July 2020)
  • 1.17.0 (June 2020)
  • 1.16.0 (June 2020)
  • 1.15.0 (June 2020)
  • 1.14.1 (June 2020)
  • 1.13.0 (May 2020)
  • 1.12.1 (May 2020)
  • 1.11.0 (March 2020)
  • 1.10.11 (February 2020)
  • 1.10.10 (February 2020)
  • 1.10.9 (February 2020)
  • 1.10.7 (January 2020)
  • 1.10.5 (January 2020)
  • 1.10.1 (Dec 2019)
  • 1.9.0 (Nov 2019)
  • 1.8.12 (Nov 2019)
  • 1.8.11 (Oct 2019)
  • 1.8.10 (Oct 2019)
  • 1.8.9 (Oct 2019)
  • 1.8.8 (Oct 2019)
  • 1.8.7 (Jul 2019)
  • 1.8.6 (Jul 2019)
  • 1.8.5 (Jul 2019)
  • 1.8.4 (Jul 2019)
  • 1.8.3 (Jun 2019)
  • 1.8.2 (Jun 2019)
  • 1.8.1 (May 2019)
  • 1.8.0 (May 2019)
  • 1.7.2 (May 2019)
  • 1.7.1 (May 2019)
  • 1.7.0 (May 2019)
  • 1.6.0 (Apr 2019)
  • 1.5.0 (Apr 2019)
  • 1.4.4 (Mar 2019)
  • 1.4.3 (Mar 2019)
  • 1.4.2 (Feb 2019)
  • 1.4.1 (Feb 2019)
  • 1.4.0 (Jan 2019)
  • 1.3.0 (Jan 2019)
  • 1.2.2 (Dec 2018)
  • 1.2.1 (Nov 2018)
  • 1.2.0 (Nov 2018)
  • 1.1.0 (Nov 2018)
  • 1.0.0 (Oct 2018)
  1. SDKs
  2. Mobile and TV SDKs
  3. Android and Android TV

Versions

2.25.1 (May 28, 2025)

Features:

  • Add new languages support (Belarus, Bosnian, Basque, English Canada, Galician, Georgian, Maltese, Albanian, Tagalog, Welsh)

New languages must be enabled from the Console once they are available.

Fixes:

  • Update properties of the Facebook vendor provided by Didomi

2.24.1 (April 30, 2025)

Fixes:

  • Revert serialized names for CurrentUserStatus object.

2.24.0 (April 25, 2025)

Features:

  • Add boolean field to identify if preferences.purposechanged API event is triggered from a Purpose Category screen or not.

Fixes:

  • Android TV: prevent Save button from updating vendor statuses.

2.23.0 (April 16, 2025)

Features:

  • Update accessibility descriptions for Preferences screens.

  • Update Didomi Consent String computation (beta).

Fixes:

  • Add missing Header (logo or App name) from the Storage of your choices screen.

  • Prevent navigation button to overlap if the label is too long from the Device Storage Disclosures screen.

2.22.0 (April 3, 2025)

Features:

  • Update accessibility description for Preferences screens.

  • When a vendor is not associated with legitimate interest purposes but has special purposes, always include it in IAB TCF Consent String legitimate interest vendors section (IAB TCF update).

  • Trigger SyncReady event even when Cross-Device feature is disabled.

  • Additional focus customization option for Android TV.

  • Add new screen to display User Information for Android TV in order to match with mobile SDK.

2.21.0 (March 18, 2025)

Features:

    • gppString field (beta).

    • Utility method shouldUserStatusBeCollected() .

  • Modify the layout of the bottom bar buttons on the Preferences screen.

  • Handle configuration parameter preferences.enableAllButtons .

2.20.0 (March 4, 2025)

Features:

  • Replace checkboxes with switches for legitimate interest-based purposes on AndroidTV.

  • Update status labels for buttons and switches from the Preferences screen on AndroidTV.

  • Update GPP library version (beta).

Fixes:

  • Set AndroidTV activities exported flag to false in manifest.

2.19.1 (February 11, 2025)

Fixes:

  • Cross-device: Make sure remote consent expiration is checked before applying consent synchronization.

2.19.0 (January 30, 2025)

Features:

Fixes:

  • Make sure the Purpose view is not shown before the Vendor view when the user requests the Vendor view from the Notice.

  • Stop forcing capital letters from the Notice's action button.

2.18.0 (January 9, 2025)

Features:

Fixes:

  • Optimize performance when updating the consent from the cross-device response.

  • The Purpose list's bulk action subtitle was always the same despite being enabled or not from Android TV preferences.

2.17.1 (December 13, 2024)

Features:

  • Add US regulation support for Utah: ucpa.

2.17.0 (December 11, 2024)

Features:

  • Accessibility: Increase contrast in toggle buttons icons.

  • Stop displaying Sensitive Personal Information in a separate screen.

Fixes:

  • Fix ConcurrentModificationException related to SDK events.

2.16.2 (November 29, 2024)

Fixes:

  • Fix a ConcurrentModificationException occurring sometimes when consent status is updated while setUser is called or status is retrieved asynchronously.

  • Accessibility: Sticky notice buttons were not always enabled when using only TalkBack to read the notice text.

2.16.1 (November 19, 2024)

Fixes:

  • Update translations and embedded GVL version.

2.16.0 (November 8, 2024)

DidomiEventListener interface implementations need to override 2 new callbacks: dcsSignatureReady / dcsSignatureError. These callbacks implementation can be left empty as they should not be active in this SDK version.

@UiThread
override fun dcsSignatureError(event: DcsSignatureErrorEvent) = Unit

@UiThread
override fun dcsSignatureReady(event: DcsSignatureReadyEvent) = Unit
@Override
public void dcsSignatureReady(@NonNull DcsSignatureReadyEvent event) {}

@Override
public void dcsSignatureError(@NonNull DcsSignatureErrorEvent event) {}

Fixes:

  • When overriding IAB vendors with custom vendors, prevent overriding vendor id with custom id.

  • Prevent ConcurrentModificationException when setting and getting user status.

2.15.0 (October 24, 2024)

Features:

Fixes:

  • Hide privacy policy button from AndroidTV's notice when the link is blank.

  • Trim translations before displaying the purpose list.

2.14.0 (October 10, 2024)

Features:

  • Update translations and embedded GVL version.

2.13.1 (October 8, 2024)

Fixes:

  • Fix notice's description display when the text contains link and justification is enabled.

  • Update Kotlin dependencies from 1.9.20 to 1.9.23.

  • Update Kotlin coroutines dependency from 1.8.1 to 1.9.0.

2.13.0 (October 1, 2024)

Fixes:

  • Update translations and embedded GVL version.

2.12.0 (September 13, 2024)

Features:

  • Support Serbian latin language script

  • Rename IDPL regulation to ICDPA

2.11.0 (August 22, 2024)

Features:

  • Use API 34 for compiling our SDK and update dependencies:

    • Dagger plugin and dependencies from 2.51.1 to 2.52.

    • Kotlin plugin from 1.8.20 to 1.9.20.

    • com.google.code.gson:gson from 2.10.1 to 2.11.0.

    • com.google.android.material:material from 1.6.1 to 1.12.0.

Your application must target API 34 starting this version (required from Google Play Store starting August 31, 2024).

2.10.1 (August 20, 2024)

Fixes:

  • Make sure DidomiToggle is not obfuscated.

  • Make sure sticky buttons behave correctly when scrolling the content of the notice.

2.10.0 (July 30, 2024)

Features:

  • Implement First Party Vendors support.

  • Support Publisher TC segment from the Consent String.

Fixes:

  • Merge duplicated Vendors declared from different sources (IAB, Didomi, Custom).

2.9.0 (July 15, 2024)

Features:

  • Add support for TCF v2.2 amendments (implement new Storage Disclosure button and screen).

2.8.0 (June 21, 2024)

Features:

  • Add support for new regulations: dpdpa, fdbr, idpl, mcdpa, nhpa, njdpa, ocpa and tdpsa.

  • Set a minimum frequency for user synchronization process.

  • Only rely on configuration obtained from Didomi to determine the user regulation.

  • Mark obsolete methods as Deprecated:

    • isConsentRequired

    • isUserConsentStatusPartial

    • isUserLegitimateInterestStatusPartial

    • getUserStatus

Fixes:

  • Prevent SDK translations to be removed from compiled app when shrinkMode option is set to strict.

  • On Android TV, bulk action buttons state was not consistent after scrolling.

  • IAB purposes 1 or 2 could incorrectly appear in notice and consent string when using vendors with Special Features.

  • Make sure a fallback is provided in case a translation is missing for an IAB element.

  • Prevent thread safety issues when SDK listens to connectivity status.

2.7.0 (June 6, 2024)

Features:

  • Update logic around setting the vendors' status based on purposes' status.

Fixes:

  • Modify package name of IAB TCF encoder/decoder fork from com.iabtcf.* to io.didomi.iabtcf.* to prevent duplicate classes issue.

2.6.1 (May 30, 2024)

Fixes:

  • Prevent external link icon to be stretched depending on the font size.

  • Increase the margin between title and toggle from the Sensitive Personal Information item.

  • Make the Sensitive Personal Information section title bold.

2.6.0 (May 10, 2024)

Features:

  • Display an icon indicating when a link targets a page outside of the application.

  • Add field isIAB in Vendor object to indicate if vendor is from the IAB Global Vendor List.

Fixes:

  • Do not obfuscate parameters class of setUser(...) method.

2.5.1 (April 26, 2024)

Features:

  • Add new parameters to DidomiInitializeParameters to override the user location determined by the SDK when getting the notice configuration:

    • countryCode: Force the user country used to get the notice configuration.

    • regionCode : Force the user region used to get the notice configuration.

  • Deprecate SyncDone event.

2.5.0 (April 26, 2024)

This version has obfuscation issues and should not be used.

2.4.0 (April 10, 2024)

Features:

  • Make sure that vendors removed from the GVL are not present in the notice or in the IAB Consent String when the IAB TCF framework is enabled.

  • Increase contrast for secondary texts to improve readability.

Fixes:

  • Add a proguard rule regarding kotlinx.parcelize.Parcelize to avoid issues in some projects configurations.

2.3.1 (March 28, 2024)

Fixes:

  • Vendors status updates were ignored when using openCurrentUserStatusTransaction method.

2.3.0 (March 27, 2024)

Features:

  • Deprecate CCPA regulation.

  • Set values for IABTCF_CmpSdkID, IABTCF_CmpSdkVersion, IABTCF_PolicyVersion and IABTCF_gdprApplies even when GDPR does not apply.

Fixes:

  • Rename incorrect openCurrentUserTransaction method to openCurrentUserStatusTransaction.

2.2.0 (March 18, 2024)

Features:

  • Display Purpose Categories for Android TV.

  • Update dependencies:

    • com.google.zxing:core from 3.5.2 to 3.5.3

    • org.jetbrains.kotlinx:kotlinx-coroutines-jdk8 from 1.7.3 to 1.8.0

    • Dagger dependencies from 2.50 to 2.51

Fixes:

  • Stop exposing GSON library as a transitive dependency.

  • Stop Exposing IAB TCF Decoder library as a transitive dependency.

  • Update the getCurrentUserStatus method so it marks as enabled those purposes that are enabled by default on the UI when the regulation applied is opt-out or mixed (e.g.: CPRA) and the user hasn’t expressed any choices yet.

2.1.0 (March 6, 2024)

Features:

Fixes:

  • Sort Device Storage Disclosure list by identifier and type in order to prevent random order from the Vendor details screen.

  • Align the Privacy Policy link to the left of the Vendor details screen.

2.0.1 (February 23, 2024)

Fixes:

  • Make sure public inner classes Vendor.Namespaces and Vendor.Url are not obfuscated in the released SDK.

  • Prevent unwanted line breaks in the notice text when using Bold font and Justified alignment.

2.0.0 (February 15, 2024)

Major update of the SDK

This release will contain some breaking changes, described below.

Migration steps:

  1. Update Didomi SDK to version 1.90.0 if it is not already the case.

  2. Replace any deprecated usages that might appear with the alternatives suggested by Android Studio (lint). If Android Studio does not suggest any updates, it means no deprecated methods are being used.

  3. Update Didomi SDK to version 2.0.0.

The Purpose class returned by getPurpose and getRequiredPurposes, and the Vendor class returned by getVendor and getRequiredVendors were modified. If you encounter an issue with these changes (such as a removed field), please reach out to support@didomi.io.

Important notes:

  • Vendor.id is now the ID provided by Didomi, without prefix

  • Purpose.description is deprecated and should be replaced by Purpose.descriptionText

Features:

  • Set the minimum supported API version (minSdk) to 19.

  • Remove deprecated functions listed below:

    Deprecated as of v1.31.0

    • setUserConsentStatus

    • setUserConsentStatusFromObjects

    Deprecated as of v1.42.0

    • (get)disabledPurposeIds

    • (get)disabledPurposes

    • (get)disabledVendorIds

    • (get)disabledVendors

    • (get)enabledPurposeIds

    • (get)enabledPurposes

    • (get)enabledVendorIds

    • (get)enabledVendors

    • initialize (without DidomiInitializeParameters)

    Deprecated as of v1.43.0

    • setUser (with authentication parameters instead of UserAuthParams)

    Deprecated as of v1.43.1

    • getUserConsentStatusForPurpose

    • getUserConsentStatusForVendor

    • getUserConsentStatusForVendorAndRequiredPurposes

    • getUserLegitimateInterestStatusForPurpose

    • getUserLegitimateInterestStatusForVendor

    • getUserLegitimateInterestStatusForVendorAndRequiredPurposes

    • getUserStatusForVendor

    Deprecated as of v1.45.0

    • setUserStatus (with sendAPIEvent parameter)

    • setUserStatusFromObjects

  • Update dependencies (com.google.code.gson:gson from 2.9.1 to 2.10.1 and androidx.recyclerview:recyclerview from 1.3.1 to 1.3.2).

  • Update Didomi brand logo for AndroidTV notices.

  • Modified Purpose class returned by methods getPurpose and getRequiredPurposes. See details below:

    • id (String) the Purpose ID.

    • name (String) the Purpose name.

    • descriptionText (String) the Purpose description. This property replaces the previous description property.

    • Removed properties:

      • iabId (String?)

      • descriptionLegal (String?)

      • illustrations (List<String>?)

      • isConsent (Boolean)

      • isEssential (Boolean)

      • isLegitimateInterest (Boolean)

      • isSpecialFeature (Boolean)

      • type (String?)

      • iabConsentRequired (Boolean)

      • iabLiRequired (Boolean)

      • category (PurposeCategory?)

      • isConsentNotEssential() (Boolean)

      • isLegitimateInterestNotEssential() (Boolean)

      • isLegitimateInterestOnly() (Boolean)

  • Modified Vendor class returned by methods getVendor and getRequiredVendors. See details below:

    • id (String) the Vendor ID provided by Didomi without any prefix.

    • name (String) the Vendor name.

    • namespaces (Namespaces?) the Namespaces of the vendor (IAB, num) and their corresponding ids.

    • policyUrl (String) the privacy policy URL (replace privacyPolicyUrl).

    • purposeIds (List<String>) the Purpose list with legal basis "consent".

    • legIntPurposeIds (List<String>) the Purpose list with legal basis "legitimate interest".

    • featureIds (List<String>) the ID list that represent features.

    • flexiblePurposeIds (List<String>) the ID list that represent flexible purposes.

    • specialFeatureIds (List<String>) the ID list that represent Special Features.

    • specialPurposeIds (List<String>) the ID list that represent Special Purposes.

    • urls (List<Url>?) the localized Privacy policy and LI disclaimer urls introduced in TCF v2.2.

    • Removed properties:

      • namespace (String)

      • iabId (String?)

      • cookieMaxAgeSeconds (Long?)

      • usesNonCookieAccess (Boolean)

      • deviceStorageDisclosureUrl (String?)

      • dataDeclaration (Set<String>)

      • dataRetention (DataRetention?)

      • didomiId (String?)

      • isIABVendor (Boolean)

      • isIabVendor (Boolean)

      • essentialPurposeIds (List<String>)

      • deviceStorageDisclosures (DeviceStorageDisclosures?)

      • isDeviceStorageDisclosureComplete (Boolean)

      • hasLegIntClaim (Boolean)

Fixes:

  • Ensure that the focus cannot go back to the SELECT title from AndroidTV notice for APIs 27 and below.

  • Stop filtering vendors if they don't have any purposes but data declaration.

1.90.0 (February 8, 2024)

Features:

  • Hide Sensitive Personal Information button from the Notice and Preferences screens if there is no such purpose to display.

  • Ensure that regulation NONE will behave as expected (no consent required, notice and preferences screens can't be displayed and all vendors and purposes are enabled).

1.89.0 (January 22, 2024)

Features:

  • Use default country code then default language when custom translations are missing for selected language.

Fixes:

  • Fix typo in TCF 2.2 notice for Spanish translation.

1.88.0 (January 11, 2024)

Features:

  • Update Didomi brand logo for preferences screens.

Fixes:

  • Serbian translation was containing some Latin labels instead of Cyrillic.

  • The consent stored after the first launch of an application could contain some discrepancies.

  • Wrong padding for the Purpose's Vendor list screen for some devices.

1.87.0 (December 12, 2023)

Features:

  • Set TCF version 2.2 as default version (current TCF 2.1 notices will be treated as TCF 2.2 notices).

1.86.3 (December 6, 2023)

Fixes:

  • Temporarily disable internal use of WebView component.

1.86.2 (December 4, 2023)

Fixes:

  • Fix Hebrew and Indonesian translations not displayed correctly on some devices.

  • Fix to ignore purposes and special features coming from Custom Vendors when creating the TCF Consent String.

1.86.1 (November 23, 2023)

Fixes:

  • Setup Notice logo constraints. Maximum height is now set to 150dp.

  • Publisher restrictions now applies to Facebook vendor.

  • Fix Polish translation for Partners count label on Notice screen.

1.86.0 (November 17, 2023)

Features:

  • Add support for new language regions: Arabic (Jordan), Dutch (Belgium), English (New Zealand), English (United Kingdom), French (Belgium), French (Canada), German (Austria), German (Switzerland).

  • Handle Regulation field (user.regs) in synchronization requests and API events.

  • Specify "non-IAB partners" instead of just "partners" when presenting count of partners associated to a purpose.

  • Update list of purposes associated to Facebook vendor.

  • Handle notice.enableBulkActionOnPurpose config parameter, to allow to hide the enable / disable all purposes switch on preferences screen.

  • Use Kotlin 1.8.20.

1.85.1 (November 7, 2023)

Fixes:

  • Remove dependencies androidx.javascriptengine:javascriptengine and com.google.guava:guava to prevent compatibility issues.

1.85.0 (November 6, 2023)

This is the minimum required sdk version to fully handle TCF v2.2 notices on Android and Android TV.

Features:

  • Enable non-transitive R class in the SDK (Didomi resources will not be present anymore in application R class, only in io.didomi.sdk.R)

  • Deprecate Vendor.isIABVendor and add Vendor.isIabVendor to use instead

Fixes:

  • Support IAB purpose 11 from TCF 2.2 (Use limited data to select content)

  • Remove unwanted dependency com.google.firebase:firebase-crashlytics-buildtools:2.9.9

  • Update exported proguard rules for gson as advised in R8 documentation.

1.84.1 (October 20, 2023)

Fixes:

  • Handle translation of TCF v2.2 purposes even when there is no internet connection.

  • Improve performance on vendors screen.

  • Update proguard rules for gson as advised in R8 documentation.

1.84.0 (October 17, 2023)

This version added support for TCF v2.2 notices on AndroidTV. However it does not correctly handle purpose 11 (Use limited data to select content), sdk version 1.85.0 or higher should be used instead.

Features:

  • Full TCF v2.2 support for AndroidTV.

  • Change label of "View our partners" notice button to "Manage our partners" .

Fixes:

  • Improve loading time to display the list of vendors associated to a purpose.

  • Incorrect UI layout for purposes illustrations, vendor details and the list of vendors associated to a purpose on tablet.

1.83.1 (October 5, 2023)

Fixes:

  • Revert dependency com.google.android.material:material to version 1.6.1 to allow use of gradle versions < 7.3.3 (required for Unity).

  • Trim names of some IAB vendors containing additional trailing space.

1.83.0 (October 4, 2023)

This version added support for TCF v2.2 notices on Android devices. However it does not correctly handle purpose 11 (Use limited data to select content), sdk version 1.85.0 or higher should be used instead.

Features:

  • TCF v2.2 support.

  • Revert the design and label of the partners button displayed on the notice (underlined / "View our partners").

  • Update Target SDK from 31 to 33.

  • Remove support of notice.content.viewOurPartners configuration parameter from AndroidTV Notice (the same default label as mobile will be used).

Fixes:

  • Prevent crash from notice when calling the setUser function multiple times.

1.82.0 (September 19, 2023)

Features:

  • Better layouts (fonts, margins, etc...) for Additional Data Processing, Purposes and Vendors detail screens.

Fixes:

  • Add missing IAB tag on Vendor detail screen.

  • Prevent duplicated screens when user is clicking multiple times.

  • Manage empty privacy policy url from Custom Vendor detail screen.

1.81.1 (August 17, 2023)

Fixes:

  • Prevent crash if Android System WebView is not available.

1.81.0 (July 18, 2023)

Features:

  • Change the "Learn More" link into button.

1.80.0 (July 7, 2023)

Features:

  • In notice, modify design of "Manage our partners" and "Learn more" links

  • In vendor details screen, move links to IAB and privacy policy outside of privacy policy disclaimer (improves accessibility)

  • Mark disableDidomiRemoteConfig initialization parameter as deprecated.

Didomi SDK configuration should be done through the console. In the future, local configuration file will no longer be supported.

Fixes:

  • GDPR was not correctly applied for additional countries set in console.

1.79.1 (June 15, 2023)

Fixes:

1.79.0 (June 14, 2023)

This version has build issues in some configurations, it should not be used.

1.78.1 (May 4, 2023)

Fixes:

  • Fix crash with Android < 21.

  • Compute opposite color from 3 digits color code (for Button theme).

  • Prevent blank Sensitive Personal Information button from Preferences (Purposes) if the label is not provided by the configuration.

1.78.0 (April 20, 2023)

Features:

  • Display message on Sensitive Personal Information screen when no Personal Data is present.

  • Display IAB TCF tag for IAB Vendors on AndroidTV vendor screens.

1.77.0 (April 3, 2023)

Features:

  • Enable CPRA regulation support.

  • Create new Sensitive Personal Information screens.

  • Update Additional Data Processing list from Purpose screen in order to improve accessibility.

Fixes:

  • Notice underlined buttons were not underlined on APIs below 26.

  • Fix padding issue for multiline label from Preferences screens Save / Save and close button.

1.76.0 (March 20, 2023)

Features:

  • Add a link to privacyPolicyURL on preferences (Purpose) screen when the link is not present in text description.

  • Remove link to privacyPolicyURL in embedded default preferences (Purpose) screen description.

Fixes:

  • Throw exception when clearUser() is called before SDK initialization.

  • Fix conflicting color resources.

1.75.2 (March 8, 2023)

Fixes:

  • Improve accessibility description of Vendor bulk action.

1.75.1 (February 28, 2023)

Fixes:

  • Fix line break from Notice description and Vendor header description.

  • Update proguard consumer rules in order to prevent obfuscation of Didomi classes.

1.75.0 (February 22, 2023)

Features:

  • Accessibility improvements in Purposes and Vendors screen.

  • Call onError callback when invalid API key is passed to Didomi.initialize.

Fixes:

  • Prevent duplicated publisher restriction from configuration.

  • Fix accessibility description for Essential Purposes.

1.74.0 (February 8, 2023)

Features:

  • Accessibility improvements in

    • Partners button on main notice

    • Purposes screen

    • Purpose details buttons

    • Vendors screen

    • Vendor details buttons

  • New User Information button from the Vendor screen.

1.73.0 (January 25, 2023)

Features:

  • Accessibility improvements on the Notice screen.

  • Accessibility improvements on the Purpose screen.

  • Update proguard consumer rules in order to keep class member only for the Didomi package.

Fixes:

  • Add missing subtitle "Select partners" for Vendor screen.

  • Some large title could overlap the close button in Preferences screens (Purpose and Vendor).

  • Some configurations allowed the Purpose screen to be closed even when the parameter preferences.canCloseWhenConsentIsMissing was false.

1.72.1 (December 15, 2022)

Fixes:

  • Rendering issue when preferences screen header text contained html lists.

1.72.0 (December 14, 2022)

Features:

1.71.0 (November 17, 2022)

Features:

  • Remove TCF v1 support.

  • Supporting url and resource name from logoUrl configuration parameter.

1.70.2 (October 27, 2022)

Fixes:

  • SetupUI was not working properly with specific Android project configurations, throwing an exception.

AndroidJavaException: java.lang.AbstractMethodError: abstract method "void androidx.lifecycle.DefaultLifecycleObserver.onStart(androidx.lifecycle.LifecycleOwner)"

1.70.1 (October 21, 2022)

Fixes:

  • Fix Toggle colors not changing for older APIs (< 24).

  • Fix Toggle state not updated on click when the view holder is recycled for older APIs (< 27).

1.70.0 (October 19, 2022)

Features:

  • Optimize display of Purpose legal description.

  • Update kotlin plugin from 1.5.31 to 1.7.20.

  • Update appcompat library from 1.3.1 to 1.4.2.

  • Update material library from 1.4.0 to 1.6.1.

  • Improve AndroidTV performance.

Fixes:

  • Prevent crash when Application is brought back from background and the Didomi SDK is not initialized from the Application class.

  • Fix device language not correctly handled for Hebrew and Indonesian.

1.69.0 (September 16, 2022)

Features:

  • Disable location query from device GPS when the location permissions are granted (we now rely only on our API to get the user location and to provide the matching regulation).

Fixes:

  • Update link to IAB TCF v2 from the vendor detail page.

  • Prevent CCPA "Sell my data" toggle neutral state.

1.68.0 (September 13, 2022)

Features:

  • Add support for CCPA regulation

1.67.0 (September 8, 2022)

Features:

  • Accessibility improvements on the vendors list

  • Improved accessibility on buttons displayed on the notice.

Fixes:

  • Consent asked events was using all required purposes as both consent and legitimate interest.

  • Fix toggle buttons behaviour when using purpose categories

1.66.0 (August 26, 2022)

Features:

  • Improve accessibility of close buttons and headings on Preferences screens.

Fixes:

  • Fix missing button padding on some devices for AndroidTV.

  • Fix a lifecycle issue causing not initialized properties errors (e.g. Fatal Exception: kotlin.UninitializedPropertyAccessExceptionlateinit property themeProvider has not been initialized).

1.65.0 (August 8, 2022)

Features:

  • Handle device storage disclosure as link (instead of json) from IAB vendor list.

  • Improve accessibility of Preferences screen.

Fixes:

  • Add missing bottom bar for Vendor details page.

  • Fix crash when displaying details of vendor with an incorrect device storage disclosure URL (java.lang.NullPointerException: Attempt to invoke virtual method 'boolean io.didomi.sdk.models.DeviceStorageDisclosure.isValid()' on a null object reference)

1.64.0 (July 21, 2022)

Features:

  • Query purposes for current language in order to always provide up-to-date translations.

updateSelectedLanguage is now asynchronous.

Fixes:

  • Fix layout on additional data processing page.

  • Disable neutral state when controlled value is legitimate interest.

1.63.0 (June 27, 2022)

Features:

  • Hide bulk action in purposes and vendors screens when there is only one item in the list.

  • Allow to call reset() method while SDK is not initialized.

1.62.0 (June 10, 2022)

Features:

Fixes:

  • Prevent notice text scrolling outside of pop-up window

1.61.1 (May 30, 2022)

Fixes:

  • Fix possible crash when app and notice were restored after staying a very long time in the background.

1.61.0 (May 17, 2022)

Features:

Fixes:

  • When notice was displayed to the user but no choice was made yet, the IAB consent string contained an incorrect list of enabled legitimate interest purposes.

  • Vendor device storage disclosure list was not displayed on devices below API 21.

1.60.0 (April 27, 2022)

Features:

  • Update design for tablets.

  • Add new languages support (Norwegian, Brazilian, Azerbaijani, Bengali, Filipino/Tagalog, Hebrew, Hindi, Indonesian, Macedonian, Swahili).

New languages must be enabled from the Console once they are available.

Bug fixes:

  • Remove Purpose and Vendor bulk action when only essential/required purposes are used.

  • Incorrect toggles animation while scrolling

  • Fix issues when legitimate interest purposes are set as essential

  • Fix a crash on Android TV preferences screen when using essential purposes

1.59.1 (April 4, 2022)

Features:

  • Migrate Didomi class to Kotlin

  • Improve banner notice layout

  • Add a default background color for secondary buttons

Fixes:

  • Fix dependencies conflict with some libraries, producing the error java.lang.VerifyError: Verifier rejected class

1.59.0 (April 4, 2022)

This version can produce crashes and should not be used

1.58.0 (March 18, 2022)

Features:

  • Improve accessibility of User Information screen

  • Update ConstraintLayout dependency from 2.1.2 to 2.1.3

Fixes:

  • Prevent glitch during Preferences screen animation for tablets

  • Revert toggle change animation for purposes screen

  • Prevent invisible toggle track for some application themes

1.57.0 (March 11, 2022)

Features:

  • Allow multiple initializations of the SDK.