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

Observação: A Adobe Experience Platform Launch está sendo reformulada como um conjunto de tecnologias de coleta de dados no Experience Platform. Essas alterações serão implementadas em toda a documentação do produto nas próximas semanas. Consulte o seguinte document para obter uma referência consolidada das alterações de terminologia.

Um módulo de biblioteca de tipo de ação é destinado a realizar uma ação, qualquer ação. O que essa ação faz é inteiramente de sua escolha. Deseja enviar um beacon, mostrar uma oferta, agradecer ao usuário por visitar, salvar um cookie ou abrir um bate-papo de suporte?

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 pressupõe que você esteja familiarizado com os módulos de biblioteca e como eles são integrados nas extensões do Platform Launch. 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.

module.exports = function(settings) {
  alert('Thanks for visiting our site!');
};

Agora, considere uma situação em que você deseja tornar a mensagem configurável pelo usuário do Adobe Experience Platform Launch. Você pode permitir que o usuário insira uma mensagem e, em seguida, a salve no objeto de configurações, com o objeto com aparência semelhante a:

{
  "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 é transmitido ao seu módulo, que contém informações contextuais sobre o evento que acionou 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