Dokumentation Produkt-Einbindung (Plugin für Shopware)

Link zum Plugin: http://bit.ly/netzperfekt-produkteinbindung

In dieser Dokumentation wird das Plugin Produkt-Integration (ProductEmbed) beschrieben. Mit diesem Plugin können Sie Ihren Shopware-Shop in externe Seiten mittels iFrames einbinden. Der Produkt-Finder ermöglicht es, aus einer Vielzahl von Produkten durch Auswahl von Filterkriterien schnell ein oder mehrere gewünschte Produkte zu selektieren und anzuzeigen. Mit einem Klick gelangt der Nutzer dann auf die Produkt-Detailseite in Ihrem Shop. 

Weiterhin steht ein Produkt-Slider/Fader zur Verfügung, der Artikel in unterschiedlichen Arten darstellt und nach einer einstellbaren Zeit wechselt. Hier ist keine manuelle Filterung möglich. 

Weiterhin wird ein Plugin für WordPress mitgeliefert, das die Einbindung in externe WordPress-Blog vereinfacht. 

Das Plugin ist somit ideal für alle Arten von Affiliate Marketing


Installation und Einrichtung

Installieren Sie bitte das Shopware-Plugin wie gewohnt über den Plugin-Manager.
(Allgemeine Hinweise dazu finden sich unter http://community.shopware.com/Plugin-Manager-ab-Shopware-5_detail_1856_643.html). 

Die Eingabe eines Lizenzschlüssels ist nicht notwendig. Falls Sie von einer Testversion auf die Kaufversion gewechselt haben, kann es bis zu 24h dauern, bis der neue Lizenzstatus im Plugin-Manager angezeigt wird.

Plugin Einstellungen

In den Plugin-Settings kann nur die Caching-Zeit eingestellt werden (Standard: 86400 Sekunden = 1 Tag, Ein Wert von 0 bedeutet, dass kein Caching des Produktfinder-Streams erfolgt). Diese steuert, wie lange die Artikel für den Produkt-Finder vorgehalten werden, da die Erzeugung einige Zeit in Anspruch nimmt. Bei einem manuellen Leeren des Shopware-Caches wird dieser Cache ebenfalls zurückgesetzt. Der erste Aufruf eines externen Produkt-Finders dauert dann - je nach Artikelanzahl im Shop - entsprechend länger. 

Siehe dazu auch weiter unten unter Stream-Cache.


Externe Produkt-Einbindung anlegen

 Das Plugin ist über einen eigenen Menüpunkt unter Backend / Marketing / Externe Produkteinbindung erreichbar. Nun können beliebig viele Produkt-Finder oder Produkt-Fader definiert werden.

Die Bedienung funktioniert wie von Shopware insgesamt gewohnt: Über Hinzufügen erstellen Sie eine neue Quelle, das Minus-Symbol lösche eine Quelle und der Bleistift erlaubt die Bearbeitung. Ein Doppelklick auf einen Eintrag in der Liste bietet einige Felder zur direkten Bearbeitung an. 

Das Code-Symbol (vor dem Löschen-Button) zeigt einen Beispiel-Code zur Einbindung als iFrame an. Über den Button Testaufruf kann zudem der Produkt-Finder direkt aufgerufen
und schnell getestet werden.

Modus: Produkt Finder

Wählen Sie im Dropdown-Feld Modus den Eintrag Produkt Finder, erstellen Sie somit eine externe Einbindung für einen Produkt-Finder. Auf der externen Seite werden dann nach verschiedenen Kriterien Produkte gefiltert und dargestellt. Ein Klick auf ein bestimmtes Produkt führt den Nutzer direkt auf die Produkt-Detailseite in Ihrem Shop.

Wichtig: die Filterung erfolgt aufgrund der hinterlegten Artikel-Eigenschaften. Stellen Sie vor der Benutzung sicher, dass Artikel-Eigenschaften definiert und auch zugeordnet sind (Shopware-Backend Menü Artikel / Eigenschaften). Das Plugin wird sonst nicht funktionieren können!

Ein solcher Produkt-Finder kann zum Beispiel so aussehen:

Hier sind folgende Eingabefelder relevant:

SchlüsselTragen Sie hier einen kurzen, eindeutigen Schlüssel ein. Dieser wird später verwendet, um die Einbindung in der externen Seite anzusprechen. Verwenden Sie hier
keine Leer- oder Sonderzeichen.

Titel, Untertitel: Sie können einen Titel und Untertitel definieren, der über dem Produkt-Finder ausgegeben wird.

Hinweis: Falls definiert, wird dieser Hinweis unter dem Produkt-Finder ausgegeben,
z.B. als Hinweis auf „Werbung“.

Header-Bild und Beschreibung: Optional können zusätzlich noch ein Bild und eine kurze Beschreibung dargestellt werden.

Modus: Der Modus muss dann hier entsprechend auf „Produkt Finder“ gestellt werden.

Produkt-Stream: Hierüber definieren Sie, welche Produkte aus Ihrem Shop im Produkt-Finder verwendet werden sollen. Sie können diesen Produkt Stream wie gewohnt im Backend unter Artikel / Produtk Streams erstellen und können diesen dann hier zuordnen.

Subshop: Wählen Sie hier den Haupt- oder Subshop aus, für den Sie den Produkt-Finder erstellen möchten. Dies ist wichtig, damit die richtigen Produkte angesprochen werden und die Verlinkung auf die Produkt-Detailseite korrekt funktioniert.

Partner-ID: Falls Sie die über den Produkt-Finder generierten Umsätze einem bestimmten Affiliate-Partner zuordnen möchten, können Sie hier die entsprechende Partner ID eintragen. Hier wird das in Shopware enthaltene Partner-System verwendet, das Sie im Backend unter Marketing / Partnerprogramm einrichten können. 

CSS-Datei: Falls Sie Anpassungen an der Darstellung in der externen Seite vornehmen möchten, können Sie hier optional eine (absolute) URL auf eine externe CSS-Datei eintragen. Diese wird dann nach den CSS-Definitionen des Plugins geladen. Die CSS-Klassen können Sie aus dem Quelltext des erzeugten Produkt-Finders entnehmen.


Optische Gestaltung

Zusätzlich stehen Ihnen für den Modus Produkt Finder folgende Einstellungen zur Anpassung der Darstellung zur Verfügung: 

Farben: Hierüber lässt sich das Erscheinungsbild des Produkt-Finders Ihrem Branding anpassen.  

Zeige Shop Button: Falls angekreuzt, wird ein Button „Zum Shop“ im Produkt-Finder angezeigt und mit der Homepage Ihres Shops verlinkt.

Zeige alle Artikel beim Start: Ist diese Option gewählt, werden beim ersten Aufruf des Produkt-Finders (auf der externen Seite) alle möglichen Artikel aus dem zugeordneten Produkt-Stream angezeigt. Andernfalls ist die Artikelanzeige zunächst leer und wechselt
erst nach der ersten Auswahl in einer Filterbox.

Zeige Filtergruppe: Falls angekreuzt, wird hinter der Eigenschaft in den Filterboxen die jeweilige Filtergruppe mit dargestellt. Ebenso wird diese nach getätigter Auswahl dargestellt.

Anzeigemodus: Hier können Sie festlegen, ob in der Artikelbox nur der Artikelname, der Artikelname und Preis oder Artikelname, Preis und Kurzbeschreibung angezeigt werden soll.

Anzahl Artikel pro Zeile: Legen Sie hier fest, wieviele Artikelboxen jeweils in einer Zeile ausgegeben werden sollen. Aus Usability-Gründen sollten Sie einen Wert von 5-7 nicht überschreiten, aber das hängt etwas von der Breite der Produkteinbindung auf der externen Seite ab.

Höhe Artikelbox: Ebenso können Sie festlegen, wie hoch die Artikelboxen sein sollen. Der hier eingegebene Wert ist in rem definiert, also relativen Einheiten in Bezug auf die Schriftgröße. 1 rem entspricht also einer font-size von 100%. Typische Werte sind hier ca. 12-17rem, etwas abhängig von Ihren Produkten und ob noch die Kurzbeschreibung mit ausgegeben werden soll.


Filterboxen

Über den Tab Filterboxen können Sie nun definieren, welche Filter für den Produkt-Finder zur Verfügung stehen sollen. Falls Sie hier keine Filter definieren, wird der Produkt Stream ausgewertet und es stehen alle möglichen Eigenschafts-Filter zur Verfügung, die in diesem Stream grundsätzlich vorkommen können. Sie können jedoch dieses Standard-Verhalten leicht ändern, in dem Sie nur die gewünschten Boxen definieren. 

Klicken Sie zunächst auf den Button Neue Filterbox und wählen dann aus der neuen Zeile die gewünschte Option aus. Auch diese Optionen werden aus allen zur Verfügung stehenen Produkt-Eigenschaften (Backend / Artikel / Eigenschaften) entnommen. Weiterhin muss ein Titel für die neue Filterbox eingegeben werden. Unter Typ können Sie auswählen, ob eine normale Darstellung im späteren Filtermenü erfolgen soll, oder eine kompakte Ausgabe  erfolgt. Diese eignet sich besonders für Artikeleigenschaften, die mit Bildern hinterlegt sind, z.B. Produktfarben: 

In der Spalte Vorselektiert können Sie - falls gewünscht - einen bestimmten Vorbelegung für die Artikeleigenschaft eintragen, die dann beim Aufruf des Produkt-Finders bereits vorbelegt ist. Bitte achten Sie hier darauf, einen zur jeweiligen Eigenschaft passenden Wert auszuwählen, sonst wird die Filterbox später nicht funktionieren.

Tipp: die Reihenfolge der Filterboxen können Sie über Drag & Drop der jeweiligen Zeile verändern.


Modus: Produkt Slider / Fader

In diesem Modus verhält sich die Produkt-Einbindung anders: der Nutzer kann hier nicht über die Filterboxen Produkte auswählen, sondern diese werden automatisch nacheinander präsentiert. Die Produkte können hier als Slider (mehrere nebeneinander oder untereinander) oder Fader (jeweils ein Produkt, dass nach einer bestimmten Zeit wechselt) dargestellt werden.

Die Feldbedeutungen für Schlüssel, Titel etc. sind hier zunächst wie im Modus Produkt Finder (siehe oben). Folgende Optionen sind jedoch unterschiedlich:

Ausrichtung: Wählen Sie zwischen einer vertikalen oder horizontalen Darstellung der Artikelfader.

Effekt: Sie können hier bestimmen, wie der Fader/Slider aussehen soll: Coverflow, Cube, Fade, Flip (einzelne Anzeige der Produkte und unterschiedliche Übergangseffekte) oder Slide (mehrere Produkte werden nebeneinander oder untereinander dargestellt).

Geschwindigkeit: Hiermit legen Sie fest, nach welcher Zeit ein neues Produkt angezeigt werden soll (der Wert ist in Millisekunden angebenen, 2000 entspricht also 2 Sekunden).


Stream-Cache

Die Einbindung in die externen Seiten erfolgt wie beschrieben über einen Shopware-Produkt Stream. Dieser wird beim Aufrufen der externen Produkteinbindung einmalig von der externen Seite via Ajax abgerufen. Bei größeren Artikelmengen kann dies unter Umständen einige Zeit in Anspruch nehmen und belastet Ihren Shopserver zusätzlich. Daher wird der Abruf des Produkt Streams über einen Zwischenspeicher (Cache) realisiert und erfolgt somit sehr schnell und mit minimaler Serverbelastung. 

Wenn Sie häufige Änderungen am zugeordneten Product Stream vornehmen, sind diese zwischengespeicherten Daten jedoch unter Umständen nicht aktuell. Sie können daher den Stream Cache über den gewohnten Shopware-Mechanismus zum Löschen der Caches manuell löschen: Wählen Sie einfach im Backend den Menüpunkt Einstellungen / Caches/Performance / Shop cache leeren.

Tipp: Falls Sie den Shopware Cache über einen CRON-Job etwa nächtlich löschen und neuaufbauen lassen (über den cache warmer), können Sie mit einem zusätzlichen Konsolenbefehl 

sw:warm:productembed:cache

den Stream-Cache für die Produktintegrationen ebenfalls erneuern.

Die Cache-Zeit können Sie insgesamt in den Plugin-Einstellungen definieren und mit dem Wert 0 auch komplett ausschalten. Dies ist jedoch nur empfehlenswert, wenn relativ wenig Produkte (maximal wenige hundert) in einen externen Produkt-Finder übertragen werden sollen.


WordPress-Plugin

Um die Einbindung in ein externes WordPress-Blog zu vereinfachen, können Sie hier ein WordPress-Plugin als ZIP-Datei herunterladen. Entpacken Sie dieses Plugin wie gewohnt in Ihren WordPress-Ordner
wp-content/plugins und aktivieren es im WordPress-Backend.

Ihnen stehen dann ein Shortcode sowie ein WordPress-Widget zur Verfügung.

Den Shortcode können an beliebiger Stelle in Posts oder Seiten verwenden, der Aufruf ist wie folgt:

    [shopware shop="www.IhrShop.de" key=„schlüssel"]


Das Widget Shopware Einbindung können Sie in eine beliebige Seitenleiste ziehen und die entsprechenden Parameter ausfüllen. In beiden Fällen wird der notwendige Code für die Einbindung mittels iFrame automatisch erzeugt. 


Textanpassungen / Übersetzungen

Sie können sämtliche Texte des Plugins sowohl für das Backend als auch für die Darstellung der Produkteinbindung auf den externen Seiten über das Textbaustein-System von Shopware verändern (Backend / Einstellungen / Textbausteine). Der Namespace lautet netzperfekt / productembed. 

Hier können Sie individuelle Anpassungen vornehmen oder das Plugin in andere Sprachen übersetzen. Eine englische Übersetzung wird bereits mitgeliefert.


Wir wünschen Ihnen viel Erfolg 
mit unserem Plugin und 
gute Geschäfte mit Shopware.