Recuperación de recomendaciones con la API de entrega

Las API de Adobe Target y Adobe Target Recommendations se pueden utilizar para enviar respuestas a páginas web, pero también se pueden utilizar en experiencias no basadas en HTML, como aplicaciones, pantallas, consolas, correos electrónicos, quioscos y otros dispositivos de visualización. En otras palabras, cuando no se pueden usar las bibliotecas de Target y JavaScript, la API de envío de Target sigue habilitando el acceso a toda la gama de funcionalidades de Target para ofrecer experiencias personalizadas.

NOTE
Al solicitar contenido que contenga recomendaciones reales (productos o artículos recomendados), utilice la API de envío de Target.

Para recuperar las recomendaciones, envíe una llamada de POST de la API de envío de Adobe Target con la información contextual adecuada, que puede incluir un ID de usuario (para su uso con recomendaciones específicas del perfil, como los artículos vistos recientemente por el usuario), un nombre de mbox relevante, parámetros de mbox, parámetros de perfil y otros atributos. La respuesta incluirá entity.ids recomendados (y pueden incluir otros datos de entidad) en formato JSON o HTML, que luego se pueden mostrar en el dispositivo.

La API de envío para Adobe Target expone todas las características existentes que proporciona una solicitud de Target estándar.

La API de envío:

  • Permite recuperar experiencias u ofertas para una ubicación y una audiencia de forma RESTful.
  • No requiere autenticación.
  • Solo POST.
  • No procesa cookies ni llamadas de redirección.
  • No requiere ni reconoce "funciones de usuario". Simplemente obtiene contenido o informa de eventos a los servidores Edge de Target.

Para utilizar la API de envío para ofrecer experiencias de Target, incluidas recomendaciones, siga estos pasos:

  1. Cree una actividad de Target (A/B, XT, AP o Recommendations) empleando el Compositor basado en formularios (no el Compositor de experiencias visuales).
  2. Utilice la API de envío para obtener una respuesta a las solicitudes generadas por la actividad de Target que acaba de crear.

<!P: ¿Por qué son necesarios ambos pasos para esto? Si tiene una recomendación basada en formularios definida para un mbox, ¿cuál es el punto o la ventaja de tener también el paso de la API de entrega para recuperar los resultados? ¿Por qué no puede hacer que la grabación basada en formularios envíe los resultados en el dispositivo de destino…?? R: Consulte el caso de uso siguiente… es cuando desea "interceptar" los resultados pendientes para hacer más cosas antes de mostrar los resultados. Cosas como comparaciones en tiempo real con niveles de inventario. —>

Crear una recomendación con el Compositor de experiencias basadas en formularios

Para crear recomendaciones que se puedan usar con la API de entrega, use Compositor basado en formularios.

  1. En primer lugar, cree y guarde un diseño basado en JSON para utilizarlo en su recomendación. Para obtener el archivo JSON de muestra, además de información básica sobre cómo se pueden devolver las respuestas JSON al configurar una actividad basada en formularios, consulte la documentación de Creación de diseños de recomendación. En este ejemplo, el diseño se denomina JSON simple.
    server-side-create-recs-json-design.png

  2. En Target, vaya a Activities > Create Activity > Recommendations y, a continuación, seleccione Form.

    server-side-create-recs.png

  3. Seleccione una propiedad y haga clic en Next.

  4. Defina la ubicación en la que desea que los usuarios reciban la respuesta de la recomendación. El ejemplo siguiente utiliza una ubicación denominada api_charter. Seleccione el diseño basado en JSON, creado anteriormente, con el nombre JSON simple.
    server-side-create-recs-form.png

  5. Guarde y active la recomendación. Generará resultados. Una vez que los resultados estén listos, puede usar la API de envío para recuperarlos.

Uso de la API de entrega

La sintaxis de la API de envío es:

POST https://{{CLIENT_CODE}}.tt.omtrdc.net/rest/v1/delivery

  1. Tenga en cuenta que el código de cliente es obligatorio. Como recordatorio, el código de cliente se puede encontrar en Adobe Target navegando a Recommendations > Settings. Observe el valor Código de cliente en la sección Token de API de recomendación.
    client-code.png

  2. Una vez que tenga el código de cliente de, cree la llamada de API de envío. El ejemplo siguiente comienza con Web Batched Mboxes Delivery API Call proporcionado en la colección Postman de la API de entrega, y realiza las modificaciones pertinentes. Por ejemplo:

    • los objetos browser y address se quitaron de Body, ya que no son necesarios para los casos de uso que no son de HTML

    • api_charter aparece como el nombre de la ubicación en este ejemplo

    • se especifica entity.id, ya que esta recomendación se basa en la Similitud de contenido, que requiere que se pase a Target una clave de elemento actual.

      server-side-Delivery-API-call.png
      Recuerde configurar los parámetros de consulta correctamente. Por ejemplo, asegúrese de especificar {{CLIENT_CODE}} según sea necesario. <!— P: En la sintaxis de llamada actualizada, entity.id se muestra como profileParameter en lugar de mboxParameter, como en versiones anteriores. —> <!— P: Imagen antigua server-side-create-recs-post.png Texto acompañante antiguo: "Tenga en cuenta que esta recomendación se basa en productos similares de contenido basados en entity.id enviados mediante mboxParameters." —>
      client-code3

  3. Envíe la solicitud. Esto se ejecuta en la ubicación api_charter, que tiene una recomendación activa en ejecución, definida con su diseño JSON que generará una lista de entidades recomendadas.

  4. Reciba una respuesta basada en el diseño JSON.
    server-side-create-recs-json-response2.png
    La respuesta incluye el ID de clave, así como los ID de entidad de las entidades recomendadas.

El uso de la API de envío con Recommendations de esta manera le permite realizar pasos adicionales antes de mostrar recomendaciones al visitante en un dispositivo que no sea de HTML. Por ejemplo, puede tomar la respuesta de la API de envío para realizar una búsqueda adicional en tiempo real de los detalles de atributos de entidad (inventario, precio, calificación, etc.) de otro sistema (como una plataforma de CMS, PIM o de comercio electrónico) antes de mostrar los resultados finales.

Con el enfoque descrito en esta guía, puede hacer que cualquier aplicación aproveche la respuesta de Target para ofrecer recomendaciones personalizadas.

Ejemplos de implementaciones

Los siguientes recursos proporcionan ejemplos de varias implementaciones no centradas en HTML. Tenga en cuenta que cada implementación será única, debido al sistema y los dispositivos implicados.

Recurso
Detalles
Configuración de la extensión de Target en Experience Platform Launch e Implementación de las API de Target
Pasos para configurar la extensión de Target en Experience Platform Launch, añadir la extensión de Target a la aplicación e implementar las API de Target para solicitar actividades, recuperar previamente ofertas e introducir el modo de vista previa.
Cliente de nodo de Adobe Target
SDK v1.0 de Node.js de Target de código abierto
Información general del lado del servidor
Información sobre las API de envío del servidor de Adobe Target, las API de envío por lotes del servidor, Node.js, SDK y las API de Adobe Target Recommendations.
Recomendaciones de contenido de Adobe Campaign en el correo electrónico
Blog que describe cómo aprovechar las recomendaciones de contenido en el correo electrónico mediante Adobe Target y Adobe I/O Runtime en Adobe Campaign.

Administración de la configuración de Recommendations con API

La mayoría de las veces, las recomendaciones se configuran en la interfaz de usuario de Adobe Target y, a continuación, se utilizan o se accede a ellas a través de las API de Target, por motivos como los mencionados en las secciones anteriores. Esta coordinación IU-API es común. Sin embargo, a veces los usuarios pueden querer realizar todas las acciones a través de las API, tanto la configuración como el uso de los resultados. Aunque es mucho menos común, los usuarios pueden configurar, ejecutar, y absolutamente aprovechar los resultados de las recomendaciones completamente mediante las API.

En una sección anterior aprendimos a administrar entidades de Recommendations de Adobe Target y a entregarlas en el servidor. Del mismo modo, Adobe Developer Console le permite administrar criterios, promociones, colecciones y plantillas de diseño sin tener que iniciar sesión en Adobe Target. Se puede encontrar una lista completa de todas las API de Recommendations aquí, pero aquí tiene un resumen para referencia.

Recurso
Detalles
Colecciones
Enumere, cree, obtenga, edite y elimine colecciones.
Criterios
Enumerar y obtener criterios.
Diseños
Muestre una lista, cree, obtenga, edite, elimine y valide diseños.
Entidades
Guarde, elimine y obtenga entidades.
Promociones
Enumere, cree, obtenga, edite y elimine promociones.
Criterios de categoría
Enumerar, crear, obtener, editar y eliminar criterios de categoría.
Criterios personalizados
Enumerar, crear, obtener, editar y eliminar criterios personalizados.
Criterios del elemento
Enumerar, crear, obtener, editar y eliminar criterios de elementos.
Criterios de popularidad
Enumere, cree, obtenga, edite y elimine criterios de popularidad.
Criterios de atributo de perfil
Enumerar, crear, obtener, editar y eliminar criterios de atributos de perfil.
Criterios recientes
Enumere, cree, obtenga, edite y elimine criterios recientes.
Criterios de secuencia
Enumerar, crear, obtener, editar y eliminar criterios de secuencia.

Documentación de referencia

Resumen y revisión

¡Felicidades! Al completar esta guía, ha aprendido cómo:

recommendation-more-help
6906415f-169c-422b-89d3-7118e147c4e3