JSON-API: Inhaltsempfehlungen

Inhaltsempfehlungen als reines JSON statt als gerendertes Widget, damit Sie sie in Ihrem eigenen Layout rendern können. Ideal für ein individuell gestaltetes Karussell, eine Single-Page-App, eine native App, eine E-Mail-Vorlage oder einen Block „Das könnte Ihnen auch gefallen“, der genau zu Ihrem eigenen Designsystem passen muss. Sie rufen sie mit einer einzigen GET-Anfrage ab.

Im Panel: Neue Kampagne › App / API › JSON-API — Inhaltsempfehlungen.

Die Schritte

Sieben Schritte: Katalog, Interaktionen, Empfehlung, Daten in der Antwort, Code, Automatisierung und Leistung. Es gibt keinen Schritt Zielgruppe: Die Auswahl gilt für die Person, die Ihre Anfrage nennt.

1. Katalog

Ihr Inhaltskatalog mit Artikeln, Leitfäden und Videos liegt unter Einstellungen → Empfehlungs-Einrichtung → Artikelkatalog. Jeder Eintrag braucht eine interne ID, einen Titel und eine URL, dazu ein Bild, wenn Ihr Layout eines verwendet. Kategorien und Tags lohnen sich sorgfältig auszufüllen, denn mit ihnen können Empfehlungen einem Thema folgen statt nur der allgemeinen Beliebtheit.

2. Interaktionen

Die Engine lernt aus dem, was Menschen lesen, liken, kommentieren und abschließen. Lesevorgänge auf Ihrer eigenen Website werden wie gewohnt über Einstellungen → Empfehlungs-Einrichtung → Artikel-Tracking erfasst. Was in Ihrem eigenen Layout passiert, ist etwas anderes, weil Personyze es nicht gezeichnet hat:

Klicks: Leiten Sie Leser über die click_url weiter, die mit jedem Artikel zurückkommt. Sie öffnet den Artikel und erfasst den Klick.
Alles außerhalb Ihrer Website, etwa ein Artikel, der in Ihrer App gelesen wird, müssen Sie selbst über die REST-API melden.

Wird das ausgelassen, ist das der übliche Grund, warum eine JSON-Inhaltsempfehlung allen dieselbe allgemeine Liste liefert: Es gibt keinen Leseverlauf, nach dem personalisiert werden könnte.

3. Empfehlung

Wählen Sie den Algorithmus. Die Auswahl ist dieselbe wie bei Widgets auf der Website, gruppiert in Personalisiert & beliebt; Co-Reads & Ähnliches; Besucherhistorie; Katalog-Ereignisse; und Benutzerdefiniert. Eine Anfrage kommt nicht von einer Seite Ihrer Website, deshalb bietet die Zeile Seite stattdessen an, was der Leser getan hat. Verwenden Sie Allgemein für eine Auswahl ohne bestimmten Artikel dahinter und Items they viewed, um dem zu folgen, was er gelesen hat.

Viele Algorithmen haben eigene Einstellungen, die auf der Karte angezeigt werden:

Zeitraum: Kürzlich, Heute, In den letzten 2 Tagen, In den letzten 4 Tagen, In der letzten Woche oder Gesamter Zeitraum.
Quelle: welcher Teil des Katalogs. Zum Beispiel eine beliebige Kategorie, die Kategorien, die der Leser gelesen hat, oder seine gemeldeten Interessen.
Sortieren nach: zum Beispiel am häufigsten angesehen oder zuletzt zum Katalog hinzugefügt.

Für einen JSON-Feed eignen sich zum Beispiel Für Sie empfohlene Inhalte, Für Sie empfohlene Inhalte — veröffentlicht seit dem letzten Besuch, Besucher, die dies lasen, lasen auch, Aktuell im Trend und Kürzlich veröffentlicht. Die Karte Ausgabe legt fest, wie viele Artikel zurückkommen (bis zu 12), welche Fallback-Algorithmen laufen, wenn der Hauptalgorithmus zu wenige liefert, und Leere Zellen füllen. Filter grenzen den Pool weiter ein: überspringen, womit sich der Leser schon beschäftigt hat, auf ausgewählte Kategorien beschränken oder eigene Regeln zu jedem Feld Ihres Feeds schreiben.

Die Algorithmen im Detail finden Sie unter Empfehlungsalgorithmen: Inhaltsempfehlungen.

4. Daten in der Antwort

Personyze antwortet mit einem JSON-Array aus Objekten, eines pro Artikel, mit den Feldern, die Sie auswählen. Sie legen hier Ihren eigenen Antwortvertrag fest, wählen Sie also genau das, was Ihr Renderer braucht.

Wählen Sie für jede Zeile das Field on Personyze aus Ihrem Katalog und geben Sie ihm den Name in JSON result, den Sie in der Ausgabe haben möchten. Jeder Artikel kommt außerdem mit einer click_urlzurück, ob Sie sie aufführen oder nicht. Sie öffnet die URL des Artikels und erfasst den Klick. Eine typische Auswahl für Inhalte:

[
  {
    "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. Code

Der Schritt Code mit dem Titel Request URL liefert Ihnen fertige URLs, sobald die Kampagne gespeichert ist. Senden Sie eine GET-Anfrage an eine davon, und die Empfehlungen kommen als JSON zurück:

URL endet auf	Empfiehlt für
`/email={INSERT EMAIL HERE}`	Der Leser mit dieser E-Mail-Adresse. Eine Adresse, die Personyze noch nicht kennt, legt ein Profil an.
`/internal_id={INSERT INTERNAL ID HERE}`	Der Leser mit Ihrer eigenen ID für ihn, in seinem Profil als Interne ID hinterlegt.
`/u={INSERT PERSONYZE USER ID HERE}`	Die numerische Benutzer-ID von Personyze, wie der Tracker sie auf Ihrer Website bereitstellt.
`/item_internal_id={INSERT ITEM INTERNAL ID HERE}`	Kein Leser: Artikel, die mit diesem Artikel zusammenhängen. Das sind Artikel, die zusammen mit ihm gelesen wurden, oder die beliebtesten in seiner Rubrik.

Eine fünfte URL, die auf /get[]=…endet, gibt die gewählten Felder für die Artikel zurück, die Sie nennen (bis zu 50), und empfiehlt nichts. Die Anfrage ist dieselbe, ob aus einem Backend, einer App oder einer E-Mail-Vorlage. Für eine App, die bereits das Mobile SDK nutzt, liefert eine Kampagne Inhaltsempfehlungen für Apps die Auswahl dort aus.

6. Automatisierung

Dieser Schritt ist optional. Fügen Sie Regeln hinzu, die Sie benachrichtigen oder handeln, wenn die Zahlen dieser Kampagne eine Grenze überschreiten. Siehe Automatisierung.

7. Leistung

Der Schritt Leistung zeigt JSON-API-Statistiken. Angesehen zählt die an Ihre Anwendung ausgelieferten Empfehlungen. Interagiert zählt Leser, die über eine zurückgegebene click_url auf Ihre Website gelangt sind, als Prozentsatz von Angesehen. Konvertiert zählt diejenigen, die anschließend in derselben Sitzung Ihr Inhaltsziel erreicht haben. Gezählt werden kann nur, was Personyze erreicht: Klicks, die die click_url umgehen, fehlen, sodass die Zahlen unterschätzen, was die Empfehlung bewirkt hat. Was jede Zahl bedeutet: Inhaltsempfehlungen.

Hinweis: Es gibt keinen Schritt QA

JSON-API-Kampagnen haben keinen Schritt QA, weil es keinen gerenderten Inhalt für eine Vorschau gibt. Prüfen Sie, indem Sie eine URL abrufen und die Antwort selbst kontrollieren: die richtige Anzahl von Einträgen, die gewählten Felder vorhanden und die Werte gefüllt statt leer. Eine Anfrage, die nicht beantwortet werden kann, gibt Folgendes zurück: {"error": "…"}, zum Beispiel No recommendations for this user.