Documentación Experience Platform Guía de destinos

Prueba del destino basado en archivos con perfiles de muestra

Last update: Fri Jul 14 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Temas:
Destinos

Creado para:

Administrador
Usuario

Información general overview

Esta página explica cómo utilizar el /testing/destinationInstance Punto final de API para probar si el destino basado en archivos está configurado correctamente y comprobar la integridad de los flujos de datos al destino configurado.

Puede realizar solicitudes al extremo de prueba con o sin agregar perfiles de muestra a la llamada. Si no envía ningún perfil en la solicitud, la API genera un perfil de muestra automáticamente y lo añade a la solicitud.

Los perfiles de muestra generados automáticamente contienen datos genéricos. Si desea probar el destino con datos de perfil personalizados e intuitivos, utilice el API de generación de perfiles de muestra para generar un perfil de muestra, personalice su respuesta e inclúyala en la solicitud a /testing/destinationInstance punto final.

Primeros pasos getting-started

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.

Requisitos previos prerequisites

Antes de usar el /testing/destinationInstance extremo, asegúrese de cumplir las siguientes condiciones:

Tiene un destino basado en archivos existente creado mediante el Destination SDK y puede verlo en su catálogo de destinos.
Ha creado al menos un flujo de activación para su destino en la interfaz de usuario de Experience Platform.
Para realizar correctamente la solicitud de API, necesita el ID de instancia de destino correspondiente a la instancia de destino que va a probar. Obtenga el ID de instancia de destino que debe utilizar en la llamada a la API, desde la dirección URL, al examinar una conexión con su destino en la interfaz de usuario de Platform.
Opcional: Si desea probar la configuración de destino con un perfil de muestra añadido a la llamada de API, utilice el /sample-profiles extremo para generar un perfil de muestra basado en el esquema de origen existente. Si no proporciona un perfil de muestra, la API generará uno y lo devolverá en la respuesta.

Pruebe la configuración de destino sin añadir perfiles a la llamada test-without-adding-profiles

Formato de API

POST /authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}

Solicitud

curl -X POST 'https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}' \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \

Parámetros de ruta

Descripción

{DESTINATION_INSTANCE_ID}

El ID de la instancia de destino para la que está generando perfiles de muestra. Consulte la requisitos previos para obtener más información sobre cómo obtener este ID.

Respuesta

Una respuesta correcta devuelve el estado HTTP 200 junto con la carga útil de respuesta.

{
   "activations":[
      {
         "segment":"6fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
         "flowRun":"81150d76-7909-46b6-83f4-fc855a92de07"
      },
      {
         "segment":"5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
         "flowRun":"4706780a-2ab3-4d33-8c76-7c87fd318cd8"
      }
   ],
   "results":"/authoring/testing/destinationInstance/fd3449fb-b929-45c8-9f3d-06b9d6aac328/results?flowRunIds=4706780a-2ab3-4d33-8c76-7c87fd318cd8,81150d76-7909-46b6-83f4-fc855a92de07",
   "inputProfiles":[
      {
         "segmentMembership":{
            "ups":{
               "fea8d394-5a8c-4cea-bebc-df020ce37f5c":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211895Z",
                  "status":"realized"
               },
               "5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211893Z",
                  "status":"realized"
               }
            }
         },
         "personalEmail":{
            "address":"john.smith@abc.com"
         },
         "identityMap":{
            "crmid":[
               {
                  "id":"crmid-P1A7l"
               }
            ]
         },
         "person":{
            "name":{
               "firstName":"string",
               "lastName":"string"
            }
         }
      }
   ]
}

Propiedad

Descripción

activations

Devuelve el ID de audiencia y el ID de ejecución de flujo para cada audiencia activada. El número de entradas de activación (y archivos generados asociados) es igual al número de audiencias asignadas en la instancia de destino.

Ejemplo: Si ha asignado dos audiencias a la instancia de destino, la variable activations La matriz contendrá dos entradas. Cada audiencia activada corresponde a un archivo exportado.

results

Devuelve el ID de instancia de destino y los ID de ejecución de flujo que puede utilizar para llamar al API de resultados, para probar aún más la integración.

inputProfiles

Devuelve los perfiles de muestra generados automáticamente por la API.

Pruebe la configuración de destino con perfiles añadidos a la llamada test-with-added-profiles

Para probar el destino con datos de perfil personalizados e intuitivos, puede personalizar la respuesta obtenida del /sample-profiles punto final con valores de su elección e incluya el perfil personalizado en la solicitud a /testing/destinationInstance punto final.

Formato de API

POST  /testing/destinationInstance/{DESTINATION_INSTANCE_ID}

Solicitud

curl -X POST 'https://platform.adobe.io/data/core/activation/authoring/testing/destinationInstance/{DESTINATION_INSTANCE_ID}'
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {IMS_ORG}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '
 {
   "profiles":[
      {
         "segmentMembership":{
            "ups":{
               "fea8d394-5a8c-4cea-bebc-df020ce37f5c":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211895Z",
                  "status":"realized"
               },
               "5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211893Z",
                  "status":"realized"
               }
            }
         },
         "personalEmail":{
            "address":"michaelsmith@example.com"
         },
         "identityMap":{
            "crmid":[
               {
                  "id":"Custom CRM ID"
               }
            ]
         },
         "person":{
            "name":{
               "firstName":"Michael",
               "lastName":"Smith"
            }
         }
      }
   ]
}'

Parámetro

Descripción

{DESTINATION_INSTANCE_ID}

El ID de instancia de destino del destino que está probando. El ID de la instancia de destino para la que está generando perfiles de muestra. Consulte la requisitos previos para obtener más información sobre cómo obtener este ID.

profiles

Matriz que puede incluir uno o varios perfiles. Utilice el ejemplo de extremo de API de perfil para generar perfiles que utilizar en esta llamada de API.

Respuesta

Una respuesta correcta devuelve el estado HTTP 200 junto con la carga útil de respuesta.

{
   "activations":[
      {
         "segment":"6fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
         "flowRun":"81150d76-7909-46b6-83f4-fc855a92de07"
      },
      {
         "segment":"5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b",
         "flowRun":"4706780a-2ab3-4d33-8c76-7c87fd318cd8"
      }
   ],
   "results":"/authoring/testing/destinationInstance/fd3449fb-b929-45c8-9f3d-06b9d6aac328/results?flowRunIds=4706780a-2ab3-4d33-8c76-7c87fd318cd8,81150d76-7909-46b6-83f4-fc855a92de07",
   "inputProfiles":[
      {
         "segmentMembership":{
            "ups":{
               "fea8d394-5a8c-4cea-bebc-df020ce37f5c":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211895Z",
                  "status":"realized"
               },
               "5fa55d3a-18e1-4f65-95ed-ac8fdb03b45b":{
                  "lastQualificationTime":"2022-01-13T11:33:28.211893Z",
                  "status":"realized"
               }
            }
         },
         "personalEmail":{
            "address":"michaelsmith@example.com"
         },
         "identityMap":{
            "crmid":[
               {
                  "id":"Custom CRM ID"
               }
            ]
         },
         "person":{
            "name":{
               "firstName":"Michael",
               "lastName":"Smith"
            }
         }
      }
   ]
}

Propiedad

Descripción

activations

results

Devuelve el ID de instancia de destino y los ID de ejecución de flujo que puede utilizar para llamar al API de resultados, para probar aún más la integración.

inputProfiles

Devuelve los perfiles de ejemplo personalizados que ha pasado en la solicitud de API.

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

Después de leer este documento, ahora sabe cómo probar la configuración de destino basada en archivos.

Si ha recibido una respuesta de API válida, el destino funciona correctamente. Si desea ver información más detallada acerca del flujo de activación, puede utilizar el results de la respuesta a ver resultados detallados de la activación.

Si está creando un destino público, ahora puede envíe su configuración de destino al Adobe para su revisión.

recommendation-more-help

7f4d1967-bf93-4dba-9789-bb6b505339d6