Banner and Prior Consent – Setup and Customization (legacy)

Further parameters for developers

cookiePolicyUrl: (string) – This is the cookie policy’s URL linked within the banner. It is available in your privacy policy’s edit page in the “integration” tab. If you don’t define this parameter it will refer to the cookie policy generated by iubenda and hosted on our servers. You can alternatively choose to host the cookie policy on a page of your website and thus fill this field with the related URL. Remember that if you decide to host the cookie policy on your own page, this page should not use cookies, beyond the technical ones. Note: this parameter will be ineffective if you are using a custom HTML for the banner (see the configuration banner.html below)

cookiePolicyInOtherWindow: (boolean, default false) – If you set this parameter to true the cookie policy will open in another window instead of the iubenda modal window

rebuildIframe (boolean, default false) – Once the user’s consent has been recorded, the default behavior of the Cookie Solution is to restore the iframes previously modified in order to make them working again. By setting this parameter to true, the iframes previously blocked are fully regenerated (or reintegrated) after the collection of consent.

preserveOriginalClasses (boolean, default false) – By default, the original classes of the snippets are deleted as a result of their reactivation. By setting this parameter to true, it makes sure that the original classes remain intact even after the activation.

preserveIubClasses (boolean, default false) – By default, the “_iub_cs_activate” class is deleted as a result of the reactivation of the snippet. By setting this parameter on true you allow this class to remain defined after the reactivation. Note: to be effective, this parameter requires also the parameter preseveOriginalClasses to be set to true (see above for further details). Moreover, this parameter has no effect on the snippets tagged with _iub_activate-inline.

inlineDelay (integer, milliseconds, default 800 (safemode 500)) – The maximum time between the activations of snippets tagged with the class _iub_cs_activate-inline (the snippet tagged in this way are activated sequentially). By decreasing this value you will reduce the total time of activation. CAUTION: The default value is set in order for the snippets to work properly; reducing it may prevent the successful activation of some snippet. It is highly recommended to check the activation of the snippet shown on your page if this setting is changed.

startOnDomReady (boolean, default false) – if true banner rendering and/or activation of blocked snippets will be performed as soon as the document status is ‘loaded’ (i.e. when the DOM reaches the ‘loaded’ status); This implies that banner rendering and/or snippet activation may occur while some resources are still being loaded (such as scripts, images, css, etc.). If the option is set to false, then the Cookie Solution will start when the page has been fully loaded (i.e. when the DOM status is ‘completed’ and all resources included in the page have been loaded) (available only on the Safemode version).

enableCMP (boolean, default false) — if true, a “customize advertising tracking” link will appear in the bottom section of Cookie Policy modal window. When clicked, this link will open a window that allows users to manage their advertising tracking preferences according to the IAB Transparency and Consent Framework. Learn more.

askConsentIfCMPNotFound (boolean, default true) — if set to true, and the IAB CMP Framework preference is not found, the Cookie Solution will, by default, request a new consent from users that had provided consent prior to the activation of the Framework. Set this option to false to disable this default behavior.

logLevel: (string) – It defines the verbosity of the logger (available values: ‘debug’, ‘info’, ‘warn’, ‘error’, ‘fatal’; the default value is ‘nolog’)).

Available classes

• iubenda-cs-close-btn – By adding this class to any element of the page, the click on the item closes the banner and assumes that the consent is provided (in an equivalent manner to the click on the X button of the banner).

• iubenda-cs-cookie-policy-lnk – By adding this class to any element of the page, the click on that element allows the displaying of the Cookie Policy (it’s equivalent to the click on the link to the Cookie Policy).

Examples

Here is an example of configuration with the optional parameters:

<script type="text/javascript">
var _iub = _iub || [];
  _iub.csConfiguration = {
    siteId: 234578,
    cookiePolicyId: 340542,
    cookiePolicyUrl: 'http://www.site.com/cookie-policy',
    enableRemoteConsent: false,
    consentOnScroll: false,
    banner: {
        slideDown: false,
      zIndex: 99999998,
      content: "
Informativa
" +
      "
Questo sito o gli strumenti terzi da questo utilizzati si avvalgono di cookie necessari al funzionamento ed utili alle finalit&agrave; illustrate nella cookie policy. Se vuoi saperne di pi&ugrave; o negare il consenso a tutti o ad alcuni cookie, consulta la %{cookie_policy_link}.
Chiudendo questo banner, scorrendo questa pagina o cliccando qualunque suo elemento acconsenti all’uso dei cookie.
",
      cookiePolicyLinkCaption: "cookie policy",
        backgroundColor: "#CCC",
        textColor: "#000",
        fontSize: "12px",
        innerHtmlCloseBtn: "OK"
    },
    footer: {
      message: 'Proseguendo la navigazione o chiudendo la finestra presti il tuo consenso all\'installazione dei cookie.',
      btnCaption: 'Prosegui la navigazione'
    },
    callback: {
      onBannerShown: function(){doSomethingOnBannerShown()},
      onConsentGiven: function(){setCustomCookies()}
    },
    preferenceCookie: {
      expireAfter: 365
    },    
    consentOnButton: true,
  };
  (function (w, d) {
    var loader = function () { var s = d.createElement("script"), tag = d.getElementsByTagName("script")[0]; s.src = "//cdn.iubenda.com/cookie_solution/iubenda_cs.js"; tag.parentNode.insertBefore(s, tag); };
    if (w.addEventListener) { w.addEventListener("load", loader, false); } else if (w.attachEvent) { w.attachEvent("onload", loader); } else { w.onload = loader; }
    })(window, document);
</script>

Other examples of possible configurations:

• Standard values
• Banner above the footer
• Banners in other colors
• Banner placed over the header
• Banner in an unsupported language (with custom “Accept” and “Learn more” buttons)

API

The iubenda Cookie Solution features a JS API for easy interaction with some of its main functions.

Syntax: _iub.cs.api.METHOD_NAME

The available methods are:

• printErrors(): prints any errors in the iubenda Cookie Solution on the browser console.

• showCP(): shows the Cookie Policy (similarly to when you click on the link to the Cookie Policy in the banner or on another link with the iubenda-cs-cookie-policy-lnk class, as described here)

• consentGiven(): provides consent. The method accepts the following as optional parameters:

  • eventName: (string), one of the following: documentClicked (default), documentScrolled, documentMoved, bannerXclose, cookiePolicyClosed; indicates the type of action by which consent is provided.
  • force: (boolean), true | false (default): if false, iubenda CS ensures that the banner is shown before actually accepting the consent; instead, by providing this option to true, consent is received in any case.

  Note: the call to this method assumes the consent provided is completely equivalent to when it is provided via UI, e.g. with page scrolling. Therefore, all actions downstream of the consent provided are performed, including the updating of the preference cookie, the activation of the previously blocked snippets and the invocation of the onConsentFirstGiven and onConsentRead callbacks.

  To activate only the snippets there’s the activateSnippets() method.

• activateSnippets(): activate the previously blocked snippets.
  Note: this method can be invoked repeatedly – already-activated snippets will not be taken into account. It is therefore useful in those installations where, upon collection of consent, previously blocked content that now needs to be activated, is dynamically added to the page (e.g. lazy loading or infinite scrolling).

  For the Safemode version only, this method has the option runOnActivationDoneCallback (boolean, default false) which, if true, will execute the onActivationDone callback upon completion of the activation of the snippet (see onActivationDone callback).

• isConsentGiven()(DOMElement, default window.document): returns true if the consent was given, otherwise it returns false.

• setConsentOnScrollOnElement()(boolean): the call to this method defines the element on which the scroll will be observed for the purpose of consent.

  Note: this method is useful when you want to take advantage of the consentOnScrollOnElement option, but the DOMelement is not yet available when the Cookie Solution is initialized. In this regard it’s possible to use the onBannerShow callback (example) which occurs when the CS is initialized.

Interpreting of the preference cookie

The consent provided by the user is saved in some cookies within the host page’s domain. By verifying the presence or the absence of these cookies you can determine whether the user has given their consent or not.

In particular, the consent is considered provided if there is the cookie _iub_cs-s[siteId] or the cookie _iub_cs-[cookiePolicyId], where siteId and cookiePolicyId are the parameters provided in the embedding code (in the case shown above, the two cookies to look for will be _iub_cs-s234578 and _iub_cs-340542). Below is an example of JavaScript code for reading out the client-side consent:

function isConsentGiven (siteId,cookiePolicyId){
        var cs = document.cookie.split(';');
  for (var i = 0; i < cs.length; i++) {
    while (cs[i].charAt(0) == ' ') cs[i] = cs[i].substring(1);
    if(cs[i].indexOf('_iub_cs-s'+ siteId) == 0||cs[i].indexOf('_iub_cs-'+ cookiePolicyId) == 0) return true;}
  return false;
}

By placing this code as high as possible within the page you can read the consent given and transmit this information to all other JavaScripts that follow.