根据源架构生成样本配置文件

测试基于文件的目标的第一步是使用/sample-profiles端点基于现有源架构生成示例配置文件。

配置文件示例可帮助您了解配置文件的JSON结构。 此外,它们还为您提供了一个默认值,您可以使用自己的配置文件数据进行自定义,以便进一步进行目标测试。

快速入门 getting-started

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

先决条件 prerequisites

在使用/sample-profiles端点之前,请确保您满足以下条件:

  • 您有一个通过Destination SDK创建的基于文件的现有目标,您可以在目标目录中看到该目标。

  • 您已在Experience PlatformUI中为目标创建至少一个激活流程。 /sample-profiles端点根据您在激活流中定义的源架构创建配置文件。 请参阅激活教程,了解如何创建激活流程。

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

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

生成用于目标测试的样本配置文件 generate-sample-profiles

您可以使用要测试的目标实例ID向/sample-profiles端点发出GET请求,从而基于源架构生成样本配置文件。

API格式

GET /authoring/sample-profiles?destinationInstanceId={DESTINATION_INSTANCE_ID}&count={NUMBER_OF_GENERATED_PROFILES}
查询参数
描述
destinationInstanceId
要为其生成样本配置文件的目标实例的ID。 有关如何获取此ID的详细信息,请参阅先决条件部分。
count
可选。 要生成的样本配置文件数。 参数可以接受1 - 1000之间的值。 如果未定义此属性,则API生成单个示例配置文件。

请求

以下请求基于在目标实例中定义的具有相应destinationInstanceId的源架构生成示例配置文件。

curl -X GET 'https://platform.adobe.io/data/core/activation/authoring/sample-profiles?destinationInstanceId={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}' \

响应

成功的响应会返回具有指定数量的示例配置文件的HTTP状态200,其中包含与源XDM架构对应的受众成员资格、身份和配置文件属性。

NOTE
响应仅返回目标实例中使用的受众成员资格、身份和配置文件属性。 即使源架构具有其他字段,这些字段也会被忽略。
[
   {
      "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"
         }
      }
   }
]

显示从UI映射到API响应中的字段的图像。

属性
描述
segmentMembership
描述个人受众成员资格的映射对象。 有关segmentMembership的详细信息,请阅读受众成员资格详细信息
lastQualificationTime
此配置文件上次符合区段资格的时间戳。
status

一个字符串字段,指明在当前请求中是否实现了受众成员资格。 接受以下值:

  • realized:配置文件是区段的一部分。
  • exited:配置文件正在作为当前请求的一部分退出受众。
identityMap
描述个人各种身份值及其关联命名空间的映射类型字段。 有关identityMap的详细信息,请参阅架构组合的基础

API错误处理 api-error-handling

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

后续步骤

阅读本文档后,您现在知道如何根据在目标激活流程中配置的源架构生成示例配置文件。

您现在可以自定义这些配置文件,或在API返回配置文件时使用它们,以测试您的基于文件的目标配置

recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6