生成示例消息转换模板 get-sample-template-api-operations
IMPORTANT
API终结点：
https://platform.adobe.io/data/core/activation/authoring/testing/template/sample此页面列出并描述了可使用/authoring/testing/template/sample API端点执行的所有API操作，以便为您的目标生成消息转换模板。 有关此端点支持的功能的说明，请阅读创建模板。
示例模板API操作快速入门 get-started
在继续之前，请查看入门指南以了解成功调用API所需了解的重要信息，包括如何获取所需的目标创作权限和所需的标头。
获取示例模板 generate-sample-template
通过向authoring/testing/template/sample/端点发出GET请求并提供要基于其创建模板的目标配置的目标ID，可以获得示例模板。
TIP
- 您应在此处使用的目标ID是与使用
/destinations端点创建的目标配置相对应的instanceId。 有关详细信息，请参阅检索目标配置。
API格式
GET authoring/testing/template/sample/{DESTINATION_ID}
参数
描述
{DESTINATION_ID}要为其生成消息转换模板的目标配置的ID。
请求
以下请求会生成一个新的示例模板，该模板由有效负载中提供的参数配置。
curl --location --request GET 'https://platform.adobe.io/data/core/activation/authoring/testing/template/sample/5114d758-ce71-43ba-b53e-e2a91d67b67f' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'x-api-key: {API_KEY}' \
--header 'Authorization: Bearer {ACCESS_TOKEN}' \
--header 'x-gw-ims-org-id: {ORG_ID}' \
--header 'x-sandbox-name: {SANDBOX_NAME}' \
响应
成功的响应会返回HTTP状态200，并带有示例模板，您可以编辑该模板以匹配预期的数据格式。
如果您提供的目标ID对应于聚合策略中具有最大努力聚合和maxUsersPerRequest=1的目标配置，则该请求将返回与以下模板类似的示例模板：
{#- THIS is an example template for a single profile -#}
{#- A '-' at the beginning or end of a tag removes all whitespace on that side of the tag. -#}
{
"identities": [
{%- for idMapEntry in input.profile.identityMap -%}
{%- set namespace = idMapEntry.key -%}
{%- for identity in idMapEntry.value %}
{
"type": "{{ namespace }}",
"id": "{{ identity.id }}"
}{%- if not loop.last -%},{%- endif -%}
{%- endfor -%}{%- if not loop.last -%},{%- endif -%}
{% endfor %}
],
"AdobeExperiencePlatformSegments": {
"add": [
{%- for segment in input.profile.segmentMembership.ups | added %}
"{{ segment.key }}"{%- if not loop.last -%},{%- endif -%}
{% endfor %}
],
"remove": [
{#- Alternative syntax for filtering audiences by status: -#}
{% for segment in removedSegments(input.profile.segmentMembership.ups) %}
"{{ segment.key }}"{%- if not loop.last -%},{%- endif -%}
{% endfor %}
]
}
}
如果您提供的目标ID对应于具有可配置的聚合或最大努力聚合且其maxUsersPerRequest大于一个的目标服务器模板，则请求将返回与以下模板类似的示例模板：
{#- THIS is an example template for multiple profiles -#}
{#- A '-' at the beginning or end of a tag removes all whitespace on that side of the tag. -#}
{
"profiles": [
{%- for profile in input.profiles %}
{
"identities": [
{%- for idMapEntry in profile.identityMap -%}
{%- set namespace = idMapEntry.key -%}
{%- for identity in idMapEntry.value %}
{
"type": "{{ namespace }}",
"id": "{{ identity.id }}"
}{%- if not loop.last -%},{%- endif -%}
{%- endfor -%}{%- if not loop.last -%},{%- endif -%}
{% endfor %}
],
"AdobeExperiencePlatformSegments": {
"add": [
{%- for segment in profile.segmentMembership.ups | added %}
"{{ segment.key }}"{%- if not loop.last -%},{%- endif -%}
{% endfor %}
],
"remove": [
{#- Alternative syntax for filtering audiences by status: -#}
{% for segment in removedSegments(profile.segmentMembership.ups) %}
"{{ segment.key }}"{%- if not loop.last -%},{%- endif -%}
{% endfor %}
]
}
}{%- if not loop.last -%},{%- endif -%}
{% endfor %}
]
}
API错误处理 api-error-handling
Destination SDKAPI端点遵循常规Experience PlatformAPI错误消息原则。 请参阅平台疑难解答指南中的API状态代码和请求标头错误。
后续步骤 next-steps
阅读本文档后，您现在知道如何使用/authoring/testing/template/sample API端点生成消息转换模板。 接下来，可以使用渲染模板API端点生成基于该模板的导出配置文件，并将其与目标的预期数据格式进行比较。
recommendation-more-help
7f4d1967-bf93-4dba-9789-bb6b505339d6