Visão geral da extensão de marcas Algolia

A extensão de Tags do Algolia permite que os profissionais de marketing configurem facilmente regras que enviam dados de interação do usuário para o Algolia, ajudando você a fornecer experiências de Pesquisa e Descoberta de IA mais personalizadas.

Essa extensão é alimentada por um recurso principal:

  • AlgoliaInsights: captura e envia automaticamente eventos de interação do usuário para Algolia, o que permite análises poderosas, experiências personalizadas e relevância de pesquisa aprimorada.

Pré-requisitos prerequisites

Você deve ter uma conta Algolia válida para usar esta extensão. Vá para a Algolia página de inscrição para criar uma conta caso ainda não tenha uma.

Coletar detalhes de configuração necessários configuration-details

Para conectar Algolia ao Adobe Experience Platform, você precisará das seguintes informações:

Credencial
Descrição
Exemplo
ID do aplicativo
A ID do Aplicativo pode ser encontrada na seção Chaves de API do Painel Algolia.
0ABCDEFG12
Chave da API de pesquisa
Sua Chave de API de Pesquisa pode ser encontrada na seção Chaves de API do seu Painel Algolia.
1234a12345678901b1234567890c1ab1

Instalar e configurar a extensão do Insights do Algolia install-configure

Para instalar a extensão do Algolia Insights, navegue até a Interface da Coleção de Dados e selecione Marcas na navegação à esquerda. Aqui, selecione uma propriedade à qual adicionar a extensão ou crie uma nova propriedade.

Depois de selecionar ou criar a propriedade desejada, selecione Extensões na navegação à esquerda e selecione a guia Catálogo. Procure o cartão Algolia Insights e selecione Instalar.

Na visualização de configuração exibida, você deve fornecer os seguintes detalhes:

Propriedade
Descrição
Application ID
Insira a ID do Aplicativo coletada anteriormente na seção detalhes de configuração.
Chave de API de Pesquisa
Insira a Chave da API de Pesquisa coletada anteriormente na seção detalhes de configuração.
Nome do Índice
O Nome do Índice contém os Produtos ou Conteúdo. Este índice será usado como padrão.
Elemento de Dados do Token do Usuário
O elemento de dados que retornará o token do usuário.
Elemento de Dados do Token do Usuário Autenticado
Definir o elemento de dados que retornará o token do usuário autenticado.
Moeda
Selecione um tipo de moeda. O valor padrão está definido como USD.

Algolia tipos de ação de extensão do Insights action-types

O Algolia oferece suporte a um conjunto de eventos padrão predefinidos, cada um com contextos e propriedades específicas. As ações disponíveis na extensão Algolia estão alinhadas a esses tipos de evento, facilitando a categorização e configuração dos eventos que você envia para o Algolia com base em seus tipos.

Carregar Insights load-insights

NOTE
Na maioria dos casos, é recomendável carregar o Algolia Insights em cada página do site.

Adicione a ação Carregar Insights à sua regra de marca sempre que fizer mais sentido para carregar Insights do Algolia com base no contexto da sua regra. Esta ação carrega a biblioteca search-insights.js na página.

Crie uma nova regra de tag ou abra uma existente. Defina as condições de acordo com suas necessidades e selecione Algolia como a Extensão e selecione Carregar Insights como o Tipo de Ação.

Propriedade
Descrição
Versão da Biblioteca Insight
A versão do Insights do Algolia. O padrão é 2.13.0.
Elemento de Dados de Recusa de Usuário
O Elemento de dados que captura a preferência de rastreamento do usuário.
Usar Cookie de Token de Usuário
Marque esta caixa para permitir que Algolia gere um cookie de Token de Usuário. Por padrão, esta opção está definida como false.

Clicado clicked

Adicione a ação Clicar à sua regra de marca para enviar eventos clicados para Algolia. Crie uma nova regra de tag ou abra uma existente. Defina as condições de acordo com suas necessidades e selecione Algolia como a Extensão e selecione Clicados como o Tipo de Ação.

Propriedade
Descrição
Nome do Evento
O Nome do evento que pode ser usado para refinar ainda mais este evento de clique.
Elemento de Dados de Detalhes do Evento

O elemento de dados retorna detalhes do evento, incluindo:

  • indexName
  • objectIDs
  • queryID (opcional)
  • position (opcional)
Elemento de dados da ID do registro
A ID do Registro é usada como uma chave para os dados do evento armazenados no armazenamento do navegador durante um evento click. Por padrão, o URL da página serve como a ID do registro. Para substituir esse comportamento, use essa propriedade para fornecer um elemento de dados que retorne a ID de registro como uma string.
NOTE
Se queryID e position forem incluídos, o evento será classificado como IDs de objeto clicado após a Pesquisa. Caso contrário, ele será classificado como um evento de IDs de objeto clicado.
​>

​>Se o Elemento de Dados não fornecer um indexName, o Nome de Índice Padrão será usado quando o evento for enviado.

Para obter mais informações sobre categorias de evento, consulte as IDs de objeto clicadas após a pesquisa
e guias de IDs de objeto clicado.

Convertido converted

Adicione a ação Convertido à sua regra de marcas para enviar eventos convertidos para Algolia. Crie uma nova regra de tag ou abra uma existente. Defina as condições de acordo com suas necessidades, selecione Algólia como a Extensão e selecione Convertidos como o Tipo de Ação.

Propriedade
Descrição
Nome do Evento
O Nome do Evento que será usado para refinar ainda mais este evento convert.
Elemento de Dados de Detalhes do Evento

O elemento de dados retorna detalhes do evento, incluindo:

  • indexName
  • objectIDs
  • queryID (opcional)
Desabilitar Remoção de Dados do Evento
Em um evento de conversão, os dados do evento são removidos do armazenamento. Se esses dados forem necessários para eventos de conversão subsequentes, desative o processo de remoção para garantir que os dados do evento permaneçam disponíveis.
Elemento de dados da ID do registro
A ID do registro é usada como uma chave para pesquisar os dados do evento armazenados no armazenamento do navegador. O URL da página é a ID de registro padrão. Para substituir esse comportamento, use essa propriedade para fornecer um elemento de dados que retorne a ID de registro como uma string.
NOTE
Se o Elemento de Dados contiver queryId, o evento será classificado como Convertido após a Pesquisa. Caso contrário, será classificado como um evento Converted.
​>

​>Se o Elemento de Dados não fornecer um indexName, o Nome de Índice Padrão será usado quando o evento for enviado.

Para obter mais informações sobre as categorias de evento, consulte os guias IDs de objeto convertido após a pesquisa e IDs de objeto convertido.

Adicionado ao carrinho added-to-cart

Adicione a ação Adicionado ao carrinho à sua regra de tag para enviar eventos adicionados ao carrinho para Algolia. Crie uma nova regra de tag ou abra uma existente. Defina as condições de acordo com suas necessidades e selecione Algolia como a Extensão e selecione Adicionado ao carrinho como o Tipo de Ação.

Propriedade
Descrição
Nome do Evento
O Nome do Evento que será usado para refinar ainda mais este evento convert.
Elemento de Dados de Detalhes do Evento

O elemento de dados retorna detalhes do evento, incluindo:

  • indexName

  • objectIDs

  • objectData

    • queryID (opcional)
    • price
    • quantity
    • discount
  • queryID (opcional)

.

Moeda
Selecione um tipo de moeda. O valor padrão está definido como USD.
NOTE
Se o Elemento de Dados contiver queryId, o evento será classificado como Adicionado às IDs de objeto do carrinho após a Pesquisa. Caso contrário, será classificado como um evento Adicionado às IDs de objeto do carrinho.
​>

​>Se o Elemento de Dados não fornecer um indexName, o Nome de Índice Padrão será usado quando o evento for enviado.
​>

​>Se os Elementos de dados padrão não atenderem aos seus requisitos, um Elemento de dados personalizado poderá ser criado para retornar os detalhes do evento desejado.

Para obter mais informações sobre as categorias de eventos, consulte os guias Adicionado às IDs de objeto do carrinho após a pesquisa e Adicionado às IDs de objeto do carrinho.

Comprado purchased

Adicione a ação Comprado à sua regra de marca para enviar eventos comprados para Algolia. Crie uma nova regra de tag ou abra uma existente. Defina as condições de acordo com suas necessidades, selecione Algólia como Extensão e Comprado como Tipo de Ação.

Propriedade
Descrição
Nome do Evento
O Nome do Evento que será usado para refinar ainda mais este evento compra.
Elemento de Dados de Detalhes do Evento

O elemento de dados retorna detalhes do evento, incluindo:

  • indexName

  • objectIDs

  • objectData

    • queryID (opcional)
    • price
    • quantity
    • discount
  • queryID (opcional)

.

Moeda
Selecione um tipo de moeda. O valor padrão está definido como USD.
NOTE
Se o Elemento de Dados contiver queryId, o evento será classificado como IDs de objeto comprado após a Pesquisa. Caso contrário, será classificado como um evento IDs de objeto compradas.
​>

​>Se o Elemento de Dados não fornecer um indexName, o Nome de Índice Padrão será usado quando o evento for enviado.
​>

​>Se os Elementos de dados padrão não atenderem aos seus requisitos, um Elemento de dados personalizado poderá ser criado para retornar os detalhes do evento desejado.

Para obter mais informações sobre categorias de evento, consulte as IDs de objeto compradas após a pesquisa
e guias de IDs de objeto comprado.

Exibido viewed

Adicione a ação Visualizado à sua regra de marca para enviar eventos comprados para Algolia. Crie uma nova regra de tag ou abra uma existente. Defina as condições de acordo com suas necessidades e selecione Algolia como a Extensão e Visualizada como o Tipo de Ação.

Propriedade
Descrição
Nome do Evento
O Nome do Evento que será usado para refinar este evento exibir.
Elemento de Dados de Detalhes do Evento

O elemento de dados retorna detalhes do evento, incluindo:

  • indexName
  • objectIDs
NOTE
Se o Elemento de Dados não fornecer um indexName, o Nome de Índice Padrão será usado ao enviar o evento.

Para obter mais informações sobre o evento de exibição, consulte o guia IDs de objeto visualizadas.

Elementos de dados da extensão do Insights do Algolia data-elements

O Algolia oferece suporte a um conjunto de elementos de dados predefinidos, cada um com contextos e propriedades específicas. As seções a seguir descrevem os elementos de dados disponíveis na extensão do Insights do Algolia.

DataSet dataset

O Elemento de Dados DataSet recupera dados associados a elementos HTML, que são usados em Algolia ações.

Propriedade
Descrição
Nome da Div/Classe do Elemento de Ocorrência
O Nome do Elemento HTML e/ou Nome da Classe CSS contendo os atributos do conjunto de dados incluindo data-insights-object-id e, opcionalmente, data-insights-query-id e data-insights-position no Elemento HTML.
Nome do Índice, Elemento Div/Nome da Classe
O Nome do Elemento HTML e/ou o Nome da Classe CSS que tem os atributos do conjunto de dados (data-indexname) no Elemento HTML.
Elemento de dados da ID da consulta
A ID da consulta é recuperada do conjunto de dados no elemento HTML. Para substituir esse comportamento, use essa propriedade para fornecer um elemento de dados que retorne a ID da consulta como uma string.
Elemento de Dados de IDs de Objetos
As IDs de objeto são recuperadas do conjunto de dados no elemento do HTML. Para substituir esse comportamento, use essa propriedade para fornecer um elemento de dados que retorne as IDs de objeto como uma matriz.
Elemento de Dados de Posições
As Posições são recuperadas do conjunto de dados no elemento HTML. Para substituir esse comportamento, use essa propriedade para fornecer um elemento de dados que retornará as Posições como uma matriz.
Elemento de Dados do Nome do Índice
O Nome do índice é recuperado do conjunto de dados no elemento HTML. Para substituir esse comportamento, use essa propriedade para fornecer um elemento de dados que retornará o Nome do índice como uma string.

Esse elemento de dados retorna:

{
  timestamp,
  queryID,
  indexName,
  objectIDs,
  positions
}

Um exemplo de HTML que contém um conjunto de dados:

<div data-indexname="acme_master_default_products" class="instant-search-comp__hits">
  <div class="hit-card"
    data-insights-object-id="${hit.objectID}"
    data-insights-position="${hit.__position}"
    data-insights-query-id="${hit.__queryID}">
    <h4 class="hit-name">...</h4>
  </div>
</div>

Sequência de consulta query-string

O Elemento de Dados da Cadeia de Caracteres de Consulta extrai dados da cadeia de caracteres de consulta da URL a serem usados em Algolia ações.

Propriedade
Descrição
Nome do Parâmetro da ID do Objeto
O nome do parâmetro de consulta que contém a ID do Objeto.
Nome do Parâmetro do Nome do Índice
O nome do parâmetro de consulta que contém o Nome do Índice.
Nome do parâmetro da ID da consulta
O nome do parâmetro de consulta que contém a ID da consulta.
Nome do Parâmetro da Posição
O nome do parâmetro de consulta que contém a Posição.

Esse elemento de dados retorna:

{
  timestamp,
  queryID,
  indexName,
  objectIDs
}

Um exemplo de HTML que contém parâmetros de consulta.

<a href="product.html?objectID=${hit.objectID}&queryID=${hit.__queryID}&indexName=${indexName}&position=${hit.position}">Read More</a>

Armazenamento storage

O Elemento de Dados de Armazenamento recupera dados do Armazenamento de Sessão para uso em ações Algolia.

Este elemento de dados recupera detalhes do evento do Armazenamento da sessão. Nenhuma configuração é necessária. Os dados são adicionados automaticamente durante a ação de evento click e removidos durante a ação de evento convert.

Propriedade
Descrição
Elemento de dados da ID do registro
A ID do registro é usada como uma chave para pesquisar os dados do evento armazenados no armazenamento do navegador. O URL da página é a ID de registro padrão. Para substituir esse comportamento, use essa propriedade para fornecer um elemento de dados que retorne a ID de registro como uma string.

Esse elemento de dados retorna o que está armazenado no Armazenamento da sessão.

{
  timestamp,
  queryID,
  indexName,
  objectIDs
}

Os eventos Clicados após a Pesquisa ou Convertidos após a Pesquisa exigem um queryId, e position também é necessário para Clicados após a Pesquisa. Estas propriedades estão disponíveis quando o sinalizador insights está habilitado nos parâmetros de consulta de Pesquisa Instantânea e/ou Preenchimento Automático. Consulte os seguintes recursos para saber como configurar o Insights para o seu site:

Próximas etapas next-steps

Este guia abordou como enviar dados para Algolia usando a extensão de tag Algolia Insights. Se você pretende enviar eventos do lado do servidor para o Algolia, agora é possível prosseguir para instalar e configurar a Conversions API extensão de encaminhamento de eventos.

Para obter mais informações sobre tags na Experience Platform, consulte a visão geral das tags.

recommendation-more-help
12b4e4a9-5028-4d88-8ce6-64a580811743