Generar una plantilla de transformación de mensaje de ejemplo

Última actualización: 2023-07-14
  • Creado para:
  • Admin
    User
IMPORTANTE

Extremo de API: https://platform.adobe.io/data/core/activation/authoring/testing/template/sample

Esta página enumera y describe todas las operaciones de API que puede realizar con la variable /authoring/testing/template/sample Extremo de API, para generar un plantilla de transformación de mensaje para su destino. Para obtener una descripción de la funcionalidad admitida por este extremo, lea crear plantilla.

Introducción a las operaciones de API de plantilla de muestra

Antes de continuar, consulte la guía de introducción para obtener información importante que necesita conocer para realizar llamadas correctamente a la API, incluido cómo obtener el permiso de creación de destino requerido y los encabezados necesarios.

Obtener plantilla de muestra

Puede obtener una plantilla de ejemplo realizando una solicitud de GET a la variable authoring/testing/template/sample/ y proporcionar el ID de destino de la configuración de destino en función de la que esté creando la plantilla.

SUGERENCIA
  • El ID de destino que debe utilizar aquí es el instanceId que corresponde a una configuración de destino, creada con la variable /destinations punto final. Consulte la recuperar una configuración de destino para obtener más información.

Formato de API

GET authoring/testing/template/sample/{DESTINATION_ID}
Parámetro Descripción
{DESTINATION_ID} El ID de la configuración de destino para la que está generando una plantilla de transformación de mensajes.

Solicitud

La siguiente solicitud genera una nueva plantilla de ejemplo, configurada por los parámetros proporcionados en la carga útil.

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

Respuesta

Una respuesta correcta devuelve el estado HTTP 200 con una plantilla de ejemplo que puede editar para que coincida con el formato de datos esperado.

Si el ID 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 bueno que uno, la solicitud devuelve 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 %}
    ]
}

Administración de errores de API

Los extremos de la API de Destination SDK siguen los principios generales del mensaje de error de la API de Experience Platform. Consulte Códigos de estado de API y errores de encabezado de solicitud en la guía de solución de problemas de Platform.

Pasos siguientes

Después de leer este documento, ahora sabe cómo generar una plantilla de transformación de mensajes utilizando /authoring/testing/template/sample Extremo de API. A continuación, puede utilizar la variable Extremo de API de plantilla de procesamiento para generar perfiles exportados basados en la plantilla y compararlos con el formato de datos esperado del destino.

En esta página