Configurar a extensão de tag do SDK da Web

Last update: Tue Nov 05 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Tópicos:

Criado para:

Desenvolvedor

A extensão de tag Web SDK envia dados para a Adobe Experience Cloud das propriedades da Web por meio do Edge Network Experience Platform.

A extensão permite transmitir dados para a Platform, sincronizar identidades, processar sinais de consentimento do cliente e coletar automaticamente dados de contexto.

Este documento explica como configurar a extensão de tag na interface do usuário de tags.

Instalar a extensão de tag do SDK da Web install

A extensão de tag do SDK da Web precisa de uma propriedade para ser instalada. Se ainda não tiver feito isso, consulte a documentação sobre criação de uma propriedade de marca.

Após criar uma propriedade, abra-a e selecione a guia Extensões na barra lateral esquerda.

Selecione a guia Catálogo. Na lista de extensões disponíveis, localize a extensão Web SDK e selecione Instalar.

Imagem mostrando a interface do usuário de Marcas com a extensão SDK da Web selecionada

Depois de selecionar Instalar, você deve configurar a extensão de tag do SDK da Web e salvar a configuração.

NOTE

A extensão de tag só é instalada depois de salvar a configuração. Consulte as próximas seções para saber como configurar a extensão de tag.

Definir configurações de instância general

As opções de configuração na parte superior da página informam à Adobe Experience Platform para onde rotear os dados e quais configurações usar no servidor.

Imagem mostrando as configurações gerais da extensão de marca do SDK da Web na interface do usuário de Marcas

Nome: a extensão SDK da Web do Adobe Experience Platform oferece suporte a várias instâncias na página. O nome é usado para enviar dados para várias organizações com uma configuração de tag. O nome padrão da instância é alloy. No entanto, é possível alterar o nome da instância para qualquer nome de objeto JavaScript válido.
ID de organização IMS: a ID da organização para a qual você deseja que os dados sejam enviados no Adobe. Na maioria das vezes, use o valor padrão preenchido automaticamente. Quando houver várias instâncias na página, preencha esse campo com o valor da segunda organização para a qual deseja enviar dados.
Domínio do Edge: o domínio do qual a extensão envia e recebe dados. O Adobe recomenda usar um domínio próprio (CNAME) para essa extensão. O domínio padrão de terceiros funciona em ambientes de desenvolvimento, mas não é adequado para ambientes de produção. As instruções sobre como configurar um CNAME primário estão listadas aqui.

Definir configurações de sequência de dados datastreams

Essa seção permite selecionar os fluxos de dados que devem ser usados para cada um dos três ambientes disponíveis (produção, preparo e desenvolvimento).

Quando uma solicitação é enviada para o Edge Network, uma ID de sequência de dados é usada para fazer referência à configuração do lado do servidor. Você pode atualizar a configuração sem precisar fazer alterações de código no site.

Consulte o guia em datastreams para saber como configurar um datastream.

Você pode escolher uma sequência de dados nos menus suspensos disponíveis ou selecionar Inserir valores e inserir uma ID de sequência de dados personalizada para cada ambiente.

Imagem mostrando as configurações de sequência de dados da extensão de marca do SDK da Web na interface do usuário de Marcas

Definir configurações de privacidade privacy

Esta seção permite configurar como o SDK da Web lida com sinais de consentimento do usuário do seu site. Especificamente, ela permite selecionar o nível padrão de consentimento assumido de um usuário se nenhuma outra preferência de consentimento explícito tiver sido fornecida.

O nível de consentimento padrão não é salvo no perfil do usuário.

Imagem mostrando as configurações de privacidade da extensão de marca do SDK da Web na interface do usuário de Marcas

Nível de consentimento padrão

Descrição

Entrada

Colete eventos que ocorrem antes de o usuário fornecer preferências de consentimento.

Saída

Descartar eventos que ocorrem antes de o usuário fornecer preferências de consentimento.

Pendente

Enfileirar eventos que ocorrem antes de o usuário fornecer preferências de consentimento. Quando as preferências de consentimento são fornecidas, os eventos são coletados ou descartados, dependendo das preferências fornecidas.

Fornecido pelo elemento de dados

O nível de consentimento padrão é determinado por um elemento de dados separado que você define. Ao usar essa opção, você deve especificar o elemento de dados usando o menu suspenso fornecido.

TIP

Use Desativado ou Pendente se você precisar de consentimento explícito do usuário para suas operações comerciais.

Definir configurações de identidade identity

Esta seção permite definir o comportamento do SDK da Web quando se trata de lidar com a identificação do usuário.

Imagem mostrando as configurações de identidade da extensão de marca do SDK da Web na interface do usuário de Marcas

Migrar ECID da VisitorAPI: esta opção é habilitada por padrão. Quando este recurso está habilitado, o SDK pode ler os cookies AMCV e s_ecid e definir o cookie AMCV usado pelo Visitor.js. Esse recurso é importante ao migrar para o SDK da Web, pois algumas páginas ainda podem estar usando o Visitor.js. Essa opção permite que o SDK continue usando o mesmo ECID para que os usuários não sejam identificados como dois usuários separados.

Usar cookies de terceiros: quando esta opção é habilitada, o SDK da Web tenta armazenar um identificador do usuário em um cookie de terceiros. Se for bem-sucedido, o usuário será identificado como um único usuário durante a navegação em vários domínios, em vez de ser identificado como um usuário separado em cada domínio. Se essa opção estiver ativada, o SDK ainda poderá não ser capaz de armazenar o identificador do usuário em um cookie de terceiros se o navegador não for compatível com cookies de terceiros ou tiver sido configurado pelo usuário para não permitir cookies de terceiros. Nesse caso, o SDK armazena apenas o identificador no domínio próprio.

note important
IMPORTANT
>Cookies de terceiros não são compatíveis com a funcionalidade de ID de dispositivo próprio no SDK da Web.

Você pode usar IDs de dispositivo primário ou cookies de terceiros, mas não pode usar ambos os recursos simultaneamente.

Definir configurações de personalização personalization

Esta seção permite configurar como você deseja ocultar determinadas partes de uma página enquanto o conteúdo personalizado é carregado. Isso garante que seus visitantes vejam apenas a página personalizada.

Imagem mostrando as configurações de personalização da extensão de marca do SDK da Web na interface do usuário de Marcas

Migrar o Target da at.js para o SDK da Web: use esta opção para permitir que o Web SDK leia e grave os cookies herdados mbox e mboxEdgeCluster usados pelas bibliotecas da at.js 1.x ou 2.x. Isso ajuda a manter o perfil do visitante ao mover de uma página que usa o SDK da Web para uma página que usa bibliotecas do at.js 1.x ou 2.x e vice-versa.

Estilo pré-ocultação prehiding-style

O editor de estilo pré-ocultação permite definir regras CSS personalizadas para ocultar seções específicas de uma página. Quando a página é carregada, o SDK da Web usa esse estilo para ocultar as seções que precisam ser personalizadas, recupera a personalização e desoculta as seções de página personalizadas. Dessa forma, seus visitantes visualizam as páginas já personalizadas, sem ver o processo de recuperação da personalização.

Pré-ocultação de trecho prehiding-snippet

O trecho pré-ocultação é útil quando a biblioteca do SDK da Web é carregada de forma assíncrona. Nessa situação, para evitar oscilação, recomendamos ocultar o conteúdo antes que a biblioteca do SDK da Web seja carregada.

Para usar o trecho pré-ocultação, copie-o e cole-o dentro do elemento <head> da sua página.

IMPORTANT

Ao usar o trecho pré-ocultação, o Adobe recomenda usar a mesma regra CSS usada pelo estilo pré-ocultação.

Definir configurações da coleção de dados data-collection

Gerenciar definições de configuração da coleta de dados. Configurações semelhantes na biblioteca JavaScript estão disponíveis usando o comando configure.

Imagem mostrando as configurações de coleta de dados da extensão de marca do SDK da Web na interface do usuário de Marcas.

Ativado antes de o evento enviar o retorno de chamada: uma função de retorno de chamada para avaliar e modificar a carga enviada para o Adobe. Use a variável content na função de retorno de chamada para modificar a carga. Este retorno de chamada é a marca equivalente a onBeforeEventSend na biblioteca JavaScript.
Coletar cliques internos em links: uma caixa de seleção que permite a coleta de dados de rastreamento de links internos no seu site ou propriedade. Quando você ativa essa caixa de seleção, as opções de agrupamento de eventos são exibidas:
- Nenhum agrupamento de eventos: os dados de rastreamento de link são enviados para o Adobe em eventos separados. Os cliques em links enviados em eventos separados podem aumentar o uso contratual dos dados enviados para o Adobe Experience Platform.
- Agrupamento de eventos usando o armazenamento de sessão: armazena dados de rastreamento de link no armazenamento de sessão até o próximo evento de página. Na página a seguir, os dados de rastreamento de link armazenados e os dados de exibição de página são enviados para o Adobe ao mesmo tempo. A Adobe recomenda ativar essa configuração ao rastrear links internos.
- Agrupamento de eventos usando objeto local: armazena dados de rastreamento de link em um objeto local até o próximo evento de página. Se um visitante navega para uma nova página, os dados de rastreamento de link são perdidos. Essa configuração é mais benéfica no contexto de aplicativos de página única.
Coletar cliques em links externos: uma caixa de seleção que habilita a coleta de links externos.
Coletar cliques no link de download: uma caixa de seleção que habilita a coleção de links de download.
Qualificador de link de download: uma expressão regular que qualifica uma URL de link como um link de download.
Filtrar propriedades de cliques: uma função de retorno de chamada para avaliar e modificar propriedades relacionadas a cliques antes da coleção. Esta função é executada antes do Ativado antes do retorno de chamada do envio de evento.
Configurações de contexto: colete automaticamente informações do visitante, que preenchem campos XDM específicos para você. Você pode escolher Todas as informações de contexto padrão ou Informações de contexto específicas. É a marca equivalente a context na biblioteca JavaScript.
- Web: coleta informações sobre a página atual.
- Dispositivo: coleta informações sobre o dispositivo do usuário.
- Ambiente: coleta informações sobre o navegador do usuário.
- Inserir contexto: coleta informações sobre a localização do usuário.
- Dicas de agente-usuário de alta entropia: coleta informações mais detalhadas sobre o dispositivo do usuário.

TIP

O campo Ativado antes do link clicar em enviar é um retorno de chamada obsoleto visível apenas para propriedades que já o têm configurado. É a marca equivalente a onBeforeLinkClickSend na biblioteca JavaScript. Use o retorno de chamada Filtrar propriedades de clique para filtrar ou ajustar dados de clique, ou use a Ativar antes de enviar o retorno de chamada para filtrar ou ajustar a carga geral enviada para o Adobe. Se o retorno de chamada Propriedades de clique de Filtro e o retorno de chamada Ativado antes do envio de cliques em links estiverem definidos, somente o retorno de chamada Propriedades de clique de Filtro será executado.

Definir configurações de coleção de mídia media-collection

O recurso de coleção de mídia ajuda a coletar dados relacionados a sessões de mídia no site.

Os dados coletados podem incluir informações sobre reprodução de mídia, pausas, conclusões e outros eventos relacionados. Depois de coletados, é possível enviar esses dados para a Adobe Experience Platform e/ou Adobe Analytics para gerar relatórios. Esse recurso fornece uma solução abrangente para rastrear e entender o comportamento de consumo de mídia no site.

Imagem mostrando as configurações de coleção de mídia da extensão de marca do SDK da Web na Interface do Usuário de Marcas

Canal: o nome do canal onde ocorre a coleção de mídia. Exemplo: Video channel.
Nome do player: o nome do reprodutor de mídia.
Versão do Aplicativo: a versão do aplicativo do reprodutor de mídia.
Intervalo de ping principal: Frequência de pings para o conteúdo principal, em segundos. O valor padrão é 10. Os valores podem variar de 10 a 50 segundos. Se nenhum valor for especificado, o valor padrão será usado ao usar sessões rastreadas automaticamente.
Intervalo de ping do anúncio: Frequência de pings para o conteúdo do anúncio, em segundos. O valor padrão é 10. Os valores podem variar de 1 a 10 segundos. Se nenhum valor for especificado, o valor padrão será usado ao usar sessões rastreadas automaticamente

Configurar substituições de sequência de dados datastream-overrides

As substituições de sequência de dados permitem definir configurações adicionais para suas sequências de dados, que são transmitidas para a rede de borda por meio do SDK da Web.

Isso ajuda a acionar comportamentos de sequência de dados diferentes dos tradicionais sem criar uma nova sequência de dados ou modificar as configurações existentes.

Criar uma substituição de configuração da sequência de dados é um processo de duas etapas:

Primeiro, você deve definir as substituições de configuração da sequência na página de configuração da sequência de dados.
Em seguida, você deve enviar as substituições para o Edge Network por meio de um comando do SDK da Web ou usando a extensão de tag do SDK da Web.

Consulte a documentação de substituições de configuração da sequência de dados para obter instruções detalhadas sobre como substituir configurações da sequência de dados.

Como alternativa à transmissão de sobreposições por meio de um comando do SDK da Web, você pode configurar as sobreposições na tela de extensão de tag mostrada abaixo.

IMPORTANT

As substituições de fluxo de dados devem ser configuradas com base no ambiente. Os ambientes de desenvolvimento, armazenamento temporário e produção têm substituições separadas. Você pode copiar as configurações entre elas usando as opções dedicadas mostradas na tela abaixo.

Imagem mostrando as substituições da configuração da sequência de dados usando a página de extensão de marca do SDK da Web.

Por padrão, a substituição da configuração da sequência de dados está desativada. A opção Corresponder configuração da sequência de dados está selecionada por padrão.

Interface do usuário da extensão de marca do SDK da Web mostrando a configuração padrão de substituições de configuração da sequência de dados.

Para habilitar substituições de sequência de dados na extensão de marca, selecione Habilitado no menu suspenso.

Interface do usuário da extensão de marca do SDK da Web mostrando as substituições de configuração da sequência de dados Habilitada.

Depois de habilitar as sobreposições de configuração do fluxo de dados, você pode configurar as sobreposições para cada serviço descrito abaixo.

As configurações de substituição de sequência de dados abaixo substituirão todas as configurações e regras de sequência de dados do lado do servidor para o ambiente selecionado.

Adobe Analytics analytics

Use as configurações desta seção para substituir o roteamento de dados para o serviço Adobe Analytics.

Imagem da interface do usuário da extensão de tag do SDK da Web mostrando as configurações de substituição da sequência de dados do Adobe Analytics.

Habilitado / Desabilitado: use este menu suspenso para habilitar ou desabilitar o roteamento de dados para o serviço Adobe Analytics.
Conjuntos de relatórios: as IDs dos conjuntos de relatórios de destino no Adobe Analytics. O valor deve ser uma substituição pré-configurada do conjunto de relatórios (ou uma lista separada por vírgulas de conjuntos de relatórios) da configuração do fluxo de dados. Essa configuração substitui os conjuntos de relatórios principais.
Adicionar Conjunto de Relatórios: selecione essa opção para adicionar outros conjuntos de relatórios.

Adobe Audience Manager audience-manager

Use as configurações desta seção para substituir o roteamento de dados para o serviço Adobe Audience Manager.

Imagem da interface do usuário da extensão de tag do SDK da Web mostrando as configurações de substituição da sequência de dados do Adobe Audience Manager.

Habilitado / Desabilitado: use este menu suspenso para habilitar ou desabilitar o roteamento de dados para o serviço Adobe Audience Manager.
Contêiner de sincronização de ID de terceiros: a ID do contêiner de sincronização de ID de terceiros de destino no Audience Manager. O valor deve ser um contêiner secundário pré-configurado da configuração da sequência de dados e substitui o contêiner primário.

Adobe Experience Platform experience-platform

Use as configurações desta seção para substituir o roteamento de dados para o serviço Adobe Experience Platform.

Imagem da interface do usuário da extensão de tag do SDK da Web mostrando as configurações de substituição da sequência de dados do Adobe Experience Platform.

Habilitado / Desabilitado: use este menu suspenso para habilitar ou desabilitar o roteamento de dados para o serviço Adobe Experience Platform.
Conjunto de dados do evento: a identificação do conjunto de dados do evento de destino na Adobe Experience Platform. O valor deve ser um conjunto de dados secundário pré-configurado na configuração do fluxo de dados.
Offer decisioning: use este menu suspenso para habilitar ou desabilitar o roteamento de dados para o serviço Offer Decisioning.
Segmentação do Edge: use este menu suspenso para habilitar ou desabilitar o roteamento de dados para o serviço Edge Segmentation.
Destinos do Personalization: use este menu suspenso para habilitar ou desabilitar o roteamento de dados para destinos de personalização.
Adobe Journey Optimizer: use este menu suspenso para habilitar ou desabilitar o roteamento de dados para o serviço Adobe Journey Optimizer.

Encaminhamento de eventos do lado do servidor do Adobe ssf

Use as configurações desta seção para substituir o roteamento de dados para o serviço de Encaminhamento de Eventos do Lado do Servidor Adobe.

Imagem da interface do usuário da extensão de tag do SDK da Web mostrando as configurações de substituição da sequência de dados do encaminhamento de eventos do lado do servidor do Adobe.

Habilitado / Desabilitado: use este menu suspenso para habilitar ou desabilitar o roteamento de dados para o serviço de Encaminhamento de Eventos do Lado do Servidor Adobe.

Adobe Target target

Use as configurações desta seção para substituir o roteamento de dados para o serviço Adobe Target.

Imagem da interface do usuário da extensão de tag do SDK da Web mostrando as configurações de substituição da sequência de dados do Adobe Target.

Habilitado / Desabilitado: use este menu suspenso para habilitar ou desabilitar o roteamento de dados para o serviço Adobe Target.

Definir configurações avançadas

Use o campo caminho base do Edge se precisar alterar o caminho base usado para interagir com o Edge Network. Isso não deve exigir atualização, mas no caso de você participar de um beta ou alfa, o Adobe pode solicitar que você altere esse campo.

Imagem mostrando as configurações avançadas usando a página de extensão de marca do SDK da Web.

recommendation-more-help

12b4e4a9-5028-4d88-8ce6-64a580811743