Personyze Wiki Personyze Wiki docs
Deutsch
Open Personyze
Docs/ Produktempfehlungen/ JSON-API: Produktempfehlungen
Produktempfehlungen

JSON-API: Produktempfehlungen

Erhalten Sie Produktempfehlungen als reines JSON und rendern Sie sie selbst – Katalog, Melden von Interaktionen, Wahl des Algorithmus, Aufbau der Antwort und wie Sie das Ergebnis verwenden.

6 min read Updated 23 Stunden ago

Produktempfehlungen als reines JSON statt als gerendertes Widget, damit Sie sie selbst anordnen können. Nutzen Sie das für ein individuell gestaltetes Widget, eine Single-Page-App, eine native App, eine E-Mail-Vorlage oder jede Fläche, deren Darstellung Sie selbst steuern und für die Sie nur die Auswahl brauchen. Sie rufen sie mit einer einzigen GET-Anfrage ab.

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

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 Katalog muss vorhanden und aktuell sein. Was Personyze nicht kennt, kann nicht empfohlen werden. Jeder Artikel braucht mindestens eine interne ID, einen Titel und eine URL, dazu ein Bild, wenn Ihr Layout eines zeigt. Der Katalog liegt unter Einstellungen → Empfehlungs-Einrichtung → Produktkatalog. Siehe Den Produkt- und Inhaltsfeed einrichten.

2. Interaktionen

Die Engine lernt aus dem, was Menschen mit Produkten tun: angesehen, in den Warenkorb gelegt, gekauft. Ansichten, Warenkorb-Hinzufügungen und Käufe auf Ihrer eigenen Website werden wie gewohnt über Einstellungen → Empfehlungs-Einrichtung → Produkt-Tracking erfasst. Bei Ihrem eigenen Layout ist das anders: Personyze hat es nicht gezeichnet und kann daher nicht sehen, was dort passiert.

  • Klicks: Leiten Sie Nutzer über die click_url weiter, die mit jedem Artikel zurückkommt. Sie öffnet das Produkt und erfasst den Klick.
  • Alles, was außerhalb Ihrer Website passiert, etwa eine Ansicht oder ein Kauf in Ihrer App, müssen Sie selbst melden. Verwenden Sie dafür die REST-API für Produktinteraktionen.

Das ist der häufigste Grund, warum eine JSON-Empfehlung schwache oder allgemeine Ergebnisse liefert: Die Ausgabe wird gerendert, aber es wird nichts zurückgemeldet.

3. Empfehlung

Wählen Sie den Algorithmus. Die Auswahl ist dieselbe wie bei Widgets auf der Website, gruppiert in Personalisiert & verhaltensbasiert; Cross-Sells, Co-Views & Upsells; Besucherhistorie; Katalog-Ereignisse; und Benutzerdefiniert. Eine Anfrage kommt nicht von einer Seite Ihrer Website, deshalb bietet die Zeile Seite stattdessen an, was die Person getan hat:

  • Allgemein: kein bestimmter Artikel.
  • Items they viewed: verankert an dem, was sie angesehen hat.
  • Items in their cart: verankert an ihrem Warenkorb.
  • Items they purchased: verankert an dem, was sie gekauft 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. Kürzere Zeitfenster folgen Trends, längere sind stabiler.
  • Quelle: welcher Teil des Katalogs. Zum Beispiel eine beliebige Kategorie, die Kategorien, die die Person angesehen hat, ihre letzte Warenkorb-Kategorie oder ihre gemeldeten Interessen.
  • Sortieren nach: Angesehen, Kürzlich zum Katalog hinzugefügt, Gekauft, In den Warenkorb, Auf Wunschliste, Günstig, Hoch bewertet oder Hohe Marge.

Die Karte Ausgabe legt fest, wie viele Artikel zurückkommen (bis zu 12), welche Fallback-Algorithmen laufen, wenn der Hauptalgorithmus zu wenige liefert, und ob Leere Zellen füllen ein zu kurzes Ergebnis mit beliebten Artikeln auffüllt. Darunter grenzen Filter den Pool ein. Sie können Artikel überspringen, mit denen sich die Person bereits beschäftigt hat, auf ausgewählte Kategorien oder auf Artikel mit Bild oder Preis beschränken oder eigene Regeln zu jedem Katalogfeld schreiben. Nicht vorrätige Artikel werden automatisch ausgeschlossen.

Zu den Algorithmen selbst siehe Empfehlungsalgorithmen. Siehe auch Filter und Fallbacks.

4. Daten in der Antwort

Personyze antwortet mit einem JSON-Array aus Objekten, eines pro Produkt, mit den Feldern, die Sie hier auswählen. Jede Zeile ordnet einem Field on Personyze seinen Name in JSON result zu, sodass Sie Ihren eigenen Antwortvertrag festlegen. Wählen Sie genau das, was Ihr Renderer braucht, und nicht mehr.

Jedes Produkt kommt außerdem mit einer click_urlzurück, ob Sie sie aufführen oder nicht. Leiten Sie den Nutzer zu dieser URL: Sie öffnet das Produkt und erfasst den Klick, und die Ansichts- und Klickstatistiken werden daraus berechnet.

Eine typische Auswahl für ein Produkt-Widget:

[
  {
    "internal_id": "nw-p001",
    "title": "Alpine Shell",
    "price": 249,
    "image_1": "https://example.test/img/alpine-shell.jpg",
    "url": "https://example.test/shop/alpine-shell",
    "click_url": "https://pic.personyze.com/href/k=…"
  },
  ...
]

Jedes eigene Katalogfeld kann aufgenommen werden. Zeigt Ihr Layout ein Badge, eine Bewertung oder einen Lagerhinweis, ordnen Sie das Feld hier zu, statt es separat nachzuschlagen.

5. Code

Der Schritt Code mit dem Titel Request URL liefert Ihnen fertige URLs. Sie erscheinen, sobald die Kampagne gespeichert ist. Senden Sie eine GET-Anfrage an eine davon, und die Empfehlungen kommen als JSON zurück. Was Sie ans Ende setzen, legt fest, für wen oder wofür sie gelten:

URL endet auf Empfiehlt für
/email={INSERT EMAIL HERE} Die Person mit dieser E-Mail-Adresse. Eine Adresse, die Personyze noch nicht kennt, legt ein Profil an; die erste Anfrage nimmt die Person also auf.
/internal_id={INSERT INTERNAL ID HERE} Die Person mit Ihrer eigenen ID für sie, in ihrem Profil als Interne ID hinterlegt. Eine unbekannte ID legt ebenfalls ein Profil an.
/u={INSERT PERSONYZE USER ID HERE} Die eigene numerische Benutzer-ID von Personyze, die der Tracker auf Ihrer Website bereitstellt. Alles andere als eine Zahl wird abgelehnt mit Invalid parameter.
/item_internal_id={INSERT ITEM INTERNAL ID HERE} Keine Person: Produkte, die mit diesem Produkt zusammenhängen. Das sind Artikel, die zusammen mit ihm angesehen oder gekauft wurden, oder die beliebtesten in seiner Kategorie.

Eine fünfte URL, die auf /get[]=…endet, empfiehlt nichts. Sie gibt die gewählten Felder für die Produkte zurück, die Sie nennen, bis zu 50 pro Anfrage, und ihr Zeitraum (1 Tag, 2 Tage, Woche, Gesamter Zeitraum) legt das Zeitfenster für alle angefragten Interaktionszähler fest.

Die Anfrage ist dieselbe, ob aus einem Backend, einer App oder einer E-Mail-Vorlage. Meldet Ihre App bereits über das Mobile SDK an Personyze, können Sie die Auswahl dort auch mit einer Kampagne Produktempfehlungen für Apps ausliefern.

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. Geklickt zählt Benutzer, die über eine zurückgegebene click_url auf Ihre Website gelangt sind, als Prozentsatz von Angesehen. In den Warenkorb und Gekauft folgen in derselben Sitzung, jeweils als Prozentsatz der vorherigen Stufe. Transaktionen, zugeordneter Umsatz und dessen Anteil am Website-Umsatz stehen daneben. Erfasst wird nur, was Personyze sehen kann: Ohne die click_urlbleiben Klicks und alles danach ungezählt. Jede Zahl wird unter Produkt- und Inhaltsempfehlungen erklärt.

Hinweis: Es gibt keinen Schritt QA

Anders als Kampagnen auf der Website haben JSON-API-Kampagnen keinen Schritt QA, weil es keinen gerenderten Inhalt gibt, den das Panel in der Vorschau zeigen könnte. Prüfen Sie, indem Sie selbst eine URL abrufen und die Antwort lesen. Kontrollieren Sie, dass Sie die erwartete Anzahl von Artikeln erhalten, dass die gewählten Felder vorhanden sind und dass die Werte gefüllt und nicht leer sind. Eine Anfrage, die nicht beantwortet werden kann, gibt trotzdem JSON zurück, und zwar als {"error": "…"}. Zum Beispiel bedeutet No recommendations for this user , dass der Algorithmus für diese Person nichts gefunden hat und kein Fallback einspringen konnte.

Verwandte Themen

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