Creación y prueba de una plantilla de transformación de mensajes create-template

Información general overview

Como parte de Destination SDK, Adobe proporciona herramientas para desarrolladores que le ayudarán a configurar y probar su destino. En esta página se describe cómo crear y probar una plantilla de transformación de mensajes. Para obtener información sobre cómo probar el destino, lee Probar la configuración de destino.

Para crear y probar una plantilla de transformación de mensajes entre el esquema de destino en Adobe Experience Platform y el formato de mensaje admitido por el destino, use la herramienta de creación de plantillas que se describe más adelante. Obtenga más información acerca de la transformación de datos entre el esquema de origen y el de destino en el documento de formato de mensaje.

A continuación se ilustra cómo la creación y prueba de una plantilla de transformación de mensajes se ajusta al flujo de trabajo de configuración de destino en Destination SDK:

Por qué necesita crear y probar una plantilla de transformación de mensajes why-create-message-transformation-template

Uno de los primeros pasos para crear su destino en Destination SDK es pensar en cómo se transforma el formato de datos para la pertenencia a audiencias, identidades y atributos de perfil al exportarlo desde Adobe Experience Platform a su destino. Encuentre información acerca de la transformación entre el esquema XDM de Adobe y el esquema de destino en el documento de formato de mensaje.

Para que la transformación tenga éxito, debe proporcionar una plantilla de transformación, similar a este ejemplo: Cree una plantilla que envíe segmentos, identidades y atributos de perfil.

Adobe proporciona una herramienta de plantilla que le permite crear y probar la plantilla de mensaje que transforma los datos del formato XDM de Adobe en el formato admitido por el destino. La herramienta tiene dos extremos de API que puede utilizar:

Pasos que se deben seguir antes de crear la plantilla prerequisites

Antes de crear la plantilla, asegúrese de completar los pasos siguientes:

Cómo utilizar la API de plantilla de ejemplo y la API de plantilla de procesamiento para crear una plantilla para el destino iterative-process

El proceso para obtener y probar la plantilla es iterativo. Repita los pasos siguientes hasta que los perfiles exportados coincidan con el formato de datos esperado del destino.

Obtenga una plantilla de ejemplo mediante la API de plantilla de ejemplo sample-template-api

Añada un ID de destino a la llamada de, como se muestra a continuación, y la respuesta devolverá un ejemplo de plantilla correspondiente al ID de destino.

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 el identificador de destino proporcionado corresponde a una configuración de destino con agregación de mejor esfuerzo y maxUsersPerRequest=1 en la directiva de agregación, la solicitud devuelve una plantilla de ejemplo similar a esta:

{#- 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 el id. de destino proporcionado corresponde a una plantilla de servidor de destino con agregación configurable o agregación de mejor esfuerzo con maxUsersPerRequest mayor que uno, la solicitud devolverá una plantilla de ejemplo similar a esta:

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

Escape de carácter en la plantilla character-escape-template

Antes de utilizar la plantilla para procesar perfiles que coincidan con el formato esperado del destino, debe aplicar caracteres de escape a la plantilla, como se muestra en la grabación de pantalla a continuación.

Puede utilizar una herramienta de escape de caracteres en línea. La demostración anterior utiliza el formateador JSON Escape.

Procesar API de plantilla render-template-api

Después de crear una plantilla de transformación de mensajes usando la API de plantilla de ejemplo, puede procesar la plantilla para generar datos exportados basados en ella. Esto le permite comprobar si los perfiles que Adobe Experience Platform exportaría a su destino coinciden con el formato esperado del destino.

Consulte la referencia de la API para ver ejemplos de llamadas que puede realizar:

Edite la plantilla y realice llamadas al extremo de la API de la plantilla de procesamiento hasta que los perfiles exportados coincidan con el formato de datos esperado del destino.

Añada la plantilla con caracteres de escape a la configuración del servidor de destino

Una vez que esté satisfecho con la plantilla de transformación de mensajes, agréguela a la configuración del servidor de destino, en httpTemplate.requestBody.value.