Algolia標籤擴充功能概觀

Algolia標籤擴充功能可讓行銷人員輕鬆設定規則,將使用者互動資料傳送至Algolia,協助您提供更個人化的AI搜尋和探索體驗。

此擴充功能由主要功能提供支援:

  • Algolia深入分析:自動擷取使用者互動事件並傳送至Algolia,如此可啟用強大的分析、個人化體驗並改善搜尋關聯性。

先決條件 prerequisites

您必須擁有有效的Algolia帳戶才能使用此擴充功能。 移至Algolia 註冊頁面以建立帳戶(如果尚未建立)。

收集必要的設定詳細資料 configuration-details

若要將Algolia與Adobe Experience Platform連線,您需要下列資訊:

認證
說明
範例
應用程式ID
您可以在儀表板的API金鑰Algolia區段中找到您的應用程式ID。
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的事件。

載入Insights 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。 否則,它被分類為​ 點選物件識別碼 ​事件。


如果資料元素未提供indexName,則會在傳送事件時使用​預設索引名稱

如需事件類別的詳細資訊,請參閱搜尋後的點選物件識別碼
已點按物件識別碼參考線。

已轉換 converted

將​ Converted ​動作新增至您的標籤規則,以將轉換的事件傳送至Algolia。 建立新標籤規則或開啟現有標籤規則。 根據您的需求定義條件,然後選取​ Algolia ​作為Extension,並選取​ Converted ​作為Action Type。

屬性
說明
Event Name
將用於進一步調整此​ 轉換 ​事件的事件名稱。
Event Details Data Element

資料元素會傳回事件詳細資料,包括:

  • indexName
  • objectIDs
  • queryID (選擇性)
  • recordID (選擇性)
NOTE
如果資料元素包含queryId,則事件在搜尋後會分類為​已轉換。 否則,它將被分類為​ 已轉換 ​事件。


如果資料元素未提供indexName,則會在傳送事件時使用​預設索引名稱

如需事件類別的詳細資訊,請參閱搜尋後的轉換的物件識別碼轉換的物件識別碼指南。

已新增至購物車 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。 否則,它將分類為​ 新增到購物車物件識別碼 ​事件。


如果資料元素未提供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
「已購買」動作會根據已購買的專案ID從瀏覽器儲存空間中擷取事件資料。 如果任何購買的專案在其儲存的資料中包含queryID,則搜尋後​ 事件將被分類為 ​購買物件ID。 否則,將被分類為​ 已購買物件識別碼 ​事件。


此方法可讓購買事件自動包含使用者先前與專案互動的所有相關內容(查詢ID、索引名稱、價格、數量、折扣)。

如需事件類別的詳細資訊,請參閱搜尋後的購買物件ID
已購買的物件識別碼參考線。

已檢視 viewed

將​ Viewed ​動作新增至您的標籤規則,以將已購買的事件傳送至Algolia。 建立新標籤規則或開啟現有標籤規則。 根據您的需求定義條件,然後選取​ Algolia ​作為Extension,並選取​ Viewed ​作為Action Type。

屬性
說明
Event Name
將用於進一步調整此​ 檢視 ​事件的事件名稱。
Event Details Data Element

資料元素會傳回JSON格式的事件詳細資料,包括:

  • indexName
  • objectIDs
NOTE
如果資料元素未提供indexName,則在傳送事件時將使用​預設索引名稱

如需檢視事件的詳細資訊,請參閱已檢視物件識別碼指南。

Algolia個Insights延伸資料元素 data-elements

Algolia支援一組預先定義的資料元素,每個元素都有特定的內容和屬性。 以下章節說明Algolia Insights擴充功能中可用的資料元素。

資料集 dataset

DataSet Data Element會擷取與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
物件ID會從HTML元素的資料集中擷取。 若要覆寫此行為,請使用此屬性來提供將物件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

查詢字串資料元素會從URL查詢字串擷取資料,以用於Algolia動作。

屬性
說明
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動作。 此資料元素也可用來以其他商業資訊來增強已儲存的資料。

此資料元素會擷取先前儲存在工作階段存放區中的事件詳細資料(通常是由點選事件期間的DataSet資料元素所儲存)。 除非明確停用移除,否則資料會在轉換事件期間自動移除。

覆寫(選擇性):

屬性
說明
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和/或Autocomplete查詢引數中啟用insights旗標時,這些屬性即可使用。 請參閱下列資源,瞭解如何設定網站的Insights:

後續步驟 next-steps

本指南說明如何使用Algolia標籤延伸將資料傳送至Algolia Insights。 如果您也打算將伺服器端事件傳送至Algolia,您現在可以繼續安裝並設定Conversions API 事件轉送擴充功能

如需Experience Platform標籤的詳細資訊,請參閱標籤總覽

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