上傳並實作端對端測試
若要在Adobe Experience Platform中測試標籤擴充功能,請使用標籤API和/或命令列工具來上傳您的擴充功能套件。 接下來,使用Platform UI或資料收集UI將您的擴充功能套件安裝至屬性,並在標籤程式庫和組建中實作其功能。
本文介紹如何為擴充功能實作端對端測試。
驗證您的擴充功能 validate
如果您的團隊對於擴充功能的效能以及在沙箱工具中看到的結果感到滿意,您就可以將擴充功能套件上傳至標籤了。
上傳之前,請先驗證是否有任何必要欄位或設定需完成。例如,檢閱您的擴充功能資訊清單、擴充功能組態、檢視以及程式庫模組 (最少)是良好的作法。
您的標誌檔案就是明確的範例:請在您的extension.json
檔案中新增"iconPath": "example.svg",
行,並將該標誌影像檔案加入您的專案中。 這是會針對擴充功能顯示之圖示的相對路徑。 此路徑不應以斜線開頭。它必須參考副檔名為 .svg
的 SVG 檔案。該SVG在呈現為正方形時應該會正常顯示,並可由使用者介面縮放。 如需詳細資訊,請參閱如何縮放SVG文章。
extension.json
中納入並附有 Exchange 清單連結的項目。您的擴充功能資訊清單應包含 "exchangeUrl":"https://www.adobeexchange.com/experiencecloud.details.12345.html"
之類的項目,指向您 Exchange 清單的 URL。建立Adobe I/O整合 integration
若要使用API或命令列工具,您需要具有Adobe I/O的技術帳戶。您必須在I/O主控台中建立技術帳戶,然後使用上傳程式工具來上傳擴充功能套件。
如需建立技術帳戶以用於Adobe Experience Platform中的標籤的詳細資訊,請參閱Reactor API快速入門指南。
如果您無法建立整合,表示您可能沒有正確的許可權。 這需要組織管理員為您完成步驟或將您指派為開發人員。
上傳您的擴充功能套件 upload
現在您已擁有憑證,可以開始端對端測試擴充功能套件了。
第一次上傳擴充功能套件時,套件會進入development
狀態。 這表示它僅對您自己的組織可見,而且只有已標示為要用於擴充功能開發的屬性。
使用命令列,在包含.zip套件的目錄中執行下列命令。
npx @adobe/reactor-uploader
npx
可讓您下載並執行npm套件,而無需在機器上實際安裝。 這是上傳程式最簡單的執行方式。
jwt-auth
認證可藉由執行
npx @adobe/reactor-uploader@v5.2.0
使用,直到2025年1月1日停止使用。 必要的引數若要執行
jwt-auth
版本,可在這裡找到。上傳程式僅需要您輸入幾項資訊。 可以從Adobe I/O主控台擷取clientId
和clientSecret
。 導覽至I/O主控台中的整合頁面。 從下拉式清單中選取正確的組織,尋找正確的整合,然後選取 檢視。
- 您的
clientId
是什麼? 請從I/O主控台複製並貼上。 - 您的
clientSecret
是什麼? 請從I/O主控台複製並貼上。 - 如果從包含 .zip 套件的目錄中叫用上傳程式,您可以直接從清單中選取,而無需輸入路徑。
您的擴充功能套件將隨即上傳,且上傳程式會為您提供 extension_package 的 ID。
extension_package
ID的狀態。 您會在目錄中看到標示為「擱置中」的擴充功能卡片。建立開發屬性 property
登入UI並在左側導覽中選取 標籤 之後,會顯示屬性畫面。 屬性是一個容器,內含您要部署的標記,可用於一或多個網站。
第一次登入時,熒幕上不會顯示任何屬性。 選取 「新增屬性」 以建立屬性。輸入名稱和 URL。請使用測試網站的URL或您要測試擴充功能的頁面。 此網域欄位可供某些擴充功能使用,或供使用核心擴充功能的條件使用。
localhost
無法當作URL值使用。 如果您使用localhost
URL,請改為使用任何模擬值進行測試。 例如, example.com。若要將此屬性用於擴充功能開發測試,您必須展開 進階OPTIONS,並確定勾選 設定擴充功能開發 的方塊。
選取底部的 「儲存」 以儲存新屬性。
「屬性」畫面隨即顯示。 選取您剛建立的屬性名稱。「屬性概述」畫面隨即顯示。 它提供系統每個區域的連結,左側欄中有全域導覽連結。
安裝您的擴充功能 install-extension
若要在此屬性中安裝您的擴充功能,請在左側欄的主要導覽連結中選取 擴充功能 連結。 核心 擴充功能會顯示在 已安裝 畫面上。 核心擴充功能包含資料收集內的所有標籤管理功能。
若要新增擴充功能,請選取 目錄 索引標籤。
目錄會顯示每個可用擴充功能的卡片圖示。如果您的擴充功能未顯示在目錄中,請確定您已完成上述「Adobe管理主控台設定」和「建立您的擴充功能套件」區段中的步驟。 如果平台尚未完成初始處理,您的擴充功能套件也可能會顯示為「擱置中」。
如果您已執行先前步驟,但目錄中仍未顯示「擱置中」或「失敗」擴充功能套件,則應直接使用API檢視擴充功能套件的狀態。 如需如何進行適當API呼叫的詳細資訊,請參閱API檔案中的擷取ExtensionPackage。
擴充功能套件處理完畢後,請選取卡片底部的 安裝。
設定畫面隨即開啟(前提是擴充功能具有擴充功能)。 新增設定擴充功能所需的任何資訊,並選取底部的 儲存。 這裡所示的設定畫面範例使用Facebook擴充功能,此擴充功能需要畫素ID。
您現在應該會看到 已安裝 擴充功能畫面,其中顯示核心擴充功能和您的擴充功能。
建立用來測試擴充功能的資源 resources
擴充功能可為Adobe Experience Platform的使用者提供新功能。 這些通常會顯示在「資料元素」或「規則產生器」中。
資料元素
標籤資料元素的用途是協助使用者儲存值。 每個資料元素都是來源資料的對應或指標。單一資料元素是可對應至查詢字串、URL、Cookie值、JavaScript變數的變數。 從左側導覽列中選取 資料元素,然後選取 建立新資料元素。
擴充功能可視需要定義資料元素類型,供擴充功能運作之用,或方便使用者操作\。當擴充功能提供資料元素型別時,這些型別會顯示在 建立資料元素 畫面上的下拉式清單中,供使用者選取:
當使用者從 擴充功能 下拉式清單選取您的擴充功能時,資料元素型別 下拉式清單會填入您的擴充功能所提供的任何資料元素型別。 使用者可將每個資料元素對應至其來源值。然後,在「資料元素變更事件」或「自訂程式碼事件」中建立規則時,可使用資料元素來觸發要執行的規則。資料元素也可用於資料元素條件或規則中的其他條件、例外或動作。
建立資料元素 (設定對應) 後,使用者只需參考資料元素即可參考來源資料。如果值的來源有所變更 (網站重新設計等),使用者只需在UI中更新一次對應,所有資料元素都會自動接收新的來源值。
規則
在左側導覽中選取 規則 連結,然後 建立新規則。
首先,輸入規則的描述性名稱。 建立規則 畫面已設定為if-then
陳述式。
如果發生事件,且符合條件,而且沒有例外,則會觸發動作。擴充功能中也存在相同的流程,您可在其中建立或運用事件、條件、例外、資料元素或動作。
以Facebook擴充功能為例,每當頁面載入測試網站時,都新增事件。
Window Loaded
事件型別 可確保每當頁面載入測試網站時,都會觸發此規則。 選取 保留變更。 在此範例中,請忽略 條件,因為測試網站上的任何頁面都應該觸發規則。
在 動作 下,選取 新增。 動作組態 畫面隨即顯示。接下來,您必須選擇要套用規則的擴充功能,以及觸發規則時要發生的動作。 從 擴充功能 下拉式清單中選取 Facebook Pixel,並從 動作型別 下拉式清單中選取 傳送頁面檢視。 在下列 編輯規則 畫面中選取 保留變更,然後選取 儲存。
測試擴充功能時,請選取任何相關的事件、條件等。 任何數量的規則中提供的任何事件、條件等。
Publish您的變更 publish
在主要導覽區中選取 「發佈」,然後選取 「新增程式庫」 連結:
程式庫是擴充功能、資料元素和規則部署後,彼此間以及與網站間將如何互動的一組指示。程式庫會編譯到組建中。一個程式庫可以包含使用者想一次進行或測試的所有變更,數量不限。
在 建立資料庫 畫面上,在 名稱 文字欄位中新增名稱。 標籤提供名為 開發 的預設開發環境。 從 環境 下拉式清單中選取 開發。 為簡化起見,請新增所有可用資源。 選取 新增所有變更的資源,然後選取 儲存。
現在,所有變更都已包含在新建的程式庫中(在提供的範例中命名為 dev),請選取 儲存並建置到開發。
建置程式完成後,程式庫名稱旁會顯示綠色的 success 指標。
標籤庫現已發佈並可供使用。 測試頁面必須使用新建立的程式庫,才能在瀏覽器中測試使用者的頁面行為。
在測試網站上安裝標籤 install-data-collection-tags
安裝指示可在環境索引標籤中取得。 此頁面顯示所有可用的環境,並可讓您建立更多環境。 當程式庫已發佈至開發環境時,請選取 開發 列上 INSTALL 欄中的方塊圖示。
開發環境的 網頁安裝指示 對話方塊就會顯示。 選取復製圖示以複製整個<script>
標籤。
將這個單一<script>
標籤放在檔案或網站範本的<head>
區段內,以完成安裝。 接下來,請造訪測試網站,檢查您已發佈的標籤程式庫的行為。
測試 test
以下是在測試頁面或網站上驗證擴充功能的實用主控台命令清單。
_satellite.setDebug(true);
將啟用偵錯模式並將有用的記錄陳述式輸出到主控台。_satellite._container
物件包含有關已部署程式庫的實用資訊,包括關於組建、資料元素、規則和擴充功能的詳細資訊。
此測試的目的是檢查已部署程式庫的功能,並確保擴充功能套件在編譯至程式庫後,能如預期般運作。
當您發現需要對擴充功能套件進行的變更時,其反覆運算程序與開發程序相類似。
-
變更專案中的程式碼。
-
使用沙箱工具驗證變更。
-
使用封裝程式工具建立新的 .zip 套件
-
使用Uploader工具上傳新的.zip套件。 此程式會遵循與先前相同的指示,進行初始上傳。 不過,您會注意到,由於在開發模式中已有同名的擴充功能套件,因此這個新套件將會覆寫較舊的版本,而非建立新版本。
note note NOTE 可在命令列上傳遞引數,以避免重複輸入認證以節省時間。 如需詳細資訊,請閱讀reactor-uploader檔案。 1. 更新現有套件時,可跳過安裝步驟。
-
修改資源 — 如果任何擴充功能元件的設定已變更,您將需要在UI中更新這些資源。
-
將您的最新變更新增至程式庫,然後重新建置。
-
完成另一輪測試。