DocumentaçãoExperience PlatformTutorial do SDK da web

Criar regras de tag

Last update: Thu Jul 18 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • Iniciante
  • Intermediário
  • Desenvolvedor

Saiba como enviar eventos para o Edge Network Adobe Experience Platform com seu objeto XDM usando regras de tag. Uma regra de tag é uma combinação de eventos, condições e ações que instrui a propriedade de tag a fazer algo. Com o SDK da Web da Platform, as regras são usadas para enviar eventos para o Platform Edge Network com os dados corretos.

Objetivos de aprendizagem

No final desta lição, você poderá:

  • Usar uma convenção de nomenclatura para gerenciar regras nas tags
  • Enviar um evento com campos XDM usando ações Atualizar variável e Enviar evento
  • Empilhar vários conjuntos de campos XDM em várias regras
  • Mapear elementos de dados de matriz individuais ou inteiros para o objeto XDM
  • Publish uma regra de tag para uma biblioteca de desenvolvimento

Pré-requisitos

Você está familiarizado com as tags da Coleção de dados e o site de demonstração Luma e concluiu as lições anteriores no tutorial:

Convenções de nomenclatura

Para gerenciar regras em tags, é recomendável seguir uma convenção de nomenclatura padrão. Este tutorial usa uma convenção de nomenclatura de cinco partes:

  • [local] - [evento] - [finalidade] - [ordem]

onde;

  1. local é a(s) página(s) no site em que a regra é acionada
  2. evento é o acionador da regra
  3. propósito é a ação principal executada pela regra
  4. ordem é a ordem na qual a regra deve ser acionada em relação a outras regras

Criar regras de tag

Nas tags, as regras são usadas para executar ações (acionar chamadas) em várias condições. A extensão de tags do SDK da Web da Platform inclui duas ações usadas nesta lição:

  • A variável de atualização mapeia elementos de dados para propriedades em um objeto XDM
  • Enviar evento envia o objeto XDM para o Edge Network Experience Platform

No restante desta lição:

  1. Crie uma regra com a ação Atualizar variável para definir uma "configuração global" de campos XDM.

  2. Crie regras adicionais com a ação Atualizar variável que substituem nossa "configuração global" e contribuem com campos XDM adicionais em determinadas condições (por exemplo, adicionar detalhes do produto nas páginas de produtos).

  3. Crie outra regra com a ação Enviar evento, que enviará o objeto XDM completo para o Edge Network do Adobe Experience Platform.

Todas essas regras serão sequenciadas corretamente usando a opção "order".

Este vídeo fornece uma visão geral do processo:

https://video.tv.adobe.com/v/3427710/?learn=on

Campos de configuração global

Para criar uma regra de tag para os campos XDM globais:

  1. Abra a propriedade da tag que você está usando neste tutorial

  2. Vá para Regras na navegação à esquerda

  3. Selecione o botão Criar nova regra

    Criar uma regra

  4. Atribua um nome à regra all pages - library loaded - set global variables - 1

  5. Na seção Eventos, selecione Adicionar

    Nomear a regra e adicionar um evento

  6. Use a Extensão principal e selecione Biblioteca carregada (Início da Página) como o Tipo de evento

  7. Selecione a lista suspensa Avançado e digite 1 como Pedido

    note note
    NOTE
    Quanto menor o número do pedido, mais cedo ele será executado. Portanto, damos à nossa "configuração global" um número de ordem baixo.

  8. Selecione Manter alterações para retornar à tela de regra principal
    Selecionar acionador de biblioteca carregada

  9. Na seção Ações, selecione Adicionar

  10. Como a Extensão, selecione o Adobe Experience Platform Web SDK

  11. Como o Tipo de ação, selecione Atualizar variável

  12. Como o Elemento de dados, selecione o xdm.variable.content criado na lição Criar elementos de dados

    Atualizar Esquema De Variável

Agora, mapeie seus elementos de dados para o esquema usado pelo seu objeto XDM. Você pode mapear para propriedades individuais ou objetos inteiros. Neste exemplo, você mapeia para propriedades individuais:

  1. Localize o campo eventType e selecione-o

  2. Digite o valor web.webpagedetails.pageViews

    note tip
    TIP
    Para entender quais valores devem ser preenchidos no campo eventType, vá para a página de esquema e selecione o campo eventType para exibir os valores sugeridos no painel direito. Você também pode inserir um novo valor, se necessário.
    eventType sugeriu valores na página de esquemas

  3. Em seguida, localize o objeto identityMap no esquema e selecione-o

  4. Mapear para o elemento de dados identityMap.loginID

    Atualizar mapa de identidade de variável

    note tip
    TIP
    Os campos XDM não serão incluídos na solicitação de rede se o elemento de dados for nulo. Portanto, quando o usuário não estiver autenticado e o elemento de dados identityMap.loginID for nulo, o objeto identityMap não será enviado. É por isso que podemos defini-la em nossa "configuração global".

  5. Role para baixo até alcançar o objeto web

  6. Selecione para abri-lo

  7. Mapear os seguintes elementos de dados para as variáveis XDM web correspondentes

    • web.webPageDetials.name a %page.pageInfo.pageName%
    • web.webPageDetials.server a %page.pageInfo.server%
    • web.webPageDetials.siteSection a %page.pageInfo.hierarchie1%

  8. Defina web.webPageDetials.pageViews.value como 1

    Atualizar conteúdo de variável

    note tip
    TIP
    Embora nem o eventType definido como web.webpagedetails.pageViews nem o web.webPageDetails.pageViews.value sejam necessários para que o Adobe Analytics processe um beacon como uma exibição de página, é útil ter uma maneira padrão de indicar uma exibição de página para outros aplicativos downstream.

  9. Selecione Manter alterações e Salvar a regra na próxima tela para concluir a criação da regra

Campos da página do produto

Agora, comece a usar a Variável de atualização em regras sequenciadas adicionais para enriquecer o objeto XDM antes de enviá-lo para o Edge Network da plataforma.

TIP
A ordem das regras determina qual regra é executada primeiro quando um evento é acionado. Se duas regras tiverem o mesmo tipo de evento, aquela com o número mais baixo será executada primeiro.

Comece rastreando as exibições do produto na página de detalhes do produto da Luma:

  1. Selecionar Adicionar regra

  2. Nomeie como ecommerce - library loaded - set product details variables - 20

  3. Selecione o + símbolo em Evento para adicionar um novo gatilho

  4. Em Extension, selecione Core

  5. Em Tipo de evento, selecione Biblioteca carregada (Início da Página)

  6. Selecione para abrir as Opções Avançadas, digite 20. Este valor de ordem garante que a regra seja executada após o all pages - library loaded - set global variables - 1, que define a configuração global.

  7. Selecione Manter alterações

    Regras XDM do Analytics

  8. Em Condições, selecione Adicionar

  9. Deixar Tipo Lógico como Regular

  10. Deixar Extensão como Núcleo

  11. Selecione o Tipo de Condição como Caminho sem a Cadeia de Caracteres de Consulta

  12. À direita, habilite a opção Regex

  13. Em caminho igual a, defina /products/. Para o site de demonstração Luma, ele garante que a regra seja acionada somente nas páginas do produto

  14. Selecione Manter alterações

    Regras XDM do Analytics

  15. Em Ações, selecione Adicionar

  16. Selecione a extensão Adobe Experience Platform Web SDK

  17. Selecione o Tipo de ação como Atualizar variável

  18. Selecione xdm.variable.content como o Elemento de dados

  19. Role para baixo até o objeto commerce

  20. Abra o objeto productViews e defina o valor como 1

    configurar exibição do produto

    note tip
    TIP
    A configuração de commerce.productViews.value=1 no XDM mapeia automaticamente para o evento prodView no Analytics

  21. Role para baixo até eventType e defina-o como commerce.productViews

    note note
    NOTE
    Como essa regra tem uma ordem maior, ela substituirá o conjunto eventType na regra de "configuração global". eventType pode conter apenas um valor e recomendamos configurá-lo com o evento mais valioso.

  22. Role para baixo até e selecione a matriz productListItems

  23. Selecione Fornecer itens individuais

  24. Selecionar Adicionar Item

    Definindo evento de exibição de produto

    note caution
    CAUTION
    O productListItems é um tipo de dados array, portanto espera que os dados entrem como uma coleção de elementos. Devido à estrutura da camada de dados do site de demonstração Luma e como é possível visualizar apenas um produto de cada vez no site Luma, você adiciona itens individualmente. Ao implementar o em seu próprio site, dependendo da estrutura da camada de dados, talvez você possa fornecer um storage inteiro.

  25. Selecione para abrir o Item 1

  26. Mapear productListItems.item1.SKU para %product.productInfo.sku%

    Variável do objeto XDM do SKU do produto

  27. Selecione Manter alterações

  28. Selecione Salvar para salvar a regra

Campos do carrinho de compras

Você pode mapear toda a matriz para um objeto XDM, desde que a matriz corresponda ao formato do esquema XDM. O elemento de dados de código personalizado cart.productInfo criado anteriormente faz loop pelo objeto de camada de dados digitalData.cart.cartEntries no Luma e o traduz no formato necessário do objeto productListItems do esquema XDM.

Para ilustrar, consulte a comparação abaixo da camada de dados do site Luma (esquerda) com o elemento de dados traduzido (direita):

Formato da matriz de objetos XDM

Compare o elemento de dados com a estrutura productListItems (dica, ele deve corresponder).

IMPORTANT
Observe como as variáveis numéricas são convertidas, com valores de cadeia de caracteres na camada de dados, como price e qty reformatados em números no elemento de dados. Esses requisitos de formato são importantes para a integridade de dados na Platform e são determinados durante a etapa configurar schemas. No exemplo, quantity usa o tipo de dados Integer.
Tipo de dados de esquema XDM

Agora, vamos mapear nossa matriz para o objeto XDM:

  1. Crie uma nova regra chamada ecommerce - library loaded - set shopping cart variables - 20

  2. Selecione o + símbolo em Evento para adicionar um novo gatilho

  3. Em Extension, selecione Core

  4. Em Tipo de evento, selecione Biblioteca carregada (Início da Página)

  5. Selecione para abrir as Opções Avançadas, digite 20

  6. Selecione Manter alterações

    Regras XDM do Analytics

  7. Em Condições, selecione Adicionar

  8. Deixar Tipo Lógico como Regular

  9. Deixar Extensões como Núcleo

  10. Selecione o Tipo de Condição como Caminho sem a Cadeia de Caracteres de Consulta

  11. À direita, não habilite a opção Regex

  12. Em caminho igual a, defina /content/luma/us/en/user/cart.html. Para o site de demonstração Luma, ele garante que a regra seja acionada somente na página do carrinho

  13. Selecione Manter alterações

    Regras XDM do Analytics

  14. Em Ações, selecione Adicionar

  15. Selecione a extensão Adobe Experience Platform Web SDK

  16. Selecione o Tipo de ação como Atualizar variável

  17. Selecione xdm.variable.content como o Elemento de dados

  18. Role para baixo até o objeto commerce e selecione para abri-lo.

  19. Abra o objeto productListViews e defina o valor como 1

    configurar exibição do produto

    note tip
    TIP
    A configuração de commerce.productListViews.value=1 no XDM mapeia automaticamente para o evento scView no Analytics

  20. Selecione eventType e defina como commerce.productListViews

  21. Role para baixo até e selecione a matriz productListItems

  22. Selecione Fornecer toda a matriz

  23. Mapear para elemento de dados cart.productInfo

  24. Selecione Manter alterações

  25. Selecione Salvar para salvar a regra

Crie duas outras regras para finalização e compra seguindo o mesmo padrão, com as diferenças abaixo:

Nome da regra: ecommerce - library loaded - set checkout variables - 20

  1. Condição: /content/luma/us/en/user/checkout.html

  2. Defina eventType como commerce.checkouts

  3. Defina commerce.checkout.value como 1

    note tip
    TIP
    Isso é equivalente à configuração do evento scCheckout no Analytics

Nome da regra: ecommerce - library loaded - set purchase variables - 20

  1. Condição: /content/luma/us/en/user/checkout/order/thank-you.html

  2. Defina eventType como commerce.purchases

  3. Defina commerce.purchases.value como 1

    note tip
    TIP
    Isso é equivalente à configuração do evento purchase no Analytics

  4. Definir commerce.order.purchaseID para o elemento de dados cart.orderId

  5. Defina commerce.order.currencyCode com o valor codificado USD

    Definindo purchaseID para o Analytics

    note tip
    TIP
    É equivalente à configuração de s.purchaseID e s.currencyCode variáveis no Analytics

  6. Role para baixo até e selecione a matriz productListItems

  7. Selecione Fornecer toda a matriz

  8. Mapear para elemento de dados cart.productInfo.purchase

  9. Selecione Manter alterações

  10. Selecione Salvar

Quando terminar, você deverá ver as seguintes regras criadas.

Regras XDM do Analytics

Enviar regra de evento

Agora que você definiu as variáveis, é possível criar a regra para enviar o objeto XDM completo para o Platform Edge Network com a ação Enviar evento.

  1. À direita, selecione Adicionar regra para criar outra regra

  2. Atribua um nome à regra all pages - library loaded - send event - 50

  3. Na seção Eventos, selecione Adicionar

  4. Use a Extensão principal e selecione Library Loaded (Page Top) como o Tipo de evento

  5. Selecione a lista suspensa Avançado e insira 50 em Pedido. Isso garantirá que esta regra seja acionada depois de todas as outras regras configuradas (que tinham 1 ou 20 como sua Ordem).

  6. Selecione Manter alterações para retornar à tela de regra principal
    Selecionar acionador de biblioteca carregada

  7. Na seção Ações, selecione Adicionar

  8. Como a Extensão, selecione o Adobe Experience Platform Web SDK

  9. Como o Tipo de ação, selecione Enviar evento

  10. Como o XDM, selecione o elemento de dados xdm.variable.content criado na lição anterior

  11. Selecione Manter alterações para retornar à tela de regra principal

    Adicionar a ação Enviar Evento

  12. Selecione Salvar para salvar a regra

    Salvar a regra

Publish as regras em uma biblioteca

Em seguida, publique a regra no ambiente de desenvolvimento para que você possa verificar se funciona.

Para criar uma biblioteca:

  1. Vá para Fluxo de Publicação na navegação à esquerda

  2. Selecione Adicionar biblioteca

    Selecione Adicionar Biblioteca

  3. Para o Nome, digite Luma Web SDK Tutorial

  4. Para o Ambiente, selecione Development

  5. Selecione Adicionar todos os recursos alterados

    note note
    NOTE
    Você deve ver todos os componentes de tag criados nas lições anteriores. A extensão principal contém a JavaScript básica exigida por todas as propriedades de tag da Web.

  6. Selecione Salvar e criar para desenvolvimento

    Criar e criar a biblioteca

A biblioteca pode levar alguns minutos para ser criada e, quando estiver concluída, exibirá um ponto verde à esquerda do nome da biblioteca:

Compilação concluída

Como você pode ver na tela Fluxo de publicação, há muito mais no processo de publicação, que está além do escopo deste tutorial. Este tutorial usa apenas uma única biblioteca no ambiente de desenvolvimento do.

Agora você está pronto para validar os dados na solicitação usando o Adobe Experience Platform Debugger.

Próximo

NOTE
Obrigado por investir seu tempo aprendendo sobre o Adobe Experience Platform Web SDK. Se você tiver dúvidas, quiser compartilhar comentários gerais ou tiver sugestões sobre conteúdo futuro, compartilhe-as nesta postagem de Discussão da Comunidade Experience League
recommendation-more-help
8cbc0fd8-ca1d-433b-9c3d-bc3f113347d4