預覽和估計端點

當您開發區段定義時,可以使用Adobe Experience Platform中的預估和預覽工具來檢視摘要層級資訊,以協助您確保隔離預期的對象。

  • ​預覽提供區段定義之合格設定檔的編頁清單,讓您能比較結果與預期的結果。

  • ​預估值會提供區段定義的統計資訊,例如投影對象大小、信賴區間和錯誤標準差。

注意

若要存取與即時客戶設定檔資料相關的類似量度,例如特定命名空間內的設定檔片段和合併設定檔總數,或整個設定檔資料存放區,請參閱「設定檔API開發人員指南」的設定檔預覽(預覽範例狀態)端點指南

快速入門

本指南中使用的端點是Adobe Experience Platform Segmentation Service API的一部分。 繼續之前,請檢閱快速入門手冊,以取得您需要了解的重要資訊,以成功呼叫API,包括必要的標題和如何讀取範例API呼叫。

如何產生估計

當將記錄擷取至設定檔存放區時,總設定檔計數會增加或減少超過5%,就會觸發取樣工作以更新計數。 資料取樣的觸發方式取決於擷取方法:

  • 批次內嵌: 針對批次內嵌,在成功將批次內嵌至設定檔存放區後15分鐘內,如果符合5%的增加或減少臨界值,則會執行工作以更新計數。
  • 串流內嵌: 針對串流資料工作流程,會每小時進行檢查,以判斷是否符合5%的增加或減少臨界值。如果已觸發,則會自動觸發工作以更新計數。

掃描的樣本大小取決於設定檔存放區中的整體數量。 下表顯示以下樣本大小:

設定檔存放區中的實體 樣本大小
不到100萬 完整資料集
1000至2000萬 100萬
2000多萬 總共5%
注意

估計通常需要10到15秒才能運行,從粗略估計開始,隨著記錄的讀取增加而細化。

建立新預覽

您可以向/preview端點提出POST請求,以建立新預覽。

注意

建立預覽作業時,系統會自動建立預估作業。 這兩個工作會共用相同的ID。

API格式

POST /preview

要求

curl -X POST https://platform.adobe.io/data/core/ups/preview \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'
 -d '
    {
        "predicateExpression": "xEvent.metrics.commerce.abandons.value > 0",
        "predicateType": "pql/text",
        "predicateModel": "_xdm.context.profile",
        "graphType": "none"
    }'
屬性 說明
predicateExpression 用於查詢資料的PQL表達式。
predicateType predicateExpression下查詢表達式的謂詞類型。 目前,此屬性唯一接受的值為pql/text
predicateModel 設定檔資料所根據的Experience Data Model (XDM)架構類的名稱。
graphType 要從中獲取群集的圖形類型。 支援的值為none(不執行身分匯整)和pdg(根據您的私人身分圖表執行身分匯整)。

回應

成功的回應會傳回HTTP狀態201(已建立),並包含新建立預覽的詳細資訊。

{
    "state": "NEW",
    "previewQueryId": "e890068b-f5ca-4a8f-a6b5-af87ff0caac3",
    "previewQueryStatus": "NEW",
    "previewId": "MDphcHAtMzJiZTAzMjgtM2YzMS00YjY0LThkODQtYWNkMGM0ZmJkYWQzOmU4OTAwNjhiLWY1Y2EtNGE4Zi1hNmI1LWFmODdmZjBjYWFjMzow",
    "previewExecutionId": 0
}
屬性 說明
state 預覽作業的目前狀態。 最初建立時,會處於「NEW」狀態。 隨後,它將處於「正在運行」狀態,直到處理完成,此時它將變為「RESULT_READY」或「FAILED」。
previewId 預覽工作的ID,用於檢視預估或預覽時的查閱用途,如下一節所述。

檢索特定預覽的結果

您可以向/preview端點提出GET請求並在請求路徑中提供預覽ID,以擷取特定預覽的詳細資訊。

API格式

GET /preview/{PREVIEW_ID}
參數 說明
{PREVIEW_ID} 您要擷取之預覽的previewId值。

要求

curl -X GET https://platform.adobe.io/data/core/ups/preview/MDphcHAtMzJiZTAzMjgtM2YzMS00YjY0LThkODQtYWNkMGM0ZmJkYWQzOmU4OTAwNjhiLWY1Y2EtNGE4Zi1hNmI1LWFmODdmZjBjYWFjMzow \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

回應

成功的回應會傳回HTTP狀態200,並包含指定預覽的詳細資訊。

{
   "results": [{
        "XID_ADOBE-MARKETING-CLOUD-ID-1": {
            "_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_ADOBE-MARKETING-CLOUD-ID-1",
            "endCustomerIds": {
                "XID_COOKIE_ID_1": {
                    "_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_COOKIE_ID_1"
                },
                "XID_PROFILE_ID_1": {
                    "_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_PROFILE_ID_1"
                }
            }
        }
    },
    {
        "XID_COOKIE-ID-2": {
            "_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_COOKIE-ID-2",
            "endCustomerIds": {
                "XID_COOKIE_ID_2-1": {
                    "_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_COOKIE_ID_2-1"

                },
                "XID_PROFILE_ID_2": {
                    "_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_PROFILE_ID_2"
                }
            }
        },
        "XID_ADOBE-MARKETING-CLOUD-ID-3": {
            "_href": "https://platform.adobe.io/data/core/ups/models/profile/XID_ADOBE-MARKETING-CLOUD-ID-1000"
        }
    }],
    "state": "RESULT_READY",
    "links": {
        "_self": "https://platform.adobe.io/data/core/ups/preview?expression=<expr-1>&limit=1000",
        "next": "",
        "prev": ""
    },
    "page": {
        "offset": 0,
        "size": 3
    }
}
屬性 說明
results 實體ID的清單,及其相關身分識別。 提供的連結可用於使用設定檔存取API端點查找指定的實體。

檢索特定估計作業的結果

建立預覽工作後,您就可以在/estimate端點的GET請求路徑中使用其previewId,檢視關於區段定義的統計資訊,包括預計對象大小、信賴區間和錯誤標準差。

API格式

GET /estimate/{PREVIEW_ID}
參數 說明
{PREVIEW_ID} 只有在建立預覽作業,且兩個作業共用相同的ID值以進行查詢時,才會觸發預估作業。 具體來說,這是建立預覽作業時傳回的previewId值。

要求

下列請求會擷取特定預估工作的結果。

curl -X GET https://platform.adobe.io/data/core/ups/estimate/MDoyOjRhNDVlODUzLWFjOTEtNGJiNy1hNDI2LTE1MDkzN2I2YWY1Yzo0Mg \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

回應

成功的回應會傳回HTTP狀態200,並包含預估工作的詳細資訊。

{
    "estimatedSize": 4275,
    "numRowsToRead": 4275,
    "estimatedNamespaceDistribution": [
        {
            "namespaceId": "4",
            "profilesMatchedSoFar": 35
        },
        {
            "namespaceId": "6",
            "profilesMatchedSoFar": 4275
        }
    ],
    "state": "RESULT_READY",
    "profilesReadSoFar": 4275,
    "standardError": 0,
    "error": {
        "description": "",
        "traceback": ""
    },
    "profilesMatchedSoFar": 4275,
    "totalRows": 4275,
    "confidenceInterval": "95%",
    "_links": {
        "preview": "https://platform.adobe.io/data/core/ups/preview/app-32be0328-3f31-4b64-8d84-acd0c4fbdad3/execution/0?previewQueryId=e890068b-f5ca-4a8f-a6b5-af87ff0caac3"
    }
}
屬性 說明
estimatedNamespaceDistribution 一個物件陣列,顯示依身分命名空間劃分之區段內的設定檔數量。 依命名空間的設定檔總數(將每個命名空間顯示的值加總)可能比設定檔計數量度高,因為一個設定檔可能與多個命名空間相關聯。 例如,如果客戶在多個管道上與您的品牌互動,則多個命名空間將會與該個別客戶相關聯。
state 預覽作業的目前狀態。 狀態將為「RUNNING」,直到處理完成,此時狀態將變為「RESULT_READY」或「FAILED」。
_links.preview state為"RESULT_READY"時,此欄位會提供URL以檢視預估值。

後續步驟

閱讀本指南後,您應該能更清楚了解如何使用「細分API」來處理預覽和預估。 若要了解如何存取與您的即時客戶設定檔資料相關的量度,例如特定命名空間內的設定檔片段和合併設定檔總數,或整個設定檔資料存放區,請造訪設定檔預覽(/previewsamplestatus)端點指南

本頁內容