Algolia标记扩展概述

Algolia Tags扩展使营销人员能够轻松设置规则以将用户交互数据发送到Algolia,从而帮助您提供更加个性化的AI搜索和发现体验。

此扩展由一项关键功能提供支持:

  • Algolia分析:自动捕获用户交互事件并将其发送到Algolia,这可以实现强大的分析、个性化体验和改进的搜索相关性。

先决条件 prerequisites

您必须拥有有效的Algolia帐户才能使用此扩展。 转到Algolia 注册页面创建帐户(如果尚未创建)。

收集所需的配置详细信息 configuration-details

要将Algolia与Adobe Experience Platform连接,您需要以下信息:

凭据
描述
示例
应用程序Id
您的应用程序ID可在仪表板的API密钥Algolia部分找到。
0ABCDEFG12
搜索API密钥
可在仪表板的API密钥Algolia部分中找到您的搜索API密钥。
1234a12345678901b1234567890c1ab1

安装和配置Algolia Insights扩展 install-configure

要安装Algolia Insights扩展,请导航到Data Collection UI,然后从左侧导航中选择​Tags。 在此处,选择要将扩展添加到的资产,或改为创建新资产。

选择或创建所需的属性后,在左侧导航中选择​Extensions,然后选择​ Catalog ​选项卡。 搜索Algolia分析卡,然后选择​Install

在显示的配置视图中,必须提供以下详细信息:

属性
描述
Application ID
输入您之前在Application Id配置详细信息部分中收集的
Search API Key
输入您之前在Search API Key配置详细信息部分中收集的
Index Name
Index Name包含产品或内容。 此索引将用作默认索引。
User Token Data Element
将返回用户令牌的数据元素。
Authenticated User Token Data Element
设置将返回经过身份验证的用户令牌的数据元素。
Currency Code
以ISO-4217格式输入货币代码,如USD或EUR。 此字段支持数据元素。

Algolia Insights扩展操作类型 action-types

Algolia支持一组预定义的标准事件,每个事件都具有特定的上下文和属性。 Algolia扩展中可用的操作与这些事件类型一致,从而可轻松根据发送给Algolia的事件类型分类和配置这些事件。

加载分析 load-insights

NOTE
在大多数情况下,建议在您的网站的每个页面上加载Algolia分析。

根据规则的上下文将​ Load Insights ​操作添加到最适合加载Algolia分析的标记规则中。 此操作将search-insights.js库加载到页面上。

创建新标记规则或打开现有标记规则。 根据您的要求定义条件,然后选择​ Algolia ​作为Extension,选择​ Load Insights ​作为Action Type。

属性
描述
Insight Library Version
Algolia分析版本。 默认值为 2.17.3
User Opt Out Data Element
捕获用户的跟踪首选项的数据元素。
Use User Token Cookie
选中此框以允许Algolia生成用户令牌Cookie。 默认情况下,此选项设置为true

已单击 clicked

将​ Click ​操作添加到您的标记规则以将点击事件发送到Algolia。 创建新标记规则或打开现有标记规则。 根据您的要求定义条件,然后选择​ Algolia ​作为Extension,选择​ Clicked ​作为Action Type。

属性
描述
Event Name
事件名称,可用于进一步细化此点击事件。
Event Details Data Element

数据元素以JSON格式返回事件详细信息,包括:

  • indexName
  • objectIDs
  • queryID (可选)
  • positions (可选)
  • price (可选)
  • quantity (可选)
  • discount (可选)
  • objectData (可选)
  • currency (可选)
NOTE
如果同时包括queryIDpositions,则该事件在搜索​ 后将被分类为 ​已点击对象ID。 否则,它被分类为​ 点击的对象ID ​事件。


如果数据元素不提供indexName,则在发送事件时将使用​默认索引名称

有关事件类别的详细信息,请参阅搜索后的点击对象ID
已单击对象ID参考线。

已转换 converted

将​ Converted ​操作添加到您的标记规则以将转换的事件发送到Algolia。 创建新标记规则或打开现有标记规则。 根据您的要求定义条件,然后选择​ Algolia ​作为Extension,选择​ Converted ​作为Action Type。

属性
描述
Event Name
将用于进一步细化此​ 转换 ​事件的事件名称。
Event Details Data Element

数据元素返回事件详细信息,包括:

  • indexName
  • objectIDs
  • queryID (可选)
  • recordID (可选)
NOTE
如果数据元素包含queryId,则将该事件分类为​Converted after Search。 否则,它将被分类为​ 转化的 ​事件。


如果数据元素不提供indexName,则在发送事件时将使用​默认索引名称

有关事件类别的详细信息,请参阅搜索转换后的对象ID转换后的对象ID指南。

已添加到购物车 added-to-cart

将​ Added to Cart ​操作添加到您的标记规则,以将添加到购物车事件的内容发送至Algolia。 创建新标记规则或打开现有标记规则。 根据您的要求定义条件,然后选择​ Algolia ​作为Extension,选择​ Added to cart ​作为Action Type。

属性
描述
Event Name
将用于进一步细化此​ 添加到购物车 ​事件的事件名称。
Event Details Data Element

数据元素以JSON格式返回事件详细信息,包括:

  • indexName
  • objectIDs
  • objectData
  • price
  • quantity
  • discount (可选)
  • queryID (可选)
  • currency (可选)

NOTE
如果数据元素包含queryId,则该事件将被分类为​ 已添加到购物车对象ID(在搜索 ​之后)。 否则,它将被分类为​ 添加到购物车对象ID ​事件。


如果数据元素不提供indexName,则在发送事件时将使用​默认索引名称


如果默认数据元素不符合您的要求,可以创建自定义一个数据元素以返回所需的事件详细信息。

有关事件类别的详细信息,请参阅在搜索后添加到购物车对象ID添加到购物车对象ID指南。

已购买 purchased

将​ Purchased ​操作添加到您的标记规则以将已购买的事件发送到Algolia。 创建新标记规则或打开现有标记规则。 根据您的要求定义条件,然后选择​ Algolia ​作为Extension,选择​ Purchased ​作为Action Type。

属性
描述
Event Name
将用于进一步细化此​ 购买 ​事件的事件名称。
Event Details Data Element

数据元素以JSON格式返回事件详细信息,包括:

  • indexName
  • objectIDs
  • objectData
  • price
  • quantity
  • discount (可选)
  • queryID (可选)
  • currency (可选)

NOTE
Purchased操作根据购买的项目ID从浏览器存储中检索事件数据。 如果任何购买的项目在其存储的数据中包含queryID,则该事件在搜索​ 后将被分类为 ​购买的对象ID。 否则,它将被分类为​ 购买的对象ID ​事件。


此方法允许购买事件自动包含用户之前与项目交互的所有相关上下文(查询ID、索引名称、价格、数量、折扣)。

有关事件类别的详细信息,请参阅搜索后的购买对象ID
已购买对象ID指南。

已查看 viewed

将​ Viewed ​操作添加到您的标记规则以将已购买的事件发送到Algolia。 创建新标记规则或打开现有标记规则。 根据您的要求定义条件,然后选择​ Algolia ​作为Extension,选择​ Viewed ​作为Action Type。

属性
描述
Event Name
将用于进一步细化此​ 视图 ​事件的事件名称。
Event Details Data Element

数据元素以JSON格式返回事件详细信息,包括:

  • indexName
  • objectIDs
NOTE
如果数据元素不提供indexName,则在发送事件时将使用​默认索引名称

有关查看事件的详细信息,请参阅已查看对象ID指南。

Algolia个Insights扩展数据元素 data-elements

Algolia支持一组预定义的数据元素,每个元素都具有特定的上下文和属性。 以下部分介绍了Algolia Insights扩展中可用的数据元素。

数据集 dataset

数据集数据元素检索与HTML元素关联的数据,然后这些数据用于Algolia操作。 此数据元素会自动将检索到的事件数据存储在浏览器存储中,以供以后使用(例如在转化或购买事件中)。

常规配置:

属性
描述
Hit Element Div/Class Name
包含数据集属性的HTML元素名称和/或CSS类名称,这些数据集属性包括HTML元素上的data-insights-object-id以及可选的data-insights-query-iddata-insights-position
Index Name Element Div/Class Name
在HTML元素上具有数据集属性(data-indexname)的HTML元素名称和/或CSS类名称。

Commerce配置(可选):

属性
描述
Price Data Element
返回项目价格的数据元素。 如果提供,这将包含在存储的商业事件事件数据中。
Quantity Data Element
返回项目数量的数据元素。 如果未提供,则默认为1。
Discount Data Element
返回项目的折扣小数值的数据元素。
Currency Code
ISO-4217格式的货币代码。 如果未指定货币代码,则将使用扩展配置中的默认货币。

覆盖(可选):

这些字段允许您覆盖从HTML数据集属性检索数据的默认行为。

属性
描述
Record ID Data Element
覆盖使用页面URL作为记录ID的默认方法。 记录ID用于存储和查找要发送到此产品/页面的Algolia的数据。
Query ID Data Element
查询ID是从HTML元素上的数据集中检索的。 要覆盖此行为,请使用此属性提供将查询ID作为字符串返回的数据元素。
Object IDs Data Element
从HTML元素上的数据集中检索对象ID。 要覆盖此行为,请使用此属性提供一个数据元素,该数据元素将对象ID作为数组返回。
Positions Data Element
从HTML元素上的数据集中检索位置。 要覆盖此行为,请使用此属性提供一个数据元素,该数据元素会将Positions作为数组返回。
Index Name Data Element
索引名称是从HTML元素上的数据集中检索的。 要覆盖此行为,请使用此属性提供一个数据元素,该数据元素将作为字符串返回索引名称。

此数据元素返回:

{
  timestamp,
  queryID,
  indexName,
  objectIDs,
  positions,
  objectData,  // Optional: commerce data if price is provided
  currency,    // Optional: if provided
  recordID
}

包含数据集的HTML示例:

<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>

查询字符串 query-string

查询字符串数据元素从Algolia操作中使用的URL查询字符串中提取数据。

属性
描述
Object ID Param Name
包含对象ID的查询参数名称。
Index Name Param Name
包含“索引名称”的查询参数名称。
Query ID Param Name
包含查询ID的查询参数名称。
Position Param Name
包含职位的查询参数名称。

此数据元素返回:

{
  timestamp,
  queryID,
  indexName,
  objectIDs,
  positions
}

包含查询参数的HTML示例:

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

存储 storage

存储数据元素从浏览器会话存储中检索数据以用于Algolia操作。 此数据元素还可用于使用其他商业信息补充存储的数据。

此数据元素检索之前存储在会话存储中的事件详细信息(通常在点击事件期间由数据集数据元素存储)。 除非明确禁用数据删除,否则数据将在转换事件期间自动删除。

覆盖(可选):

属性
描述
Record ID Data Element
记录ID用作查找存储在浏览器存储中的事件数据的键。 页面URL是默认的记录ID。 要覆盖此行为,请使用此属性提供以字符串形式返回记录ID的数据元素。
Price Data Element
返回项目价格的数据元素。 如果提供,这将会用价格信息更新存储的事件数据。
Quantity Data Element
返回项目数量的数据元素。 如果提供,这将使用数量信息更新存储的事件数据。
Discount Data Element
返回项目的折扣小数值的数据元素。 如果提供,这将使用折扣信息更新存储的事件数据。
Currency Code
以ISO-4217格式输入货币代码。 如果提供,这将使用货币信息更新存储的事件数据。

此数据元素返回会话存储中存储的内容,包括任何增强的商务数据:

{
  timestamp,
  queryID,
  indexName,
  objectIDs,
  positions,      // If available from original event
  objectData,     // Optional: commerce data if price is provided
  currency,       // Optional: if provided
  recordID
}

搜索​ 后点击的 ​或搜索​ 后转换的 ​事件需要queryID,搜索positions后点击的​也需要。 在InstantSearch和/或自动完成查询参数中启用insights标志时,这些属性可用。 请参阅以下资源,了解如何为网站配置Insights:

后续步骤 next-steps

本指南介绍了如何使用Algolia标记扩展将数据发送到Algolia Insights。 如果您还计划向Algolia发送服务器端事件,则现在可以继续安装和配置Conversions API 事件转发扩展

有关Experience Platform中标记的详细信息,请参阅标记概述

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