產生範例訊息轉換範本 get-sample-template-api-operations

Last update: Tue Jul 16 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主題：
目標

建立對象：

管理員
使用者

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 SDK API端點遵循一般Experience Platform API錯誤訊息原則。請參閱Platform疑難排解指南中的API狀態碼和請求標頭錯誤。

後續步驟 next-steps

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

recommendation-more-help

7f4d1967-bf93-4dba-9789-bb6b505339d6