使用示例配置文件测试基于文件的目标

上次更新: 2023-07-17
  • 创建对象:
  • Developer
    User
    Admin
    Leader

概述

本页介绍如何使用 /testing/destinationInstance API端点,用于测试基于文件的目标是否配置正确,并验证数据流到已配置目标的完整性。

您可以向测试端点发出请求,无论是否添加 样本配置文件 到电话那边。 如果您未在请求上发送任何配置文件,则API会自动生成示例配置文件并将其添加到请求中。

自动生成的样本配置文件包含通用数据。 如果要使用自定义、更直观的配置文件数据测试目标,请使用 示例配置文件生成API 以生成示例配置文件,然后自定义其响应并将其包含在对 /testing/destinationInstance 端点。

快速入门

在继续之前,请查看 快速入门指南 要成功调用API需要了解的重要信息,包括如何获取所需的目标创作权限和所需的标头。

先决条件

在使用 /testing/destinationInstance 端点,确保您满足以下条件:

  • 您有一个通过Destination SDK创建的基于文件的现有目标,并且您可以在以下位置中看到该目标: 目标目录.

  • 您已在Experience PlatformUI中为目标创建至少一个激活流程。

  • 要成功发出API请求,您需要与要测试的目标实例对应的目标实例ID。 在Platform UI中浏览与目标建立的连接时,从URL获取应在API调用中使用的目标实例ID。

    显示如何从URL获取目标实例ID的UI图像。

  • 可选:如果要使用添加到API调用中的示例配置文件测试目标配置,请使用 /sample-profiles 端点,以基于您现有的源架构生成示例配置文件。 如果您不提供示例配置文件,则API将生成一个配置文件并在响应中返回它。

测试目标配置,而不将配置文件添加到调用

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} 要为其生成示例配置文件的目标实例的ID。 请参阅 先决条件 部分,了解有关如何获取此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 返回每个已激活受众的受众ID和流量运行ID。 激活条目(以及关联的生成文件)的数量等于在目标实例上映射的受众数量。

示例:如果将两个受众映射到目标实例,则 activations 数组将包含两个条目。 每个激活的受众将对应于一个导出的文件。
results 返回目标实例ID和可用于调用的流运行ID。 结果API,以进一步测试集成。
inputProfiles 返回由API自动生成的示例配置文件。

使用添加到调用的用户档案测试目标配置

要使用自定义、更直观的配置文件数据测试您的目标,您可以自定义从 /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} 您正在测试的目标的目标实例ID。 要为其生成示例配置文件的目标实例的ID。 请参阅 先决条件 部分,了解有关如何获取此ID的详细信息。
profiles 可包含一个或多个配置文件的数组。 使用 示例配置文件API端点 生成要在此API调用中使用的配置文件。

响应

成功的响应会返回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 返回每个已激活受众的受众ID和流量运行ID。 激活条目(以及关联的生成文件)的数量等于在目标实例上映射的受众数量。

示例:如果将两个受众映射到目标实例,则 activations 数组将包含两个条目。 每个激活的受众将对应于一个导出的文件。
results 返回目标实例ID和可用于调用的流运行ID。 结果API,以进一步测试集成。
inputProfiles 返回您在API请求中传递的自定义示例配置文件。

API错误处理

Destination SDKAPI端点遵循常规Experience PlatformAPI错误消息原则。 请参阅 API状态代码请求标头错误 平台疑难解答指南中的。

后续步骤

阅读本文档后,您现在知道如何测试基于文件的目标配置。

如果您收到了有效的API响应,则表示您的目标运行正常。 如果您想查看有关激活流程的更多详细信息,您可以使用 results 响应中的属性 查看详细的激活结果.

如果您正在构建公共目标,则现在可以 提交目标配置 以Adobe审查。

在此页面上