Show Menu
TÓPICOS×

Referência a objeto do Launch

Em muitos campos de formulário na interface do usuário do Launch, é possível usar a sintaxe %% para fazer referência às variáveis, reduzindo a necessidade de chamar _satellite.getVar() . Por exemplo, usar %product% acessará o valor do elemento de dados do produto ou a variável personalizada.

Referência a objeto do Launch

Essa referência documenta o objeto _satellite e as coisas que você pode fazer com ele.

track

Código

_satellite.track(identifier: string [, detail: *] )

Exemplo

_satellite.track('contact_submit', { name: 'John Doe' });

Aciona todas as regras usando o tipo de evento Chamada direta da extensão principal configurada com o identificador especificado. O exemplo acima aciona todas as regras usando um tipo de evento Chamada direta em que o identificador configurado é contact_submit . Um objeto opcional contendo informações relacionadas também é transmitido. O objeto detalhado pode ser acessado digitando %event.detail% em um campo de texto em uma condição ou ação ou event.detail dentro do editor de códigos em uma condição ou ação de código personalizado.

getVar

Código

_satellite.getVar(name: string) => *

Exemplo

var product = _satellite.getVar('product');

Se um elemento de dados existir com um nome correspondente, o valor do elemento de dados será retornado. Se não houver nenhum elemento de dados correspondente, ele verificará se uma variável personalizada com um nome correspondente foi definida anteriormente usando o _satellite.setVar() . Se uma variável personalizada correspondente for encontrada, seu valor será retornado.
Observe que em muitos campos de formulário na interface do usuário do Launch, é possível usar a sintaxe %% para fazer referência a variáveis, reduzindo a necessidade de chamar _satellite.getVar() . Por exemplo, usar %product% acessará o valor do elemento de dados do produto ou a variável personalizada.

setVar

Código

_satellite.setVar(name: string, value: *)

Exemplo

_satellite.setVar('product', 'Circuit Pro');

Define uma variável personalizada com um determinado nome e valor. O valor da variável pode ser acessado posteriormente usando _satellite.getVar() .
Como opção, é possível definir várias variáveis de uma vez transmitindo um objeto em que as chaves são nomes de variáveis e os valores são os respectivos valores de variáveis.
_satellite.setVar({ 'product': 'Circuit Pro', 'category': 'hobby' });

getVisitorId

Código

_satellite.getVisitorId() => Object

Exemplo

var visitorIdInstance = _satellite.getVisitorId();

Se a extensão Adobe Experience Cloud ID for instalada na propriedade, esse método retornará a instância da ID de visitante. Consulte a documentação do Experience Cloud ID Service para obter mais informações.

logger

Código

_satellite.logger.log(message: string)

_satellite.logger.info(message: string)

_satellite.logger.warn(message: string)

_satellite.logger.error(message: string)

Exemplo

_satellite.logger.error('No product ID found.');

Registra uma mensagem no console do navegador. A mensagem será exibida somente se a depuração do Launch estiver habilitada pelo usuário (chamando _satellite.setDebug(true) ou usando uma extensão apropriada do navegador).

buildInfo

Código

_satellite.buildInfo

Esse objeto contém informações sobre a build da biblioteca de tempo de execução atual do Launch. O objeto contém as seguintes propriedades:

turbineVersion

A versão Turbine usada dentro da biblioteca atual.

turbineBuildDate

A data da ISO 8601 quando a versão de Turbine usada no container foi criada.

buildDate

A data da ISO 8601 quando a biblioteca atual foi criada.

ambiente

O ambiente para o qual essa biblioteca foi criada. Os valores possíveis são:
  • desenvolvimento
  • armazenamento temporário
  • produção
Este exemplo demonstra os valores do objeto:
{
  turbineVersion: "14.0.0",
  turbineBuildDate: "2016-07-01T18:10:34Z",
  buildDate: "2016-03-30T16:27:10Z",
  environment: "development"
}

notificar

Esse método foi substituído. Em vez disso, use _satellite.logger.log() .

Código

_satellite.notify(message: string[, level: number])

Exemplo

_satellite.notify('Hello world!');

Registra uma mensagem no console do navegador. A mensagem será exibida somente se a depuração do Launch estiver habilitada pelo usuário (chamando _satellite.setDebug(true) ou usando uma extensão apropriada do navegador).
Um nível de registro opcional pode ser transmitido, o que afetará o estilo e a filtragem da mensagem que está sendo registrada. Os níveis suportados são os seguintes:
3 - Mensagens informativas.
4 - Mensagens de aviso.
5 - Mensagens de erro.
Se você não fornecer um nível de registro ou passar qualquer outro valor de nível, a mensagem será registrada como uma mensagem regular.

setCookie

Esse método foi substituído. Em vez disso, use _satellite.cookie.set() .

Código

_satellite.setCookie(name: string, value: string, days: number)

Exemplo

_satellite.setCookie('product', 'Circuit Pro', 3);

Define um cookie no navegador do usuário. O cookie persistirá pelo número de dias especificados.

readCookie

Esse método foi substituído. Em vez disso, use _satellite.cookie.get() .

Código

_satellite.readCookie(name: string) => string

Exemplo

var product = _satellite.readCookie('product');

Lê um cookie no navegador do usuário.

removeCookie

Esse método foi substituído. Em vez disso, use _satellite.cookie.remove() .

Código

_satellite.removeCookie(name: string)

Exemplo

_satellite.removeCookie('product');

Remove um cookie no navegador do usuário.

Funções de depuração

As funções a seguir não devem ser acessadas do código de produção. Elas são destinados apenas à depuração e serão alteradas ao longo do tempo, conforme necessário.

container

Código

_satellite._container

Exemplo

Esta função não deve ser acessada do código de produção. Ela é destinada apenas à depuração e será alterada ao longo do tempo, conforme necessário.

monitor

Código

_satellite._monitors

Exemplo

Esta função não deve ser acessada do código de produção. Ela é destinada apenas à depuração e será alterada ao longo do tempo, conforme necessário.

Amostra

Em sua página da Web que executa uma biblioteca do Launch, adicione um snippet de código ao seu HTML. Normalmente, o código é colocado na tag <head> , antes da tag <script> que carrega a biblioteca Launch. Isso permite que o monitor capture os primeiros eventos do sistema que ocorrerem na biblioteca Launch. Por exemplo:
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Title</title>
  <script>
    window._satellite = window._satellite || {};
    window._satellite._monitors = window._satellite._monitors || [];
    window._satellite._monitors.push({
      ruleTriggered: function (event) {
        console.log(
          'rule triggered',
          event.rule
        );
      },
      ruleCompleted: function (event) {
        console.log(
          'rule completed',
          event.rule
        );
      },
      ruleConditionFailed: function (event) {
        console.log(
          'rule condition failed',
          event.rule,
          event.condition
        );
      }
    });
  </script>
  <script src="//assets.adobedtm.com/launch-EN5bfa516febde4b22b3e7c6f96f6b439f.min.js"
          async></script>
</head>
<body>
  <h1>Click me!</h1>
</body>
</html>

Na tag do primeiro script, como a biblioteca Launch ainda não foi carregada, o objeto _satellite inicial será criado e uma matriz no _satellite._monitors será inicializada. O script então adiciona um objeto de monitor a essa matriz. O objeto do monitor pode especificar os seguintes métodos que serão chamados, posteriormente, pela biblioteca Launch:

ruleTriggered

Chamado depois que um evento aciona uma regra, mas antes de as condições e ações da regra terem sido processadas. O objeto do evento transmitido para ruleTriggered contém informações sobre a regra que foi acionada.

ruleCompleted

Chamada depois que uma regra tiver sido totalmente processada. Em outras palavras, o evento ocorreu, todas as condições foram transmitidas e todas as ações foram executadas. O objeto do evento transmitido para ruleCompleted contém informações sobre a regra que foi concluída.

ruleConditionFailed

Chamada depois de uma regra ter sido acionada e uma de suas condições ter falhado. O objeto do evento transmitido para ruleConditionFailed contém informações sobre a regra que foi acionada e a condição que falhou.
Se ruleTriggered for chamado, ruleCompleted ou ruleConditionFailed será chamado logo depois disso.
Um monitor não precisa especificar todos os três métodos ( ruleTriggered , ruleCompleted e ruleConditionFailed ). O Launch funciona com os métodos compatíveis fornecidos pelo monitor.

Teste do monitor

O exemplo acima especifica todos os três métodos no monitor. Quando são chamados, o monitor faz logout de informações relevantes. Para testar isso, configure duas regras na biblioteca do Launch:
  1. Uma regra com um evento de clique e uma condição do navegador que é transmitida somente se o navegador for Chrome.
  2. Uma regra com um evento de clique e uma condição do navegador que é transmitida somente se o navegador for Firefox.
Se você abrir a página em Chrome, abrir o console do navegador e clicar na página, o seguinte aparecerá no console:
Os trechos ou as informações adicionais podem ser adicionados a esses manipuladores, conforme necessário.