[整合]{class="badge positive"}

使用AEM Sites產生Experience PlatformFPID

[AEM Sites as a Cloud Service、AEM Sites 6.5]{class="badge informative"}

將Adobe Experience Manager (AEM) Sites與Adobe Experience Platform (AEP)整合需要AEM產生和維護唯一的第一方裝置ID (FPID) Cookie,以唯一追蹤使用者活動。

閱讀支援檔案,以便瞭解第一部分裝置ID和Experience CloudID如何搭配運作的詳細資訊

以下是使用AEM做為Web主機時,FPID的運作方式概觀。

使用AEM 的FPID與ECID

使用AEM產生並保留FPID

AEM Publish服務會儘可能在CDN和AEM Dispatcher快取中快取要求,以最佳化效能。

絕不會快取產生每位使用者不重複FPID Cookie並傳回FPID值的HTTP請求並直接從AEM Publish (可實作邏輯以確保唯一性)提供服務,這點至關重要。

請避免在網頁或其他可快取資源的請求上產生FPID Cookie,因為FPID的唯一性要求組合會造成這些資源無法快取。

下圖說明AEM Publish服務如何管理FPID。

FPID與AEM流程圖

  1. 網頁瀏覽器會要求使用AEM託管的網頁。 CDN或AEM Dispatcher快取的網頁快取復本可為請求提供服務。
  2. 如果網頁無法從CDN或AEM Dispatcher快取提供服務,要求會送達AEM Publish服務,該服務會產生要求的網頁。
  3. 接著,網頁會傳回至網頁瀏覽器,並填入無法處理請求的快取。 使用AEM時,CDN和AEM Dispatcher快取命中率會高於90%。
  4. 此網頁包含的JavaScript會對AEM Publish服務中的自訂FPID servlet發出無法快取的非同步XHR (AJAX)請求。 由於這是無法快取的請求(因其隨機查詢引數和快取控制標頭),CDN或AEM Dispatcher永遠不會快取它,且一律會送達AEM Publish服務以產生回應。
  5. AEM Publish服務中的自訂FPID servlet會處理要求、在沒有找到現有FPID Cookie時產生新的FPID,或延長任何現有FPID Cookie的生命週期。 此servlet也會傳回回應本文中的FPID,以供使用者端JavaScript使用。 幸運的是,自訂FPID servlet邏輯是輕量級的,防止此請求影響AEM Publish服務效能。
  6. XHR要求的回應會傳回給瀏覽器,並在回應本文中以JSON格式顯示FPID Cookie,以供Platform Web SDK使用。

程式碼範例

下列程式碼和設定可部署至AEM Publish服務,以建立端點,產生或延長現有FPID Cookie的生命週期,並將FPID傳回JSON。

必須建立AEM HTTP端點,以使用Sling servlet產生或擴充FPID Cookie。

  • 此servlet已繫結至/bin/aem/fpid,因為存取它不需要驗證。 如果需要驗證,則繫結到Sling資源型別。
  • 此servlet接受HTTPGET要求。 回應標示為Cache-Control: no-store以防止快取,但應使用唯一的防快取查詢引數來要求此端點。

當HTTP請求到達servlet時,此servlet會檢查請求上是否存在FPID Cookie:

  • 如果FPID Cookie存在,請延長Cookie的生命週期,並收集其值以寫入回應。
  • 如果FPID Cookie不存在,請產生新的FPID Cookie,並儲存值以寫入回應。

然後,Servlet會將FPID以JSON物件的形式寫入回應: { fpid: "<FPID VALUE>" }

請務必在正文中將FPID提供給使用者端,因為FPID Cookie標示為HttpOnly,表示只有伺服器可以讀取其值,使用者端JavaScript則無法讀取。

回應本文中的FPID值是用來引數化Platform Web SDK的呼叫。

以下是AEM servlet端點的範常式式碼(可透過HTTP GET /bin/aep/fpid取得),其會產生或重新整理FPID Cookie,並傳回FPID為JSON。

  • core/src/main/java/com/adobe/aem/guides/wkndexamples/core/aep/impl/FpidServlet.java
package com.adobe.aem.guides.wkndexamples.core.aep.impl;

import com.google.gson.JsonObject;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.sling.api.SlingHttpServletResponse;
import org.apache.sling.api.servlets.SlingAllMethodsServlet;
import org.osgi.service.component.annotations.Component;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.servlet.Servlet;
import javax.servlet.http.Cookie;
import java.io.IOException;
import java.util.UUID;

import static org.apache.sling.api.servlets.ServletResolverConstants.SLING_SERVLET_PATHS;
import static org.apache.sling.api.servlets.ServletResolverConstants.SLING_SERVLET_METHODS;

@Component(
        service = {Servlet.class},
        property = {
                SLING_SERVLET_PATHS + "=/bin/aep/fpid",
                SLING_SERVLET_METHODS + "=GET"
        }
)
public class FpidServlet extends SlingAllMethodsServlet {
    private static final Logger log = LoggerFactory.getLogger(FpidServlet.class);
    private static final String COOKIE_NAME = "FPID";
    private static final String COOKIE_PATH = "/";
    private static final int COOKIE_MAX_AGE = 60 * 60 * 24 * 30 * 13;
    private static final String JSON_KEY = "fpid";

    @Override
    protected final void doGet(SlingHttpServletRequest request, SlingHttpServletResponse response) throws IOException {
        // Try to get an existing FPID cookie, this will give us the user's current FPID if it exists
        final Cookie existingCookie = request.getCookie(COOKIE_NAME);

        String cookieValue;

        if (existingCookie == null) {
            //  If no FPID cookie exists, Create a new FPID UUID
            cookieValue = UUID.randomUUID().toString();
        } else {
            // If a FPID cookie exists. get its FPID UUID so it's life can be extended
            cookieValue = existingCookie.getValue();
        }

        // Add the newly generate FPID value, or the extended FPID value to the response
        // Use addHeader(..), as we need to set SameSite=Lax (and addCoookie(..) does not support this)
        response.addHeader("Set-Cookie",
                COOKIE_NAME + "=" + cookieValue + "; " +
                        "Max-Age=" + COOKIE_MAX_AGE + "; " +
                        "Path=" + COOKIE_PATH + "; " +
                        "HttpOnly; " +
                        "Secure; " +
                        "SameSite=Lax");

        // Avoid caching the response in any cache
        response.addHeader("Cache-Control", "no-store");

        // Since the FPID is HttpOnly, JavaScript cannot read it (only the server can)
        // Write the FPID to the response as JSON so client JavaScript can access it.
        final JsonObject json = new JsonObject();
        json.addProperty(JSON_KEY, cookieValue);

        // The JSON `{ fpid: "11111111-2222-3333-4444-55555555" }` is returned in the response
        response.setContentType("application/json");
        response.getWriter().write(json.toString());
    }
}

HTML指令碼

必須在頁面中新增自訂使用者端JavaScript,以非同步叫用servlet,產生或重新整理FPID Cookie,並在回應中傳回FPID。

此JavaScript指令碼通常會新增至頁面,並使用下列其中一種方法:

對自訂AEM FPID servlet的XHR呼叫雖然非同步,但速度很快,因此使用者可以造訪AEM提供的網頁,並在完成請求之前導覽離開。
如果發生這種情形,相同的程式會在從AEM載入網頁的下一個頁面時重新嘗試。

AEM FPID servlet (/bin/aep/fpid)的HTTPGET會使用隨機查詢引數加以引數化,以確保瀏覽器與AEM Publish服務之間的任何基礎結構都不會快取要求的回應。
同樣地,已新增Cache-Control: no-store要求標頭以支援避免快取。

在叫用AEM FPID servlet時,會從JSON回應擷取FPID,並由Platform Web SDK用來將其傳送至Experience Platform API。

請參閱Experience Platform檔案以取得有關在identityMap🔗中使用FPID的的詳細資訊

...
<script>
    // Invoke the AEM FPID servlet, and then do something with the response

    fetch(`/bin/aep/fpid?_=${new Date().getTime() + '' + Math.random()}`, {
            method: 'GET',
            headers: {
                'Cache-Control': 'no-store'
            }
        })
        .then((response) => response.json())
        .then((data) => {
            // Get the FPID from JSON returned by AEM's FPID servlet
            console.log('My FPID is: ' + data.fpid);

            // Send the `data.fpid` to Experience Platform APIs
        });
</script>

Dispatcher允許篩選器

最後,必須透過AEM Dispatcher的filter.any設定來允許對自訂FPID servlet的HTTPGET要求。

如果此Dispatcher設定未正確實作,對/bin/aep/fpid的HTTPGET請求會導致404。

  • dispatcher/src/conf.dispatcher.d/filters/filters.any
/1099 { /type "allow" /method "GET" /url "/bin/aep/fpid" }

Experience Platform資源

檢閱下列有關第一方裝置ID (FPID)和使用Platform Web SDK管理身分資料的Experience Platform檔案。

recommendation-more-help
bb44cebf-d964-4e3c-b64e-ce882243fe4d