Programmatic API

Search…
Programmatic API
If you need more control over when and how tags are loaded, the Didomi SDK exposes a function to get an observable on the consent status for a given vendor. This allows you to listen to changes to the consent status and react to them to decide when to enable a vendor.
Here are a few use cases and how to implement them with the getObservableOnUserConsentStatusForVendor function. You can find more examples and documentation on the function in the Reference.
Enable a vendor when the user has allowed it
With this structure, your function gets called exactly once and only when the user has given consent to the vendor specifically. It could be immediately if the user has already given consent or later on after the user gives consent.
1
window.didomiOnReady = window.didomiOnReady || [];
2
window.didomiOnReady.push(function (Didomi) {
3
    if (Didomi.isConsentRequired()) {
4
        // Consent is required: your visitor is from the EU or you are an EU company
5
        // Only enable the vendor when consent is given
6
        Didomi.getObservableOnUserConsentStatusForVendor('vendor-id')
7
            .filter(function(status) { return status === true; }) // Filter out updates where status is not true
8
            .first() // Only get the first consent status update
9
            .subscribe(function (consentStatusForVendor) {
10
                // The user has given consent to the vendor
11
                // Enable it
12
            });
13
    } else {
14
        // Consent is not required, enable your vendor immediately
15
    }
16
});
Copied!
If your tag is configured to only collect consent for visitors from the EU, you can enable all your tags for other visitors without waiting for the consent. Use the isConsentRequired() function to check if consent is required or not for the current visitor on the page.
Get notified when the consent status for a vendor changes
With this structure, your function gets called every single time the consent status for the vendor changes. If the user has not given consent information yet, your function is called immediately with undefined as the consent status. If the consent status of the user changes multiple times on the page, the function will be called multiple times.
1
window.didomiOnReady = window.didomiOnReady || [];
2
window.didomiOnReady.push(function (Didomi) { 
3
    if (Didomi.isConsentRequired()) {
4
        // Consent is required: your visitor is from the EU or you are an EU company
5
        // Only enable the vendor when consent is given
6
        Didomi.getObservableOnUserConsentStatusForVendor('vendor-id')
7
            .subscribe(function (consentStatusForVendor) {
8
                // The consent status for the vendor has changed
9
                if (consentStatusForVendor === true) {
10
                    // The vendor has consent
11
                } else if (consentStatusForVendor === false) {
12
                    // The vendor does not have consent
13
                } else if (consentStatusForVendor === undefined) {
14
                    // The consent status for the vendor is unknown
15
                }
16
            });
17
    } else {
18
        // Consent is not required, enable your vendor immediately
19
    }
20
});
Copied!
If your tag is configured to only collect consent for visitors from the EU, you can enable all your tags for other visitors without waiting for the consent. Use the isConsentRequired() function to check if consent is required or not for the current visitor on the page.
Custom Didomi <script> tags
Tag managers
Last modified 1yr ago
Copy link
Contents
Enable a vendor when the user has allowed it
Get notified when the consent status for a vendor changes