Advanced Tutorials
Configurations override (API)

5min
IIn the context of CMP usage, it may be necessary to modify CMP configurations through custom logic within your website.To enable this, we introduce the ability to specify configurations through the global configuration override variable for the PubConsent CMP. Currently, this override is only possible in standard web integrations and not in AMP integrations, where it's available only if enabled the Consent Sharing: AMP <-> Web Standard﻿.
JS
window.__pub_tech_override_cmp_config
window.__pub_tech_override_cmp_config
﻿
Must be specified as an object:
JS
window.__pub_tech_override_cmp_config = {
	//...
}
window.__pub_tech_override_cmp_config = {
	//...
}
﻿
Inside, we can specify all the parameters we want to override, as in the example:
JS
window.__pub_tech_override_cmp_config = {
	policyUrl: 'https://www.yourwebsite.com/privacy-policy/',
  logoUrl: 'https://www.yourwebsite.com/img/logo.png',
	primaryColor: '#c66653', 
  secondaryColor: '',
  closeButtonColor: '',
  // Se the list below
}
window.__pub_tech_override_cmp_config = {
	policyUrl: 'https://www.yourwebsite.com/privacy-policy/',
  logoUrl: 'https://www.yourwebsite.com/img/logo.png',
	primaryColor: '#c66653', 
  secondaryColor: '',
  closeButtonColor: '',
  // Se the list below
}
﻿
It's important that this variable is specified before the CMP is executed.

For this reason, we recommend specifying this variable before the CMP integration script tag.

As shown in the example below:
HTML
...
<head>
    <script>
        window.__pub_tech_override_cmp_config = {
            policyUrl: 'https://www.yourwebsite.com/privacy-policy/',
            logoUrl: 'https://www.yourwebsite.com/img/logo.png',
            primaryColor: '#c66653',
        }
    </script>

	<!-- Integration code copied from PubConsent configurator -->

	<script>
		var __pub_tech_cmp_on_consent_queue = __pub_tech_cmp_on_consent_queue || [];
		__pub_tech_cmp_on_consent_queue.push(function onConsent(consentStrings, consentObject, publisherConsentObject) {
		  console.log(consentStrings, consentObject, publisherConsentObject);
		  // Put your logic here.
		});
	</script>
</head>
...
...
<head>
    <script>
        window.__pub_tech_override_cmp_config = {
            policyUrl: 'https://www.yourwebsite.com/privacy-policy/',
            logoUrl: 'https://www.yourwebsite.com/img/logo.png',
            primaryColor: '#c66653',
        }
    </script>

	<!-- Integration code copied from PubConsent configurator -->

	<script>
		var __pub_tech_cmp_on_consent_queue = __pub_tech_cmp_on_consent_queue || [];
		__pub_tech_cmp_on_consent_queue.push(function onConsent(consentStrings, consentObject, publisherConsentObject) {
		  console.log(consentStrings, consentObject, publisherConsentObject);
		  // Put your logic here.
		});
	</script>
</head>
...
﻿
Param list
Below, you can check all the configuration parameters.
﻿
acceptAllText: (string | null)
Description: Overrides the default text for the "Accept All" button in the user interface.
adaptiveFont: (boolean | null)
Description: If set to true, the font of the Consent Management Platform (CMP) will use the default font of the website (check your website's CSS).
buttonBorderStyle: (ButtonBorderStyle | null)
Description: Overrides the default style of the button border.
buttonShadow: (boolean | null)
Description: If true, removes the CSS box-shadow effect on buttons.
buttonThickness: (ThicknessButtonType | null)
Description: Specifies the thickness of the buttons.
Options: 0 (base), 1 (bold), 2 (medium).
closeButton: (boolean | null) 
Description: Enables advanced closure of the CMP through a "X" button at the top.
closeButtonAcceptAllBehaviour: (boolean | null)
Description: If true, the "X" close button behaves as accepting all purposes.
closeButtonBackgroundColor: (string | null)
Description: Overrides the background color of the close button.
closeButtonBorder: (boolean | null)
Description: If true, displays a border around the close button.
closeButtonBorderColor: (string | null)
Description: Overrides the border color of the close button.
closeButtonColor: (string | null)
Description: Overrides the primary color specifically for the close button.
closeButtonType: (CloseButtonType | null)
Description: Specifies the type of close button. Options: 0 ("X" button), 1 ("Close" button for GDPR), 2 (custom close with texts).
closeText: (string | null)
Description: Overrides the default text for the close button.
contentAlign: (UIAlignment | null)
Description: Specifies the alignment of the content inside the CMP.
customMessage: (string | null)
Description: Replaces the default message in the main panel of the CMP with a custom message. HTML format is supported.
Within the custom text, HTML can be inserted. Within the HTML, a link to the vendor list can be specified using an element with the 'partners-shortcut' class; the CMP will automatically enable clicking to open the vendor list. For the privacy policy link, we recommend adding the link as in the example at the bottom of the page. **(1)
debug: (boolean | null)
Description: Enables or disables the debug functionality of the CMP.
differentiateButtons: (boolean | null)
Description: If true, every button in the footer will have different style.
disableLegitimateMirror: (boolean | null)
Description: If true, the status of legal consents will not be reflected in the respective legitimate interests.
disableProofOfConsent: (boolean | null)
Description: If true, the proof of consent endpoint will not be called.
disableTracking: (boolean | null)
Description: If true, disables default CMP event tracking.
disableVendorsAutomaticallyEnabling: (boolean | null)
Description: If true, vendors will not be enabled for auditing.
expirationDaysForPartialConsents: (number | null)
Description: Sets the number of days before a partial consent expires and the CMP UI reappears.
flatUIPosition: (FlatUIPosition | null)
Description: Changes the position when the CMP UI uses the Flat UI parameter.
footerAlign: (UIAlignment | null)
Description: Specifies the footer alignment within the CMP.
forceLimitedAdsAtLeast: (boolean | null)
Description: Logical parameter.
hideMoreOptionsButton: (boolean | null)
Description: If true, hides the "More Options" button.
isFlatUI: (boolean | null)
Description: If true, indicates use of the flat version of the UI.
lockBodyScroll: (boolean | null)
Description: If true, blocks site scrolling when the CMP panel is shown.
logoAlign: (UIAlignment | null)
Description: Specifies the logo alignment within the CMP.
logoUrl: (string | null)
Description: Overrides the publisher's default logo URL.
manageOptionsText: (string | null)
Description: Overrides the default text for handling options.
openButton: (boolean | null)
Description: If true, show the button to reopen the CMP at the bottom.
openButtonCTAColor: (string | null)
Description: Specifies the color of the text or symbol used in the open button.
openButtonPosition: (OpenButtonPosition | null)
Description: Specifies the location of the open button (if enabled). Options: center, bottom.
openButtonSide: (OpenButtonSide | null)
Description: Specifies the screen side for the open button (if enabled). Options: left, right.
cookieName: (string | null) 
Description: Changes the name of the cookie used to save the TC string. Warning: Changing the cookie name does not delete the old cookie.
popupWallModeEnabled: (boolean | null)
Description: If true, show a popup after the user clicks the decline button to force an action. Behaviors differ based on the 'cookieWallModeEnabled' flag.
popupWallModeMessage: (string | null)
Description: Used when 'popupWallMode' is enabled to show a user a specific message under the title.
popupWallModeRequireAcceptOfMandatoryCookies: (boolean | null)
Description: If true, requires acceptance of mandatory cookies when 'popupWallMode' is enabled.
primaryColor: (string | null)
Description: Configures the primary color used by the CMP UI.
purposesIdsThatMustBeEnabled: (number[] | null)
Description: Forces specific primary scope IDs to be true in all cases.
secondaryColor: (string | null)
Description: Configures the secondary color used by the CMP UI.
skipBot: (boolean | null)
Description: If true, the CMP will not skip the bot and will accept everything directly without rendering.
skipRoutesConsentRequest: (string[] | null)
Description: Contains the paths where the CMP should be hidden.
switchCloseBtnToRight: (boolean | null)
Description: If true, place the close button on the right and the back button on the left.
titleAlign: (UIAlignment | null)
Description: Specifies the title alignment within the CMP.
uiBorderStyle: (UIBorderStyle | null)
Description: Overrides the default UI border style.
useCompactACStringAsCookie: (boolean | null)
Description: If true, store AC string in compact mode in cookie instead of localStorage. It must be true if the publisher needs sharing consent.
cookieWallModeEnabled: (boolean | null)
Description: If true, enables plan mode, preventing refusal of consent by forcing the user to accept everything or sign up for a subscription.
cookieWallModeLoginPage: (string | null)
Description: Required field used in the UI to create a button that redirects users to the login page when cookie wall mode is enabled.
cookieWallModeOptOutCookieName: (string | null)
Description: Required field used to exclude the CMP UI from being rendered to the user when cookie wall mode is enabled.
cookieWallModeSkipRoutesConsentRequest: (string[] | null)
Description: Paths where the CMP should skip the consent request when cookie wall mode is enabled.
cookieWallModeSubscriptionPageLink: (string | null)
Description: Required field used in the UI to create a button that redirects users to the plan (subscription) page when cookie wall mode is enabled.
﻿
**(1) Example link to privacy policy.
HTML
<a rel="nofollow noopener noreferrer" href="link to policy" target="_blank">privacy url</a>
<a rel="nofollow noopener noreferrer" href="link to policy" target="_blank">privacy url</a>
﻿
﻿
﻿
Updated 08 May 2024
Did this page help you?
Advanced Tutorials
Consent Sharing: AMP <-> Web Standard
Configurations override (API)

Param list

﻿
