Einstein Recommendations

Einstein Recommendations API 有兩個主要功能:接收活動、輸出推薦。只要使用我們的區域元件,客戶還可以在不變更任何程式碼的情況下,靈活地切換建議工具。

此 API 文件主要是為 Salesforce Commerce Cloud 客戶撰寫。

若要啟用對 Einstein Recommendations API 的存取,請前往 Einstein Configurator,然後在 API 頁面中輸入您的 Commerce Cloud Account Manager 用戶端 ID。使用「網站管理員」存取權限,您可以在 Account Manager 頁面上建立必要的用戶端 ID。如需更多資訊,請參閱新增 API 用戶端 ID

啟用後,只要傳遞了正確的用戶端 ID,API 即可在所有環境中運作,包括 Production、Staging、Development、Sandbox 執行個體。

每個 API 呼叫都必須傳遞 x-cq-client-id 標頭,以進行 API 金鑰驗證。

在用戶端或伺服器端實作我們的 API,需要進行一些取捨。為了確實保密您的用戶端 ID,我們建議您在伺服器端實作我們的 API,以提高安全性。若在用戶端實作,會面臨將用戶端 ID 暴露給惡意執行者的風險。

若在伺服器端實作,取得推薦的要求與某些使用者活動 (如 viewProduct、viewReco、clickReco) 則需要考慮到快取。舉例來說,在使用者檢視已快取的產品頁面的情況下,仍應傳送 viewProduct 活動。重要的是 Einstein 接收所有事件,而且不快取推薦。

此 Einstein Recommendations API 並非為電子郵件推薦使用案例而設計。不支援在電子郵件中嵌入 Einstein 推薦。

我們的服務遍布全球,不僅可水平擴縮,也能根據流量自動上下調整,因此無需進行負載測試。我們建議您避免任何負載測試,因為這會影響推薦結果。

為了協助替每位購物者產生相關的產品推薦,Einstein Recommendations API 提供了用於識別購物者的參數。

為避免潛在的惡意活動,使用者識別碼參數必須是非連續的形式。參數不應包括序列、模式、IP 位址、電子郵件地址、姓名或與特定人員相關的任何內容。所有使用者識別碼參數必須透過雜湊或其他方法,遵守《一般資料保護規則》(General Data Protection Regulation,GDPR)。

  • cookieId (必填) - 匿名購物者的唯一識別碼。一般來說,cookieId 是第一方 Cookie 的值。
    • 從傳統 Commerce Cloud 網店發出 API 要求時,請傳遞 cqcid Cookie 值來符合傳統網店上的自動活動追蹤。如需更多資訊,請參閱瀏覽器型本機資料儲存
    • 使用 Salesforce Commerce API 時,請在權杖擷取過程中,傳遞可用的 USID 值。如需更多資訊,請參閱 Shopper Login and API Access Service 文件。
    • 使用 OCAPI 時,請傳遞訪客登入回應的 visit_id 值以符合自動活動。如需更多資訊,請參閱 OCAPI 客戶文件
  • userId (建議) - 已登入購物者的唯一識別碼。此參數讓 Einstein 能夠在多個裝置上,連結相同的登入使用者。
    • 從傳統 Commerce Cloud 網店發出 API 要求時,請傳遞 cquid Cookie 值來符合傳統網店上的自動活動追蹤。如需更多資訊,請參閱瀏覽器型本機資料儲存
    • 使用 Salesforce Commerce API 時,請傳遞已註冊登入回應的 hashed_login 值以符合自動活動。如需更多資訊,請參閱 Shopper Login and API Access Service 文件。
    • 使用 OCAPI 時,請傳遞已註冊登入回應的 hashed_login 值以符合自動活動。如需更多資訊,請參閱 OCAPI 客戶文件

透過 Einstein API 使用的建議工具標準效能報告,與您數位網站上使用的其他建議工具標準效能報告相同。您可以在 Einstein Reports & Dashboard 中檢視報告 (請參閱此文件來進一步瞭解 Einstein Reports & Dashboard)。

為了讓個別的報告和疑難排解更輕鬆,我們建議您為 Einstein API 建立單獨的建議工具。舉例來說,將建議工具命名為「pdp-mobile-API」,代表該建議工具用於行動應用程式的產品詳細資料頁面。

報告指標是以活動為依據。若使用 Einstein Recommendations API 的應用程式無法傳送活動,則 API 建議工具的所有指標都將顯示為零 (0)。

Rights of ALBERT EINSTEIN are used with permission of The Hebrew University of Jerusalem. Represented exclusively by Greenlight.