Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The functions enableWelcomeTitle and enableWelcomeText enable a welcome text for the AdConsent GDPR GUI main page, that explains the user in an easy-to-understand way which consent the user is asked for. This text is shown before the fixed legal texts that are required by a IAB certified CMP. The welcome title and text are by default disabled and can be enabled using these functions. The text can be customized with the publishers' own text by using setTranslationFiles.

Syntax

function adconsent.gdpr()

...

argument name

type

optional

value

description

command

string

'enableWelcomeText'

Sets a customizable description in the CMP GUI first layer.

parameter

-

✔️

-

Not applicable.

callback

function

✔️

function(result:boolean, success:boolean)

The callback function that is called with the function call result.

Description

Enabling the title and/or the description text allows the publisher to better customize the CMP appearance and the message to be sent to the user before entering the legal wording paragraphs. AdConsent default is to have these labels disabled, having a general look much like the one below:

...

The default texts as seen in the images above are defaults provided by AdConsent and available in all supported languages.These texts are also fully customizable through the setTranslationFiles function, and accept HTML in them for a style and/or link customization.

...

When providing custom translations, multi-language support should be considered as well. As an alternative, if the page focuses on one language only, forceLocale and setDefaultLocale should be considered. This example provides only a translation for English and forces the CMP language to show text only in English as well.

...