建立及測試訊息轉換範本 create-template

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

主題：
目標

建立對象：

管理員
使用者

概觀 overview

作為Destination SDK的一部分，Adobe提供開發人員工具，協助您設定和測試目的地。此頁面說明如何建立和測試訊息轉換範本。如需如何測試目的地的詳細資訊，請閱讀測試目的地組態。

若要 在Adobe Experience Platform中的目標結構描述與目的地支援的訊息格式之間，建立並測試訊息轉換範本，請使用 範本撰寫工具，如下所述。在訊息格式檔案中，閱讀有關來源和目標結構描述之間資料轉換的詳細資訊。

以下說明如何建立和測試訊息轉換範本符合Destination SDK中的目的地設定工作流程：

建立範本步驟適合目的地設定工作流程的圖形

為何需要建立和測試訊息轉換範本 why-create-message-transformation-template

在Destination SDK中建立目的地的首要步驟之一，就是考慮將對象會籍、身分和設定檔屬性的資料格式從Adobe Experience Platform匯出至目的地時，如何進行轉換。在訊息格式檔案中尋找有關AdobeXDM結構描述和目的地結構描述之間轉換的資訊。

若要轉換成功，您必須提供轉換範本，類似於此範例：建立傳送區段、身分和設定檔屬性的範本。

Adobe提供範本工具，可讓您建立並測試訊息範本，將資料從AdobeXDM格式轉換為目的地支援的格式。此工具有兩個API端點可供您使用：

使用 範例範本API 取得範例範本。
使用 轉譯範本API 來轉譯範例範本，讓您可以比較結果與目的地預期的資料格式。將匯出的資料與目的地預期的資料格式進行比較後，您可以編輯範本。如此一來，您產生的匯出資料就會符合目的地預期的資料格式。

建立範本前需完成的步驟 prerequisites

在您準備好建立範本之前，請務必完成下列步驟：

建立目的地伺服器組態。根據您為maxUsersPerRequest引數提供的值，將產生的範本會有所不同。
- 如果您希望目的地的API呼叫包含單一設定檔，以及其對象資格、身分和設定檔屬性，請使用maxUsersPerRequest=1。
- 如果您希望目的地的API呼叫包含多個設定檔，以及其對象資格、身分和設定檔屬性，請使用值大於1的maxUsersPerRequest。
建立目的地組態，並在destinationDelivery.destinationServerId中新增目的地伺服器組態的識別碼。
取得您剛建立的目的地組態識別碼，以便用於範本建立工具。
瞭解您可以在訊息轉換範本中使用哪些函式和篩選器。

如何使用範例範本API和轉譯範本API為您的目的地建立範本 iterative-process

TIP

在建立及編輯訊息轉換範本之前，您可以先使用簡單範本呼叫轉譯範本API端點，該範本會匯出您的原始設定檔而不套用任何轉換。簡單範本的語法為：
"template": "{% for profile in input.profiles %}{{profile|raw}}{% endfor %}}"

取得及測試範本的程式是反複性的。重複下列步驟，直到匯出的設定檔符合目的地預期的資料格式為止。

首先，取得範例範本。
使用範例範本作為建立您自己的草稿的起點。
使用您自己的範本呼叫轉譯器範本API端點。 Adobe會根據您的結構描述產生範例設定檔，並傳回結果或任何遇到的錯誤。
將匯出的資料與目的地預期的資料格式進行比較。如有需要，請編輯範本。
重複此程式，直到匯出的設定檔符合目的地預期的資料格式。

使用範例範本API取得範例範本 sample-template-api

NOTE

如需完整的API參考檔案，請閱讀取得範本API作業。

將目的地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}' \

如果您提供的目的地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 %}
    ]
}

範本的字元逸出 character-escape-template

在使用範本呈現符合目的地預期格式的設定檔之前，您必須對範本進行字元逸出，如下面的熒幕錄製所示。

說明如何使用線上字元逸出工具逸出範本的影片

您可以使用線上字元逸出工具。上述示範使用JSON Escape格式化程式。

轉譯器範本API render-template-api

使用範例範本API建立訊息轉換範本後，您可以轉譯範本，以根據範本產生匯出的資料。這可讓您驗證Adobe Experience Platform要匯出至目的地的設定檔是否符合目的地的預期格式。

如需可進行的呼叫範例，請參閱API參考資料：

編輯範本並呼叫轉譯器範本API端點，直到匯出的設定檔符合您目的地的預期資料格式為止。

將您的字元逸出範本新增至目的地伺服器設定

在您滿意訊息轉換範本後，請在httpTemplate.requestBody.value中將它新增至您的目的地伺服器組態。

recommendation-more-help

7f4d1967-bf93-4dba-9789-bb6b505339d6