Generar perfiles de muestra basados en un esquema de origen

El primer paso para probar el destino basado en archivos es utilizar /sample-profiles extremo para generar un perfil de muestra basado en el esquema de origen existente.

Los perfiles de muestra pueden ayudarle a comprender la estructura JSON de un perfil. Además, le proporcionan un valor predeterminado que puede personalizar con sus propios datos de perfil para realizar más pruebas de destino.

Primeros pasos

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

Antes de usar el /sample-profiles 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. El /sample-profiles El punto de conexión crea los perfiles en función del esquema de origen definido en el flujo de activación. Consulte la tutorial de activación para obtener información sobre cómo crear un flujo de activación.

  • 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.

    Imagen de la interfaz de usuario que muestra cómo obtener el ID de instancia de destino desde la URL.

Generar perfiles de muestra para las pruebas de destino

Puede generar perfiles de muestra basados en el esquema de origen realizando una solicitud de GET al /sample-profiles punto final con el ID de instancia de destino del destino que desea probar.

Formato de API

GET /authoring/sample-profiles?destinationInstanceId={DESTINATION_INSTANCE_ID}&count={NUMBER_OF_GENERATED_PROFILES}
Parámetros de consulta Descripción
destinationInstanceId 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.
count Opcional. El número de perfiles de muestra que desea generar. El parámetro puede tomar valores entre 1 - 1000. Si esta propiedad no está definida, la API genera un solo perfil de muestra.

Solicitud

La siguiente solicitud genera un perfil de muestra basado en el esquema de origen definido en la instancia de destino con el correspondiente destinationInstanceId.

curl -X GET 'https://platform.adobe.io/data/core/activation/authoring/sample-profiles?destinationInstanceId={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}' \

Respuesta

Una respuesta correcta devuelve el estado HTTP 200 con el número especificado de perfiles de muestra, con pertenencia a audiencia, identidades y atributos de perfil que corresponden al esquema XDM de origen.

NOTA

La respuesta solo devuelve la pertenencia a audiencias, identidades y atributos de perfil que se utilizan en la instancia de destino. Aunque el esquema de origen tenga otros campos, estos se ignoran.

[
   {
      "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"
         }
      }
   }
]

Imagen que muestra la asignación de la interfaz de usuario a los campos de la respuesta de la API.

Propiedad Descripción
segmentMembership Un objeto map que describe las pertenencias de audiencia del individuo. Para obtener más información sobre segmentMembership, lea Detalles de pertenencia a audiencia.
lastQualificationTime Una marca de tiempo de la última vez que este perfil se clasificó para el segmento.
status Campo de cadena que indica si el abono a audiencia se ha realizado como parte de la solicitud actual. Se aceptan los siguientes valores:
  • realized: el perfil forma parte del segmento.
  • exited: el perfil se está saliendo de la audiencia como parte de la solicitud actual.
identityMap Campo de tipo mapa que describe los distintos valores de identidad de un individuo, junto con sus áreas de nombres asociadas. Para obtener más información sobre identityMap, consulte base de composición de esquema.

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 perfiles de muestra basados en el esquema de origen que configuró en su destino flujo de activación.

Ahora puede personalizar estos perfiles o utilizarlos a medida que la API los devuelve para prueba de la configuración de destino basada en archivos.

En esta página