Personyze Wiki Personyze Wiki docs
Español
Open Personyze
Documentación/ Recomendaciones de contenido/ API JSON — Recomendaciones de contenido
Recomendaciones de contenido

API JSON — Recomendaciones de contenido

Obtenga recomendaciones de contenido como JSON sin procesar y muéstrelas con su propio diseño: catálogo, notificación de interacciones, modificadores del algoritmo y forma de la respuesta.

6 min read Actualizado hace 22 horas

Recomendaciones de contenido entregadas como JSON sin procesar en lugar de como un widget ya generado, para que pueda mostrarlas con su propio diseño. Ideal para un carrusel de diseño propio, una single-page app, una app nativa, una plantilla de email o un bloque “también le puede gustar” que tiene que encajar exactamente con su propio sistema de diseño. Se obtienen con una única solicitud GET.

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

Los pasos

Siete pasos: Catálogo, Interacciones, Recomendación, Datos en la respuesta, Código, Automatización y Rendimiento. No hay paso Segmentar: la selección es para quien indique su solicitud.

1. Catálogo

Su catálogo de contenidos con artículos, guías y vídeos está en Configuración → Configuración de recomendaciones → Catálogo de artículos. 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, porque permiten que las recomendaciones sigan un tema en lugar de solo la popularidad general.

2. Interacciones

El motor aprende de lo que la gente lee, marca con me gusta, comenta y termina. Las lecturas en su propio sitio web se registran como siempre, desde Configuración → Configuración de recomendaciones → Seguimiento de artículos. Lo que ocurre dentro de su propio diseño es distinto, porque Personyze no lo dibujó:

  • Clics: haga pasar a los lectores por el click_url que llega con cada artículo. Abre el artículo y registra el clic.
  • Todo lo que ocurre fuera de su sitio web, como un artículo leído dentro de su app, tiene que notificarlo usted a través de la API REST.

Saltarse esto es la razón habitual por la que una recomendación de contenido 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 algoritmo. El selector es el mismo que usan los widgets en el sitio, agrupado en Personalizados y populares; Co-lecturas y relacionados; Historial del visitante; Eventos del catálogo; y Personalizado. Una solicitud no llega desde una página de su sitio, así que la fila Página ofrece en su lugar lo que hizo el lector. Use General para una selección sin ningún artículo concreto detrás, e Items they viewed para seguir lo que leyó.

Muchos algoritmos tienen ajustes propios, que se muestran en la tarjeta:

  • Periodo: Recientemente, Hoy, En los últimos 2 días, En los últimos 4 días, En la última semana o En todo el tiempo.
  • Tomado de: qué parte del catálogo. Por ejemplo, cualquier categoría, las categorías que leyó o sus intereses notificados.
  • Ordenar por: por ejemplo, lo más visto o lo añadido recientemente al catálogo.

Algunos que encajan en un feed JSON son Contenido recomendado para ti, Contenido recomendado para ti — publicado desde la última visita, Los visitantes que leyeron esto también leyeron, Tendencia ahora y Publicados recientemente. La tarjeta Salida fija cuántos artículos se devuelven (hasta 12), los Algoritmos de respaldo para cuando el principal devuelve demasiado pocos, y Rellenar celdas vacías. Los filtros acotan aún más el conjunto: omitir aquello con lo que el lector ya interactuó, restringir a categorías elegidas o escribir reglas personalizadas sobre cualquier campo de su feed.

Consulte Algoritmos de recomendación: recomendaciones de contenido para ver los algoritmos en detalle.

4. Datos en la respuesta

Personyze responde con un array JSON de objetos, uno por artículo, con los campos que seleccione. Aquí define su propio contrato de respuesta, así que elija exactamente lo que necesita su código de presentación.

En cada fila, elija el Field on Personyze de su catálogo y dele el Name in JSON result que quiera en la salida. Cada artículo llega además con un click_url, lo incluya o no en la lista. Abre la URL del artículo y registra el clic. 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",
    "click_url": "https://pic.personyze.com/href/k=…"
  },
  ...
]

5. Código

El paso Código, titulado Request URL, le da URL ya preparadas una vez guardada la campaña. Haga una solicitud GET a una de ellas y las recomendaciones llegan como JSON:

La URL termina en Recomienda para
/email={INSERT EMAIL HERE} El lector con esa dirección de email. Una dirección que Personyze no ha visto crea un perfil.
/internal_id={INSERT INTERNAL ID HERE} El lector con su propio ID para él, guardado en su perfil como ID interno.
/u={INSERT PERSONYZE USER ID HERE} El ID numérico de usuario de Personyze, tal como lo expone el tracker en su sitio.
/item_internal_id={INSERT ITEM INTERNAL ID HERE} Ningún lector: artículos relacionados con ese artículo. Son artículos leídos junto con él, o los más populares de su sección.

Una quinta URL, que termina en /get[]=…, devuelve los campos que haya elegido para los artículos que indique (hasta 50) y no recomienda nada. La solicitud es la misma desde un backend, una app o una plantilla de email. Para una app que ya usa el SDK móvil, una campaña Recom. de contenido para apps entrega allí la selección.

6. Automatización

Este paso es opcional. Añada reglas que le avisen, o que actúen, cuando las cifras de esta campaña crucen un umbral. Consulte Automatización.

7. Rendimiento

El paso Rendimiento muestra las Estadísticas JSON API. Visto cuenta las recomendaciones servidas a su aplicación. Interacción cuenta los lectores que pasaron por un click_url devuelto y llegaron a su sitio, como % de Visto. Convertido cuenta los que llegaron después a su objetivo de contenido en la misma sesión. Solo puede contar lo que llega a Personyze: faltan los clics que se saltan el click_url , así que las cifras se quedan por debajo de lo que hizo realmente la recomendación. Qué significa cada cifra: Recomendaciones de contenido.

Nota: no hay paso QA

Las campañas de API JSON no tienen paso QA, porque no hay contenido generado que previsualizar. Valide solicitando una URL y comprobando usted mismo la respuesta: el número correcto de elementos, los campos que seleccionó presentes y los valores rellenos y no vacíos. Una solicitud que no se puede responder devuelve {"error": "…"}, por ejemplo No recommendations for this user.

Relacionado

Did this page answer your question?
Thank you — that goes to whoever maintains this page.