Einstein Recommendations

Die Einstein Recommendations API hat zwei Hauptfunktionen: Empfang von Aktivitäten und Ausgabe von Empfehlungen. Durch Nutzung unserer Zonenkomponenten können unsere Kunden auch ohne Codeänderungen flexibel zwischen Recommendern wechseln.

Diese API-Dokumentation richtet sich in erster Linie an Salesforce Commerce Cloud-Kunden.

Um den Zugriff auf die Einstein Recommendations API zu aktivieren, wechseln Sie zu Einstein Configurator und geben Sie Ihre Client-ID für Commerce Cloud Account Manager in die API-Seite ein. Mit Website-Administrator-Zugriff können Sie die erforderliche Client-ID auf der Account Manager-Seite erstellen. Weitere Informationen finden Sie unter Add an API Client ID (API-Client-ID hinzufügen).

Wenn sie aktiviert ist und solange die richtige Client-ID übergeben wird, funktioniert die API in allen Umgebungen, einschließlich Produktions-, Staging-, Entwicklungs- und Sandbox-Instanzen.

Jeder API-Aufruf muss den Header x-cq-client-id zur Authentifizierung des API-Schlüssels übergeben.

Die Implementierung unserer API auf der Client- oder Serverseite ist mit einigen Kompromissen verbunden. Um sicherzustellen, dass Sie Ihre Kunden-ID geheim halten, empfehlen wir Ihnen zur Erhöhung der Sicherheit, unsere API auf der Serverseite zu implementieren. Die clientseitige Implementierung birgt das Risiko, dass Ihre Client-ID für böswillige Akteure sichtbar wird.

Bezüglich der Anfragen zum Abrufen von Empfehlungen und bestimmten Benutzeraktivitäten wie viewProduct, viewReco und clickReco müssen Überlegungen zum Caching angestellt werden, wenn sie serverseitig implementiert werden. Wenn ein Benutzer beispielsweise eine zwischengespeicherte Produktseite betrachtet, sollte die Aktivität viewProduct dennoch gesendet werden. Es ist wichtig, dass Einstein alle Ereignisse erhält und dass Empfehlungen nicht zwischengespeichert werden.

Diese Einstein Recommendations API ist nicht für den Anwendungsfall der E-Mail-Empfehlungen ausgelegt. Sie bietet keine Unterstützung für das Einbetten von Einstein Recommendations in E-Mails.

Unsere Serviceleistungen sind global verteilt, horizontal skalierbar und können je nach Traffic-Aufkommen automatisch hoch- und herunterskaliert werden, sodass keine Belastungstests erforderlich sind. Wir empfehlen, jegliche Belastungstests zu vermeiden, da sie die Ergebnisse der Empfehlungen beeinflussen.

Um relevante Produktempfehlungen für jeden Käufer zu generieren, bietet die Einstein Recommendations API Parameter zur Identifizierung der Käufer.

Um potenzielle böswillige Aktivitäten zu vermeiden, dürfen die Parameter der Benutzerkennungen nicht fortlaufend sein. Die Parameter sollten keine laufenden Nummern, Muster, IP-Adressen, E-Mail-Adressen, Namen oder sonstige mit einer bestimmten Person verbundenen Angaben enthalten. Alle Benutzerkennungsparameter müssen durch Hashing oder andere Methoden der Datenschutz-Grundverordnung (DSGVO) entsprechen.
  • cookieId (erforderlich) – Eindeutige Kennung eines anonymen Käufers. In der Regel ist die cookieId der Wert eines Erstanbieter-Cookies.
    • Wenn Sie API-Anfragen von einer herkömmlichen Commerce Cloud-Storefront aus stellen, übergeben Sie den Cookie-Wert cqcid, um die automatische Aktivitätsverfolgung für die herkömmliche Storefront abzugleichen. Weitere Informationen finden Sie unter Browser-Based Local Data Storage (Browserbasierter lokaler Datenspeicher).
    • Wenn Sie die Salesforce Commerce APIs verwenden, übergeben Sie den USID-Wert, der als Teil des Token-Abrufprozesses verfügbar ist. Weitere Informationen finden Sie in der Dokumentation Shopper Login and API Access Service (Käufer-Anmeldung und API-Zugangsservice).
    • Wenn Sie OCAPI nutzen, übergeben Sie den Wert visit_id aus der Antwort auf die Gastanmeldung für den Abgleich automatischer Aktivitäten. Weitere Informationen finden Sie im OCAPI Customer Document (OCAPI-Kundendokument).
  • userId (empfohlen) – Eindeutige Kennung eines angemeldeten Käufers. Dieser Parameter ermöglicht es Einstein, den gleichen angemeldeten Benutzer auf mehreren Geräten zu verknüpfen.
    • Wenn Sie API-Anfragen von einer herkömmlichen Commerce Cloud-Storefront aus stellen, übergeben Sie den Cookie-Wert cquid, um die automatische Aktivitätsverfolgung für die herkömmliche Storefront abzugleichen. Weitere Informationen finden Sie unter Browser-Based Local Data Storage (Browserbasierter lokaler Datenspeicher).
    • Wenn Sie die Salesforce Commerce APIs nutzen, übergeben Sie den Wert hashed_login aus der Antwort auf die registrierte Anmeldung für den Abgleich automatischer Aktivitäten. Weitere Informationen finden Sie in der Dokumentation Shopper Login and API Access Service (Käufer-Anmeldung und API-Zugangsservice).
    • Wenn Sie OCAPI nutzen, übergeben Sie den Wert hashed_login aus der Antwort auf die registrierte Anmeldung für den Abgleich automatischer Aktivitäten. Weitere Informationen finden Sie im OCAPI Customer Document (OCAPI-Kundendokument).

Standard-Leistungsberichte für Recommender, die über die Einstein API verwendet werden, sind identisch mit denjenigen für andere Recommender, die für Ihre Online-Shops verwendet werden. Die Berichte können Sie in den Einstein Berichten und im Dashboard einsehen (weitere Informationen zu Einstein Berichten und zum Dashboard finden Sie in diesem Dokument).

Um separate Berichte anzulegen und die Fehlerbehebung zu erleichtern, empfehlen wir Ihnen, getrennte Recommender für die Einstein API zu erstellen. Wenn Sie für einen Recommender beispielsweise die Bezeichnung „pdp-mobile-API“ angeben, bedeutet dies, dass der Recommender auf der Produktdetailseite einer mobilen App verwendet wird.

Die Berichtsmetriken basieren auf Aktivitäten. Wenn eine Anwendung, die die Einstein Recommendations API nutzt, keine Aktivitäten sendet, werden alle Metriken für den API-Recommender als null (0) angezeigt.

Rights of ALBERT EINSTEIN are used with permission of The Hebrew University of Jerusalem. Represented exclusively by Greenlight.