獲取範本API操作示例

重要

API端點: https://platform.adobe.io/data/core/activation/authoring/testing/template/sample

本頁列出並說明了所有可使用/authoring/testing/template/sample API端點執行的API操作,以為目標生成消息轉換模板。 有關此終結點支援的功能的說明,請閱讀create template

範本API操作範例快速入門

繼續之前,請檢閱快速入門手冊,以取得成功呼叫API所需的重要資訊,包括如何取得必要的目的地編寫權限和必要的標題。

取得範本範例

您可以向authoring/testing/template/sample/端點提出GET請求,並根據您建立範本的目的地配置提供目的地ID,從而獲取範例範本。

秘訣
  • 您應在此處使用的目標ID是與使用/destinations端點建立的目標配置對應的instanceId。 請參閱目標配置API參考

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: {IMS_ORG}' \
--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 segments by status: -#}
        {% for segment in removedSegments(input.profile.segmentMembership.ups) %}
            "{{ segment.key }}"{%- if not loop.last -%},{%- endif -%}
        {% endfor %}
        ]
    }
}

如果您提供的目標ID與具有可配置聚合最佳工作聚合maxUsersPerRequest大於1的目標伺服器模板相對應,則請求將返回與以下類似的示例模板:

{#- 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 segments by status: -#}
                {% for segment in removedSegments(profile.segmentMembership.ups) %}
                    "{{ segment.key }}"{%- if not loop.last -%},{%- endif -%}
                {% endfor %}
                ]
            }
        }{%- if not loop.last -%},{%- endif -%}
    {% endfor %}
    ]
}

API錯誤處理

目標SDK API端點會遵循一般Experience PlatformAPI錯誤訊息原則。 請參閱平台疑難排解指南中的API狀態代碼要求標題錯誤

後續步驟

閱讀本檔案後,您現在知道如何使用/authoring/testing/template/sample API端點產生訊息轉換範本。 接下來,您可以使用呈現範本API端點來根據範本產生匯出的設定檔,並與目的地的預期資料格式比較。

本頁內容