{"id":1263,"date":"2022-05-25T12:28:47","date_gmt":"2022-05-25T12:28:47","guid":{"rendered":"https:\/\/www.cookiebot.com\/en\/?page_id=1263"},"modified":"2026-03-12T08:18:41","modified_gmt":"2026-03-12T08:18:41","slug":"developer","status":"publish","type":"page","link":"https:\/\/www.cookiebot.com\/us\/developer\/","title":{"rendered":"Cookiebot Developer Resources"},"content":{"rendered":"\n

Below is advanced technical information, mainly for developers. If you are looking for our default implementation guide on how to get started with Cookiebot CMP, it can be found here<\/a>.<\/em><\/p>\n\n\n\n

On this page you will find our SDK documentation to build custom implementations of banner and cookie controls. As well as the options for manual overrides of the automated mechanisms of our cookie consent banner.<\/p>\n\n\n\n

For the below SDK to function, the Cookiebot CMP script needs to be implemented on your website.<\/p>\n\n\n\n

Load the cookie consent script through:<\/p>\n\n\n\n

https://consent.cookiebot.com\/uc.js?cbid=00000000-0000-0000-0000-00000000000<\/code><\/pre>\n\n\n\n
Or as:<\/p>\n\n\n\n
https://consent.cookiebot.com\/uc.js<\/code><\/pre>\n\n\n\n
(with the attribute data-cbid='00000000-0000-0000-0000-000000000000')<\/p>\n\n\n\n
Remember to replace 00000000-0000-0000-0000-000000000000 with your own domain group ID found under \"Your scripts\" on your Cookiebot CMP account.<\/p>\n\n\n\n
The Cookiebot CMP script loads and constructs a client-side JavaScript object named 'Cookiebot' which exposes the following public properties, methods, events and callback functions.<\/p>\n\n\n\n
Properties<\/h2>\n\n\n\n
Name<\/th>Type<\/th>Default<\/th>Description<\/th><\/tr><\/thead>
consent.necessary<\/td>bool<\/td>true<\/td>True if current user has accepted necessary cookies. The property is read only.<\/td><\/tr>
consent.preferences<\/td>bool<\/td>false<\/td>True if current user has accepted preference cookies. The property is read only.<\/td><\/tr>
consent.statistics<\/td>bool<\/td>false<\/td>True if current user has accepted statistics cookies. The property is read only.<\/td><\/tr>
consent.marketing<\/td>bool<\/td>false<\/td>True if current user has accepted marketing cookies. The property is read only.<\/td><\/tr>
consent.method<\/td>string<\/td>null<\/td>The way the consent was given. Either \u2018implied\u2019 when a consent is given automatically or \u2018explicit\u2019 when given by the user. If there is no consent the value is null. If the consent method is unknown (old consents) it is considered \u2018implied\u2019. The property is read only.<\/td><\/tr>
consented<\/td>bool<\/td>false<\/td>True if the user has accepted cookies. The property is read only.<\/td><\/tr>
declined<\/td>bool<\/td>false<\/td>True if the user has declined the use of cookies. The property is read only.<\/td><\/tr>
hasResponse<\/td>bool<\/td>false<\/td>True if the user has responded to the dialog with either 'accept' or 'decline'. The property is read only.<\/td><\/tr>
doNotTrack<\/td>bool<\/td>false<\/td>True if the user has enabled the web browser's 'Do not track' (DNT) setting. If DNT is enabled Cookiebot will not set the third party cookie CookieConsentBulkTicket used for bulk consent. The property is read only.<\/td><\/tr>
regulations.gdprApplies<\/td>bool<\/td>false<\/td>Allows you to determine if GDPR applies based on the user's geo-location. The property is read only.<\/td><\/tr>
regulations.ccpaApplies<\/td>bool<\/td>false<\/td>Allows you to determine if CCPA applies based on the user's geo-location. The property is read only.<\/td><\/tr>
regulations.lgpdApplies<\/td>bool<\/td>false<\/td>Allows you to determine if LGPD applies based on the user's geo-location. The property is read only.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Methods<\/h2>\n\n\n\n
Name<\/th>Parameters<\/th>Description<\/th><\/tr><\/thead>
show<\/td>None<\/td>Forces the cookie consent dialog to show.<\/td><\/tr>
hide<\/td>None<\/td>Forces the cookie consent dialog to hide.<\/td><\/tr>
renew<\/td>None<\/td>Shows the cookie consent dialog to the website user to renew or change the user's consent state.<\/td><\/tr>
getScript<\/td>string URL,
bool async,
func callback<\/td>		Loads a JavaScript-file. URL: Absolute path to the JavaScript-file.
async (Optional): Determines if the script should load asynchronously.
callback (Optional): JavaScript function to execute when the script has finished loading.<\/td><\/tr>
runScripts<\/td>None<\/td>Evaluates all loaded script tags of type \"text\/plain\" with the attribute \"data-cookieconsent\" and executes the scripts in accordance with the user's consent state. For use by websites that load content dynamically, e.g. in single page applications. Scripts are only executed once, so this function is safe to call several times, e.g. every time new content is loaded.<\/td><\/tr>
withdraw<\/td>None<\/td>Withdraw my consent for this website.<\/td><\/tr>
submitCustomConsent<\/td>bool optinPreferences,
bool optinStatistics,
bool optinMarketing<\/td>		Use this outside the context of the cookie banner, such as a button in your site's header\/footer to opt in or out - Or to add a button to your banner that enables partial consent, to for instance \"Accept Preferences & Statistics\".<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n