預覽和估計端點
開發區段定義時,您可以使用Adobe Experience Platform中的預估和預覽工具來檢視摘要層級的資訊,協助確保您隔離預期的對象。
-
預覽 提供符合區段定義之資格設定檔的分頁清單,讓您比較結果與預期。
-
預估 提供有關區段定義的統計資訊,例如預計對象人數、信賴區間和錯誤標準差。
快速入門
本指南中使用的端點屬於 Adobe Experience Platform Segmentation Service API。 在繼續之前,請檢閱 快速入門手冊 如需成功呼叫API所需的重要資訊,包括必要的標題以及如何讀取範例API呼叫。
如何產生預估值
當將記錄擷取至設定檔存放區後,設定檔總數增加或減少超過5%,則會觸發取樣工作以更新計數。 資料取樣觸發的方式取決於擷取方法:
- 批次擷取: 對於批次擷取,在成功將批次擷取到設定檔存放區後15分鐘內,如果符合5%增加或減少臨界值,則會執行工作以更新計數。
- 串流擷取: 對於串流資料工作流程,會每小時進行一次檢查,以判斷是否符合增加或減少5%的臨界值。 如果超過100次,系統就會自動觸發工作以更新計數。
掃描的樣本大小取決於設定檔存放區中的實體總數。 下表顯示這些範例大小:
建立新的預覽 create-preview
您可以透過向以下發出POST請求來建立新的預覽 /preview
端點。
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: {ORG_ID}' \
-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
predicateType
predicateExpression
. 目前此屬性唯一接受的值是 pql/text
.predicateModel
graphType
none
(不執行身分拼接)和 pdg
(根據您的私人身分圖表執行身分拼接)。回應
成功的回應會傳回HTTP狀態201 (已建立)以及新建立預覽的詳細資料。
{
"state": "NEW",
"previewQueryId": "e890068b-f5ca-4a8f-a6b5-af87ff0caac3",
"previewQueryStatus": "NEW",
"previewId": "MDphcHAtMzJiZTAzMjgtM2YzMS00YjY0LThkODQtYWNkMGM0ZmJkYWQzOmU4OTAwNjhiLWY1Y2EtNGE4Zi1hNmI1LWFmODdmZjBjYWFjMzow",
"previewExecutionId": 0
}
state
previewId
擷取特定預覽的結果 get-preview
您可以透過向「 」發出GET請求來擷取有關特定預覽的詳細資訊 /preview
端點並在請求路徑中提供預覽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: {ORG_ID}' \
-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
擷取特定估算工作的結果 get-estimate
建立預覽作業後,您可以使用其 previewId
在GET請求的路徑中 /estimate
端點可檢視關於區段定義的統計資訊,包括預計對象人數、信賴區間和錯誤標準差。
API格式
GET /estimate/{PREVIEW_ID}
{PREVIEW_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: {ORG_ID}' \
-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
_links.preview
state
為「RESULT_READY」,此欄位會提供一個URL來檢視預估值。後續步驟
閱讀本指南後,您應該更瞭解如何使用分段API來處理預覽和預估。 若要瞭解如何存取與即時客戶設定檔資料相關的量度,例如特定名稱空間內的設定檔片段總數和合併的設定檔總數,或是設定檔資料存放區整體,請造訪 設定檔預覽(/previewsamplestatus
)端點指南.