關於將電子郵件與 Recommendations 整合方式的資訊。
電子郵件服務提供者的能力決定了可用的方法。您的客戶經理或顧問可以幫助您選擇最適合您的選項。
傳送 API 是 POST 要求,可與建置時間電子郵件搭配使用。此選項是用於建置時間電子郵件偏好的方法。
多數電子郵件用戶端不允許 POST 要求; 因此,針對開啟時間使用案例不建議此 API。部分電子郵件用戶端 (例如 Gmail 或 Outlook),可能會快取內容或封鎖影像,並要求收件者主動允許影像呈現。
您無法使用傳送 API 傳回預設內容。
下列程式碼是 API 傳送要求的範例:
curl -X POST \
'https://clientcode.tt.omtrdc.net/rest/v1/mbox/?client=clientcode' \
-H 'authorization: Bearer 3423614b-4843-4664-83c4-c6c3f6c8869b' \
-H 'cache-control: no-cache' \
-H 'content-type: application/json' \
-d '{
"mbox" : "email-mbox",
"tntId" : "111499796294071-449025.28_44",
"requestLocation" : {
"host" : "prod"
},
"profileParameters" : {
},
"mboxParameters" : {
"at_property": "b468a242-64a4-32a0-ca0c-890bddd78789",
"entity.id": "article-123",
"entity.event.detailsOnly" : "true"
}
"contentAsJson": true
}'
其中,clientcode
為您的 Target 用戶端代碼。
各電子郵件收件人 (如各 API 呼叫) 的 sessionId
及 tntId
或 thirdPartyId
兩者之一,請務必提供不重複的值。如果您沒有為這些欄位提供唯一值,API 回應可能會因為在單一設定檔中產生的大量事件,導致變慢或失敗。
如需詳細資訊,請參閱傳送 API 文件。
rawbox 類似於 mbox 要求,但是是用於非 Web 環境,例如電子郵件服務提供者 (ESP)。因為您沒有 mbox.js 或 at.js 可在 rawbox 要求中使用,您必須手動建立您的要求。以下範例說明如何在電子郵件中使用 rawbox 要求。
使用rawbox和Target時,請參閱建立允許清單下的重要安全性注意事項,此清單指定授權將mbox呼叫傳送至Target的主機。
透過該方法,您可在電子郵件中追蹤建議的效能,以正常方式測試建議,並繼續在網站上追蹤。
在 Adobe Target 中使用「表單式體驗撰寫器」選項設定 Recommendations 活動。針對位置,選取您選擇在來自 ESP 的 Rawbox 要求中使用的 mbox 的名稱。選取符合您對電子郵件所需外觀的設計。在電子郵件建置時,ESP 會對每個要產生的電子郵件中的每個 Rawbox 對 Adobe Target 伺服器進行呼叫。您的 ESP 必須有一個方式可在電子郵件中包括傳回的 HTML (如果有傳送)。
您使用的電子郵件系統應該有能力處理這些案例:
在此情況中,Target 伺服器將傳回下列內容:
//ERROR: application server timeout
電子郵件應用程式應該搜尋該文字並能夠處理錯誤。電子郵件提供者有多個選項可用於處理此情況:
https://client_code.tt.omtrdc.net/m2/client_code/ubox/raw?mbox=mbox_name&mboxSession=1396032094853-955654&mboxPC=1396032094853-955654&mboxXDomain=disabled&entity.event.detailsOnly=true&mboxDefault=nocontent&mboxNoRedirect=1&entity.id=2A229&entity.categoryId=5674
若要在電子郵件中使用 Recommendations,rawbox 呼叫一般必須包括 entity.id
或 entity.categoryId
或是兩者,視建議條件的類型而定。以上的樣本呼叫包括這兩者。
參數 | 值 | 說明 | 驗證 |
---|---|---|---|
client_code |
client_code | 在 Recommendations 中所使用用戶端的程式碼。您的 Adobe 顧問可以提供此值。 | |
mbox |
mboxName | 用於鎖定目標的 mbox 名稱。 | 對所有 mbox 呼叫使用相同的驗證身分。 250 個字元限制。 不能包括下列任一個字元: ', ", %22, %27, <, >, %3C, %3E |
mboxXDomain |
已停用 | 防止回應在非 Web 環境中設定 Cookie。 | |
entity.id (某些類型的條件為必要: 檢視/檢視、檢視/購買、購買/購買) |
entity_id | 建議所根據的 productId,例如購物車中放棄的產品或先前的購買。 如果條件要求,rawbox 呼叫必須包括 entity.id 。 |
|
entity.event.detailsOnly |
true | 如果傳遞了 entity.id ,則非常建議您也傳遞此參數,以防止要求為了不要扭曲產品檢視式的演算法,而遞增專為某項目調整的頁面檢視數量。 |
|
entity.categoryId (某些類型的條件為必要: 依檢視次數最多類別和依最暢銷商品類別) |
category_id | 類別建議的根據,例如類別中的最暢銷商品。 如果條件要求,rawbox 呼叫必須包括 entity.categoryId 。 |
|
mboxDefault |
https://www.default.com |
如果 mboxNoRedirect 參數未出現,如果沒有可用的建議,mboxDefault 應該是將傳回預設內容的絕對 URL。這可以是影像或其他靜態內容。如果 mboxNoRedirect 參數出現,mboxDefault 可以是任何文字,指出沒有任何建議,例如 no_content 。電子郵件提供者將需要處理傳回此值的情況,並插入預設的 HTML 至電子郵件。 安全性最佳實務:請注意,如果 mboxDefault URL中使用的網域未列出,您可能會面臨「開啟重新導向弱點」的風險。為避免第三方未授權使用重新導向程式連結或mboxDefault ,建議您使用「授權主機」來允許列出預設的重新導向URL網域。 Target使用主機來允許列出您要允許重新導向的網域。 如需詳細資訊,請參閱建立允許清單,指定在Hosts中授權傳送mbox呼叫至Target的主機。 |
|
mboxHost |
mbox_host | 這是呼叫觸發時新增至預設環境 (主機群組) 的網域。 | |
mboxPC |
空白 | (使用訪客的設定檔的建議為必要。) 如果未提供 "thirdPartyId",則會產生新的 tntId,並隨著回應傳回。否則會保持空白。 注意: 請務必為每個電子郵件收件人 (即每個 API 呼叫) 提供 mboxSession 和 mboxPC 的唯一值。如果您沒有為這些欄位提供唯一值,API 回應可能會因為在單一設定檔中產生的大量事件,導致變慢或失敗。 |
1 < 長度 < 128 不能包含超過一個「.」(句點)。 允許的唯一一個句點用於設定檔位置字尾。 |
參數 | 值 | 說明 | 驗證 |
---|---|---|---|
mboxPC (可選) |
mboxPCId | Target 訪客 ID。如果您想要追蹤使用者在多次造訪間完全回到您的網站,或使用使用者設定檔參數時,請使用此值。 此值必須是使用者的實際 Adobe Target PCID,它會從網站匯出至您的 CRM。電子郵件提供者會從您的 CRM 或資料倉儲擷取此 ID,並使用它做為此參數的值。 當建議屬於 A/B 活動時, mboxPC 值對於追蹤多次造訪間的度量追蹤的訪客網站行為也很實用。注意: 請務必為每個電子郵件收件人 (即每個 API 呼叫) 提供 mboxSession 和 mboxPC 的唯一值。如果您沒有為這些欄位提供唯一值,API 回應可能會因為在單一設定檔中產生的大量事件,導致變慢或失敗。 |
1 < 長度 < 128 不能包含超過一個「.」(句點)。 允許的唯一一個句點用於設定檔位置字尾。 |
mboxNoRedirect (可選) |
1 | 依預設,在找不到可傳遞的內容時會將呼叫端重新導向。用來停用預設行為。 | |
mbox3rdPartyId |
xxx | 如果您有要用於設定檔鎖定目標的自訂訪客 ID,請使用此值。 |
回應 | 說明 |
---|---|
//錯誤: | 當它無法傳回內容時由負載平衡器產生 |
success | mboxNoRedirect 參數設為 'true',而伺服器未傳回任何建議 (亦即,沒有 mbox 的相符項目或伺服器快取未初始化)。 |
bad request | 遺漏 mbox 參數。
|
Cannot redirect to default content, please specify mboxDefault parameter |
當要求的相符項目不存在時,mboxDefault 未指定,並且 mboxNoRedirect 參數未指定。 |
Invalid mbox name:= MBOX_NAME |
指出 mbox 參數包括無效的字元。 |
Mbox name [MBOX_NAME] is too long |
指出 mbox 參數長於 250 個字元。 |
照常設定建議,但選擇顯示區域中的僅供下載,而不是範本和 mbox 組合。然後在 ESP 中,告訴 ESP 您所建立的建議 ID。ESP 透過 API 存取建議資料。該資料顯示應為特定類別或主要項目所建議的項目,例如購物車中放棄的項目。ESP 會儲存資料,以其自身的外觀和感覺連接它,顯示各項目的相關資訊,並透過電子郵件傳送。
使用該選項, Recommendations 伺服器無法直接追蹤建議的效能,或將流量分入多個演算法/範本組合。同時,建議未繫結至訪客設定檔。
如需下載 API 的詳細資訊,請參閱「舊版 API > 下載」。