Push Notifications (OneSignal) für Shopware 6
- Christopher Holst
- Sebastian Krziwanie
- Ümit Cekirge
Vorwort
Wir freuen uns, dass Sie sich für unser Plugin Push Notifications (OneSignal) entschieden haben.
Das Plugin bietet Ihnen die Möglichkeit, Push Notifications basierend auf dem kostenlosen Service von OneSignal in Ihren Shop zu integrieren und dies unabhängig voneinander für jeden Haupt- oder Subshop mit eigenständiger Domain.
Sprachshops mit virtueller URL bieten Push Notifications über die Domain des Hauptshops. Die Spracheinstellung des Shops wird OneSignal als Tag zur Verfügung gestellt, so dass eine Segmentierung der Benutzer nach Spracheinstellung möglich ist. Eine detaillierte Plugin Konfiguration ermöglich es Ihnen, Design und Texte von Anmeldeglocke und Dialogen für jeden Shop explizit anzupassen.
Sollten Sie Vorschläge zur Weiterentwicklung des Plugins haben oder individuelle Anpassungen wünschen, zögern Sie nicht, uns zu kontaktieren. Registrieren Sie sich hierzu unter SYNERGY NETWORKS GmbH und erstellen ein Ticket für unser Entwicklerteam. Wir setzen uns anschließend umgehend mit Ihnen in Verbindung.
Anleitung
Wie Sie unser Plugin Push Notifications (One Signal) nach Ihren Anforderungen anpassen, zeigen wir Ihnen Schritt für Schritt in dieser Dokumentation.
Inhaltsverzeichnis
- 1 1. Systemvoraussetzungen
- 2 2. Installation und Update
- 3 3. OneSignal Account
- 4 4. Konfiguration des Plugins
- 5 5. Verfügbare Shopware Tags
- 6 6. Changelog
- 6.1 Version 3.3.0
- 6.2 Version 3.2.0
- 6.3 Version 3.1.0
- 6.4 Version 3.0.0
- 6.5 Version 2.1.0
- 6.6 Version 2.0.0
- 6.7 Version 1.0.7
- 6.8 Version 1.0.6
- 6.9 Version 1.0.5
- 6.10 Version 1.0.4
- 6.11 Version 1.0.3
- 6.12 Version 1.0.2
- 6.13 Version 1.0.1
- 6.14 Version 1.0.0
1. Systemvoraussetzungen
Bitte beachten Sie, dass die OneSignal Implementierung unseres Plugins die vollständige Unterstützung des HTTPS-Protokolls durch Ihren Shop voraussetzt!
2. Installation und Update
2.1 Plugin testen/ mieten
Sie haben die Möglichkeit, das Plugin vor der Miete ausgiebig zu testen. Wir stellen Ihnen einen Shopware-Demoshop zur Verfügung, um das Plugin im Backend und im Frontend zu testen.
Sie erreichen das Frontend unter demo6.synergynetworks.de und das Backend unter https://demo6.synergynetworks.de/admin
Benutzername: push
Passwort: notifications
Nach Abschluss der Bestellung der Mietversion im Shopware-Store befinden sich Downloads und Lizenzen in der Lizenz-Verwaltung Ihres Shopware-Accounts.
2.2 Plugin installieren/updaten
Zur Installation des Plugins:
öffnen Sie Erweiterungen > Meine Erweiterungen in der Shopware-Administration,
installieren bzw. updaten Sie das Plugin,
falls nicht bereits geschehen, aktivieren Sie das Plugin.
3. OneSignal Account
Zum Verwalten und Versenden der Push Notifications wird der kostenlose Push Notification Service von OneSignal verwendet. Erstellen Sie dazu bitte unter nachfolgender URL einen Account bei OneSignal: OneSignal Registrierung
3.1 Anmelden
Klicken Sie in der Navigation der Seite auf LOG IN und nutzen Sie eine der im Dialog aufgeführten Optionen zur Erstellung Ihres OneSignal Accounts.
3.2 One Signal App
3.2.1 OneSignal App erstellen
Nach der Anmeldung bei OneSignal wird Ihnen ein Dialogfeld angezeigt, um Sie durch die ersten Schritte der Einrichtung zu führen. Wählen Sie auf der letzten Seite des Dialogs „New App/Website“ (1).
Geben Sie einen Namen (1) für Ihre neue OneSignal App ein. Tragen Sie den Firmennamen (2) ein.
Eine OneSignal App verwaltet Push Notifications für jeweils eine Domain (Dies entspricht einem Haupt- oder Subshop). Idealerweise verwenden Sie hier die Domain des betreffenden Shops, z.B. mein-shop.de.
Wählen Sie die Einstellung „Web" (3) aus.
3.2.2 Web Configuration
Wählen Sie hier Custom Code (1) aus. Tragen Sie den Shopnamen (2) ein. Geben Sie die URL (3) des Shops ein, für den Sie die OneSignal App einrichten. Optional kann ein eigenes Benachrichtigungs-Icon per Upload oder URL (4) hinterlegt werden. Speichern (5) Sie Ihre Einstellungen ab.
Hinweis: Bitte beachten Sie bei der Einrichtung, dass wir Ihnen an dieser Stelle dringend empfehlen, Ihre Seite auf https umzustellen, falls dies nicht bereits geschehen ist.
3.2.3 APP-ID und Safari-Web-ID
Nach dem Speichern öffnet sich eine weitere Seite der Web Configuration. Kopieren Sie (unter dem Punkt Add Code to Site) nun die APP-ID (1) und hinterlegen diese in der Plugin-Konfiguration in Ihrer Shopware-Administration. Kopieren Sie die Safari-Web-ID (2) und hinterlegen diese in der Plugin-Konfiguration in Ihrer Shopware-Administration.
Grundsätzlich können Sie Ihre OneSignal Apps immer über das Side-Menü unter dem Punkt „All Apps" verwalten. Hier lassen sich Apps anlegen, löschen oder bearbeiten.
3.2.4 API-Schlüssel
Um den API-Schlüssel zu erstellen, gehen Sie in die Einstellung Settings (1) und wählen die Einstellung Keys & IDs (2) aus.
Wählen Sie nun die Einstellung Add Key (1).
Tragen Sie in das Eingabefeld einen Namen (1) ein und erzeugen Sie den API-Schlüssel (2).
Kopieren Sie den API-Schlüssel (1) und hinterlegen diesen in der Plugin-Konfiguration in Ihrer Shopware-Administration.
4. Konfiguration des Plugins
Die Plugin-Konfiguration in Ihrer Shopware-Administration ist spezifisch für jeden Shop und untergliedert sich in mehrere Abschnitte. Im Folgenden werden die Einstellungen der einzelnen Abschnitte näher erklärt.
4.1 Grundeinstellungen
In den Grundeinstellungen wird die Verbindung zum OneSignal Notification Service konfiguriert. Tragen Sie hier die App ID ein, die Ihnen beim Erstellen der OneSignal App für diese Domain ausgegeben wurde, weiterhin Namen und Kurznamen Ihrer Seite bzw. Ihres Unternehmens. Sie müssen den API-Schlüssel schreiben, um Ihre Anmeldeinformationen zu validieren/überprüfen.
(1) Tragen Sie hier Ihre APP-ID ein, die Ihnen beim Erstellen der OneSignal App (siehe 2.2.4) für diese Domain ausgegeben wurde.
(2) Tragen Sie hier den Namen Ihres Unternehmens oder Ihrer Seite ein.
(3) Tragen Sie hier den Kurznamen Ihres Unternehmens oder Ihrer Seite ein.
(4) Tragen Sie hier die Safari-Web-ID ein, die Ihnen beim Erstellen der OneSignal App (siehe 2.2.4) für diese Domain ausgegeben wurde.
(5) Tragen Sie hier den API-Schlüssel ein, die Ihnen beim Erstellen der OneSignal App (siehe 2.2.5) für diese Domain ausgegeben wurde.
(6) Validieren Sie die Anmeldeinformationen.
Hinweis: Bitte beachten Sie, dass bei der Konfiguration eines Sprachshops (Shop mit virtueller URL wie z.B. https://mein-shop.de/en) die Konfiguration der Verbindungsdaten mit dem Hauptshop identisch sein muss!
4.2 Cookie-Einstellungen
Hinweis: Zur Anzeige im Frontend müssen die notwendigen Cookies vom Nutzer/ Kunden akzeptiert werden. Nutzen Sie in Ihrem Shop den Standard-Cookie-Hinweises von Shopware: Entweder „Alle Cookies akzeptieren“ oder in der Konfiguration der Cookie-Voreinstellung > Komfortfunktion > One Signal: Push-Benachrichtigung akzeptieren.
(1) Auswahl, um innerhalb der Komfortfunktion des Standard-Cookie-Hinweises von Shopware das Auswahlfeld für die Cookie-Einstellungen anzuzeigen oder nicht.
(2) Falls Sie Usercentrics für das Cookie-Management auf Ihrer Website verwenden, aktivieren Sie es bitte.
(3) Bitte geben Sie den Titel des Cookies an, das Sie in Usercentrics für OneSignal erstellt haben.
4.3 Einstellungen
4.3.1 Anmeldeglocke Einstellungen
Die Einstellungen für die Anmeldeglocke sind selbsterklärend. Die Eingabe der Werte für die Abstände sind in CSS-konformen Größen möglich (px, %, em usw.). Der Abstand links bzw. rechts wird nur beachtet, wenn die Anmeldeglocke auch links bzw. rechts positioniert ist.
4.3.2 Anmeldeglocke Texte
Die Texte für die Anmeldeglocke sind bereits mit Standardwerten vorbelegt. Sie können diese Texte Ihren Bedürfnissen entsprechend anpassen und sollten dies für fremdsprachige Subshops auch unbedingt tun.
4.3.3 Anmeldeglocke Farben
Um die Anmeldeglocke an das Design Ihres Shops anzupassen, können Sie alle relevanten Farbwerte der Anmeldeglocke selbst spezifizieren. Sie können Farben in Form von Hex-Werten, RGB-Angaben oder als String eingeben.
4.3.4 Willkommensnachricht Texte
Hier konfigurieren Sie Titel und Nachricht der ersten Push Notification, die der Kunde erhält, nachdem er sich für die Push Notifications angemeldet hat.
4.3.5 Slide Prompt Einstellungen
In dieser Einstellung können Sie die Einwilligungsbenachrichtigung in der Shopansicht konfigurieren.
(1) Verzögerung der Eingabeaufforderung
Gibt an, ab welchem Seitenaufruf, die Eingabeaufforderung angezeigt/ geladen wird.
(2) Delay Time
Gibt die Zeit (in Sekunden) an, die vergeht, bis die Eingabeaufforderung eingeblendet wird.
(3) Aktionsnachricht
Tragen Sie hier Ihre Benachrichtigungsmitteilung ein. Im Standard ist Wir möchten Ihnen Benachrichtigungen über die neuesten Nachrichten und Updates anzeigen gesetzt.
(4) Schaltfläche Akzeptieren
Tragen Sie hier den Namen der Schaltfläche ein. Im Standard ist Akzeptieren gesetzt.
(5) Schaltfläche Abrechen
Tragen Sie hier den Namen der Schaltfläche ein. Im Standard ist Abrechen gesetzt.
5. Verfügbare Shopware Tags
Zusätzlich zu den von OneSignal angebotenen allgemeinen Tags, stellt das Plugin weitere Tags zur Verfügung, die Sie im OneSignal Dashboard verwenden können, um Segmente zu
erstellen. Diese Segmente verwenden Tag-Filter, um Benutzergruppen zu definieren, denen sie Push Notifications senden können.
TagsTA | Filterwerte |
user_id |
|
user_type | Kürzel der Kundengruppe |
salutation | mr, ms |
firstname |
|
lastname |
|
realname | Vorname Nachname |
birthdate | yyyy-MM-dd (Bsp: 1965-05-02) |
gender | mr, ms, company (Rechnungsadresse) |
postcode | Postleitzahl der Rechnungsadresse |
region | Ort (Rechnungsadresse) |
birthyear | yyyy |
user_type_firstlogin | yyyyMMdd (Bsp: 20161105) |
user_type_lastlogindate | yyyyMMdd |
user_type_lastlogintime | hhmmss (Bsp: 163422) |
user_type_newsletter | 0, 1 |
user_type_shop | Name des Shops |
6. Changelog
Version 3.3.0
Für Safari-Nutzer wurde eine Verbesserung bezüglich des Problems mit dem Abonnieren vorgenommen.
Version 3.2.0
Eine Integration für das Cookie-Management mit Usercentrics wurde implementiert.
Version 3.1.0
Eine Integration für das Cookie-Management mit Usercentrics wurde implementiert.
Version 3.0.0
Kompatibilität mit Shopware 6.6
Version 2.1.0
Aktualisiert gemäß Onesignal v11.0
Version 2.0.0
Kompatibilität mit Shopware 6.5
Version 1.0.7
Kompatibilität mit Shopware 6.4.15.0. Jetzt direkt kompatibel mit minor Updates.
Version 1.0.6
Kompatibilität mit Shopware 6.4.14.0
Version 1.0.5
Kompatibilität mit Shopware 6.4.13.0
Version 1.0.4
Kompatibilität mit Shopware 6.4.12.0
Version 1.0.3
Kompatibilität mit Shopware 6.4.11.1
Version 1.0.2
Neue Konfiguration zum Ändern der Cookie-Gruppe des Plugins entsprechend der Verkaufskanälen hinzugefügt.
Version 1.0.1
Der API-Test-Button ist jetzt mit neuen Versionen kompatibel. Funktion zum Zusammenführen von Cookies überarbeitet.
Version 1.0.0
Initiale Veröffentlichung