Como usar o snippet de ocultação de página do Optimize

Este guia explica como usar o snippet de ocultação de página do Optimize, que possibilita carregar o contêiner de forma assíncrona enquanto mantém a página oculta (até a conclusão do carregamento do contêiner). Esse processo garante que os usuários não vejam o conteúdo da página inicial antes que ele seja modificado por um experimento.

Código do snippet de ocultação de página

Para adicionar o snippet de ocultação de página ao seu site, insira o código a seguir na seção <head> de todas as páginas que carregam o contêiner do Optimize antes de qualquer outro código. Você também precisa substituir a string GTM-XXXXXX pelo código do seu contêiner do Optimize:

<style>.async-hide { opacity: 0 !important} </style>
<script>(function(a,s,y,n,c,h,i,d,e){s.className+=' '+y;h.start=1*new Date;
h.end=i=function(){s.className=s.className.replace(RegExp(' ?'+y),'')};
(a[n]=a[n]||[]).hide=h;setTimeout(function(){i();h.end=null},c);h.timeout=c;
})(window,document.documentElement,'async-hide','dataLayer',4000,
{'GTM-XXXXXX':true});</script>

Para entender melhor como funciona o snippet de ocultação de página do Optimize, consulte a versão comentada abaixo:

<!-- Optimize page-hiding CSS code -->
<style>
/* Sets the opacity of any element with this class to 0 */
.async-hide {
  opacity: 0 !important
}
</style>

<!-- Optimize page-hiding JavaScript code -->
<script>
/**
 * Adds a class to the <html> element that hides the page until the Optimize
 * container is loaded and the experiment is ready. Once Optimize is ready
 * (or 4 seconds has passed), the class is removed from the <html> element
 * and the page becomes visible again.
 *
 * @param {Window} a The global object.
 * @param {HTMLHtmlElement} s The <html> element.
 * @param {string} y The name of the class used to hide the <html> element.
 * @param {string} n The name of property that references the dataLayer object.
 * @param {number} c The max time (in milliseconds) the page will be hidden.
 * @param {Object} h An object whose keys are Optimize container IDs.
 * @param {undefined} i (unused parameter).
 * @param {undefined} d (unused parameter).
 * @param {undefined} e (unused parameter).
 */
(function(a, s, y, n, c, h, i, d, e) {
  // Adds a class (defaulting to 'async-hide') to the <html> element.
  s.className += ' ' + y;

  // Keeps track of the exact time that the snippet executes.
  h.start = 1*new Date;

  // Creates a function and assigns it to a local variable `i` as well as
  // the `end` property of the Optimize container object. Once Optimize is
  // loaded it will call this function, which will remove the 'async-hide'
  // class from the <html> element, causing the page to become visible again.
  h.end = i = function() {
    s.className = s.className.replace(RegExp(' ?' + y), '');
  };

  // Initalizes the dataLayer as an empty array if it's not already initialized
  // and assigns the passed Optimize container object to the dataLayer's `hide`
  // property. This makes the function defined above accessible globally at the
  // path `window.dataLayer.hide.end`, so it can be called by Optimize.
  (a[n] = a[n] || []).hide = h;

  // Creates a timeout that will call the page-showing function after the
  // timeout amount (defaulting to 4 seconds), in the event that Optimize has
  // not already loaded. This ensures your page will not stay hidden in the
  // event that Optimize takes too long to load.
  setTimeout(function() {
    i();
    h.end = null
  }, c);
  h.timeout = c;
})(
    window, // The initial value for local variable `a`.
    document.documentElement, // The initial value for local variable `s`.
    'async-hide', // The initial value for local variable `y`.
    'dataLayer', // The initial value for local variable `n`.
    4000, // The initial value for local variable `c`.
    {'GTM-XXXXXX': true} // The initial value for local variable `h`.
);
</script>

Como personalizar o snippet de ocultação de página

Em alguns casos, você precisa personalizar o snippet de ocultação de página para atingir os seguintes objetivos:

  • Possibilitar o carregamento de vários contêineres do Optimize.
  • Prolongar o tempo limite de retorno de chamada.
  • Alterar o nome da classe adicionada ao elemento <html>.

Como carregar vários contêineres

Se estiver carregando vários contêineres do Optimize, você poderá personalizar o snippet para garantir que a página permaneça oculta até a conclusão do carregamento de todos eles.

Para especificar mais de um contêiner, adicione outras chaves ao objeto do contêiner no final do snippet. O código a seguir aguarda o carregamento dos contêineres GTM-XXXXXX e GTM-YYYYYY:

<style>.async-hide { opacity: 0 !important} </style>
<script>(function(a,s,y,n,c,h,i,d,e){s.className+=' '+y;h.start=1*new Date;
h.end=i=function(){s.className=s.className.replace(RegExp(' ?'+y),'')};
(a[n]=a[n]||[]).hide=h;setTimeout(function(){i();h.end=null},c);h.timeout=c;
})(window,document.documentElement,'async-hide','dataLayer',4000,
{'GTM-XXXXXX':true,'GTM-YYYYYY':true});</script>

Como alterar o tempo limite

Para alterar o período de espera do Optimize antes de remover a classe .async-hide do elemento <html> (caso o Optimize demore mais do que o esperado para carregar), atualize o número informado no final do snippet.

Com o código a seguir, você implementa uma espera de 5.000 milissegundos antes de mostrar a página:

<style>.async-hide { opacity: 0 !important} </style>
<script>(function(a,s,y,n,c,h,i,d,e){s.className+=' '+y;h.start=1*new Date;
h.end=i=function(){s.className=s.className.replace(RegExp(' ?'+y),'')};
(a[n]=a[n]||[]).hide=h;setTimeout(function(){i();h.end=null},c);h.timeout=c;
})(window,document.documentElement,'async-hide','dataLayer',5000,
{'GTM-XXXXXX':true});</script>

Como alterar o nome da classe async-hide

Se o nome da classe async-hide já estiver definido no seu CSS, você poderá escolher um nome diferente. Para alterá-lo, atualize a classe na tag <style> e no argumento informado no final do snippet.

O código a seguir usa a classe optimize-loading em vez de async-hide:

<style>.optimize-loading { opacity: 0 !important} </style>
<script>(function(a,s,y,n,c,h,i,d,e){s.className+=' '+y;h.start=1*new Date;
h.end=i=function(){s.className=s.className.replace(RegExp(' ?'+y),'')};
(a[n]=a[n]||[]).hide=h;setTimeout(function(){i();h.end=null},c);h.timeout=c;
})(window,document.documentElement,'optimize-loading','dataLayer',4000,
{'GTM-XXXXXX':true});</script>