Tipos de ação para extensões da Web

OBSERVAÇÃO

A Adobe Experience Platform Launch foi reformulada como um conjunto de tecnologias de coleta de dados no Adobe Experience Platform. Como resultado, várias alterações de terminologia foram implementadas na documentação do produto. Consulte o seguinte documento para obter uma referência consolidada das alterações de terminologia.

No contexto de tags de coleta de dados, uma ação é algo que é executado depois que um evento de regra ocorre e todas as condições passaram na avaliação.

Por exemplo, uma extensão pode fornecer um tipo de ação "mostrar o bate-papo de suporte", que pode exibir uma caixa de diálogo de bate-papo de suporte para ajudar usuários que estejam com dificuldades ao fazer check-out.

Este documento aborda como definir tipos de ação para uma extensão da Web no Adobe Experience Platform.

IMPORTANTE

Esse documento abrange tipos de ação para extensões da Web. Se você estiver desenvolvendo uma extensão de borda, consulte o manual sobre tipos de ação para extensões de borda.

Este documento também pressupõe que você esteja familiarizado com os módulos de biblioteca e como eles são integrados nas extensões da Web. Se você precisar de uma introdução, consulte a visão geral sobre formatação do módulo de biblioteca antes de retornar a este guia.

Os tipos de ação normalmente consistem no seguinte:

  1. Uma view mostrada na interface do usuário da coleta de dados que permite que os usuários modifiquem as configurações da ação.
  2. Um módulo de biblioteca emitido na biblioteca de tempo de execução de tags para interpretar as configurações e executar uma ação.
module.exports = function(settings) {
  alert('Thanks for visiting our site!');
};

Por exemplo, para tornar a mensagem configurável pelo usuário do Adobe Experience Platform, é possível permitir que o usuário insira e salve uma mensagem no objeto de configurações. O objeto com esta aparência:

{
  "message": "Thank you for being one of our VIP members!"
}

Para operar na mensagem definida pelo usuário, seu módulo precisará ser alterado para:

module.exports = function(settings) {
  alert(settings.message);
}

Dados do evento contextuais

Um segundo argumento teria que ser passado para o módulo que contém as informações contextuais sobre o evento que aciona a regra. Pode ser benéfico em certos casos e pode ser acessado da seguinte forma:

module.exports = function(settings, event) {
  // event contains information regarding the event that fired the rule
};

O objeto event deve conter as seguintes propriedades:

Propriedade Descrição
$type Uma string que descreve o nome da extensão e o nome do evento, unida usando um ponto. Por exemplo, youtube.play.
$rule Um objeto que contém informações sobre a regra em execução no momento. O objeto deve conter as seguintes subpropriedades:
  • id: a ID da regra em execução no momento.
  • name: o nome da regra em execução no momento.

Como alternativa, a extensão que fornece o tipo de evento que acionou a regra pode adicionar outras informações úteis a esse objeto event.

Nesta página