Tipos de elementos de dados para extensões de borda

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 da biblioteca de tipo de elemento de dados tem uma meta: recuperar dados. A maneira como esses dados são recuperados depende de você. Por exemplo, você pode usar um tipo de elemento de dados para permitir que os usuários do Adobe Experience Platform Launch recuperem dados de um armazenamento local, um cookie ou um elemento DOM.

IMPORTANTE

Esse documento abrange tipos de elementos de dados para extensões da Web. Se você estiver desenvolvendo uma extensão de borda, consulte o manual sobre tipos de elementos de dados 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.

Considere uma situação em que você deseja permitir que os usuários recuperem dados de um item de armazenamento local chamado productName. Seu módulo pode ser semelhante a:

module.exports = function(settings) {
  return localStorage.getItem('productName');
}

Se você quiser que o nome do item de armazenamento local seja configurável pelo usuário do Platform Launch, poderá permitir que o usuário insira um nome e depois o salve no objeto settings. O objeto pode ser semelhante a:

{
  itemName: "campaignId"
}

Para operar no nome do item de armazenamento local definido pelo usuário, seu módulo precisará mudar para:

module.exports = function(settings) {
  return localStorage.getItem(settings.itemName);
}

Suporte a valores padrão

Esteja ciente de que os usuários têm a opção de configurar um valor padrão para qualquer elemento de dados. Se o módulo da biblioteca de elementos de dados retornar um valor de undefined ou null, ele será automaticamente substituído pelo valor padrão que o usuário configurou para o elemento de dados.

Dados do evento contextuais

Se o elemento de dados estiver sendo recuperado como resultado do acionamento de uma regra (por exemplo, elementos de dados são usados nas condições e ações da regra), um segundo argumento será transmitido ao módulo com 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