Passar para o conteúdo principal

Opções e modo avançado: axeptioSettings

Escrito por Alexandre Dias Da Silva

Você pode configurar o comportamento do SDK passando opções preliminares antes de carregar o script.

Ao carregar o script, nosso SDK verificará se um objeto axeptioSettings foi declarado anteriormente. Se for o caso, ele extrairá os parâmetros dele.

Quando você instala o Axeptio :

Ao copiar/colar nosso script, você verá uma das primeiras configurações obrigatórias que é o clientId.


É o identificador único do seu projeto que permite carregar sua configuração.

Você também tem o cookiesVersion que é um dos parâmetros que pode ser enviado ao nosso SDK.

Todas as opções de axeptioSettings

No objeto axeptioSettings, você pode adicionar outros parâmetros que nosso SDK sabe interpretar.


Como aqui o userCookiesDuration que é o número de dias de duração de vida do cookie.


Aqui configurado para 180 dias.


Todos os parâmetros têm valores padrão que você pode deixar sem modificar.

window.axeptioSettings = {
userCookiesDuration: 180
}

As diferentes propriedades deste objeto são as seguintes :

/** @type {string} clientId ObjectID corresponding to the project object */
clientId;

/** @type {Token} user token set by the website (if the user is logged in)*/
tokenInstance;

/**
* String identifier of the version of Cookie configuration
* that should be loaded. If this parameter is omitted, then it's the "pages"
* property in the configuration that gets parsed in case of
* multiple cookies configurations.
* @type {string}
*/
cookiesVersion;

/**
* Flag to tell whether GTM Events should be written in the dataLayer variable or not
* @type {boolean}
*/
triggerGTMEvents = true;

/**
* Name of the cookies containing the JSON value of user choices
* @type {string}
*/
jsonCookieName = 'axeptio_cookies';

/**
* Name of the cookies that stores authorized vendors (comma-separated string)
* @type {string}
*/
authorizedVendorsCookieName = 'axeptio_authorized_vendors';

/**
* Name of the cookies that stores authorized vendors (comma-separated string)
* @type {string}
*/
allVendorsCookieName = 'axeptio_all_vendors';

/**
* Number of days used the cookie holding user's choices should be active
* @type {number|"page"|"session"}
*/
userCookiesDuration = 365;

/**
* If specified, domain name on which the cookie containing user choices
* will be available. This allows to request one consent for various subdomains
* @type {string}
*/
userCookiesDomain = 'mondomaine.com';

/**
* If specified, define the SameSite value of the cookie. Usually Lax, Strict or None.
* @type {string}
*/
userCookiesSameSite;

/**
* Whether or not the cookie holding choices is HTTPS only
* @type {boolean}
*/
userCookiesSecure = true;

/**
* If set to true, Axeptio will open the cookie widget if the vendors described
* in the current cookie config do not match the vendors saved in the visitors
* cookies.
* @type {boolean}
*/
openCookiesWidgetIfVendorsMismatch = false;

/**
* ClassName of the <div> tag were Axeptio's WebsiteOverlay will be mounted
* @type {string}
*/
mountClassName = 'axeptio_mount';

/**
* URL on which the widget will send its POST and GET requests, if you use serverSide
* for querying and storing consent proofs.
* @type {string}
*/
apiUrl = 'https://api.axept.io/v1';

/**
* Boolean for the geolocation feature
* To base it on the website's language
* Or the browser language (default)
* @type {boolean}
*/
useDocumentLang = false;

Varnish

Para usuários do Varnish, o cache de conteúdo proíbe o uso de cookies, a menos que eles sejam prefixados. Consulte a documentação do Gandi sobre este assunto. Para contornar essa limitação, você pode renomear os dois cookies do Axeptio declarando-os no seu objeto axeptioSettings :

window.axeptioSettings = { 
authorizedVendorsCookieName: "STYXKEY_axeptio_vendors",
jsonCookieName: "STYXKEY_axeptio_json"
}
Respondeu à sua pergunta?