预览和估计端点
在开发区段定义时,您可以使用Adobe Experience Platform中的评估和预览工具来查看摘要级别的信息,从而帮助确保隔离您预期的受众。
-
预览 提供符合区段定义资格的用户档案的分页列表,允许您比较结果与预期结果。
-
估算值 提供有关区段定义的统计信息,例如预计受众大小、置信区间和误差标准偏差。
快速入门
本指南中使用的端点是Adobe Experience Platform Segmentation Service API的一部分。 在继续之前,请查看快速入门指南以了解成功调用API所需了解的重要信息,包括所需的标头以及如何读取示例API调用。
如何生成估算
当将记录摄取到配置文件存储中增加或减少总配置文件计数超过5%时,将触发取样作业以更新计数。 数据采样的触发方式取决于摄取方法:
- 批次摄取: 对于批次摄取,在成功将批次摄取到配置文件存储区后15分钟内,如果达到5%的增加或减少阈值,将运行作业以更新计数。
- 流式摄取: 对于流式数据工作流,每小时进行一次检查,以确定是否已达到5%的增加或减少阈值。 如果超过100次,则会自动触发作业以更新计数。
扫描的样本大小取决于配置文件存储区中的实体总数。 下表显示了这些样本量:
新建预览 create-preview
您可以通过向/preview
端点发出POST请求来创建新的预览。
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
您可以通过向/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: {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
创建预览作业后,您可以在指向/estimate
端点的GET请求路径中使用其previewId
来查看有关区段定义的统计信息,包括预计受众大小、置信区间和错误标准偏差。
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
)端点指南。