使用示例配置文件测试基于文件的目标
概述 overview
本页说明如何使用/testing/destinationInstance
API端点来测试您的基于文件的目标是否已正确配置,并验证流向您配置的目标的数据流的完整性。
无论是否向调用添加示例配置文件,您都可以向测试端点发出请求。 如果您未在请求中发送任何配置文件,则API会自动生成示例配置文件并将其添加到请求中。
自动生成的样本配置文件包含通用数据。 如果要使用自定义、更直观的配置文件数据测试目标,请使用示例配置文件生成API生成示例配置文件,然后自定义其响应并将其包含在对/testing/destinationInstance
端点的请求中。
快速入门 getting-started
在继续之前,请查看入门指南以了解成功调用API所需了解的重要信息,包括如何获取所需的目标创作权限和所需的标头。
先决条件 prerequisites
在使用/testing/destinationInstance
端点之前,请确保您满足以下条件:
-
您有一个通过Destination SDK创建的基于文件的现有目标,您可以在目标目录中看到该目标。
-
您已在Experience PlatformUI中为目标创建至少一个激活流程。
-
要成功发出API请求,您需要与要测试的目标实例对应的目标实例ID。 在Platform UI中浏览与目标之间的连接时,从URL获取应在API调用中使用的目标实例ID。
-
可选:如果要使用添加到API调用的示例配置文件测试目标配置,请使用/sample-profiles端点基于现有源架构生成示例配置文件。 如果您不提供示例配置文件,则API将生成一个API并在响应中返回它。
测试目标配置,而不将配置文件添加到调用 test-without-adding-profiles
API格式
POST /authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}
请求
curl -X POST 'https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}' \
-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}' \
{DESTINATION_INSTANCE_ID}
响应
成功的响应会返回HTTP状态200以及响应有效负载。
{
"activations":[
{
"segment":"6fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
"flowRun":"81150d76-7909-46b6-83f4-fc855a92de07"
},
{
"segment":"5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
"flowRun":"4706780a-2ab3-4d33-8c76-7c87fd318cd8"
}
],
"results":"/authoring/testing/destinationInstance/fd3449fb-b929-45c8-9f3d-06b9d6aac328/results?flowRunIds=4706780a-2ab3-4d33-8c76-7c87fd318cd8,81150d76-7909-46b6-83f4-fc855a92de07",
"inputProfiles":[
{
"segmentMembership":{
"ups":{
"fea8d394-5a8c-4cea-bebc-df020ce37f5c":{
"lastQualificationTime":"2022-01-13T11:33:28.211895Z",
"status":"realized"
},
"5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b":{
"lastQualificationTime":"2022-01-13T11:33:28.211893Z",
"status":"realized"
}
}
},
"personalEmail":{
"address":"john.smith@abc.com"
},
"identityMap":{
"crmid":[
{
"id":"crmid-P1A7l"
}
]
},
"person":{
"name":{
"firstName":"string",
"lastName":"string"
}
}
}
]
}
activations
示例:如果将两个受众映射到目标实例,
activations
数组将包含两个条目。 每个激活的受众将对应于一个导出的文件。results
inputProfiles
使用添加到调用的用户档案测试目标配置 test-with-added-profiles
若要使用自定义、更直观的配置文件数据测试您的目标,您可以使用选择的值自定义从/sample-profiles端点获取的响应,并在对/testing/destinationInstance
端点的请求中包含该自定义配置文件。
API格式
POST /testing/destinationInstance/{DESTINATION_INSTANCE_ID}
请求
curl -X POST 'https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}'
-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 '
{
"profiles":[
{
"segmentMembership":{
"ups":{
"fea8d394-5a8c-4cea-bebc-df020ce37f5c":{
"lastQualificationTime":"2022-01-13T11:33:28.211895Z",
"status":"realized"
},
"5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b":{
"lastQualificationTime":"2022-01-13T11:33:28.211893Z",
"status":"realized"
}
}
},
"personalEmail":{
"address":"michaelsmith@example.com"
},
"identityMap":{
"crmid":[
{
"id":"Custom CRM ID"
}
]
},
"person":{
"name":{
"firstName":"Michael",
"lastName":"Smith"
}
}
}
]
}'
{DESTINATION_INSTANCE_ID}
profiles
响应
成功的响应会返回HTTP状态200以及响应有效负载。
{
"activations":[
{
"segment":"6fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
"flowRun":"81150d76-7909-46b6-83f4-fc855a92de07"
},
{
"segment":"5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
"flowRun":"4706780a-2ab3-4d33-8c76-7c87fd318cd8"
}
],
"results":"/authoring/testing/destinationInstance/fd3449fb-b929-45c8-9f3d-06b9d6aac328/results?flowRunIds=4706780a-2ab3-4d33-8c76-7c87fd318cd8,81150d76-7909-46b6-83f4-fc855a92de07",
"inputProfiles":[
{
"segmentMembership":{
"ups":{
"fea8d394-5a8c-4cea-bebc-df020ce37f5c":{
"lastQualificationTime":"2022-01-13T11:33:28.211895Z",
"status":"realized"
},
"5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b":{
"lastQualificationTime":"2022-01-13T11:33:28.211893Z",
"status":"realized"
}
}
},
"personalEmail":{
"address":"michaelsmith@example.com"
},
"identityMap":{
"crmid":[
{
"id":"Custom CRM ID"
}
]
},
"person":{
"name":{
"firstName":"Michael",
"lastName":"Smith"
}
}
}
]
}
activations
示例:如果将两个受众映射到目标实例,
activations
数组将包含两个条目。 每个激活的受众将对应于一个导出的文件。results
inputProfiles
API错误处理 api-error-handling
Destination SDKAPI端点遵循常规Experience PlatformAPI错误消息原则。 请参阅平台疑难解答指南中的API状态代码和请求标头错误。
后续步骤
阅读本文档后,您现在知道如何测试基于文件的目标配置。
如果您收到了有效的API响应,则表明目标运行正常。 如果要查看有关激活流程的更多详细信息,可以使用响应中的results
属性查看详细的激活结果。
如果您正在构建公共目标,您现在可以提交目标配置以Adobe审查。