Obtener operaciones de API de plantilla de ejemplo

IMPORTANTE

Punto de conexión de API: https://platform.adobe.io/data/core/activation/authoring/testing/template/sample

En esta página se enumeran y describen todas las operaciones de API que puede realizar mediante la /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 plantillas de ejemplo

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

Obtener plantilla de ejemplo

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

SUGERENCIA

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 se está generando una plantilla de transformación de mensaje.

Solicitud

La siguiente solicitud genera una nueva plantilla de ejemplo, configurada mediante 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 que proporciona corresponde a una configuración de destino con agregación del mejor esfuerzo y maxUsersPerRequest=1 en la política 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 segments by status: -#}
        {% for segment in removedSegments(input.profile.segmentMembership.ups) %}
            "{{ segment.key }}"{%- if not loop.last -%},{%- endif -%}
        {% endfor %}
        ]
    }
}

Si el ID de destino que proporciona corresponde a una plantilla de servidor de destino con agregación configurable o agregación del 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 segments by status: -#}
                {% for segment in removedSegments(profile.segmentMembership.ups) %}
                    "{{ segment.key }}"{%- if not loop.last -%},{%- endif -%}
                {% endfor %}
                ]
            }
        }{%- if not loop.last -%},{%- endif -%}
    {% endfor %}
    ]
}

Gestión de errores de API

Los extremos de la API del Destination SDK siguen los principios generales del mensaje de error de la API del Experience Platform. Consulte Códigos de estado de API y errores en el encabezado de la 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 mensaje usando la variable /authoring/testing/template/sample extremo de API. A continuación, puede usar la variable Punto final de API de plantilla de renderización para generar perfiles exportados basados en la plantilla y compararlos con el formato de datos esperado del destino.

En esta página