Generar una plantilla de transformación de mensaje de ejemplo get-sample-template-api-operations
https://platform.adobe.io/data/core/activation/authoring/testing/template/sampleEsta página enumera y describe todas las operaciones de API que puede realizar mediante el extremo de API /authoring/testing/template/sample para generar una plantilla de transformación de mensajes 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 get-started
Antes de continuar, revisa la guía de introducción para obtener información importante que necesitas conocer para poder realizar llamadas a la API correctamente, incluyendo cómo obtener el permiso de creación de destino requerido y los encabezados requeridos.
Obtener plantilla de muestra generate-sample-template
Puede obtener una plantilla de ejemplo realizando una solicitud de GET al extremo authoring/testing/template/sample/ y proporcionando el identificador de destino de la configuración de destino en función de la cual está creando la plantilla.
- El id. de destino que debe usar aquí es el
instanceIdque corresponde a una configuración de destino creada con el extremo/destinations. Consulte recuperar una configuración de destino para obtener más información.
Formato de API
GET authoring/testing/template/sample/{DESTINATION_ID}
{DESTINATION_ID}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 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 %}
]
}
Administración de errores de API api-error-handling
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 next-steps
Después de leer este documento, ahora sabe cómo generar una plantilla de transformación de mensajes utilizando el extremo de API /authoring/testing/template/sample. A continuación, puede usar el extremo de la API de la plantilla de procesamiento para generar perfiles exportados basados en la plantilla y compararlos con el formato de datos esperado del destino.