Création et test d’un modèle de transformation de message create-template

Vue d’ensemble overview

Dans le cadre de Destination SDK, Adobe fournit des outils de développement pour vous aider à configurer et tester la destination. Cette page décrit comment créer et tester un modèle de transformation de messages. Pour en savoir plus sur la manière de tester la destination, consultez la documentation Tester la configuration de destination.

Pour créer et tester un modèle de transformation de message entre le schéma cible d’Adobe Experience Platform et le format de message pris en charge par la destination, utilisez la méthode Outil de création de modèles décrite plus en détail ci-après. Consultez leDocument du format du message pour en savoir plus sur la transformation des données entre le schéma source et le schéma cible.

L’illustration ci-dessous montre comment la création et le test d’un modèle de transformation de message s’intègrent dans le workflow de configuration de la destination de Destination SDK :

Pourquoi créer et tester un modèle de transformation de messages why-create-message-transformation-template

L’une des premières étapes de la création de la destination dans Destination SDK consiste à réfléchir à la manière dont le format de données pour l’appartenance à une audience, les identités et les attributs de profil est transformé au moment de l’exportation d’Adobe Experience Platform vers la destination. Pour plus d’informations sur la transformation entre le schéma XDM d’Adobe et votre schéma de destination, consultez le Document du format du message.

Pour que la transformation réussisse, vous devez fournir un modèle de transformation semblable au modèle suivant : Création d’un modèle qui envoie des segments, des identités et des attributs de profil.

Adobe fournit un outil de modèle qui vous permet de créer et de tester le modèle de message transformant les données du format XDM d’Adobe en un format pris en charge par la destination. L’outil comporte deux points d’entrée API que vous pouvez utiliser :

Étapes à suivre avant de créer le modèle prerequisites

Avant de pouvoir créer le modèle, procédez comme suit :

Utilisation de l’exemple d’API de modèle et de l’API de modèle de rendu pour créer un modèle pour la destination iterative-process

Le processus d’obtention et de test du modèle se répète. Répétez les étapes ci-dessous jusqu’à ce que les profils exportés correspondent au format de données attendu de la destination.

Obtention d’un modèle type à l’aide de l’exemple d’API de modèle sample-template-api

Ajoutez un identifiant de destination à l’appel, comme illustré ci-dessous, pour que la réponse renvoie un modèle type correspondant à l’identifiant de destination.

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}' \

Si l’identifiant de destination que vous fournissez correspond à une configuration de destination avec agrégation des meilleurs efforts et maxUsersPerRequest=1 dans la politique d’agrégation, la requête renvoie un modèle type similaire à celui-ci :

{#- 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 %}
        ]
    }
}

Si l’identifiant de destination que vous fournissez correspond à un modèle de serveur de destination avec agrégation configurable ou agrégation des meilleurs efforts et que maxUsersPerRequest est supérieur à un, la requête renvoie un modèle type similaire à celui-ci :

{#- 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 %}
    ]
}

Caractère d’échappement dans votre modèle character-escape-template

Avant d’utiliser le modèle pour effectuer le rendu des profils qui correspondent au format attendu de la destination, vous devez insérer un caractère d’échappement dans le modèle, comme indiqué dans l’enregistrement d’écran ci-dessous.

Vous pouvez utiliser un outil d’échappement de caractères en ligne. La méthode Formateur d’échappement JSON est utilisée dans la démo ci-dessus.

API du modèle de rendu render-template-api

Après avoir créé un modèle de transformation de message à l’aide de l’API du modèle type, vous pouvez effectuer le rendu du modèle pour générer les données exportées en fonction de celle-ci. Cela vous permet de vérifier si les profils qu’Adobe Experience Platform exporterait vers la destination correspondent au format prévu de la destination.

Consultez la référence d’API pour obtenir des exemples d’appels que vous pouvez effectuer :

Modifiez le modèle et effectuez des appels vers le point d’entrée de l’API du modèle de rendu jusqu’à ce que les profils exportés correspondent au format de données attendu de la destination.

Ajoutez votre modèle avec caractères d’échappement à la configuration du serveur de destination

Une fois que votre modèle de transformation de messages vous satisfait, ajoutez-le à la configuration du serveur de destination, dans httpTemplate.requestBody.value.