Personyze Wiki Personyze Wiki docs
Español
  • English
  • Español
  • Français
  • Deutsch
  • Italiano
  • Nederlands
  • Português
  • Polski
  • 日本語
  • العربية
Open Personyze
Documentación/ Recomendaciones de contenido/ API JSON — Recomendaciones de contenido
Recomendaciones de contenido

API JSON — Recomendaciones de contenido

Recomendaciones de contenido como JSON sin procesar para mostrarlas con su propio diseño: catálogo, interacciones que debe notificar usted, algoritmo, campos de la respuesta y el código para insertarlas.

3 min read Actualizado hace 57 minutos

Recomendaciones de contenido entregadas como JSON sin procesar en lugar de un widget renderizado, para que pueda mostrarlas con su propio diseño. Ideal para un carrusel diseñado a medida, una aplicación de una sola página, una app nativa o un bloque de “quizá también le guste” que tenga que encajar exactamente con su propio sistema de diseño.

En el panel: Nueva campaña › App / API › API JSON — Recom. de contenido.

Los pasos

Seis pasos: Catálogo, Interacciones, Recomendación, Datos en la respuesta, Código y Rendimiento.

1. Catálogo

Su catálogo de contenidos — artículos, guías, vídeos. Cada elemento necesita un ID interno, un título y una URL, además de una imagen si su diseño la usa. Merece la pena rellenar bien las categorías y las etiquetas: son las que permiten que las recomendaciones sigan un tema en lugar de limitarse a la popularidad general.

2. Interacciones

El motor aprende de lo que la gente lee, marca con me gusta, comenta y completa. Como usted mismo muestra el JSON, tiene que notificar usted mismo estas interacciones — Personyze no puede deducir una lectura a partir de un diseño que no ha dibujado.

Saltarse esto es la razón habitual por la que una recomendación de contenido por JSON devuelve la misma lista genérica a todo el mundo: no tiene historial de lectura con el que personalizar.

3. Recomendación

Elija el contexto — página de inicio, página de artículo, página de categoría — y el algoritmo. Los modificadores disponibles:

  • Ventana de tiempo — hoy, recientemente, los últimos días, la última semana o todo el tiempo.
  • Ámbito de categoría — de todas las categorías, o de la categoría del artículo actual.
  • Ámbito de intereses — de los intereses deducidos del visitante.
  • Actualidad y orden — primero los recientes, primero los más antiguos, añadidos recientemente o nuevos desde la última visita del visitante.
  • Coocurrencia — vistos juntos dentro de la categoría actual.

Los filtros acotan aún más el conjunto — tipo de contenido, etiqueta, categoría o cualquier campo personalizado de su feed.

Consulte Tipos de algoritmos de recomendación para ver los algoritmos en detalle.

4. Datos en la respuesta

Personyze genera un array JSON de objetos, cada uno con los campos que seleccione. Aquí está definiendo su propio contrato de respuesta, así que elija exactamente lo que necesita su código de renderizado.

Para cada campo, elija el campo de origen de su catálogo y dele el nombre de clave que quiera en el resultado. Una selección típica para contenidos:

[
  {
    "internal_id": "nw-a001",
    "title": "How to layer for winter hiking",
    "category": "Skills",
    "image_1": "https://example.test/img/layering.jpg",
    "url": "https://example.test/journal/how-to-layer-for-winter-hiking"
  },
  ...
]

5. Código

El asistente genera el fragmento que debe insertar. Hay dos formas de usarlo:

  • En una página — el fragmento asigna el array JSON a una variable de JavaScript con el nombre que usted elija, y su propio código lo muestra.
  • En el servidor o desde una app — llame a /rest/tracker-v1 y lea el JSON del campo data de la acción correspondiente. Consulte Implementar una app de recomendaciones personalizada.

6. Rendimiento

Resultados una vez en vivo — limitados por lo que usted notifique, como se explica arriba.

Nota: no hay paso de QA

Las campañas de API JSON no tienen paso de QA, porque no hay contenido renderizado que previsualizar. Valídelas obteniendo el JSON y comprobándolo usted mismo: el número correcto de elementos, los campos seleccionados presentes y los valores rellenados en lugar de vacíos.

Relacionado